Interface DirectoryNode

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

interface DirectoryNode {
    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

Properties

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

Properties

Flags

Flags: number

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

index

index: string

Indexes

Indexes: string[]

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

OptionalIndexNext

IndexNext?: number

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

OptionalIndexPrevious

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

LedgerEntryType: "DirectoryNode"

OptionalOwner

Owner?: string

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

OptionalPreviousTxnID

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.

OptionalPreviousTxnLgrSeq

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

RootIndex: string

The ID of root object for this directory.

OptionalTakerGetsCurrency

TakerGetsCurrency?: string

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

OptionalTakerGetsIssuer

TakerGetsIssuer?: string

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

OptionalTakerPaysCurrency

TakerPaysCurrency?: string

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

OptionalTakerPaysIssuer

TakerPaysIssuer?: string

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

Settings

Member Visibility

On This Page

Properties