Skip to main content

MPToken

Struct MPToken 

Source
pub struct MPToken<'a> {
Show 14 fields pub common_fields: CommonFields<'a, MPTokenFlag>, pub account: Cow<'a, str>, pub mptoken_issuance_id: Cow<'a, str>, pub mpt_amount: Cow<'a, str>, pub previous_txn_id: Cow<'a, str>, pub previous_txn_lgr_seq: u32, pub owner_node: Option<Cow<'a, str>>, pub locked_amount: Option<Cow<'a, str>>, pub confidential_balance_inbox: Option<Cow<'a, str>>, pub confidential_balance_spending: Option<Cow<'a, str>>, pub confidential_balance_version: Option<u32>, pub issuer_encrypted_balance: Option<Cow<'a, str>>, pub auditor_encrypted_balance: Option<Cow<'a, str>>, pub holder_encryption_key: Option<Cow<'a, str>>,
}
Expand description

The MPToken ledger object represents a single account’s holdings of a specific Multi-Purpose Token issuance.

<https://xrpl.org/docs/references/protocol/ledger-data/ledger-entry-types/mptoken>

Fields§

§common_fields: CommonFields<'a, MPTokenFlag>

The base fields for all ledger object models.

§account: Cow<'a, str>

The owner (holder) of these MPTs.

§mptoken_issuance_id: Cow<'a, str>

The MPTokenIssuance identifier.

§mpt_amount: Cow<'a, str>

The amount of tokens currently held by the owner. The minimum is 0 and the maximum is 2^63-1.

§previous_txn_id: Cow<'a, str>

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

§previous_txn_lgr_seq: u32

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

§owner_node: Option<Cow<'a, str>>

A hint indicating which page of the owner directory links to this entry, in case the directory consists of multiple pages.

§locked_amount: Option<Cow<'a, str>>

The amount of this MPT currently locked in escrow or by other mechanisms. Present only when the TokenEscrow amendment is active.

§confidential_balance_inbox: Option<Cow<'a, str>>

CB_IN — the holder’s confidential inbox balance: a 66-byte EC-ElGamal ciphertext accumulating incoming confidential transfers until the holder merges them with ConfidentialMPTMergeInbox (XLS-0096).

§confidential_balance_spending: Option<Cow<'a, str>>

CB_S — the holder’s confidential spending balance, as a 66-byte EC-ElGamal ciphertext. Proofs are generated against this balance.

§confidential_balance_version: Option<u32>

Monotonic counter bumped whenever CB_S changes, binding proofs to a specific balance state (folded into the transaction’s context hash).

§issuer_encrypted_balance: Option<Cow<'a, str>>

The issuer’s mirror of this holder’s confidential balance, encrypted under the issuance’s IssuerEncryptionKey.

§auditor_encrypted_balance: Option<Cow<'a, str>>

The auditor’s mirror of this holder’s confidential balance, encrypted under the issuance’s AuditorEncryptionKey, when one is registered.

§holder_encryption_key: Option<Cow<'a, str>>

The holder’s 33-byte compressed EC-ElGamal public key, registered by the holder’s first ConfidentialMPTConvert.

Trait Implementations§

Source§

impl<'a> Clone for MPToken<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for MPToken<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<'a> Eq for MPToken<'a>

Source§

impl<'a> LedgerObject<MPTokenFlag> for MPToken<'a>

Source§

impl<'a> Model for MPToken<'a>

Source§

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

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

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

Simply forwards the error from get_errors if there was one.
Source§

fn is_valid(&self) -> bool

Checks if the model is valid.
Source§

impl<'a> PartialEq for MPToken<'a>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> Serialize for MPToken<'a>

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<'a> StructuralPartialEq for MPToken<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for MPToken<'a>

§

impl<'a> RefUnwindSafe for MPToken<'a>

§

impl<'a> Send for MPToken<'a>

§

impl<'a> Sync for MPToken<'a>

§

impl<'a> Unpin for MPToken<'a>

§

impl<'a> UnsafeUnpin for MPToken<'a>

§

impl<'a> UnwindSafe for MPToken<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more