Enum ShieldTransition 

pub enum ShieldTransition {
    V0(ShieldTransitionV0),
}

Variants

V0(ShieldTransitionV0)

Implementations

impl ShieldTransition

pub fn feature_version(&self) -> FeatureVersion

pub fn verify_protocol_version( &self, protocol_version: u32, ) -> Result<bool, ProtocolError>

Trait Implementations

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

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 ShieldTransition

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 ShieldTransition

fn clone(&self) -> ShieldTransition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShieldTransition

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for ShieldTransition

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 ShieldTransition

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

Decode with explicit untrusted field dispatch and resource handling.

impl<'de> Deserialize<'de> for ShieldTransition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for ShieldTransition

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

Encode a given type.

impl FeatureVersioned for ShieldTransition

fn feature_version(&self) -> FeatureVersion

impl From<ShieldTransition> for StateTransition

fn from(value: ShieldTransition) -> Self

Converts to this type from the input type.

impl From<ShieldTransitionV0> for ShieldTransition

fn from(value: ShieldTransitionV0) -> Self

Converts to this type from the input type.

impl JsonConvertible for ShieldTransition

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

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

impl JsonSafeFields for ShieldTransition

impl OptionallyAssetLockProved for ShieldTransition

fn optional_asset_lock_proof(&self) -> Option<&AssetLockProof>

Returns asset lock proof if state transition implements it

impl PartialEq for ShieldTransition

fn eq(&self, other: &ShieldTransition) -> 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 PlatformDeserializableTrusted for ShieldTransition

fn deserialize_from_bytes_trusted(data: &[u8]) -> Result<Self, ProtocolError>

where Self: Sized,

fn deserialize_from_bytes_trusted_no_limit( data: &[u8], ) -> Result<Self, ProtocolError>

where Self: Sized,

impl PlatformDeserializableUntrusted for ShieldTransition

fn deserialize_from_bytes_untrusted(data: &[u8]) -> Result<Self, ProtocolError>

where Self: Sized,

fn deserialize_from_bytes_untrusted_no_limit( data: &[u8], ) -> Result<Self, ProtocolError>

where Self: Sized,

impl PlatformSerializable for ShieldTransition

type Error = ProtocolError

fn serialize_to_bytes(&self) -> Result<Vec<u8>, Self::Error>

fn serialize_consume_to_bytes(self) -> Result<Vec<u8>, Self::Error>

If the trait is not used just do a simple serialize

impl PlatformVersionEncode for ShieldTransition

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

Encode a given type.

impl<'__de> PlatformVersionedBorrowDecode<'__de> for ShieldTransition

fn platform_versioned_borrow_decode<__D: BorrowDecoder<'__de, Context = BincodeContext>>( decoder: &mut __D, platform_version: &PlatformVersion, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl PlatformVersionedDecode for ShieldTransition

