Enum BatchTransition 

pub enum BatchTransition {
    V0(BatchTransitionV0),
    V1(BatchTransitionV1),
}

Variants

V0(BatchTransitionV0)

V1(BatchTransitionV1)

Implementations

impl BatchTransition

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

impl BatchTransition

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 BatchTransition

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

Attempt to decode this type with the given BorrowDecode.

impl Clone for BatchTransition

fn clone(&self) -> BatchTransition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchTransition

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for BatchTransition

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

Attempt to decode this type with the given Decode.

impl<'de> Deserialize<'de> for BatchTransition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DocumentsBatchTransitionAccessorsV0 for BatchTransition

fn transitions_iter(&self) -> Self::IterType<'_>

Iterator for BatchedTransitionRef items.

type IterType<'a> = DocumentBatchIterator<'a> where Self: 'a

Associated type for the iterator.

fn transitions_len(&self) -> usize

fn transitions_are_empty(&self) -> bool

fn first_transition(&self) -> Option<BatchedTransitionRef<'_>>

fn first_transition_mut(&mut self) -> Option<BatchedTransitionMutRef<'_>>

fn contains_document_transition(&self) -> bool

fn contains_token_transition(&self) -> bool

impl DocumentsBatchTransitionMethodsV0 for BatchTransition

fn all_document_purchases_amount( &self, ) -> Result<Option<Credits>, ProtocolError>

fn all_conflicting_index_collateral_voting_funds( &self, ) -> Result<Option<Credits>, ProtocolError>

fn set_transitions(&mut self, transitions: Vec<BatchedTransition>)

fn set_identity_contract_nonce( &mut self, identity_contract_nonce: IdentityNonce, )

