xrpl
    Preparing search index...

    Interface DirectoryNode

    The DirectoryNode object type provides a list of links to other objects in the ledger's state tree.

    interface DirectoryNode {
        DomainID?: string;
        Flags: number;
        index: string;
        Indexes: string[];
        IndexNext?: number;
        IndexPrevious?: number;
        LedgerEntryType: "DirectoryNode";
        Owner?: string;
        PreviousTxnID?: string;
        PreviousTxnLgrSeq?: number;
        RootIndex: string;
        TakerGetsCurrency?: string;
        TakerGetsIssuer?: string;
        TakerPaysCurrency?: string;
        TakerPaysIssuer?: string;
    }

    Hierarchy

    • BaseLedgerEntry
    • HasOptionalPreviousTxnID
      • DirectoryNode
    Index

    Properties

    DomainID? Flags index Indexes IndexNext? IndexPrevious? LedgerEntryType Owner? PreviousTxnID? PreviousTxnLgrSeq? RootIndex TakerGetsCurrency? TakerGetsIssuer? TakerPaysCurrency? TakerPaysIssuer?

    Properties

    DomainID?: string

    The domain that the offer directory is a part of.

    Flags: number

    A bit-map of boolean flags enabled for this directory. Currently, the protocol defines no flags for DirectoryNode objects.

    index: string
    Indexes: string[]

    The contents of this Directory: an array of IDs of other objects.

    IndexNext?: number

    If this Directory consists of multiple pages, this ID links to the next object in the chain, wrapping around at the end.

    IndexPrevious?: number

    If this Directory consists of multiple pages, this ID links to the previous object in the chain, wrapping around at the beginning.

    LedgerEntryType: "DirectoryNode"
    Owner?: string

    The address of the account that owns the objects in this directory.

    PreviousTxnID?: string

    The identifying hash of the transaction that most recently modified this object. This field was added in the fixPreviousTxnID amendment, so it may not be present in every object.

    PreviousTxnLgrSeq?: number

    The index of the ledger that contains the transaction that most recently modified this object. This field was added in the fixPreviousTxnID amendment, so it may not be present in every object.

    RootIndex: string

    The ID of root object for this directory.

    TakerGetsCurrency?: string

    The currency code of the TakerGets amount from the offers in this directory.

    TakerGetsIssuer?: string

    The issuer of the TakerGets amount from the offers in this directory.

    TakerPaysCurrency?: string

    The currency code of the TakerPays amount from the offers in this directory.

    TakerPaysIssuer?: string

    The issuer of the TakerPays amount from the offers in this directory.

    Settings

    Member Visibility

    On This Page

    Properties