Struct TransactionKernel

pub struct TransactionKernel;

Implementations

impl TransactionKernel

pub const NUM_VERSIONS: usize = 1usize

Number of currently used kernel versions.

pub const PROCEDURES: [&'static [Digest]; 1]

Array of all available kernels.

pub fn procedures_as_elements(kernel_version: u8) -> Vec<Felt>

Returns procedures of the kernel specified by the kernel_version as vector of Felts.

pub fn commitment(kernel_version: u8) -> Digest

Computes the accumulative hash of all procedures of the kernel specified by the kernel_version.

pub fn kernel_commitment() -> Digest

Computes a hash from all kernel commitments.

impl TransactionKernel

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, tx_args: &TransactionArgs, init_advice_inputs: Option<AdviceInputs>, ) -> Result<(StackInputs, AdviceInputs), TransactionInputError>

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

If init_advice_inputs is provided, they will be included in the returned advice inputs.

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 build_input_stack( account_id: AccountId, init_account_commitment: Digest, input_notes_commitment: Digest, block_commitment: Digest, 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: Digest, output_notes_commitment: Digest, expiration_block_num: BlockNumber, ) -> StackOutputs

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

[
    expiration_block_num,
    OUTPUT_NOTES_COMMITMENT,
    FINAL_ACCOUNT_COMMITMENT,
]

Where:

• OUTPUT_NOTES_COMMITMENT is a commitment to the output notes.
• FINAL_ACCOUNT_COMMITMENT is a hash of the account’s final state.
• expiration_block_num is the block number at which the transaction will expire.

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

Extracts transaction output data from the provided stack outputs.

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

Stack: [OUTPUT_NOTES_COMMITMENT, FINAL_ACCOUNT_COMMITMENT, tx_expiration_block_num]

Where:

• OUTPUT_NOTES_COMMITMENT is the commitment of the output notes.
• FINAL_ACCOUNT_COMMITMENT is the final account commitment of the account that the transaction is being executed against.
• 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:

• Words 3 and 4 on the stack are not 0.
• Overflow addresses are not empty.

pub fn from_transaction_parts( stack: &StackOutputs, adv_map: &AdviceMap, 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 arrange as follows:

Stack: [OUTPUT_NOTES_COMMITMENT, FINAL_ACCOUNT_COMMITMENT, tx_expiration_block_num]

Where:

• OUTPUT_NOTES_COMMITMENT is the commitment of the output notes.
• FINAL_ACCOUNT_COMMITMENT is the final account commitment of the account that the transaction is being executed against.
• 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 FINAL_ACCOUNT_COMMITMENT.