Struct TransactionKernel 

pub struct TransactionKernel;

Implementations

impl TransactionKernel

pub const PROCEDURES: &'static [Word]

Array of kernel procedures.

pub fn kernel() -> KernelLibrary

Returns a library with the transaction kernel system procedures.

Panics

Panics if the transaction kernel source is not well-formed.

pub fn main() -> Program

Returns an AST of the transaction kernel executable program.

Panics

Panics if the transaction kernel source is not well-formed.

pub fn tx_script_main() -> Program

Returns an AST of the transaction script executor program.

Panics

Panics if the transaction kernel source is not well-formed.

pub fn program_info() -> ProgramInfo

Returns ProgramInfo for the transaction kernel executable program.

Panics

Panics if the transaction kernel source is not well-formed.

pub fn prepare_inputs( tx_inputs: &TransactionInputs, ) -> Result<(StackInputs, TransactionAdviceInputs), TransactionAdviceMapMismatch>

Transforms the provided TransactionInputs into stack and advice inputs needed to execute a transaction kernel for a specific transaction.

pub fn assembler() -> Assembler

Returns a new Miden assembler instantiated with the transaction kernel and loaded with the Miden stdlib as well as with miden-lib.

pub fn assembler_with_source_manager( source_manager: Arc<dyn SourceManagerSync>, ) -> Assembler

Returns a new assembler instantiated with the transaction kernel and loaded with the Miden stdlib as well as with miden-lib.

pub fn build_input_stack( account_id: AccountId, initial_account_commitment: Word, input_notes_commitment: Word, block_commitment: Word, block_num: BlockNumber, ) -> StackInputs

Returns the stack with the public inputs required by the transaction kernel.

The initial stack is defined:

[
    BLOCK_COMMITMENT,
    INITIAL_ACCOUNT_COMMITMENT,
    INPUT_NOTES_COMMITMENT,
    account_id_prefix, account_id_suffix, block_num
]

Where:

• BLOCK_COMMITMENT is the commitment to the reference block of the transaction.
• block_num is the reference block number.
• account_id_{prefix,suffix} are the prefix and suffix felts of the account that the transaction is being executed against.
• INITIAL_ACCOUNT_COMMITMENT is the account state prior to the transaction, EMPTY_WORD for new accounts.
• INPUT_NOTES_COMMITMENT, see transaction::api::get_input_notes_commitment.

pub fn build_output_stack( final_account_commitment: Word, account_delta_commitment: Word, output_notes_commitment: Word, fee: FungibleAsset, expiration_block_num: BlockNumber, ) -> StackOutputs

Builds the stack for expected transaction execution outputs. The transaction kernel’s output stack is formed like so:

[
    OUTPUT_NOTES_COMMITMENT,
    ACCOUNT_UPDATE_COMMITMENT,
    FEE_ASSET,
    expiration_block_num,
]

Where:

• OUTPUT_NOTES_COMMITMENT is a commitment to the output notes.
• ACCOUNT_UPDATE_COMMITMENT is the hash of the the final account commitment and account delta commitment.
• FEE_ASSET is the fungible asset used as the transaction fee.
• expiration_block_num is the block number at which the transaction will expire.

pub fn parse_output_stack( stack: &StackOutputs, ) -> Result<(Word, Word, FungibleAsset, BlockNumber), TransactionOutputError>

Extracts transaction output data from the provided stack outputs.

The data on the stack is expected to be arranged as follows:

[
    OUTPUT_NOTES_COMMITMENT,
    ACCOUNT_UPDATE_COMMITMENT,
    FEE_ASSET,
    expiration_block_num,
]

Where:

• OUTPUT_NOTES_COMMITMENT is the commitment of the output notes.
• ACCOUNT_UPDATE_COMMITMENT is the hash of the the final account commitment and account delta commitment.
• FEE_ASSET is the fungible asset used as the transaction fee.
• tx_expiration_block_num is the block height at which the transaction will become expired, defined by the sum of the execution block ref and the transaction’s block expiration delta (if set during transaction execution).

Errors

Returns an error if:

• Indices 13..16 on the stack are not zeroes.
• Overflow addresses are not empty.

pub fn from_transaction_parts( stack: &StackOutputs, advice_inputs: &AdviceInputs, output_notes: Vec<OutputNote>, ) -> Result<TransactionOutputs, TransactionOutputError>

Returns TransactionOutputs constructed from the provided output stack and advice map.

The output stack is expected to be arranged as follows:

[
    OUTPUT_NOTES_COMMITMENT,
    ACCOUNT_UPDATE_COMMITMENT,
    FEE_ASSET,
    expiration_block_num,
]

Where:

• OUTPUT_NOTES_COMMITMENT is the commitment of the output notes.
• ACCOUNT_UPDATE_COMMITMENT is the hash of the final account commitment and the account delta commitment of the account that the transaction is being executed against.
• FEE_ASSET is the fungible asset used as the transaction fee.
• tx_expiration_block_num is the block height at which the transaction will become expired, defined by the sum of the execution block ref and the transaction’s block expiration delta (if set during transaction execution).

The actual data describing the new account state and output notes is expected to be located in the provided advice map under keys OUTPUT_NOTES_COMMITMENT and ACCOUNT_UPDATE_COMMITMENT, where the final data for the account state is located under FINAL_ACCOUNT_COMMITMENT.

pub fn to_commitment(&self) -> Word

Computes the sequential hash of all kernel procedures.

Trait Implementations

impl SequentialCommit for TransactionKernel

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

Returns kernel procedures as vector of Felts.

type Commitment = Word

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

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

Computes the commitment to the object.