ripple

package
v0.12.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 28, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_txproto_ripple_ripple_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AccountSet added in v0.10.0

type AccountSet struct {
	SetFlag      uint32 `protobuf:"varint,1,opt,name=set_flag,json=setFlag,proto3" json:"set_flag,omitempty"`                // AccountSetFlag to enable (0 = not set)
	ClearFlag    uint32 `protobuf:"varint,2,opt,name=clear_flag,json=clearFlag,proto3" json:"clear_flag,omitempty"`          // AccountSetFlag to disable (0 = not set)
	Domain       []byte `protobuf:"bytes,3,opt,name=domain,proto3" json:"domain,omitempty"`                                  // domain name as bytes; empty = not set
	TransferRate uint32 `protobuf:"varint,4,opt,name=transfer_rate,json=transferRate,proto3" json:"transfer_rate,omitempty"` // 1000000000–2000000000; 0 = not set
	TickSize     uint32 `protobuf:"varint,5,opt,name=tick_size,json=tickSize,proto3" json:"tick_size,omitempty"`             // 3–15; 0 = not set
	// contains filtered or unexported fields
}

AccountSet — modify account flags/domain.

func (*AccountSet) Descriptor deprecated added in v0.10.0

func (*AccountSet) Descriptor() ([]byte, []int)

Deprecated: Use AccountSet.ProtoReflect.Descriptor instead.

func (*AccountSet) GetClearFlag added in v0.10.0

func (x *AccountSet) GetClearFlag() uint32

func (*AccountSet) GetDomain added in v0.10.0

func (x *AccountSet) GetDomain() []byte

func (*AccountSet) GetSetFlag added in v0.10.0

func (x *AccountSet) GetSetFlag() uint32

func (*AccountSet) GetTickSize added in v0.10.0

func (x *AccountSet) GetTickSize() uint32

func (*AccountSet) GetTransferRate added in v0.10.0

func (x *AccountSet) GetTransferRate() uint32

func (*AccountSet) ProtoMessage added in v0.10.0

func (*AccountSet) ProtoMessage()

func (*AccountSet) ProtoReflect added in v0.10.0

func (x *AccountSet) ProtoReflect() protoreflect.Message

func (*AccountSet) Reset added in v0.10.0

func (x *AccountSet) Reset()

func (*AccountSet) String added in v0.10.0

func (x *AccountSet) String() string

type EscrowCreate added in v0.10.0

type EscrowCreate struct {
	Amount         string `protobuf:"bytes,1,opt,name=amount,proto3" json:"amount,omitempty"`                                        // drops
	Destination    string `protobuf:"bytes,2,opt,name=destination,proto3" json:"destination,omitempty"`                              // XRP address
	DestinationTag uint32 `protobuf:"varint,3,opt,name=destination_tag,json=destinationTag,proto3" json:"destination_tag,omitempty"` // 0 = not set
	CancelAfter    uint32 `protobuf:"varint,4,opt,name=cancel_after,json=cancelAfter,proto3" json:"cancel_after,omitempty"`          // Ripple epoch; 0 = not set
	FinishAfter    uint32 `protobuf:"varint,5,opt,name=finish_after,json=finishAfter,proto3" json:"finish_after,omitempty"`          // Ripple epoch; 0 = not set
	Condition      []byte `protobuf:"bytes,6,opt,name=condition,proto3" json:"condition,omitempty"`                                  // PREIMAGE-SHA-256 condition bytes; empty = not set
	// contains filtered or unexported fields
}

EscrowCreate — time-locked payment.

func (*EscrowCreate) Descriptor deprecated added in v0.10.0

func (*EscrowCreate) Descriptor() ([]byte, []int)

Deprecated: Use EscrowCreate.ProtoReflect.Descriptor instead.

func (*EscrowCreate) GetAmount added in v0.10.0

func (x *EscrowCreate) GetAmount() string

func (*EscrowCreate) GetCancelAfter added in v0.10.0

func (x *EscrowCreate) GetCancelAfter() uint32

func (*EscrowCreate) GetCondition added in v0.10.0

func (x *EscrowCreate) GetCondition() []byte

func (*EscrowCreate) GetDestination added in v0.10.0

func (x *EscrowCreate) GetDestination() string

