Queries the ledger for account info of an account's address.
The function calls the AccountInfo request method using the WebsocketClient/AsyncWebsocketClient.
The returning Response struct may not have been added yet. Keep a look at https://github.com/sephynox/xrpl-rust/issues/17, if the tick is already set.
The user can choose which ledger he wants to query using the ledger_index argument. If no ledger_index is defined (: None) the default is "validated". If a Ledger Index is defined edit the AccountInfo request as wished.
fields
type
explanation
account
&str
An accounts classic address.
client
WebsocketClient/AsyncWebsocketClient
A websocket client object.
ledger_index
Option<&str>
A ledger index. Must be one of: "validated", "current", "closed", integer as str
Queries the Ledger for the last transaction a given account has sent.
The function calls the AccountTx request method using the WebsocketClient/AsyncWebsocketClient.
The returning Response struct may not have been added yet. Keep a look at https://github.com/sephynox/xrpl-rust/issues/17, if the tick is already set.
To receive an account's latest transaction define request:
Queries the Ledger for transactions sent by a given address.
The function calls the AccountTx request method using the WebsocketClient/AsyncWebsocketClient.
If an account has send too many transactions for the node to send, the node sends as many transactions as it can and includes a marker field to tell you to how many Ledgers it looked back. You can define the marker field in AccountTx to receive the next batch of transactions.
fields
type
explanation
account
&str
An accounts classic address.
client
WebsocketClient/AsyncWebsocketClient
A websocket client object.
marker
u32
The Marker to request the next batch of transactions.
does_account_exist -> bool
The function simply calls the
get_account_info
function. If theResult
is no error the account exists.&str
WebsocketClient
/AsyncWebsocketClient
Option<&str>
Sources:
https://github.com/XRPLF/xrpl-py/blob/master/xrpl/asyncio/account/main.py#L12
[x]
get_next_valid_account_seq_number -> u32
The function simply calls the
get_account_root
function and returns the AccountRoot object'sSequence
field.&str
WebsocketClient
/AsyncWebsocketClient
Option<&str>
Sources:
https://github.com/XRPLF/xrpl-py/blob/master/xrpl/asyncio/account/main.py#L42
[x]
get_account_xrp_balance -> Currency
The function simply calls the
get_account_root
function and returns the AccountRoot object'sBalance
field.Use
drops_to_xrp
to convert the drops amount into a XRP amount.&str
WebsocketClient
/AsyncWebsocketClient
Optional<&str>
Sources:
https://github.com/XRPLF/xrpl.js/blob/main/packages/xrpl/src/sugar/balances.ts#L43
https://github.com/XRPLF/xrpl-py/blob/master/xrpl/asyncio/account/main.py#L64
[ ]
get_account_balances -> Vec<Currency>
The function calls the
get_account_xrp_balance
and theAccountLines
request method and brings the balances in an easy-to-use format.&str
WebsocketClient
/AsyncWebsocketClient
Optional<&str>
Sources:
https://github.com/XRPLF/xrpl.js/blob/main/packages/xrpl/src/sugar/balances.ts#L77
[x]
get_account_root -> AccountRoot
The function simply calls the
get_account_info
function and returns the result'saccount_data
field.The return type
AccountRoot
may not be defined yet.&str
WebsocketClient
/AsyncWebsocketClient
Option<&str>
Sources:
https://github.com/XRPLF/xrpl-py/blob/master/xrpl/asyncio/account/main.py#L84
[ ]
get_account_info -> Response
The function calls the
AccountInfo
request method using theWebsocketClient
/AsyncWebsocketClient
.The returning
Response
struct may not have been added yet. Keep a look at https://github.com/sephynox/xrpl-rust/issues/17, if the tick is already set. The user can choose which ledger he wants to query using theledger_index
argument. If noledger_index
is defined (: None
) the default is "validated". If a Ledger Index is defined edit theAccountInfo
request as wished.&str
WebsocketClient
/AsyncWebsocketClient
Option<&str>
Sources:
https://github.com/XRPLF/xrpl-py/blob/master/xrpl/asyncio/account/main.py#L105
https://xrpl.org/account_info.html
[x]
get_latest_transaction -> Response
The function calls the
AccountTx
request method using theWebsocketClient
/AsyncWebsocketClient
.The returning
Response
struct may not have been added yet. Keep a look at https://github.com/sephynox/xrpl-rust/issues/17, if the tick is already set. To receive an account's latest transaction define request:&str
WebsocketClient
/AsyncWebsocketClient
Sources:
https://github.com/XRPLF/xrpl-py/blob/master/xrpl/asyncio/account/transaction_history.py#L10
[ ]
get_account_transactions
The function calls the
AccountTx
request method using theWebsocketClient
/AsyncWebsocketClient
.If an account has send too many transactions for the node to send, the node sends as many transactions as it can and includes a
marker
field to tell you to how many Ledgers it looked back. You can define themarker
field inAccountTx
to receive the next batch of transactions.&str
WebsocketClient
/AsyncWebsocketClient
u32
Sources:
https://xrpl.org/markers-and-pagination.html#markers-and-pagination
https://xrpl.org/account_tx.html#account_tx
https://github.com/XRPLF/xrpl-py/blob/master/xrpl/asyncio/account/transaction_history.py#L35
[ ]
get_account_payment_transactions
TransactionType
Payment
.The function simply calls the
get_account_transactions
function and filters the list of transactions for transactions withTransactionType
Payment
.&str
WebsocketClient
/AsyncWebsocketClient
u32
Sources: