Enum StateTransition

Source

pub enum StateTransition {
Show 24 variants
    DataContractCreate(DataContractCreateTransition),
    DataContractUpdate(DataContractUpdateTransition),
    Batch(BatchTransition),
    IdentityCreate(IdentityCreateTransition),
    IdentityTopUp(IdentityTopUpTransition),
    IdentityCreditWithdrawal(IdentityCreditWithdrawalTransition),
    IdentityUpdate(IdentityUpdateTransition),
    IdentityCreditTransfer(IdentityCreditTransferTransition),
    MasternodeVote(MasternodeVoteTransition),
    IdentityCreditTransferToAddresses(IdentityCreditTransferToAddressesTransition),
    IdentityCreateFromAddresses(IdentityCreateFromAddressesTransition),
    IdentityTopUpFromAddresses(IdentityTopUpFromAddressesTransition),
    AddressFundsTransfer(AddressFundsTransferTransition),
    AddressFundingFromAssetLock(AddressFundingFromAssetLockTransition),
    AddressCreditWithdrawal(AddressCreditWithdrawalTransition),
    Shield(ShieldTransition),
    ShieldedTransfer(ShieldedTransferTransition),
    Unshield(UnshieldTransition),
    ShieldFromAssetLock(ShieldFromAssetLockTransition),
    ShieldedWithdrawal(ShieldedWithdrawalTransition),
    IdentityCreateFromShieldedPool(IdentityCreateFromShieldedPoolTransition),
    ShieldFromIdentity(ShieldFromIdentityTransition),
    IdentityTopUpFromShieldedPool(IdentityTopUpFromShieldedPoolTransition),
    IdentityKeyLimitsUpdate(IdentityKeyLimitsUpdateTransition),
}

Variants§

§

IdentityKeyLimitsUpdate(IdentityKeyLimitsUpdateTransition)

Implementations§

Source §

impl StateTransition

Source

pub fn deserialize_from_bytes_untrusted_in_version( bytes: &[u8], platform_version: &PlatformVersion, ) -> Result<Self, ProtocolError>

Source

pub fn active_version_range(&self) -> RangeInclusive<ProtocolVersion>

Source

pub fn is_identity_signed(&self) -> bool

Source

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

Source

pub fn name(&self) -> String

Returns state transition name

Source

pub fn signature(&self) -> Option<&BinaryData>

returns the signature as a byte-array

Source

pub fn required_number_of_private_keys(&self) -> u16

returns the number of private keys

Source

pub fn user_fee_increase(&self) -> UserFeeIncrease

returns the fee_increase additional percentage multiplier, it affects only processing costs

Source

pub fn transaction_id(&self) -> Result<[u8; 32], ProtocolError>

The transaction id is a single hash of the data with the signature

Source

pub fn signature_public_key_id(&self) -> Option<KeyID>

returns the signature as a byte-array

Source

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

returns the key security level requirement for the state transition

Source

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

returns the key purpose requirement for the state transition

Source

pub fn owner_id(&self) -> Option<Identifier>

returns the signature as a byte-array

Source

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

returns the signature as a byte-array

Source

pub fn state_transition_type(&self) -> StateTransitionType

returns the state transition type

Source

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

returns the unique identifiers for the state transition

Source

pub fn set_signature(&mut self, signature: BinaryData) -> bool

set a new signature

Source

pub fn set_user_fee_increase(&mut self, user_fee_increase: UserFeeIncrease)

set fee multiplier

Source

pub fn set_signature_public_key_id(&mut self, public_key_id: KeyID)

set a new signature

Source

pub async fn sign_external<S: Signer<IdentityPublicKey>>( &mut self, identity_public_key: &IdentityPublicKey, signer: &S, get_data_contract_security_level_requirement: Option<impl Fn(Identifier, String) -> Result<SecurityLevel, ProtocolError>>, ) -> Result<(), ProtocolError>

Source

pub async fn sign_external_with_options<S: Signer<IdentityPublicKey>>( &mut self, identity_public_key: &IdentityPublicKey, signer: &S, get_data_contract_security_level_requirement: Option<impl Fn(Identifier, String) -> Result<SecurityLevel, ProtocolError>>, options: StateTransitionSigningOptions, ) -> Result<(), ProtocolError>

Source

pub fn sign( &mut self, identity_public_key: &IdentityPublicKey, private_key: &[u8], bls: &impl BlsModule, ) -> Result<(), ProtocolError>

Source

pub fn sign_with_options( &mut self, identity_public_key: &IdentityPublicKey, private_key: &[u8], bls: &impl BlsModule, options: StateTransitionSigningOptions, ) -> Result<(), ProtocolError>

