Transaction script compilation support by greenhat · Pull Request #625 · 0xMiden/compiler

greenhat · 2025-07-31T15:37:45Z

Close #618
Close #621
Close #622

Corresponding templates repo PR - 0xMiden/rust-templates#18

This PR introduces transaction script compilation support.

Key Changes

Added the cargo miden new --tx-script option to generate a tx script project;
Added project-kind under [package.metadata.miden] in Cargo.toml to identify project kind (account, note script, tx script);
Renamed both note script and tx script entrypoint function to be run;
Added the arg: Word parameter to both note and tx scripts entrypoint functions;
Added missing tx kernel bindings and changed existing ones where MASM signature changed;
Finished the test_basic_wallet_p2id_local test against the local node instance with the scenario Faucet -> Alice -> Bob asset movement.
Added basic-wallet-tx-script to cargo miden example command;

See basic-walled-tx-script at

compiler/examples/basic-wallet-tx-script/src/lib.rs

Lines 29 to 64 in 5872ba2

    
           struct BasicWalletTxScript; 
        
           // Input layout constants 
        
           const TAG_INDEX: usize = 0; 
        
           const AUX_INDEX: usize = 1; 
        
           const NOTE_TYPE_INDEX: usize = 2; 
        
           const EXECUTION_HINT_INDEX: usize = 3; 
        
           const RECIPIENT_START: usize = 4; 
        
           const RECIPIENT_END: usize = 8; 
        
           const ASSET_START: usize = 8; 
        
           const ASSET_END: usize = 12; 
        
           impl Guest for BasicWalletTxScript { 
        
               fn run(arg: Word) { 
        
                   let num_felts = adv_push_mapvaln(arg.clone()); 
        
                   let num_felts_u64 = num_felts.as_u64(); 
        
                   assert_eq(Felt::from_u32((num_felts_u64 % 4) as u32), felt!(0)); 
        
                   let num_words = Felt::from_u64_unchecked(num_felts_u64 / 4); 
        
                   let commitment = arg; 
        
                   let input = adv_load_preimage(num_words, commitment); 
        
                   let tag = input[TAG_INDEX]; 
        
                   let aux = input[AUX_INDEX]; 
        
                   let note_type = input[NOTE_TYPE_INDEX]; 
        
                   let execution_hint = input[EXECUTION_HINT_INDEX]; 
        
                   let recipient: [Felt; 4] = input[RECIPIENT_START..RECIPIENT_END].try_into().unwrap(); 
        
                   let note_idx = miden::tx::create_note( 
        
                       tag.into(), 
        
                       aux, 
        
                       note_type.into(), 
        
                       execution_hint, 
        
                       recipient.into(), 
        
                   ); 
        
                   let asset: [Felt; 4] = input[ASSET_START..ASSET_END].try_into().unwrap(); 
        
                   basic_wallet::move_asset_to_note(asset.into(), note_idx); 
        
               } 
        
           }

And the offchain code that calls it at

compiler/tests/integration-node/src/node_tests/helpers.rs

Lines 342 to 390 in 5872ba2

    
           let tx_script_program = tx_script_package.unwrap_program(); 
        
           let tx_script = TransactionScript::from_parts( 
        
               tx_script_program.mast_forest().clone(), 
        
               tx_script_program.entrypoint(), 
        
           ); 
        
           // Prepare note recipient 
        
           let program_hash = tx_script_program.hash(); 
        
           let serial_num = RpoRandomCoin::new(program_hash.into()).draw_word(); 
        
           let inputs = NoteInputs::new(vec![ 
        
               recipient_account_id.prefix().as_felt(), 
        
               recipient_account_id.suffix(), 
        
           ]) 
        
           .unwrap(); 
        
           let note_recipient = NoteRecipient::new(serial_num, p2id_note.script().clone(), inputs); 
        
           // Prepare commitment data 
        
           let mut input: Vec<Felt> = vec![ 
        
               config.tag.into(), 
        
               config.aux, 
        
               config.note_type.into(), 
        
               config.execution_hint.into(), 
        
           ]; 
        
           let recipient_digest: [Felt; 4] = note_recipient.digest().into(); 
        
           input.extend(recipient_digest); 
        
           let asset_arr: [Felt; 4] = asset.into(); 
        
           input.extend(asset_arr); 
        
           let mut commitment: [Felt; 4] = miden_core::crypto::hash::Rpo256::hash_elements(&input).into(); 
        
           assert_eq!(input.len() % 4, 0, "input needs to be word-aligned"); 
        
           // Prepare advice map 
        
           let mut advice_map = std::collections::BTreeMap::new(); 
        
           advice_map.insert(commitment.into(), input.clone()); 
        
           let recipients = vec![note_recipient.clone()]; 
        
           // NOTE: passed on the stack reversed 
        
           commitment.reverse(); 
        
           let tx_request = TransactionRequestBuilder::new() 
        
               .custom_script(tx_script) 
        
               .script_arg(commitment) 
        
               .expected_output_recipients(recipients) 
        
               .extend_advice_map(advice_map) 
        
               .build() 
        
               .unwrap();

The updated basic-wallet Rust code is at

