Show / Hide Table of Contents

Class DexSnapshotOptions

How DexSnapshot's FromNodeAsync reads the books.

Inheritance
object
DexSnapshotOptions
Namespace: Xrpl.Amounts
Assembly: Xrpl.dll
Syntax
public sealed class DexSnapshotOptions

Properties

| Edit this page View Source

BookDepth

Null to read each book with one book_offers request - the funded offers at its top, at most 100 from a public node - or the number of offers to read from each book by walking its directories, unfunded offers included. A book with more offers than were read is listed in PartialBooks.

Declaration
public int? BookDepth { get; init; }
Property Value
Type Description
int?
| Edit this page View Source

Ledger

The ledger to read: a sequence - the ledger before a past transaction's, to replay it - or validated, closed or current; null for the last validated one.

Declaration
public LedgerIndex Ledger { get; init; }
Property Value
Type Description
LedgerIndex
| Edit this page View Source

OwnerFundsFromBook

Whether to build each offer owner from what book_offers reports of its funds (owner_funds) instead of reading its account and trust lines: one request per book instead of up to three per owner. Owners the snapshot reads anyway - the transaction's accounts, the issuers - are still read.

Declaration
public bool OwnerFundsFromBook { get; init; }
Property Value
Type Description
bool
Remarks

Such an owner is listed in ApproximatedOwners. Its funds of what an offer gives are exact, and the reserve an offer frees when it is deleted is counted. What the snapshot does not know about it: whether it trusts the issuer of what it receives and for how much - a line is assumed, with room for anything - and its line's quality, NoRipple and freeze settings, which are assumed at their defaults, with the issuer's authorization granted.

Not combined with BookDepth: a directory walk reads no funds.

  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX