XRPL.Transaction (xrpl v1.0.0)

XRPL.Transaction is a module to interact with transaction modules on the XRP Ledger. Transactions are the only thing that can modify the shared state of the XRP Ledger. All business on the XRP Ledger takes the form of transactions. Use these methods to work with transactions.

Official RPC documentation https://xrpl.org/transaction-methods.html

Summary

Functions

Builds a changeset from the schema and params.

A submit-only request includes the following parameters

The submit_multisigned command applies a multi-signed transaction and sends it to the network to be included in future ledgers. (You can also submit multi-signed transactions in binary form using the submit command in submit-only mode.)

The transaction_entry method retrieves information on a single transaction from a specific ledger version. (The tx method, by contrast, searches all ledgers for the specified transaction. We recommend using that method instead.)

The tx method retrieves information on a single transaction, by its identifying hash or its CTID.

The tx_history method retrieves some of the most recent transactions made.

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

Link to this function

changeset(name, params \\ %{}, opts \\ [])

Builds a changeset from the schema and params.

A submit-only request includes the following parameters:

  • tx_blob (String) - The signed transaction to submit, encoded as hex
  • fail_hard (Boolean) - If true, the transaction fails if it cannot be applied immediately. Otherwise, the transaction is queued. (Optional; defaults to false)

Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit/#submit

Link to this function

submit!(params)

Link to this function

submit_multisigned(params)

The submit_multisigned command applies a multi-signed transaction and sends it to the network to be included in future ledgers. (You can also submit multi-signed transactions in binary form using the submit command in submit-only mode.)

Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit_multisigned/#submit_multisigned

Link to this function

submit_multisigned!(params)

Link to this function

transaction_entry(params)

The transaction_entry method retrieves information on a single transaction from a specific ledger version. (The tx method, by contrast, searches all ledgers for the specified transaction. We recommend using that method instead.)

Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry/#transaction_entry

Link to this function

transaction_entry!(params)

The tx method retrieves information on a single transaction, by its identifying hash or its CTID.

Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx/#tx

Link to this function

tx_history(params)

The tx_history method retrieves some of the most recent transactions made.

Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx_history

Link to this function

tx_history!(params)

Link to this function

validate(changeset)

@spec validate(changeset()) :: {:ok, params()} | {:error, changeset()}

Returns the validated parameters or an error changeset.

Link to this function

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.

Link to this function

xrpl(method, params)

Link to this function

xrpl(method, validator, params)