XRPL.Account (xrpl v0.1.0)

XRPL.Account is a module to interact with accounts on the XRP Ledger. An account in the XRP Ledger represents a holder of XRP and a sender of transactions. Use these methods to work with account info.

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

Summary

Functions

The account_channels method returns information about an account's Payment Channels. This includes only channels where the specified account is the channel's source, not the destination. (A channel's "source" and "owner" are the same.) All information retrieved is relative to a particular version of the ledger.

The account_currencies command retrieves a list of currencies that an account can send or receive, based on its trust lines

The account_info command retrieves information about an account, its activity, and its XRP balance. All information retrieved is relative to a particular version of the ledger.

The account_lines command returns information about an account's trust lines, including balances in all non-XRP currencies and assets. All information retrieved is relative to a particular version of the ledger.

The account_nfts method returns a list of NFToken objects for the specified account.

The account_objects command returns the raw ledger format for all objects owned by an account. For a higher-level view of an account's trust lines and balances, see the account_lines method instead.

The account_offers method retrieves a list of offers made by a given account that are outstanding as of a particular ledger version.

The account_tx method retrieves a list of transactions that involved the specified account.

The gateway_balances command calculates the total balances issued by a given account, optionally excluding amounts held by operational addresses.

The noripple_check command provides a quick way to check the status of the Default Ripple field for an account and the No Ripple flag of its trust lines, compared with the recommended settings.

Functions

Link to this function

account_channels(account, destination_account)

@spec account_channels(String.t(), String.t()) :: Tesla.Env.result()

The account_channels method returns information about an account's Payment Channels. This includes only channels where the specified account is the channel's source, not the destination. (A channel's "source" and "owner" are the same.) All information retrieved is relative to a particular version of the ledger.

Official documentation: https://xrpl.org/account_channels.html

Link to this function

account_channels!(account, destination_account)

Link to this function

account_currencies(account, opts \\ [])

@spec account_currencies(String.t(), Keyword.t()) :: Tesla.Env.result()

The account_currencies command retrieves a list of currencies that an account can send or receive, based on its trust lines

Official documentation: https://xrpl.org/account_currencies.html

Link to this function

account_currencies!(account)

Link to this function

account_info(account, opts \\ [])

@spec account_info(String.t(), Keyword.t()) :: Tesla.Env.result()

The account_info command retrieves information about an account, its activity, and its XRP balance. All information retrieved is relative to a particular version of the ledger.

Official documentation: https://xrpl.org/account_info.html

Link to this function

account_info!(account)

Link to this function

account_lines(account)

@spec account_lines(String.t()) :: Tesla.Env.result()

The account_lines command returns information about an account's trust lines, including balances in all non-XRP currencies and assets. All information retrieved is relative to a particular version of the ledger.

Official documentation: https://xrpl.org/account_lines.html

Link to this function

account_lines!(account)

Link to this function

account_nfts(account, opts \\ [])

@spec account_nfts(String.t(), Keyword.t()) :: Tesla.Env.result()

The account_nfts method returns a list of NFToken objects for the specified account.

Official documentation: https://xrpl.org/account_nfts.html

Link to this function

account_nfts!(account)

Link to this function

account_objects(account, opts \\ [])

The account_objects command returns the raw ledger format for all objects owned by an account. For a higher-level view of an account's trust lines and balances, see the account_lines method instead.

Ref: https://xrpl.org/account_objects.html

Link to this function

account_objects!(account, opts)

Link to this function

account_offers(account, opts \\ [])

@spec account_offers(String.t(), Keyword.t()) :: Tesla.Env.result()

The account_offers method retrieves a list of offers made by a given account that are outstanding as of a particular ledger version.

Ref: https://xrpl.org/account_offers.html

Link to this function

account_offers!(account, opts)

Link to this function

account_tx(account, index_min \\ -1, index_max \\ -1, opts \\ [])

@spec account_tx(String.t(), integer(), integer(), Keyword.t()) :: Tesla.Env.result()

The account_tx method retrieves a list of transactions that involved the specified account.

Ref: https://xrpl.org/account_tx.html

Link to this function

account_tx!(account, index_min \\ -1, index_max \\ -1, opts \\ [])

Link to this function

gateway_balance(account, opts \\ [])

@spec gateway_balance(String.t(), Keyword.t()) :: Tesla.Env.result()

The gateway_balances command calculates the total balances issued by a given account, optionally excluding amounts held by operational addresses.

Ref: https://xrpl.org/gateway_balances.html

Link to this function

gateway_balance!(account, opts \\ [])

Link to this function

noripple_check(account, role \\ "user", opts \\ [])

The noripple_check command provides a quick way to check the status of the Default Ripple field for an account and the No Ripple flag of its trust lines, compared with the recommended settings.

Ref: https://xrpl.org/noripple_check.html

Link to this function

noripple_check!(account, role \\ "user", opts \\ [])