Enum TransactionType 

#[non_exhaustive]
pub enum TransactionType {
    P2ID {
        recipient: AccountId,
        faucet_id: AccountId,
        amount: u64,
    },
    ConsumeNotes {
        note_ids: Vec<NoteId>,
        metadata_version: Option<u32>,
        notes: Vec<SerializedNote>,
    },
    AddCosigner {
        new_commitment: Word,
    },
    RemoveCosigner {
        commitment: Word,
    },
    SwitchGuardian {
        new_endpoint: String,
        new_commitment: Word,
    },
    UpdateProcedureThreshold {
        procedure: ProcedureName,
        new_threshold: u32,
    },
    UpdateSigners {
        new_threshold: u32,
        signer_commitments: Vec<Word>,
    },
    Custom,
}

Types of transactions supported by the multisig SDK.

Marked #[non_exhaustive] so future proposal types (including evolutions of the custom-type support, issue #266) can be added without breaking external crates: downstream match statements must already include a wildcard arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

P2ID

Fields

recipient: AccountId

faucet_id: AccountId

amount: u64

ConsumeNotes

Fields

note_ids: Vec<NoteId>

metadata_version: Option<u32>

None/Some(1) => v1, Some(2) => v2 (issue #229).

notes: Vec<SerializedNote>

v2 embedded notes, index-aligned with note_ids. Empty on v1.

AddCosigner

Fields

new_commitment: Word

RemoveCosigner

Fields

commitment: Word

SwitchGuardian

Fields

new_endpoint: String

new_commitment: Word

UpdateProcedureThreshold

Fields

procedure: ProcedureName

new_threshold: u32

UpdateSigners

Fields

new_threshold: u32

signer_commitments: Vec<Word>

Custom

A custom proposal whose proposal_type the SDK does not model (issue #266). Can be parsed, listed, signed, and exported/imported; the original label is preserved in ProposalMetadata.proposal_type. The generic SDK cannot build or execute the on-chain transaction for a custom procedure; the integration that owns the recipe drives execution via prepare_custom_execution.

Implementations

impl TransactionType

pub fn transfer(recipient: AccountId, faucet_id: AccountId, amount: u64) -> Self

Creates a P2ID transfer transaction.

pub fn consume_notes(note_ids: Vec<NoteId>) -> Self

Legacy (v1) — no embedded notes. Use consume_notes_v2 for new proposals.

pub fn consume_notes_v2( note_ids: Vec<NoteId>, notes: Vec<SerializedNote>, ) -> Self

v2 — embeds the notes inline so verification doesn’t read the local store (issue #229).

pub fn add_cosigner(new_commitment: Word) -> Self

Creates an AddCosigner transaction.

pub fn remove_cosigner(commitment: Word) -> Self

Creates a RemoveCosigner transaction.

pub fn switch_guardian( new_endpoint: impl Into<String>, new_commitment: Word, ) -> Self

Creates a SwitchGuardian transaction.

pub fn update_procedure_threshold( procedure: ProcedureName, new_threshold: u32, ) -> Self

Creates an UpdateProcedureThreshold transaction.

pub fn update_signers(new_threshold: u32, signer_commitments: Vec<Word>) -> Self

Creates an UpdateSigners transaction.

pub fn type_name(&self) -> &'static str

Returns a stable transaction type name for diagnostics and flow checks.

pub fn supports_offline_execution(&self) -> bool

Returns true when execution can proceed without a GUARDIAN acknowledgment.

pub fn requires_guardian_ack(&self) -> bool

Returns true when execution requires a GUARDIAN acknowledgment signature.

Trait Implementations

impl Clone for TransactionType

fn clone(&self) -> TransactionType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionType

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

Formats the value using the given formatter.

impl Eq for TransactionType

impl PartialEq for TransactionType

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