fn platform_versioned_decode<__D: Decoder<Context = BincodeContext>>( decoder: &mut __D, platform_version: &PlatformVersion, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Serialize for ShieldTransition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ShieldTransitionAccessorsV0 for ShieldTransition

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

Get the serialized Orchard actions (spend/output pairs).

fn set_actions(&mut self, actions: Vec<SerializedAction>)

Replace the serialized Orchard actions.

fn amount(&self) -> u64

Get the amount of credits being shielded (entering the shielded pool).

fn set_amount(&mut self, amount: u64)

Set the amount of credits being shielded.

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

Get the Orchard anchor (Sinsemilla root of the note commitment tree).

fn set_anchor(&mut self, anchor: [u8; 32])

Set the Orchard anchor.

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

Get the Halo2 proof bytes.

fn set_proof(&mut self, proof: Vec<u8>)

Set the Halo2 proof bytes.

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

Get the RedPallas binding signature.

fn set_binding_signature(&mut self, binding_signature: [u8; 64])

Set the RedPallas binding signature.

fn fee_strategy(&self) -> &AddressFundsFeeStrategy

Get the fee payment strategy.

fn set_fee_strategy(&mut self, fee_strategy: AddressFundsFeeStrategy)

Set the fee payment strategy.

fn nullifiers<T: From<[u8; 32]>>(&self) -> Vec<T>

Extract nullifier bytes from each action. Generic over the element type: use Vec<u8> or [u8; 32] as needed.

impl ShieldTransitionMethodsV0 for ShieldTransition

async fn try_from_bundle_with_signer<S: Signer<PlatformAddress>>( inputs: BTreeMap<PlatformAddress, (AddressNonce, Credits)>, actions: Vec<SerializedAction>, amount: u64, anchor: [u8; 32], proof: Vec<u8>, binding_signature: [u8; 64], fee_strategy: AddressFundsFeeStrategy, signer: &S, user_fee_increase: UserFeeIncrease, platform_version: &PlatformVersion, ) -> Result<StateTransition, ProtocolError>

fn get_type() -> StateTransitionType

Get State Transition Type

impl Signable for ShieldTransition

fn signable_bytes(&self) -> Result<Vec<u8>, ProtocolError>

impl StateTransitionEstimatedFeeValidation for ShieldTransition

fn calculate_min_required_fee( &self, platform_version: &PlatformVersion, ) -> Result<Credits, ProtocolError>

Returns an advisory lower bound on a transparent Shield’s fee: the predictable COMPUTE portion compute_shielded_verification_fee(num_actions) (the per-bundle Halo 2 proof-verification fee + the per-action processing fee).

This is NOT the funding floor and is NOT the full fee. Unlike the asset-lock transitions, the transparent Shield is excluded from the address-minimum-balance pre-check (StateTransition::required_asset_lock_balance_for_processing_start does not dispatch to it), so no consensus or funding path consumes this value — it is only reachable via the generic SDK advisory StateTransition::calculate_estimated_fee().

Shield is metered + compute: GroveDB meters the real storage and processing of the note/nullifier writes, and the execution-event layer adds only this compute fee on top (see validate_fees_of_event / the ExecutionEvent construction). The metered storage/processing portion depends on live GroveDB tree state and therefore cannot be known statelessly here, so the real fee a Shield will be charged is strictly greater than this number. A caller that needs the actual required balance must price the metered portion against state (e.g. via the fee-validation pass), not rely on this estimate.

impl StateTransitionFieldTypes for ShieldTransition

fn signature_property_paths() -> Vec<&'static str>

fn identifiers_property_paths() -> Vec<&'static str>

fn binary_property_paths() -> Vec<&'static str>

impl StateTransitionHasUserFeeIncrease for ShieldTransition

fn user_fee_increase(&self) -> UserFeeIncrease

returns the fee multiplier

fn set_user_fee_increase(&mut self, user_fee_increase: UserFeeIncrease)

set a fee multiplier

impl StateTransitionLike for ShieldTransition

fn modified_data_ids(&self) -> Vec<Identifier>

Returns ID of the created contract

fn state_transition_type(&self) -> StateTransitionType

returns the type of State Transition

fn state_transition_protocol_version(&self) -> FeatureVersion

returns the protocol version

fn unique_identifiers(&self) -> Vec<String>

unique identifiers for the state transition This is often only one String except in the case of a documents batch state transition

fn is_document_state_transition(&self) -> bool

returns true if state transition is a document state transition

fn is_data_contract_state_transition(&self) -> bool

returns true if state transition is a data contract state transition

fn is_identity_state_transition(&self) -> bool

return true if state transition is an identity state transition

fn is_voting_state_transition(&self) -> bool

return true if state transition is a voting state transition

impl StateTransitionStructureValidation for ShieldTransition

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

Validates the structure of the state transition

impl StateTransitionWitnessSigned for ShieldTransition

fn inputs(&self) -> &BTreeMap<PlatformAddress, (AddressNonce, Credits)>

Get inputs

fn inputs_mut( &mut self, ) -> &mut BTreeMap<PlatformAddress, (AddressNonce, Credits)>

Get inputs as a mutable map

fn set_inputs( &mut self, inputs: BTreeMap<PlatformAddress, (AddressNonce, Credits)>, )

Set inputs

fn witnesses(&self) -> &Vec<AddressWitness>

returns the witnesses as an array

fn set_witnesses(&mut self, witnesses: Vec<AddressWitness>)

set new witnesses

impl StateTransitionWitnessValidation for ShieldTransition

fn validate_witnesses(&self, signable_bytes: &[u8]) -> WitnessValidationResult

Validates that all input witnesses are valid for the given signable bytes.

impl StructuralPartialEq for ShieldTransition

impl ValueConvertible for ShieldTransition

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,