func (*EscrowCreate) GetDestinationTag added in v0.10.0

func (x *EscrowCreate) GetDestinationTag() uint32

func (*EscrowCreate) GetFinishAfter added in v0.10.0

func (x *EscrowCreate) GetFinishAfter() uint32

func (*EscrowCreate) ProtoMessage added in v0.10.0

func (*EscrowCreate) ProtoMessage()

func (*EscrowCreate) ProtoReflect added in v0.10.0

func (x *EscrowCreate) ProtoReflect() protoreflect.Message

func (*EscrowCreate) Reset added in v0.10.0

func (x *EscrowCreate) Reset()

func (*EscrowCreate) String added in v0.10.0

func (x *EscrowCreate) String() string

type EscrowFinish added in v0.10.0

type EscrowFinish struct {
	Owner         string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`                                       // address of escrow creator
	OfferSequence uint32 `protobuf:"varint,2,opt,name=offer_sequence,json=offerSequence,proto3" json:"offer_sequence,omitempty"` // sequence of the EscrowCreate tx
	Condition     []byte `protobuf:"bytes,3,opt,name=condition,proto3" json:"condition,omitempty"`                               // PREIMAGE-SHA-256 condition; empty if no condition
	Fulfillment   []byte `protobuf:"bytes,4,opt,name=fulfillment,proto3" json:"fulfillment,omitempty"`                           // preimage bytes; empty if no condition
	// contains filtered or unexported fields
}

EscrowFinish — release an escrow.

func (*EscrowFinish) Descriptor deprecated added in v0.10.0

func (*EscrowFinish) Descriptor() ([]byte, []int)

Deprecated: Use EscrowFinish.ProtoReflect.Descriptor instead.

func (*EscrowFinish) GetCondition added in v0.10.0

func (x *EscrowFinish) GetCondition() []byte

func (*EscrowFinish) GetFulfillment added in v0.10.0

func (x *EscrowFinish) GetFulfillment() []byte

func (*EscrowFinish) GetOfferSequence added in v0.10.0

func (x *EscrowFinish) GetOfferSequence() uint32

func (*EscrowFinish) GetOwner added in v0.10.0

func (x *EscrowFinish) GetOwner() string

func (*EscrowFinish) ProtoMessage added in v0.10.0

func (*EscrowFinish) ProtoMessage()

func (*EscrowFinish) ProtoReflect added in v0.10.0

func (x *EscrowFinish) ProtoReflect() protoreflect.Message

func (*EscrowFinish) Reset added in v0.10.0

func (x *EscrowFinish) Reset()

func (*EscrowFinish) String added in v0.10.0

func (x *EscrowFinish) String() string

type OfferCancel added in v0.10.0

type OfferCancel struct {
	OfferSequence uint32 `protobuf:"varint,1,opt,name=offer_sequence,json=offerSequence,proto3" json:"offer_sequence,omitempty"` // sequence number of the offer to cancel
	// contains filtered or unexported fields
}

OfferCancel — cancel an existing DEX order.

func (*OfferCancel) Descriptor deprecated added in v0.10.0

func (*OfferCancel) Descriptor() ([]byte, []int)

Deprecated: Use OfferCancel.ProtoReflect.Descriptor instead.

func (*OfferCancel) GetOfferSequence added in v0.10.0

func (x *OfferCancel) GetOfferSequence() uint32

func (*OfferCancel) ProtoMessage added in v0.10.0

func (*OfferCancel) ProtoMessage()

func (*OfferCancel) ProtoReflect added in v0.10.0

func (x *OfferCancel) ProtoReflect() protoreflect.Message

func (*OfferCancel) Reset added in v0.10.0

func (x *OfferCancel) Reset()

func (*OfferCancel) String added in v0.10.0

func (x *OfferCancel) String() string

type OfferCreate added in v0.10.0

type OfferCreate struct {
	TakerPaysCurrency string `protobuf:"bytes,1,opt,name=taker_pays_currency,json=takerPaysCurrency,proto3" json:"taker_pays_currency,omitempty"` // empty/"XRP" = native drops
	TakerPaysIssuer   string `protobuf:"bytes,2,opt,name=taker_pays_issuer,json=takerPaysIssuer,proto3" json:"taker_pays_issuer,omitempty"`
	TakerPaysValue    string `protobuf:"bytes,3,opt,name=taker_pays_value,json=takerPaysValue,proto3" json:"taker_pays_value,omitempty"` // drops string if native, decimal if issued
	TakerGetsCurrency string `protobuf:"bytes,4,opt,name=taker_gets_currency,json=takerGetsCurrency,proto3" json:"taker_gets_currency,omitempty"`
	TakerGetsIssuer   string `protobuf:"bytes,5,opt,name=taker_gets_issuer,json=takerGetsIssuer,proto3" json:"taker_gets_issuer,omitempty"`
	TakerGetsValue    string `protobuf:"bytes,6,opt,name=taker_gets_value,json=takerGetsValue,proto3" json:"taker_gets_value,omitempty"`
	Flags             uint32 `protobuf:"varint,7,opt,name=flags,proto3" json:"flags,omitempty"`
	OfferSequence     uint32 `protobuf:"varint,8,opt,name=offer_sequence,json=offerSequence,proto3" json:"offer_sequence,omitempty"` // sequence of an existing offer to replace (0 = new)
	// contains filtered or unexported fields
}

OfferCreate — place a DEX order.

func (*OfferCreate) Descriptor deprecated added in v0.10.0

func (*OfferCreate) Descriptor() ([]byte, []int)

Deprecated: Use OfferCreate.ProtoReflect.Descriptor instead.

func (*OfferCreate) GetFlags added in v0.10.0

func (x *OfferCreate) GetFlags() uint32

func (*OfferCreate) GetOfferSequence added in v0.10.0

func (x *OfferCreate) GetOfferSequence() uint32

func (*OfferCreate) GetTakerGetsCurrency added in v0.10.0

func (x *OfferCreate) GetTakerGetsCurrency() string

func (*OfferCreate) GetTakerGetsIssuer added in v0.10.0

func (x *OfferCreate) GetTakerGetsIssuer() string

func (*OfferCreate) GetTakerGetsValue added in v0.10.0

func (x *OfferCreate) GetTakerGetsValue() string

func (*OfferCreate) GetTakerPaysCurrency added in v0.10.0

func (x *OfferCreate) GetTakerPaysCurrency() string

func (*OfferCreate) GetTakerPaysIssuer added in v0.10.0

func (x *OfferCreate) GetTakerPaysIssuer() string

func (*OfferCreate) GetTakerPaysValue added in v0.10.0

func (x *OfferCreate) GetTakerPaysValue() string

func (*OfferCreate) ProtoMessage added in v0.10.0

func (*OfferCreate) ProtoMessage()

func (*OfferCreate) ProtoReflect added in v0.10.0

func (x *OfferCreate) ProtoReflect() protoreflect.Message

func (*OfferCreate) Reset added in v0.10.0

func (x *OfferCreate) Reset()

func (*OfferCreate) String added in v0.10.0

func (x *OfferCreate) String() string

type Payment

type Payment struct {
	Amount         int64  `protobuf:"varint,1,opt,name=amount,proto3" json:"amount,omitempty"`          // drops
	Destination    string `protobuf:"bytes,2,opt,name=destination,proto3" json:"destination,omitempty"` // r... address
	DestinationTag int64  `protobuf:"varint,3,opt,name=destination_tag,json=destinationTag,proto3" json:"destination_tag,omitempty"`
	// contains filtered or unexported fields
}

XRP (native) payment.

func (*Payment) Descriptor deprecated

func (*Payment) Descriptor() ([]byte, []int)

Deprecated: Use Payment.ProtoReflect.Descriptor instead.

func (*Payment) GetAmount

func (x *Payment) GetAmount() int64

func (*Payment) GetDestination

func (x *Payment) GetDestination() string

func (*Payment) GetDestinationTag

func (x *Payment) GetDestinationTag() int64

func (*Payment) ProtoMessage

func (*Payment) ProtoMessage()

func (*Payment) ProtoReflect

func (x *Payment) ProtoReflect() protoreflect.Message

func (*Payment) Reset

func (x *Payment) Reset()

func (*Payment) String

func (x *Payment) String() string

type SigningInput

type SigningInput struct {
	Fee                int64  `protobuf:"varint,1,opt,name=fee,proto3" json:"fee,omitempty"`
	Sequence           uint32 `protobuf:"varint,2,opt,name=sequence,proto3" json:"sequence,omitempty"`
	LastLedgerSequence uint32 `protobuf:"varint,3,opt,name=last_ledger_sequence,json=lastLedgerSequence,proto3" json:"last_ledger_sequence,omitempty"`
	Account            string `protobuf:"bytes,4,opt,name=account,proto3" json:"account,omitempty"` // sender r... address
	Flags              uint32 `protobuf:"varint,5,opt,name=flags,proto3" json:"flags,omitempty"`
	// Types that are valid to be assigned to Transaction:
	//
	//	*SigningInput_Payment
	//	*SigningInput_TrustSet
	//	*SigningInput_OfferCreate
	//	*SigningInput_OfferCancel
	//	*SigningInput_EscrowCreate
	//	*SigningInput_EscrowFinish
	//	*SigningInput_AccountSet
	Transaction isSigningInput_Transaction `protobuf_oneof:"transaction"`
	// contains filtered or unexported fields
}

SigningInput for XRP Ledger transactions.

func (*SigningInput) Descriptor deprecated

func (*SigningInput) Descriptor() ([]byte, []int)

Deprecated: Use SigningInput.ProtoReflect.Descriptor instead.

func (*SigningInput) GetAccount

func (x *SigningInput) GetAccount() string

func (*SigningInput) GetAccountSet added in v0.10.0

func (x *SigningInput) GetAccountSet() *AccountSet

func (*SigningInput) GetEscrowCreate added in v0.10.0

func (x *SigningInput) GetEscrowCreate() *EscrowCreate

func (*SigningInput) GetEscrowFinish added in v0.10.0

func (x *SigningInput) GetEscrowFinish() *EscrowFinish

func (*SigningInput) GetFee

func (x *SigningInput) GetFee() int64

func (*SigningInput) GetFlags

func (x *SigningInput) GetFlags() uint32

func (*SigningInput) GetLastLedgerSequence

func (x *SigningInput) GetLastLedgerSequence() uint32

func (*SigningInput) GetOfferCancel added in v0.10.0

func (x *SigningInput) GetOfferCancel() *OfferCancel

func (*SigningInput) GetOfferCreate added in v0.10.0

func (x *SigningInput) GetOfferCreate() *OfferCreate

func (*SigningInput) GetPayment

func (x *SigningInput) GetPayment() *Payment

func (*SigningInput) GetSequence

func (x *SigningInput) GetSequence() uint32

func (*SigningInput) GetTransaction added in v0.10.0

func (x *SigningInput) GetTransaction() isSigningInput_Transaction

func (*SigningInput) GetTrustSet added in v0.10.0

func (x *SigningInput) GetTrustSet() *TrustSet

func (*SigningInput) ProtoMessage

func (*SigningInput) ProtoMessage()

func (*SigningInput) ProtoReflect

func (x *SigningInput) ProtoReflect() protoreflect.Message

func (*SigningInput) Reset

func (x *SigningInput) Reset()

func (*SigningInput) String

func (x *SigningInput) String() string

type SigningInput_AccountSet added in v0.10.0

type SigningInput_AccountSet struct {
	AccountSet *AccountSet `protobuf:"bytes,16,opt,name=account_set,json=accountSet,proto3,oneof"`
}

type SigningInput_EscrowCreate added in v0.10.0

type SigningInput_EscrowCreate struct {
	EscrowCreate *EscrowCreate `protobuf:"bytes,14,opt,name=escrow_create,json=escrowCreate,proto3,oneof"`
}

type SigningInput_EscrowFinish added in v0.10.0

type SigningInput_EscrowFinish struct {
	EscrowFinish *EscrowFinish `protobuf:"bytes,15,opt,name=escrow_finish,json=escrowFinish,proto3,oneof"`
}

type SigningInput_OfferCancel added in v0.10.0

type SigningInput_OfferCancel struct {
	OfferCancel *OfferCancel `protobuf:"bytes,13,opt,name=offer_cancel,json=offerCancel,proto3,oneof"`
}

type SigningInput_OfferCreate added in v0.10.0

type SigningInput_OfferCreate struct {
	OfferCreate *OfferCreate `protobuf:"bytes,12,opt,name=offer_create,json=offerCreate,proto3,oneof"`
}

type SigningInput_Payment added in v0.10.0

type SigningInput_Payment struct {
	Payment *Payment `protobuf:"bytes,10,opt,name=payment,proto3,oneof"`
}

type SigningInput_TrustSet added in v0.10.0

type SigningInput_TrustSet struct {
	TrustSet *TrustSet `protobuf:"bytes,11,opt,name=trust_set,json=trustSet,proto3,oneof"`
}

type SigningOutput

type SigningOutput struct {
	Encoded    []byte `protobuf:"bytes,1,opt,name=encoded,proto3" json:"encoded,omitempty"` // serialized signed transaction
	EncodedHex string `protobuf:"bytes,2,opt,name=encoded_hex,json=encodedHex,proto3" json:"encoded_hex,omitempty"`
	Error      string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// Transaction id/hash: upper-case hex of the first 32 bytes of SHA-512 over
	// the serialized signed transaction (sha512Half).
	TxId string `protobuf:"bytes,4,opt,name=tx_id,json=txId,proto3" json:"tx_id,omitempty"`
	// contains filtered or unexported fields
}

SigningOutput mirrors a minimal subset of TW.Ripple.Proto.SigningOutput.

func (*SigningOutput) Descriptor deprecated

func (*SigningOutput) Descriptor() ([]byte, []int)

Deprecated: Use SigningOutput.ProtoReflect.Descriptor instead.

func (*SigningOutput) GetEncoded

func (x *SigningOutput) GetEncoded() []byte

func (*SigningOutput) GetEncodedHex

func (x *SigningOutput) GetEncodedHex() string

func (*SigningOutput) GetError

func (x *SigningOutput) GetError() string

func (*SigningOutput) GetTxId added in v0.6.0

func (x *SigningOutput) GetTxId() string

func (*SigningOutput) ProtoMessage

func (*SigningOutput) ProtoMessage()

func (*SigningOutput) ProtoReflect

func (x *SigningOutput) ProtoReflect() protoreflect.Message

func (*SigningOutput) Reset

func (x *SigningOutput) Reset()

func (*SigningOutput) String

func (x *SigningOutput) String() string

type TrustSet added in v0.10.0

type TrustSet struct {
	LimitAmountCurrency string `protobuf:"bytes,1,opt,name=limit_amount_currency,json=limitAmountCurrency,proto3" json:"limit_amount_currency,omitempty"` // 3-letter or 40-hex currency code
	LimitAmountIssuer   string `protobuf:"bytes,2,opt,name=limit_amount_issuer,json=limitAmountIssuer,proto3" json:"limit_amount_issuer,omitempty"`       // base58check XRP address
	LimitAmountValue    string `protobuf:"bytes,3,opt,name=limit_amount_value,json=limitAmountValue,proto3" json:"limit_amount_value,omitempty"`          // decimal string, e.g. "1000000"
	Flags               uint32 `protobuf:"varint,4,opt,name=flags,proto3" json:"flags,omitempty"`
	// contains filtered or unexported fields
}

TrustSet — create/modify a trust line for an issued currency.

func (*TrustSet) Descriptor deprecated added in v0.10.0

func (*TrustSet) Descriptor() ([]byte, []int)

Deprecated: Use TrustSet.ProtoReflect.Descriptor instead.

func (*TrustSet) GetFlags added in v0.10.0

func (x *TrustSet) GetFlags() uint32

func (*TrustSet) GetLimitAmountCurrency added in v0.10.0

func (x *TrustSet) GetLimitAmountCurrency() string

func (*TrustSet) GetLimitAmountIssuer added in v0.10.0

func (x *TrustSet) GetLimitAmountIssuer() string

func (*TrustSet) GetLimitAmountValue added in v0.10.0

func (x *TrustSet) GetLimitAmountValue() string

func (*TrustSet) ProtoMessage added in v0.10.0

func (*TrustSet) ProtoMessage()

func (*TrustSet) ProtoReflect added in v0.10.0

func (x *TrustSet) ProtoReflect() protoreflect.Message

func (*TrustSet) Reset added in v0.10.0

func (x *TrustSet) Reset()

func (*TrustSet) String added in v0.10.0

func (x *TrustSet) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL