xrpl
    Preparing search index...

    Interface Offer

    interface Offer {
        Account: string;
        AdditionalBooks?: Book[];
        BookDirectory: string;
        BookNode: string;
        DomainID?: 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
    Index

    Properties

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

    Properties

    Account: string

    The address of the account that placed this Offer.

    AdditionalBooks?: Book[]

    An additional list of order book directories that this offer belongs to. Currently this field only applicable to hybrid offers.

    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.

    DomainID?: string

    The domain that the offer must be a part of.

    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.

    index: string
    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.

    Settings

    Member Visibility

    On This Page

    Properties