Struct AccountSet

pub struct AccountSet<'a> {
    pub common_fields: CommonFields<'a, AccountSetFlag>,
    pub clear_flag: Option<AccountSetFlag>,
    pub domain: Option<Cow<'a, str>>,
    pub email_hash: Option<Cow<'a, str>>,
    pub message_key: Option<Cow<'a, str>>,
    pub nftoken_minter: Option<Cow<'a, str>>,
    pub set_flag: Option<AccountSetFlag>,
    pub transfer_rate: Option<u32>,
    pub tick_size: Option<u32>,
}

An AccountSet transaction modifies the properties of an account in the XRP Ledger.

See AccountSet: <https://xrpl.org/docs/references/protocol/transactions/types/accountset>

Fields

common_fields: CommonFields<'a, AccountSetFlag>

The base fields for all transaction models.

See Transaction Common Fields: <https://xrpl.org/transaction-common-fields.html>

clear_flag: Option<AccountSetFlag>

Unique identifier of a flag to disable for this account.

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

The domain that owns this account, as a string of hex representing the ASCII for the domain in lowercase. Cannot be more than 256 bytes in length.

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

Hash of an email address to be used for generating an avatar image. Conventionally, clients use Gravatar to display this image.

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

Public key for sending encrypted messages to this account. To set the key, it must be exactly 33 bytes, with the first byte indicating the key type: 0x02 or 0x03 for secp256k1 keys, 0xED for Ed25519 keys. To remove the key, use an empty value.

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

Sets an alternate account that is allowed to mint NFTokens on this account’s behalf using NFTokenMint’s Issuer field. This field is part of the experimental XLS-20 standard for non-fungible tokens.

set_flag: Option<AccountSetFlag>

Flag to enable for this account.

transfer_rate: Option<u32>

The fee to charge when users transfer this account’s tokens, represented as billionths of a unit. Cannot be more than 2000000000 or less than 1000000000, except for the special case 0 meaning no fee.

tick_size: Option<u32>

Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are 3 to 15 inclusive, or 0 to disable.

Implementations

impl<'a> AccountSet<'a>

pub fn new( account: Cow<'a, str>, account_txn_id: Option<Cow<'a, str>>, fee: Option<XRPAmount<'a>>, flags: Option<FlagCollection<AccountSetFlag>>, last_ledger_sequence: Option<u32>, memos: Option<Vec<Memo>>, sequence: Option<u32>, signers: Option<Vec<Signer>>, source_tag: Option<u32>, ticket_sequence: Option<u32>, clear_flag: Option<AccountSetFlag>, domain: Option<Cow<'a, str>>, email_hash: Option<Cow<'a, str>>, message_key: Option<Cow<'a, str>>, set_flag: Option<AccountSetFlag>, transfer_rate: Option<u32>, tick_size: Option<u32>, nftoken_minter: Option<Cow<'a, str>>, ) -> Self

pub fn with_clear_flag(self, flag: AccountSetFlag) -> Self

Set clear flag

pub fn with_domain(self, domain: Cow<'a, str>) -> Self

Set domain

pub fn with_email_hash(self, email_hash: Cow<'a, str>) -> Self

Set email hash

pub fn with_message_key(self, message_key: Cow<'a, str>) -> Self

Set message key

pub fn with_nftoken_minter(self, nftoken_minter: Cow<'a, str>) -> Self

Set NFToken minter

pub fn with_set_flag(self, flag: AccountSetFlag) -> Self

Set flag to enable

pub fn with_transfer_rate(self, transfer_rate: u32) -> Self

Set transfer rate

pub fn with_tick_size(self, tick_size: u32) -> Self

Set tick size

Trait Implementations

impl<'a> AccountSetError for AccountSet<'a>

fn _get_tick_size_error(&self) -> Result<(), XRPLModelException>

fn _get_transfer_rate_error(&self) -> Result<(), XRPLModelException>

fn _get_domain_error(&self) -> Result<(), XRPLModelException>

fn _get_clear_flag_error(&self) -> Result<(), XRPLModelException>

fn _get_nftoken_minter_error(&self) -> Result<(), XRPLModelException>

impl<'a> Clone for AccountSet<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> CommonTransactionBuilder<'a, AccountSetFlag> for AccountSet<'a>

fn get_mut_common_fields(&mut self) -> &mut CommonFields<'a, AccountSetFlag>

Get mutable reference to common fields

fn into_self(self) -> Self

Return self after modification (for method chaining)

fn with_fee(self, fee: XRPAmount<'a>) -> Self

where Self: Sized,

Set fee

fn with_sequence(self, sequence: u32) -> Self

where Self: Sized,

Set sequence

fn with_last_ledger_sequence(self, last_ledger_sequence: u32) -> Self

where Self: Sized,

Set last ledger sequence

fn with_memo(self, memo: Memo) -> Self

where Self: Sized,

Add memo

fn with_source_tag(self, source_tag: u32) -> Self

where Self: Sized,

Set source tag

fn with_ticket_sequence(self, ticket_sequence: u32) -> Self

where Self: Sized,

Set ticket sequence

fn with_account_txn_id(self, account_txn_id: Cow<'a, str>) -> Self

where Self: Sized,

Set account transaction ID

impl<'a> Debug for AccountSet<'a>

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

Formats the value using the given formatter.

impl<'a> Default for AccountSet<'a>

fn default() -> AccountSet<'a>

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Model for AccountSet<'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 AccountSet<'a>

fn eq(&self, other: &AccountSet<'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 AccountSet<'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> Transaction<'a, AccountSetFlag> for AccountSet<'a>

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

fn get_transaction_type(&self) -> &TransactionType

fn get_common_fields(&self) -> &CommonFields<'_, AccountSetFlag>

fn get_mut_common_fields(&mut self) -> &mut CommonFields<'a, AccountSetFlag>

fn get_field_value(&self, field: &str) -> XRPLModelResult<Option<String>>

fn is_signed(&self) -> bool

fn get_hash(&self) -> XRPLModelResult<Cow<'_, str>>

where Self: Serialize + DeserializeOwned + Debug + Clone,

Hashes the Transaction object as the ledger does. Only valid for signed Transaction objects.

impl<'a> ValidateCurrencies for AccountSet<'a>

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

impl<'a> Eq for AccountSet<'a>

impl<'a> StructuralPartialEq for AccountSet<'a>