compiler/examples/basic-wallet/src/lib.rs

Lines 29 to 49 in 5872ba2

    
           #[component] 
        
           struct MyAccount; 
        
           impl basic_wallet::Guest for MyAccount { 
        
               fn receive_asset(asset: Asset) { 
        
                   miden::account::add_asset(asset); 
        
               } 
        
               /// Moves an asset from the account to a note. 
        
               /// 
        
               /// This function removes the specified asset from the account and adds it to 
        
               /// the note identified by the given index. 
        
               /// 
        
               /// # Arguments 
        
               /// * `asset` - The asset to move from the account to the note 
        
               /// * `note_idx` - The index of the note to receive the asset 
        
               fn move_asset_to_note(asset: Asset, note_idx: NoteIdx) { 
        
                   let asset = miden::account::remove_asset(asset); 
        
                   miden::tx::add_asset_to_note(asset, note_idx); 
        
               } 
        
           }

bitwalker

I know this is still in draft status, but figured I'd take a pass through early. No notes, aside from one about how we name the entrypoint for note and transaction scripts, but it isn't necessarily a blocker, just something that sticks out to me now.

examples/basic-wallet-tx-script/src/lib.rs

to accommodate both note script and tx scripts.

needed for the transaction script.

loaded elements

…ient test

`transaction-script` variants.

greenhat · 2025-08-11T14:24:28Z

@bitwalker It's ready for review.

greenhat force-pushed the greenhat/i622-tx-script-compilation branch 2 times, most recently from 523e9d0 to a368353 Compare August 1, 2025 14:13

greenhat changed the base branch from greenhat/i544-run-basic-wallet-testnet to greenhat/i626-advice-map-sdk August 1, 2025 14:13

This was linked to issues Aug 1, 2025

Remove send_asset in basic-wallet example in favor of the new move_asset_to_note procedure #621

Closed

Update Miden SDK tx:create_note to the new signature #618

Closed

greenhat mentioned this pull request Aug 4, 2025

Add the tx-script new project template 0xMiden/rust-templates#18

Merged

greenhat force-pushed the greenhat/i626-advice-map-sdk branch from b230f2d to 4815892 Compare August 6, 2025 03:51

greenhat force-pushed the greenhat/i622-tx-script-compilation branch from 3ee8160 to e6a7e82 Compare August 6, 2025 05:41

greenhat mentioned this pull request Aug 7, 2025

Data segments overlap the BumpAlloc instance #631

Closed

greenhat force-pushed the greenhat/i622-tx-script-compilation branch from e6a7e82 to 851770a Compare August 7, 2025 13:51

greenhat changed the base branch from greenhat/i626-advice-map-sdk to greenhat/data-segments-word-align August 7, 2025 13:52

greenhat force-pushed the greenhat/i622-tx-script-compilation branch 3 times, most recently from d350d3a to 56b69d6 Compare August 8, 2025 09:03

bitwalker reviewed Aug 9, 2025

View reviewed changes

examples/basic-wallet-tx-script/src/lib.rs Outdated Show resolved Hide resolved

greenhat force-pushed the greenhat/i622-tx-script-compilation branch from aa73a28 to e6807e5 Compare August 11, 2025 11:19

greenhat mentioned this pull request Aug 11, 2025

add_asset_to_note procedure results overhead when calling from Rust 0xMiden/protocol#1717

Closed

Base automatically changed from greenhat/data-segments-word-align to next August 11, 2025 13:09

greenhat added 12 commits August 11, 2025 16:53

feature: rename note script rollup target into script

ea58ab3

to accommodate both note script and tx scripts.

test: add basic-wallet-tx-script example

4bb605b

fix: add arg: Word parameter to script

47af0ff

feature: add missing and fix existing tx kernel function bindings

b9116b0

needed for the transaction script.

test: use advice map API in the basic wallet tx script

7707f69

fix: switch to v0.12.0 tag for new project templates

4af868c

test: add checks to test_adv_load_preimage test for accessing the

bec716e

loaded elements

fix: tx:add_asset_to_note Miden SDK bindings

4a471df

fix: account::remove_asset Miden SDK bindings

4f8031a

fix: WIT interface for core Wasm module imports for Miden SDK

603135c

test: remove multi-asset support from the basic-wallet tx script

67d38bf

test: add Alice -> Bob steps in the test_basic_wallet_p2id_local cl…

ffd1687

…ient test

greenhat added 10 commits August 11, 2025 16:53

test: update expected files

9c945c1

test: extract the checking for an asset presence into helpers module

ee7e7c3

test: check that Alice's account reflects changes after sending to Bob

110f6c1

test: extract note creation into the helper function

f25290b

feature: add project-kind with account, note-script and

172d8e1

`transaction-script` variants.

feature: add --tx-script option to the cargo miden new command

fd51012

feature: add basic-wallet-tx-script to the cargo miden example command

b7fad4f

refactor: rename note-script and tx-script entrypoints to run

c08e5aa

refactor: use constants for indices in the basic-wallet-tx-script

d0dbe02

chore: add doc comments

fb81ad5

