types

Documentation

Index

• type Alternative
• type BookOffer
• type BookOfferCurrency
• type RippleAlternative
• type RipplePathFindCurrency

Types

type Alternative

type Alternative struct {
	PathsComputed [][]transaction.PathStep `json:"paths_computed"`
	// SourceAmount      types.CurrencyAmount     `json:"source_amount"`
	SourceAmount any `json:"source_amount"`
	// DestinationAmount types.CurrencyAmount     `json:"destination_amount,omitempty"`
	DestinationAmount any `json:"destination_amount,omitempty"`
}

type BookOffer

type BookOffer struct {
	// The unique ID for this ledger entry. In JSON, this field is represented with different names depending on the
	// context and API method. (Note, even though this is specified as "optional" in the code, every ledger entry
	// should have one unless it's legacy data from very early in the XRP Ledger's history.)
	Index types.Hash256 `json:"index,omitempty"`
	// Set of bit-flags for this ledger entry.
	Flags uint32
	// The value 0x006F, mapped to the string Offer, indicates that this is an Offer entry.
	LedgerEntryType ledger.EntryType
	// The address of the account that owns this Offer.
	Account types.Address
	// The ID of the Offer Directory that links to this Offer.
	BookDirectory types.Hash256
	// A hint indicating which page of the offer directory links to this entry, in case the
	// directory consists of multiple pages.
	BookNode string
	// 	Indicates the time after which this Offer is considered unfunded. See Specifying Time for details.
	Expiration uint32 `json:",omitempty"`
	// A hint indicating which page of the owner directory links to this entry, in case the directory consists of multiple pages.
	OwnerNode string
	// The identifying hash of the transaction that most recently modified this entry.
	PreviousTxnID types.Hash256
	// The index of the ledger that contains the transaction that most recently modified this object.
	PreviousTxnLgrSeq uint32
	// 	The Sequence value of the OfferCreate transaction that created this offer.
	// Used in combination with the Account to identify this offer.
	Sequence uint32
	// The remaining amount and type of currency requested by the Offer creator.
	TakerPays types.CurrencyAmount
	// The remaining amount and type of currency being provided by the Offer creator.
	TakerGets  types.CurrencyAmount
	OwnerFunds string `json:"owner_funds,omitempty"`
	// TakerGetsFunded types.CurrencyAmount `json:"taker_gets_funded,omitempty"`
	TakerGetsFunded any `json:"taker_gets_funded,omitempty"`
	// TakerPaysFunded types.CurrencyAmount `json:"taker_pays_funded,omitempty"`
	TakerPaysFunded any    `json:"taker_pays_funded,omitempty"`
	Quality         string `json:"quality,omitempty"`
}

type BookOfferCurrency

type BookOfferCurrency struct {
	Currency string `json:"currency"`
	Issuer   string `json:"issuer,omitempty"`
}

type RippleAlternative

type RippleAlternative struct {
	PathsComputed [][]transaction.PathStep `json:"paths_computed"`
	// SourceAmount  types.CurrencyAmount     `json:"source_amount"`
	SourceAmount any `json:"source_amount"`
}

type RipplePathFindCurrency

type RipplePathFindCurrency struct {
	Currency string        `json:"currency"`
	Issuer   types.Address `json:"issuer,omitempty"`
}