Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RippleState

The RippleState object type connects two accounts in a single currency.

Hierarchy

  • default
    • RippleState

Index

Properties

Balance: IssuedCurrencyAmount

The balance of the trust line, from the perspective of the low account. A negative balance indicates that the low account has issued currency to the high account. The issuer is always the neutral value ACCOUNT_ONE.

Flags: number

A bit-map of boolean options enabled for this object.

HighLimit: IssuedCurrencyAmount

The limit that the high account has set on the trust line. The issuer is the address of the high account that set this limit.

HighNode?: string

A hint indicating which page of the high account's owner directory links to this object, in case the directory consists of multiple pages.

HighQualityIn?: number

The inbound quality set by the high account, as an integer in the implied ratio HighQualityIn:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value.

HighQualityOut?: number

The outbound quality set by the high account, as an integer in the implied ratio HighQualityOut:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value.

LedgerEntryType: "RippleState"
LowLimit: IssuedCurrencyAmount

The limit that the low account has set on the trust line. The issuer is the address of the low account that set this limit.

LowNode?: string

A hint indicating which page of the low account's owner directory links to this object, in case the directory consists of multiple pages.

LowQualityIn?: number

The inbound quality set by the low account, as an integer in the implied ratio LowQualityIn:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value.

LowQualityOut?: number

The outbound quality set by the low account, as an integer in the implied ratio LowQualityOut:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value.

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.

index: string

Generated using TypeDoc