Struct MultisigAuthArgs 

pub struct MultisigAuthArgs { /* private fields */ }

The inputs the multisig authentication components receive through the transaction’s auth args.

AUTH_ARGS: [BLOCK_WORD, SALT, CONVERSION_INFO]

where BLOCK_WORD is [bound_block_num, approval_expiration_block_num, 0, 0].

Implementations

impl MultisigAuthArgs

pub fn new(bound_block_num: BlockNumber, salt: Word) -> MultisigAuthArgs

Creates new multisig auth args binding the summary to the given block.

The signers approve a transaction summary that commits to bound_block_num, so the party executing the transaction must pass the same block number, no matter how far the chain has advanced since. The block must be at or before the transaction’s reference block and must be tracked by the transaction’s partial blockchain, since that is the only way the kernel can read its commitment.

The approval does not expire unless Self::with_approval_expiration_delta sets an expiration.

salt is bound by the transaction summary and is what makes otherwise identical transactions distinguishable, which is what the replay protection of the multisig components relies on. It should be chosen at random.

pub fn with_approval_expiration_delta( self, delta: NonZero<u32>, ) -> Result<MultisigAuthArgs, AccountError>

Returns new multisig auth args whose approval expires delta blocks after the bound block.

The transaction must be included by block bound_block_num + delta. The expiration is bound by the transaction summary, so the party executing the transaction can neither shorten nor extend it.

Errors

Returns an error if bound_block_num + delta exceeds BlockNumber::MAX.

pub fn with_conversion_info( self, conversion_info: FeeConversionInfo, ) -> MultisigAuthArgs

Returns new multisig auth args carrying the conversion info the fee payment needs.

Must be FeeConversionInfo::one_to_one built with the reference block’s fee faucet. Anything else, or no conversion info at all, aborts on chains that charge a non-zero verification base fee.

pub fn bound_block_num(&self) -> BlockNumber

Returns the number of the block the transaction summary binds.

pub fn approval_expiration_block_num(&self) -> Option<BlockNumber>

Returns the first reference block at which the approvers’ signatures are no longer valid, or None if the approval does not expire.

pub fn salt(&self) -> Word

Returns the salt bound by the transaction summary.

pub fn conversion_info(&self) -> Option<FeeConversionInfo>

Returns the fee conversion info, or None if none was committed - in which case the fee payment aborts on fee-charging chains.

Trait Implementations

impl Clone for MultisigAuthArgs

fn clone(&self) -> MultisigAuthArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MultisigAuthArgs

impl Debug for MultisigAuthArgs

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

Formats the value using the given formatter.

impl Eq for MultisigAuthArgs

impl PartialEq for MultisigAuthArgs

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

Equality operator ==.

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

Inequality operator !=.

impl SequentialCommit for MultisigAuthArgs

type Commitment = Word

A type of the commitment which must be derivable from Word.

fn to_elements(&self) -> Vec<Felt>

Returns a representation of the object as a sequence of fields elements.

fn to_commitment(&self) -> Self::Commitment

Computes the commitment to the object.

impl StructuralPartialEq for MultisigAuthArgs