Interface Offer

interface Offer {
    Account: string;
    BookDirectory: string;
    BookNode: string;
    Expiration?: number;
    Flags: number;
    index: string;
    LedgerEntryType: "Offer";
    OwnerNode: string;
    PreviousTxnID: string;
    PreviousTxnLgrSeq: number;
    Sequence: number;
    TakerGets: Amount;
    TakerPays: Amount;
}

Hierarchy (View Summary)

  • BaseLedgerEntry
  • HasPreviousTxnID

Properties

Account BookDirectory BookNode Expiration? Flags index LedgerEntryType OwnerNode PreviousTxnID PreviousTxnLgrSeq Sequence TakerGets TakerPays

Properties

Account

Account: string

The address of the account that placed this Offer.

BookDirectory

BookDirectory: string

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

BookNode

BookNode: string

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

OptionalExpiration

Expiration?: number

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

Flags

Flags: number

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

index

index: string

LedgerEntryType

LedgerEntryType: "Offer"

OwnerNode

OwnerNode: string

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

PreviousTxnID

PreviousTxnID: string

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

PreviousTxnLgrSeq

PreviousTxnLgrSeq: number

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

Sequence

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

TakerGets: Amount

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

TakerPays

TakerPays: Amount

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

Settings

Member Visibility

On This Page

Properties