Enum TokenBurnFromPoolTransition 

pub enum TokenBurnFromPoolTransition {
    V0(TokenBurnFromPoolTransitionV0),
}

Destroys amount of a token held inside the token’s shielded pool.

The Orchard bundle spends notes and has a value balance of +amount; the tokens leave the pool and the total supply. The burner must be authorized by manualBurningRules like a transparent burn, and the token id, owner id and amount are bound into the Orchard sighash.

Variants

V0(TokenBurnFromPoolTransitionV0)

Implementations

impl TokenBurnFromPoolTransition

pub fn calculate_action_id_with_fields( token_id: &[u8; 32], owner_id: &[u8; 32], identity_contract_nonce: IdentityNonce, amount: TokenAmount, actions_digest: &[u8; 32], ) -> Identifier

The group action id: unlike a transparent burn, the digest of the Orchard actions is part of it, so two proposals that differ only in the notes never share an id.

Trait Implementations

impl AllowedAsMultiPartyAction for TokenBurnFromPoolTransition

fn calculate_action_id( &self, owner_id: Identifier, platform_version: &PlatformVersion, ) -> Result<Identifier, ProtocolError>

impl<'__de, __Context> BorrowDecode<'__de, __Context> for TokenBurnFromPoolTransition

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl<'__de, __Context> BorrowDecodeUntrusted<'__de, __Context> for TokenBurnFromPoolTransition

fn borrow_decode_untrusted<__D: BorrowUntrustedDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Borrow-decode with explicit untrusted field dispatch and resource handling.

impl Clone for TokenBurnFromPoolTransition

fn clone(&self) -> TokenBurnFromPoolTransition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenBurnFromPoolTransition

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for TokenBurnFromPoolTransition

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<__Context> DecodeUntrusted<__Context> for TokenBurnFromPoolTransition

fn decode_untrusted<__D: UntrustedDecoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Decode with explicit untrusted field dispatch and resource handling.

impl Default for TokenBurnFromPoolTransition

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TokenBurnFromPoolTransition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TokenBurnFromPoolTransition

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

Formats the value using the given formatter.

impl Encode for TokenBurnFromPoolTransition

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl From<TokenBurnFromPoolTransition> for TokenTransition

fn from(value: TokenBurnFromPoolTransition) -> Self

Converts to this type from the input type.

impl From<TokenBurnFromPoolTransitionV0> for TokenBurnFromPoolTransition

fn from(value: TokenBurnFromPoolTransitionV0) -> Self

Converts to this type from the input type.

impl JsonConvertible for TokenBurnFromPoolTransition

Available on crate features json-conversion and serde-conversion only.

fn to_json(&self) -> Result<JsonValue, ProtocolError>

fn from_json(json: JsonValue) -> Result<Self, ProtocolError>

impl PartialEq for TokenBurnFromPoolTransition

fn eq(&self, other: &TokenBurnFromPoolTransition) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TokenBurnFromPoolTransition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TokenBurnFromPoolTransition

impl TokenBaseTransitionAccessors for TokenBurnFromPoolTransition

fn base(&self) -> &TokenBaseTransition

Returns a reference to the base field of the DocumentCreateTransitionV0.

fn base_mut(&mut self) -> &mut TokenBaseTransition

Returns a mut reference to the base field of the DocumentCreateTransitionV0.

fn set_base(&mut self, base: TokenBaseTransition)

Sets the value of the base field in the DocumentCreateTransitionV0.

impl TokenBurnFromPoolTransitionStructureValidation for TokenBurnFromPoolTransition

fn validate_structure( &self, platform_version: &PlatformVersion, ) -> Result<SimpleConsensusValidationResult, ProtocolError>

impl TokenBurnFromPoolTransitionV0Methods for TokenBurnFromPoolTransition

fn amount(&self) -> TokenAmount

Tokens entering or leaving the pool. Equals the absolute value of the bundle’s value balance.

fn actions(&self) -> &[SerializedAction]

Orchard actions.

fn anchor(&self) -> &[u8; 32]

Sinsemilla root of the token pool’s note commitment tree (Orchard anchor).

fn proof(&self) -> &[u8]

Halo 2 proof bytes.

fn binding_signature(&self) -> &[u8; 64]

RedPallas binding signature.

fn public_note(&self) -> Option<&String>

Optional public note. Only a group action proposer may set one.

fn public_note_owned(self) -> Option<String>

Takes the public note.

fn set_amount(&mut self, amount: TokenAmount)

Sets amount.

fn set_public_note(&mut self, public_note: Option<String>)

Sets public_note.

impl ValueConvertible for TokenBurnFromPoolTransition

Available on crate features serde-conversion and value-conversion only.

fn to_object(&self) -> Result<Value, ProtocolError>

where Self: Sized,

fn into_object(self) -> Result<Value, ProtocolError>

where Self: Sized,

fn from_object(value: Value) -> Result<Self, ProtocolError>

where Self: Sized,

fn from_object_ref(value: &Value) -> Result<Self, ProtocolError>

where Self: Sized,