Source

pub fn sign_by_private_key( &mut self, private_key: &[u8], key_type: KeyType, bls: &impl BlsModule, ) -> Result<(), ProtocolError>

Signs data with the private key

Source

pub async fn sign_with_core_signer<S: Signer>( &mut self, path: &DerivationPath, signer: &S, ) -> Result<(), ProtocolError>

Sign self.signable_bytes() with an external Core-wallet signer and store the resulting Core-ECDSA signature in the transition’s wrapper signature field.

§Position in the signing-primitive family

This is a primitive in the same family as Self::sign_by_private_key — it performs no validation of the transition variant, the key, or the relationship between them. It is the external-custody sibling of sign_by_private_key:

Primitive	Key source	Validation
`Self::sign_by_private_key`	raw `&[u8]` in host memory	none
`sign_with_core_signer`	external signer (HSM / hardware wallet / secure enclave / remote signing service), key reached via BIP32 [`DerivationPath`]	none

Both produce byte-identical wrapper signatures over the same digest when given the same underlying private key (proven by sign_with_signer_matches_sign_by_private_key_byte_for_byte in this file’s tests). The only difference is where the key bytes live: in host memory vs inside the signer’s trust boundary. The signer performs the derive + sign + zeroise sequence atomically; this function never sees raw key material, only a 32-byte digest and the resulting signature.

§Scope (what the BIP32 path means)

The path parameter selects a key in the signer’s Core wallet (BIP32-derived). For that path’s signature to be meaningful the transition’s wrapper signature field must itself carry a Core-key signature. Today that is exactly the four asset-lock-signed variants — IdentityCreate, IdentityTopUp, AddressFundingFromAssetLock, ShieldFromAssetLock — where the wrapper signature is the asset-lock proof signed by the credit output’s Core key.

For identity-signed variants (DataContractCreate, Batch, IdentityCreditTransfer, etc.) the wrapper signature is an identity-key signature paired with a signature_public_key_id, and the right external-signer entry point is Self::sign_external with a Signer<IdentityPublicKey>. Calling sign_with_core_signer on such a variant compiles and produces a structurally valid 65-byte signature, but the signature is semantically meaningless — Platform validation will reject the transition because the signature doesn’t match the expected identity public key and signature_public_key_id isn’t set. The same caveat applies to misusing sign_by_private_key, the sibling primitive — both rely on the caller passing a key the wrapper signature is meant to carry.

§Wire-format parity with `sign_by_private_key`

The byte layout of the stored signature mirrors dashcore::signer::sign:

digest = double_sha256(self.signable_bytes()?)
signer.sign_ecdsa(path, digest).await → non-recoverable (secp256k1::ecdsa::Signature, secp256k1::PublicKey).
Recover the recovery id by trying all four candidates against the returned public key (libsecp256k1 normalises both signing paths to low-s form so the 64-byte r||s payload is bit-identical).
Serialise as a 65-byte compact recoverable signature with the compressed prefix convention used by CompactSignature — i.e. [recovery_id + 27 + 4, r (32) || s (32)].

§Errors

Returns ProtocolError::ExternalSignerError wrapping the signer’s Display error when the underlying signer fails.
Returns ProtocolError::ExternalSignerError if no recovery id matches the public key returned by the signer — this should be unreachable for a conformant signer (invariant violation by a non-conformant signer) but is surfaced rather than panicked on.
Returns ProtocolError::Generic if the SHA-256 transform did not yield a 32-byte digest (defensive — should never happen).
Returns ProtocolError::InvalidVerificationWrongNumberOfElements if set_signature rejects the result (matches sign_by_private_key).

Source

pub fn verify_identity_signed_signature( &self, public_key: &IdentityPublicKey, bls: &impl BlsModule, ) -> Result<(), ProtocolError>

Trait Implementations§

Source §

impl<'de, Context> BorrowDecode<'de, Context> for StateTransition

Source §

fn borrow_decode<D: BorrowDecoder<'de, Context = Context>>( decoder: &mut D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

Source §

impl<'de, Context> BorrowDecodeUntrusted<'de, Context> for StateTransition

Source §

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.

Source §

impl Clone for StateTransition

Source §

fn clone(&self) -> StateTransition

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 Debug for StateTransition

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<Context> Decode<Context> for StateTransition

Source §

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

Attempt to decode this type with the given Decode.

Source §

impl<Context> DecodeUntrusted<Context> for StateTransition

Source §

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

Decode with explicit untrusted field dispatch and resource handling.

Source §

impl<'de> Deserialize<'de> for StateTransition

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 Encode for StateTransition

Source §

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

Encode a given type.

Source §