TokenTransitionAction

drive::state_transition_action::batch::batched_transition::token_transition

Enum TokenTransitionAction

pub enum TokenTransitionAction {
    BurnAction(TokenBurnTransitionAction),
    MintAction(TokenMintTransitionAction),
    TransferAction(TokenTransferTransitionAction),
    FreezeAction(TokenFreezeTransitionAction),
    UnfreezeAction(TokenUnfreezeTransitionAction),
    ClaimAction(TokenClaimTransitionAction),
    EmergencyActionAction(TokenEmergencyActionTransitionAction),
    DestroyFrozenFundsAction(TokenDestroyFrozenFundsTransitionAction),
    ConfigUpdateAction(TokenConfigUpdateTransitionAction),
    DirectPurchaseAction(TokenDirectPurchaseTransitionAction),
    SetPriceForDirectPurchaseAction(TokenSetPriceForDirectPurchaseTransitionAction),
}

Expand description

token action

Variants§

BurnAction(TokenBurnTransitionAction)

burn

MintAction(TokenMintTransitionAction)

issuance

TransferAction(TokenTransferTransitionAction)

transfer

FreezeAction(TokenFreezeTransitionAction)

freeze

UnfreezeAction(TokenUnfreezeTransitionAction)

unfreeze

ClaimAction(TokenClaimTransitionAction)

release

EmergencyActionAction(TokenEmergencyActionTransitionAction)

emergency action

DestroyFrozenFundsAction(TokenDestroyFrozenFundsTransitionAction)

destroy frozen funds action

ConfigUpdateAction(TokenConfigUpdateTransitionAction)

update the token configuration

DirectPurchaseAction(TokenDirectPurchaseTransitionAction)

purchases the token from the contract owner

SetPriceForDirectPurchaseAction(TokenSetPriceForDirectPurchaseTransitionAction)

sets the price for direct purchase of the token

Implementations§

impl TokenTransitionAction

pub fn associated_token_event(&self) -> TokenEvent

Gets the associated token event for the transition action

impl TokenTransitionAction

pub fn base(&self) -> &TokenBaseTransitionAction

Returns a reference to the base token transition action if available

pub fn base_owned(self) -> TokenBaseTransitionAction

Consumes self and returns the base token transition action if available

pub fn historical_document_type_name(&self) -> &str

Historical document type name for the token history contract

pub fn historical_document_type<'a>( &self, token_history_contract: &'a DataContract, ) -> Result<DocumentTypeRef<'a>, ProtocolError>

Historical document type for the token history contract

pub fn historical_document_id(&self, owner_id: Identifier) -> Identifier

Historical document id

pub fn build_historical_document( &self, token_id: Identifier, owner_id: Identifier, owner_nonce: IdentityNonce, block_info: &BlockInfo, platform_version: &PlatformVersion, ) -> Result<Document, Error>

Historical document

pub fn keeps_history(&self) -> Result<bool, Error>

Do we keep history for this action

Trait Implementations§

impl Clone for TokenTransitionAction

fn clone(&self) -> TokenTransitionAction

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for TokenTransitionAction

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

Formats the value using the given formatter. Read more

impl From<TokenBurnTransitionAction> for TokenTransitionAction

fn from(value: TokenBurnTransitionAction) -> Self

Converts to this type from the input type.

impl From<TokenClaimTransitionAction> for TokenTransitionAction

fn from(value: TokenClaimTransitionAction) -> Self

Converts to this type from the input type.

impl From<TokenConfigUpdateTransitionAction> for TokenTransitionAction

fn from(value: TokenConfigUpdateTransitionAction) -> Self

Converts to this type from the input type.

impl From<TokenDestroyFrozenFundsTransitionAction> for TokenTransitionAction

fn from(value: TokenDestroyFrozenFundsTransitionAction) -> Self

Converts to this type from the input type.

impl From<TokenDirectPurchaseTransitionAction> for TokenTransitionAction

fn from(value: TokenDirectPurchaseTransitionAction) -> Self

Converts to this type from the input type.

impl From<TokenEmergencyActionTransitionAction> for TokenTransitionAction

fn from(value: TokenEmergencyActionTransitionAction) -> Self

Converts to this type from the input type.

impl From<TokenFreezeTransitionAction> for TokenTransitionAction

fn from(value: TokenFreezeTransitionAction) -> Self

Converts to this type from the input type.

impl From<TokenMintTransitionAction> for TokenTransitionAction

fn from(value: TokenMintTransitionAction) -> Self

Converts to this type from the input type.

impl From<TokenSetPriceForDirectPurchaseTransitionAction> for TokenTransitionAction

fn from(value: TokenSetPriceForDirectPurchaseTransitionAction) -> Self

Converts to this type from the input type.

impl From<TokenTransferTransitionAction> for TokenTransitionAction

fn from(value: TokenTransferTransitionAction) -> Self

Converts to this type from the input type.

impl From<TokenTransitionAction> for BatchedTransitionAction

fn from(value: TokenTransitionAction) -> Self

Converts to this type from the input type.

impl From<TokenUnfreezeTransitionAction> for TokenTransitionAction

fn from(value: TokenUnfreezeTransitionAction) -> Self

Converts to this type from the input type.

impl TokenTransitionActionTypeGetter for TokenTransitionAction

fn action_type(&self) -> TokenTransitionActionType

Auto Trait Implementations§

impl Freeze for TokenTransitionAction

impl RefUnwindSafe for TokenTransitionAction

impl Send for TokenTransitionAction

impl Sync for TokenTransitionAction

impl Unpin for TokenTransitionAction

impl UnwindSafe for TokenTransitionAction

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> CostsExt for T

fn wrap_with_cost(self, cost: OperationCost) -> CostContext<Self>
where Self: Sized,

Wraps any value into a CostContext object with provided costs.

fn wrap_fn_cost( self, f: impl FnOnce(&Self) -> OperationCost, ) -> CostContext<Self>
where Self: Sized,

Wraps any value into CostContext object with costs computed using the value getting wrapped.

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T, U> IntoOnNetwork<U> for T
where U: FromOnNetwork<T>,

fn into_on_network(self, network: Network) -> U

Calls U::from_on_network(self).

impl<T, U> IntoPlatformVersioned<U> for T
where U: FromPlatformVersioned<T>,

fn into_platform_versioned(self, platform_version: &PlatformVersion) -> U

Performs the conversion.

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

fn try_from_versioned( value: U, _grove_version: &GroveVersion, ) -> Result<T, <T as TryFromVersioned<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryIntoPlatformVersioned<U> for T
where U: TryFromPlatformVersioned<T>,

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

The type returned in the event of a conversion error.

fn try_into_platform_versioned( self, platform_version: &PlatformVersion, ) -> Result<U, <U as TryFromPlatformVersioned<T>>::Error>

Performs the conversion.

impl<T, U> TryIntoVersioned<U> for T
where U: TryFromVersioned<T>,

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

The type returned in the event of a conversion error.

fn try_into_versioned( self, grove_version: &GroveVersion, ) -> Result<U, <U as TryFromVersioned<T>>::Error>

Performs the conversion.

impl<T, U> TryIntoWithBlockHashLookup<U> for T
where U: TryFromWithBlockHashLookup<T>,

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

fn try_into_with_block_hash_lookup<F>( self, block_hash_lookup: F, network: Network, ) -> Result<U, <T as TryIntoWithBlockHashLookup<U>>::Error>
where F: Fn(&BlockHash) -> Option<u32>,

Converts self into T, using a block hash lookup function.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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