Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BookOffer

Hierarchy

Index

Properties

Account: string

The address of the account that placed this Offer.

BookDirectory: string

The ID of the Offer Directory that links to this Offer.

BookNode: string

A hint indicating which page of the Offer Directory links to this object, in case the directory consists of multiple pages.

Expiration?: number

The time this Offer expires, in seconds since the Ripple Epoch.

Flags: number

A bit-map of boolean flags enabled for this Offer.

LedgerEntryType: "Offer"
OwnerNode: string

A hint indicating which page of the Owner Directory links to this object, in case the directory consists of multiple pages.

PreviousTxnID: string

The identifying hash of the transaction that most recently modified this object.

PreviousTxnLgrSeq: number

The index of the ledger that contains the transaction that most recently modified this object.

Sequence: number

The Sequence value of the OfferCreate transaction that created this Offer object. Used in combination with the Account to identify this Offer.

TakerGets: Amount

The remaining amount and type of currency being provided by the Offer creator.

TakerPays: Amount

The remaining amount and type of currency requested by the Offer creator.

index: string
owner_funds?: string

Amount of the TakerGets currency the side placing the offer has available to be traded. (XRP is represented as drops; any other currency is represented as a decimal value.) If a trader has multiple offers in the same book, only the highest-ranked offer includes this field.

quality?: string

The exchange rate, as the ratio taker_pays divided by taker_gets. For fairness, offers that have the same quality are automatically taken first-in, first-out.

taker_gets_funded?: Amount

The maximum amount of currency that the taker can get, given the funding status of the offer.

taker_pays_funded?: Amount

The maximum amount of currency that the taker would pay, given the funding status of the offer.

Generated using TypeDoc