greenhat force-pushed the greenhat/i622-tx-script-compilation branch from 5872ba2 to fb81ad5 Compare August 11, 2025 14:02

greenhat added 2 commits August 11, 2025 17:02

chore: update expected tests after rebase

fb20f57

chore: add doc comment to receive_asset in the basic-wallet

4d93209

greenhat marked this pull request as ready for review August 11, 2025 14:24

bitwalker approved these changes Aug 15, 2025

View reviewed changes

bitwalker merged commit c614530 into next Aug 15, 2025
12 checks passed

bitwalker deleted the greenhat/i622-tx-script-compilation branch August 15, 2025 03:59

greenhat mentioned this pull request Aug 15, 2025

Run basic-wallet and p2id note-script examples on the local node #544

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Transaction script compilation support#625

Transaction script compilation support#625
bitwalker merged 24 commits intonextfrom
greenhat/i622-tx-script-compilation

greenhat commented Jul 31, 2025 •

edited

Loading

Uh oh!

bitwalker left a comment

Uh oh!

Uh oh!

greenhat commented Aug 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	struct BasicWalletTxScript;

	// Input layout constants
	const TAG_INDEX: usize = 0;
	const AUX_INDEX: usize = 1;
	const NOTE_TYPE_INDEX: usize = 2;
	const EXECUTION_HINT_INDEX: usize = 3;
	const RECIPIENT_START: usize = 4;
	const RECIPIENT_END: usize = 8;
	const ASSET_START: usize = 8;
	const ASSET_END: usize = 12;

	impl Guest for BasicWalletTxScript {
	fn run(arg: Word) {
	let num_felts = adv_push_mapvaln(arg.clone());
	let num_felts_u64 = num_felts.as_u64();
	assert_eq(Felt::from_u32((num_felts_u64 % 4) as u32), felt!(0));
	let num_words = Felt::from_u64_unchecked(num_felts_u64 / 4);
	let commitment = arg;
	let input = adv_load_preimage(num_words, commitment);
	let tag = input[TAG_INDEX];
	let aux = input[AUX_INDEX];
	let note_type = input[NOTE_TYPE_INDEX];
	let execution_hint = input[EXECUTION_HINT_INDEX];
	let recipient: [Felt; 4] = input[RECIPIENT_START..RECIPIENT_END].try_into().unwrap();
	let note_idx = miden::tx::create_note(
	tag.into(),
	aux,
	note_type.into(),
	execution_hint,
	recipient.into(),
	);
	let asset: [Felt; 4] = input[ASSET_START..ASSET_END].try_into().unwrap();
	basic_wallet::move_asset_to_note(asset.into(), note_idx);
	}
	}

	let tx_script_program = tx_script_package.unwrap_program();
	let tx_script = TransactionScript::from_parts(
	tx_script_program.mast_forest().clone(),
	tx_script_program.entrypoint(),
	);

	// Prepare note recipient
	let program_hash = tx_script_program.hash();
	let serial_num = RpoRandomCoin::new(program_hash.into()).draw_word();
	let inputs = NoteInputs::new(vec![
	recipient_account_id.prefix().as_felt(),
	recipient_account_id.suffix(),
	])
	.unwrap();
	let note_recipient = NoteRecipient::new(serial_num, p2id_note.script().clone(), inputs);

	// Prepare commitment data
	let mut input: Vec<Felt> = vec![
	config.tag.into(),
	config.aux,
	config.note_type.into(),
	config.execution_hint.into(),
	];
	let recipient_digest: [Felt; 4] = note_recipient.digest().into();
	input.extend(recipient_digest);

	let asset_arr: [Felt; 4] = asset.into();
	input.extend(asset_arr);

	let mut commitment: [Felt; 4] = miden_core::crypto::hash::Rpo256::hash_elements(&input).into();

	assert_eq!(input.len() % 4, 0, "input needs to be word-aligned");

	// Prepare advice map
	let mut advice_map = std::collections::BTreeMap::new();
	advice_map.insert(commitment.into(), input.clone());

	let recipients = vec![note_recipient.clone()];

	// NOTE: passed on the stack reversed
	commitment.reverse();

	let tx_request = TransactionRequestBuilder::new()
	.custom_script(tx_script)
	.script_arg(commitment)
	.expected_output_recipients(recipients)
	.extend_advice_map(advice_map)
	.build()
	.unwrap();

	#[component]
	struct MyAccount;

	impl basic_wallet::Guest for MyAccount {
	fn receive_asset(asset: Asset) {
	miden::account::add_asset(asset);
	}

	/// Moves an asset from the account to a note.
	///
	/// This function removes the specified asset from the account and adds it to
	/// the note identified by the given index.
	///
	/// # Arguments
	/// * `asset` - The asset to move from the account to the note
	/// * `note_idx` - The index of the note to receive the asset
	fn move_asset_to_note(asset: Asset, note_idx: NoteIdx) {
	let asset = miden::account::remove_asset(asset);
	miden::tx::add_asset_to_note(asset, note_idx);
	}
	}

Conversation

greenhat commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Key Changes

Uh oh!

bitwalker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

greenhat commented Aug 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

greenhat commented Jul 31, 2025 •

edited

Loading