Struct AccountRoot

pub struct AccountRoot<'a> {

    pub common_fields: CommonFields<'a, AccountRootFlag>,
    pub account: Cow<'a, str>,
    pub owner_count: u32,
    pub previous_txn_id: Cow<'a, str>,
    pub previous_txn_lgr_seq: u32,
    pub sequence: u32,
    pub account_txn_id: Option<Cow<'a, str>>,
    pub balance: Option<XRPAmount<'a>>,
    pub burned_nftokens: Option<u32>,
    pub domain: Option<Cow<'a, str>>,
    pub email_hash: Option<Cow<'a, str>>,
    pub message_key: Option<Cow<'a, str>>,
    pub minted_nftokens: Option<u32>,
    pub nftoken_minter: Option<Cow<'a, str>>,
    pub regular_key: Option<Cow<'a, str>>,
    pub ticket_count: Option<u8>,
    pub tick_size: Option<u8>,
    pub transfer_rate: Option<u32>,
    pub wallet_locator: Option<Cow<'a, str>>,
    pub wallet_size: Option<u32>,
}

The AccountRoot object type describes a single account, its settings, and XRP balance.

<https://xrpl.org/accountroot.html#accountroot>

Fields

common_fields: CommonFields<'a, AccountRootFlag>

The base fields for all ledger object models.

See Ledger Object Common Fields: <https://xrpl.org/ledger-entry-common-fields.html>

account: Cow<'a, str>

The identifying (classic) address of this account.

owner_count: u32

The number of objects this account owns in the ledger, which contributes to its owner reserve.

previous_txn_id: Cow<'a, str>

The identifying hash of the transaction that most recently modified this object.

previous_txn_lgr_seq: u32

The index of the ledger that contains the transaction that most recently modified this object.

sequence: u32

The sequence number of the next valid transaction for this account.

account_txn_id: Option<Cow<'a, str>>

The identifying hash of the transaction most recently sent by this account. This field must be enabled to use the AccountTxnID transaction field. To enable it, send an AccountSet transaction with the asfAccountTxnID flag enabled.

balance: Option<XRPAmount<'a>>

The account’s current XRP balance in drops, represented as a string.

burned_nftokens: Option<u32>

How many total of this account’s issued non-fungible tokens have been burned. This number is always equal or less than MintedNFTokens.

domain: Option<Cow<'a, str>>

A domain associated with this account. In JSON, this is the hexadecimal for the ASCII representation of the domain. Cannot be more than 256 bytes in length.

email_hash: Option<Cow<'a, str>>

The md5 hash of an email address. Clients can use this to look up an avatar through services such as Gravatar

message_key: Option<Cow<'a, str>>

A public key that may be used to send encrypted messages to this account. In JSON, uses hexadecimal. Must be exactly 33 bytes, with the first byte indicating the key type: 0x02 or 0x03 for secp256k1 keys, 0xED for Ed25519 keys.

minted_nftokens: Option<u32>

How many total non-fungible tokens have been minted by and on behalf of this account.

nftoken_minter: Option<Cow<'a, str>>

Another account that can mint non-fungible tokens on behalf of this account.

regular_key: Option<Cow<'a, str>>

The address of a key pair that can be used to sign transactions for this account instead of the master key. Use a SetRegularKey transaction to change this value.

ticket_count: Option<u8>

How many Tickets this account owns in the ledger. This is updated automatically to ensure that the account stays within the hard limit of 250 Tickets at a time. This field is omitted if the account has zero Tickets.

tick_size: Option<u8>

How many significant digits to use for exchange rates of Offers involving currencies issued by this address. Valid values are 3 to 15, inclusive.

transfer_rate: Option<u32>

A transfer fee to charge other users for sending currency issued by this account to each other.

wallet_locator: Option<Cow<'a, str>>

An arbitrary 256-bit value that users can set.

wallet_size: Option<u32>

Unused. (The code supports this field but there is no way to set it.)

Implementations

impl<'a> AccountRoot<'a>

pub fn new( flags: FlagCollection<AccountRootFlag>, index: Option<Cow<'a, str>>, ledger_index: Option<Cow<'a, str>>, account: Cow<'a, str>, owner_count: u32, previous_txn_id: Cow<'a, str>, previous_txn_lgr_seq: u32, sequence: u32, account_txn_id: Option<Cow<'a, str>>, balance: Option<XRPAmount<'a>>, burned_nftokens: Option<u32>, domain: Option<Cow<'a, str>>, email_hash: Option<Cow<'a, str>>, message_key: Option<Cow<'a, str>>, minted_nftokens: Option<u32>, nftoken_minter: Option<Cow<'a, str>>, regular_key: Option<Cow<'a, str>>, ticket_count: Option<u8>, tick_size: Option<u8>, transfer_rate: Option<u32>, wallet_locator: Option<Cow<'a, str>>, wallet_size: Option<u32>, ) -> Self

Trait Implementations

impl<'a> Clone for AccountRoot<'a>

fn clone(&self) -> AccountRoot<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for AccountRoot<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for AccountRoot<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> LedgerObject<AccountRootFlag> for AccountRoot<'a>

fn get_ledger_entry_type(&self) -> LedgerEntryType

fn has_flag(&self, flag: &T) -> bool

impl<'a> Model for AccountRoot<'a>

fn get_errors(&self) -> XRPLModelResult<()>

Collects a models errors and returns the first error that occurs.

fn validate(&self) -> XRPLModelResult<()>

Simply forwards the error from get_errors if there was one.

fn is_valid(&self) -> bool

Checks if the model is valid.

impl<'a> PartialEq for AccountRoot<'a>

fn eq(&self, other: &AccountRoot<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for AccountRoot<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for AccountRoot<'a>

impl<'a> StructuralPartialEq for AccountRoot<'a>