XRPL.LedgerEntry (xrpl v1.0.0)
The ledger_entry method returns a single ledger entry from the XRP Ledger in its raw format. See ledger format for information on the different types of entries you can retrieve.
Official documentation: https://xrpl.org/ledger_entry.html
Summary
Functions
Retrieve an AccountRoot entry by its address. This is roughly equivalent to the account_info method.
Retrieve an Automated Market-Maker (AMM) object from the ledger. This is similar to amm_info method, but the ledger_entry version returns only the ledger entry as stored.
Retrieve any type of ledger object by its unique ID.
Builds a changeset from the schema and params.
Retrieve a Check entry, which is a potential payment that can be cashed by its recipient.
Retrieve a DepositPreauth entry, which tracks preauthorization for payments to accounts requiring Deposit Authorization.
Retrieve a DirectoryNode, which contains a list of other ledger objects. Can be provided as string (object ID of the Directory) or as an object.
Retrieve an Escrow entry, which holds XRP until a specific time or condition is met. Can be provided as string (object ID of the Escrow) or as an object.
Return an NFT Page in its raw ledger format.
Retrieve an Offer entry, which defines an offer to exchange currency. Can be provided as string (unique index of the Offer) or as an object.
Retrieve a PayChannel entry, which holds XRP for asynchronous payments.
Retrieve a RippleState entry, which tracks a (non-XRP) currency balance between two accounts.
Retrieve a Ticket entry, which represents a sequence number set aside for future use. (Added by the TicketBatch amendment)
Returns the validated parameters or an error changeset.
Returns the validated parameters or an error changeset.
Expects a schema to be defined with defparams
.
Functions
account_root(params)
Retrieve an AccountRoot entry by its address. This is roughly equivalent to the account_info method.
Official documentation: https://xrpl.org/ledger_entry.html#get-accountroot-object
account_root!(params)
amm(params)
Retrieve an Automated Market-Maker (AMM) object from the ledger. This is similar to amm_info method, but the ledger_entry version returns only the ledger entry as stored.
Official documentation: https://xrpl.org/ledger_entry.html#get-amm-object
amm!(params)
by_id(params)
Retrieve any type of ledger object by its unique ID.
Official documentation: https://xrpl.org/ledger_entry.html#get-ledger-object-by-id
by_id!(params)
changeset(name, params \\ %{}, opts \\ [])
Builds a changeset from the schema and params.
check(params)
Retrieve a Check entry, which is a potential payment that can be cashed by its recipient.
Official documentation: https://xrpl.org/ledger_entry.html#get-check-object
check!(params)
deposit_preauth(params)
Retrieve a DepositPreauth entry, which tracks preauthorization for payments to accounts requiring Deposit Authorization.
Official documentation: https://xrpl.org/ledger_entry.html#get-depositpreauth-object
deposit_preauth!(params)
directory_node(params)
Retrieve a DirectoryNode, which contains a list of other ledger objects. Can be provided as string (object ID of the Directory) or as an object.
Official documentation: https://xrpl.org/ledger_entry.html#get-directorynode-object
directory_node!(params)
escrow(params)
Retrieve an Escrow entry, which holds XRP until a specific time or condition is met. Can be provided as string (object ID of the Escrow) or as an object.
Official documentation: https://xrpl.org/ledger_entry.html/#get-escrow-object
escrow!(params)
nft_page(params)
Return an NFT Page in its raw ledger format.
Official documentation: https://xrpl.org/ledger_entry.html#get-nft-page
nft_page!(params)
offer(params)
Retrieve an Offer entry, which defines an offer to exchange currency. Can be provided as string (unique index of the Offer) or as an object.
Official documentation: https://xrpl.org/ledger_entry.html#get-offer-object
offer!(params)
payment_channel(params)
Retrieve a PayChannel entry, which holds XRP for asynchronous payments.
Official documentation: https://xrpl.org/ledger_entry.html#get-paychannel-object
payment_channel!(params)
ripple_state(params)
Retrieve a RippleState entry, which tracks a (non-XRP) currency balance between two accounts.
Official documentation: https://xrpl.org/ledger_entry.html#get-ripplestate-object
ripple_state!(params)
schema(binary)
ticket(params)
Retrieve a Ticket entry, which represents a sequence number set aside for future use. (Added by the TicketBatch amendment)
Official documentation: https://xrpl.org/ledger_entry.html#get-ticket-object
ticket!(params)
validate(changeset)
@spec validate(changeset()) :: {:ok, params()} | {:error, changeset()}
Returns the validated parameters or an error changeset.
validate(name, params \\ %{}, opts \\ [])
@spec validate(name(), params(), opts()) :: {:ok, params()} | {:error, changeset()}
Returns the validated parameters or an error changeset.
Expects a schema to be defined with defparams
.