Account Methods¶
Async methods for interacting with XRPL accounts.
- async xrpl.asyncio.account.does_account_exist(address: str, client: xrpl.asyncio.clients.client.Client, ledger_index: Union[str, int] = 'validated') bool ¶
Query the ledger for whether the account exists.
- Parameters
address – the account to query.
client – the network client used to make network calls.
ledger_index – The ledger index to use for the request. Must be an integer ledger value or “current” (the current working version), “closed” (for the closed-and-proposed version), or “validated” (the most recent version validated by consensus). The default is “validated”.
- Returns
Whether the account exists on the ledger.
- Raises
XRPLRequestFailureException – if the transaction fails.
- async xrpl.asyncio.account.get_account_info(address: str, client: xrpl.asyncio.clients.client.Client, ledger_index: Union[str, int] = 'validated') xrpl.models.response.Response ¶
Query the ledger for account info of given address.
- Parameters
address – the account to query.
client – the network client used to make network calls.
ledger_index – The ledger index to use for the request. Must be an integer ledger value or “current” (the current working version), “closed” (for the closed-and-proposed version), or “validated” (the most recent version validated by consensus). The default is “validated”.
- Returns
The account info for the address.
- Raises
XRPLException – If the ledger_index value is invalid.
XRPLRequestFailureException – if the rippled API call fails.
- async xrpl.asyncio.account.get_account_payment_transactions(address: str, client: xrpl.asyncio.clients.client.Client) List[Dict[str, Any]] ¶
Query the ledger for a list of payment transactions that involved a given account.
- Parameters
address – the account to query.
client – the network client used to make network calls.
- Returns
The payment transaction history for the address.
- async xrpl.asyncio.account.get_account_root(address: str, client: xrpl.asyncio.clients.client.Client, ledger_index: Union[str, int] = 'validated') Dict[str, Union[int, str]] ¶
Query the ledger for the AccountRoot object associated with a given address.
- Parameters
address – the account to query.
client – the network client used to make network calls.
ledger_index – The ledger index to use for the request. Must be an integer ledger value or “current” (the current working version), “closed” (for the closed-and-proposed version), or “validated” (the most recent version validated by consensus). The default is “validated”.
- Returns
The AccountRoot dictionary for the address.
- async xrpl.asyncio.account.get_account_transactions(address: str, client: xrpl.asyncio.clients.client.Client) List[Dict[str, Any]] ¶
Query the ledger for a list of transactions that involved a given account.
- Parameters
address – the account to query.
client – the network client used to make network calls.
- Returns
The transaction history for the address.
- Raises
XRPLRequestFailureException – if the transaction fails.
- async xrpl.asyncio.account.get_balance(address: str, client: xrpl.asyncio.clients.client.Client, ledger_index: Union[str, int] = 'validated') int ¶
Query the ledger for the balance of the given account.
- Parameters
address – the account to query.
client – the network client used to make network calls.
ledger_index – The ledger index to use for the request. Must be an integer ledger value or “current” (the current working version), “closed” (for the closed-and-proposed version), or “validated” (the most recent version validated by consensus). The default is “validated”.
- Returns
The balance of the address.
- async xrpl.asyncio.account.get_latest_transaction(account: str, client: xrpl.asyncio.clients.client.Client) xrpl.models.response.Response ¶
Fetches the most recent transaction on the ledger associated with an account.
- Parameters
account – the account to query.
client – the network client used to communicate with a rippled node.
- Returns
The Response object containing the transaction info.
- Raises
XRPLRequestFailureException – if the transaction fails.
- async xrpl.asyncio.account.get_next_valid_seq_number(address: str, client: xrpl.asyncio.clients.client.Client, ledger_index: Union[str, int] = 'current') int ¶
Query the ledger for the next available sequence number for an account.
- Parameters
address – the account to query.
client – the network client used to make network calls.
ledger_index – The ledger index to use for the request. Must be an integer ledger value or “current” (the current working version), “closed” (for the closed-and-proposed version), or “validated” (the most recent version validated by consensus). The default is “current”.
- Returns
The next valid sequence number for the address.