fn new_document_creation_transition_from_document<S: Signer<IdentityPublicKey>>( document: Document, document_type: DocumentTypeRef<'_>, entropy: [u8; 32], identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, token_payment_info: Option<TokenPaymentInfo>, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

fn new_document_replacement_transition_from_document<S: Signer<IdentityPublicKey>>( document: Document, document_type: DocumentTypeRef<'_>, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, token_payment_info: Option<TokenPaymentInfo>, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

fn new_document_transfer_transition_from_document<S: Signer<IdentityPublicKey>>( document: Document, document_type: DocumentTypeRef<'_>, recipient_owner_id: Identifier, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, token_payment_info: Option<TokenPaymentInfo>, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

fn new_document_deletion_transition_from_document<S: Signer<IdentityPublicKey>>( document: Document, document_type: DocumentTypeRef<'_>, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, token_payment_info: Option<TokenPaymentInfo>, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

fn new_document_update_price_transition_from_document<S: Signer<IdentityPublicKey>>( document: Document, document_type: DocumentTypeRef<'_>, price: Credits, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, token_payment_info: Option<TokenPaymentInfo>, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

fn new_document_purchase_transition_from_document<S: Signer<IdentityPublicKey>>( document: Document, document_type: DocumentTypeRef<'_>, new_owner_id: Identifier, price: Credits, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, token_payment_info: Option<TokenPaymentInfo>, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

fn combined_security_level_requirement( &self, get_data_contract_security_level_requirement: Option<impl Fn(Identifier, String) -> Result<SecurityLevel, ProtocolError>>, ) -> Result<Vec<SecurityLevel>, ProtocolError>

impl DocumentsBatchTransitionMethodsV1 for BatchTransition

fn new_token_mint_transition<S: Signer<IdentityPublicKey>>( token_id: Identifier, owner_id: Identifier, data_contract_id: Identifier, token_contract_position: TokenContractPosition, amount: TokenAmount, issued_to_identity_id: Option<Identifier>, public_note: Option<String>, using_group_info: Option<GroupStateTransitionInfoStatus>, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

Creates a StateTransition to mint new tokens.

fn new_token_burn_transition<S: Signer<IdentityPublicKey>>( token_id: Identifier, owner_id: Identifier, data_contract_id: Identifier, token_contract_position: u16, amount: TokenAmount, public_note: Option<String>, using_group_info: Option<GroupStateTransitionInfoStatus>, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

Creates a StateTransition to burn tokens, permanently removing them from circulation.

fn new_token_transfer_transition<S: Signer<IdentityPublicKey>>( token_id: Identifier, owner_id: Identifier, data_contract_id: Identifier, token_contract_position: u16, amount: TokenAmount, recipient_id: Identifier, public_note: Option<String>, shared_encrypted_note: Option<SharedEncryptedNote>, private_encrypted_note: Option<PrivateEncryptedNote>, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

Creates a StateTransition to transfer tokens from one identity to another.

fn new_token_freeze_transition<S: Signer<IdentityPublicKey>>( token_id: Identifier, owner_id: Identifier, data_contract_id: Identifier, token_contract_position: u16, freeze_identity_id: Identifier, public_note: Option<String>, using_group_info: Option<GroupStateTransitionInfoStatus>, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

Creates a StateTransition to freeze tokens belonging to a specific identity.

fn new_token_unfreeze_transition<S: Signer<IdentityPublicKey>>( token_id: Identifier, owner_id: Identifier, data_contract_id: Identifier, token_contract_position: u16, unfreeze_identity_id: Identifier, public_note: Option<String>, using_group_info: Option<GroupStateTransitionInfoStatus>, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

Creates a StateTransition to unfreeze tokens previously frozen for a specific identity.

fn new_token_destroy_frozen_funds_transition<S: Signer<IdentityPublicKey>>( token_id: Identifier, owner_id: Identifier, data_contract_id: Identifier, token_contract_position: u16, frozen_identity_id: Identifier, public_note: Option<String>, using_group_info: Option<GroupStateTransitionInfoStatus>, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

Creates a StateTransition to destroy previously frozen tokens, removing them permanently from supply.

fn new_token_emergency_action_transition<S: Signer<IdentityPublicKey>>( token_id: Identifier, owner_id: Identifier, data_contract_id: Identifier, token_contract_position: u16, emergency_action: TokenEmergencyAction, public_note: Option<String>, using_group_info: Option<GroupStateTransitionInfoStatus>, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

Creates a StateTransition to execute an emergency action for a token.

fn new_token_config_update_transition<S: Signer<IdentityPublicKey>>( token_id: Identifier, owner_id: Identifier, data_contract_id: Identifier, token_contract_position: u16, update_token_configuration_item: TokenConfigurationChangeItem, public_note: Option<String>, using_group_info: Option<GroupStateTransitionInfoStatus>, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

Creates a StateTransition to update the configuration of a token.

fn new_token_claim_transition<S: Signer<IdentityPublicKey>>( token_id: Identifier, owner_id: Identifier, data_contract_id: Identifier, token_contract_position: u16, distribution_type: TokenDistributionType, public_note: Option<String>, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

Creates a StateTransition to claim tokens from a distribution source.

fn new_token_change_direct_purchase_price_transition<S: Signer<IdentityPublicKey>>( token_id: Identifier, owner_id: Identifier, data_contract_id: Identifier, token_contract_position: u16, token_pricing_schedule: Option<TokenPricingSchedule>, public_note: Option<String>, using_group_info: Option<GroupStateTransitionInfoStatus>, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

Creates a StateTransition to set or update the price of a token for direct purchase.

fn new_token_direct_purchase_transition<S: Signer<IdentityPublicKey>>( token_id: Identifier, owner_id: Identifier, data_contract_id: Identifier, token_contract_position: u16, amount: TokenAmount, total_agreed_price: Credits, identity_public_key: &IdentityPublicKey, identity_contract_nonce: IdentityNonce, user_fee_increase: UserFeeIncrease, signer: &S, platform_version: &PlatformVersion, options: Option<StateTransitionCreationOptions>, ) -> Result<StateTransition, ProtocolError>

Creates a StateTransition to perform a direct purchase of tokens by a user.

impl Encode for BatchTransition

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

Encode a given type.

impl FeatureVersioned for BatchTransition

fn feature_version(&self) -> FeatureVersion

impl From<BatchTransition> for StateTransition

fn from(value: BatchTransition) -> Self

Converts to this type from the input type.

impl From<BatchTransitionV0> for BatchTransition

fn from(value: BatchTransitionV0) -> Self

Converts to this type from the input type.

impl From<BatchTransitionV1> for BatchTransition

fn from(value: BatchTransitionV1) -> Self

Converts to this type from the input type.

impl OptionallyAssetLockProved for BatchTransition

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

Returns asset lock proof if state transition implements it

impl PartialEq for BatchTransition

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

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

where Self: Sized,

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

where Self: Sized,

impl PlatformSerializable for BatchTransition

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 BatchTransition

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

Encode a given type.

impl<'__de> PlatformVersionedBorrowDecode<'__de> for BatchTransition

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 BatchTransition

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 BatchTransition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Signable for BatchTransition

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

impl StateTransitionEstimatedFeeValidation for BatchTransition

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

Calculates the estimated minimum fee required for this state transition.

impl StateTransitionFieldTypes for BatchTransition

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

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

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

impl StateTransitionHasUserFeeIncrease for BatchTransition

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 StateTransitionIdentityEstimatedFeeValidation for BatchTransition

fn validate_estimated_fee( &self, identity_known_balance: Credits, platform_version: &PlatformVersion, ) -> Result<SimpleConsensusValidationResult, ProtocolError>

Validates that sufficient identity balance is available to cover the estimated fee.

impl StateTransitionIdentitySigned for BatchTransition

fn signature_public_key_id(&self) -> KeyID

fn set_signature_public_key_id(&mut self, key_id: KeyID)

fn security_level_requirement(&self, purpose: Purpose) -> Vec<SecurityLevel>

Returns minimal key security level that can be used to sign this ST. Override this method if the ST requires a different security level.

fn purpose_requirement(&self) -> Vec<Purpose>

The purpose requirement for the signing key The default is authentication However for Withdrawals and Fund Transfers the requirement is TRANSFER

fn verify_public_key_level_and_purpose( &self, public_key: &IdentityPublicKey, options: StateTransitionSigningOptions, ) -> Result<(), ProtocolError>

Verifies that the supplied public key has the correct security level and purpose to sign the state transition This should only be used for authentication

fn verify_public_key_is_enabled( &self, public_key: &IdentityPublicKey, ) -> Result<(), ProtocolError>

impl StateTransitionJsonConvert<'_> for BatchTransition

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

Returns the serde_json::Value instance that encodes:

impl StateTransitionLike for BatchTransition

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 StateTransitionOwned for BatchTransition

fn owner_id(&self) -> Identifier

Get owner ID

impl StateTransitionSingleSigned for BatchTransition

fn signature(&self) -> &BinaryData

returns the signature as a byte-array

fn set_signature(&mut self, signature: BinaryData)

set a new signature

fn set_signature_bytes(&mut self, signature: Vec<u8>)

sets the signature bytes

impl StateTransitionValueConvert<'_> for BatchTransition

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

Returns the [platform_value::Value] instance that preserves the Vec<u8> representation for Identifiers and binary data

fn to_canonical_object( &self, skip_signature: bool, ) -> Result<Value, ProtocolError>

Returns the [platform_value::Value] instance that preserves the Vec<u8> representation for Identifiers and binary data

fn to_canonical_cleaned_object( &self, skip_signature: bool, ) -> Result<Value, ProtocolError>

Returns the [platform_value::Value] instance that preserves the Vec<u8> representation for Identifiers and binary data

fn to_cleaned_object( &self, skip_signature: bool, ) -> Result<Value, ProtocolError>

fn from_object( raw_object: Value, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

fn from_value_map( raw_value_map: BTreeMap<String, Value>, platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

fn clean_value(value: &mut Value) -> Result<(), ProtocolError>

impl StructuralPartialEq for BatchTransition