feat: migrate transaction scripts to Library

CHANGELOG.md

@@ -70,6 +70,7 @@
 - [BREAKING] Renamed `create_user_fungible_faucet` to `create_singlesig_user_fungible_faucet` and added the `create_multisig_user_fungible_faucet(auth_component: AuthMultisig, ...)` and `create_guarded_user_fungible_faucet(auth_component: AuthGuardedMultisig, ...)`. `create_network_fungible_faucet` now allowlists the canonical `ExpirationTransactionScript` in its tx-script allowlist ([#3143](https://github.com/0xMiden/protocol/pull/3143)).
 - Added the `CodeInspection` standard account component, exposing the `has_procedure`, `get_code_commitment`, `get_num_procedures`, and `get_procedure_root` introspection procedures on an account's public interface ([#3162](https://github.com/0xMiden/protocol/pull/3162)).
 - Updated `AuthRequest` event to carry either signature of TX summary, but not both ([#3157](https://github.com/0xMiden/protocol/pull/3157)).
+- [BREAKING] Added `@transaction_script` attribute to mark the script entrypoint. Migrated transaction scripts assembly to `Library` ([#3173](https://github.com/0xMiden/protocol/pull/3173)).
 - Documented that the `ecdsa_k256_keccak` authentication scheme discloses the signer's public key and signature at proving time via precompile calldata ([#3178](https://github.com/0xMiden/protocol/pull/3178)).
 
 ### Fixes

bin/bench-transaction/src/context_setups.rs

@@ -59,7 +59,8 @@ fn tx_create_single_p2id_note_with_auth(auth_scheme: AuthScheme) -> Result<Trans
         use miden::protocol::output_note
         use miden::core::sys
 
-        begin
+        @transaction_script
+        pub proc main
             # create an output note with fungible asset
             push.{RECIPIENT}
             push.{note_type}

crates/miden-protocol/src/errors/mod.rs

@@ -877,6 +877,10 @@ pub enum TransactionScriptError {
     AssemblyError(Report),
     #[error("failed to convert package to transaction script:\n{}", PrintDiagnostic::new(.0))]
     PackageNotProgram(Report),
+    #[error("library does not contain a procedure with @transaction_script attribute")]
+    NoProcedureWithAttribute,
+    #[error("library contains multiple procedures with @transaction_script attribute")]
+    MultipleProceduresWithAttribute,
 }
 
 // TRANSACTION INPUT ERROR

crates/miden-protocol/src/transaction/tx_args.rs

@@ -11,6 +11,7 @@ use miden_mast_package::Package;
 
 use super::{Felt, Hasher, Word};
 use crate::account::auth::{PublicKeyCommitment, Signature};
+use crate::assembly::Library;
 use crate::errors::TransactionScriptError;
 use crate::note::{NoteId, NoteRecipient};
 use crate::utils::serde::{
@@ -318,6 +319,9 @@ impl Deserializable for TransactionScriptRoot {
 // TRANSACTION SCRIPT
 // ================================================================================================
 
+/// The attribute name used to mark the entrypoint procedure in a transaction script library.
+const TRANSACTION_SCRIPT_ATTRIBUTE: &str = "transaction_script";
+
 /// Transaction script.
 ///
 /// A transaction script is a program that is executed in a transaction after all input notes
@@ -336,6 +340,8 @@ impl TransactionScript {
     // --------------------------------------------------------------------------------------------
 
     /// Returns a new [TransactionScript] instantiated with the provided code.
+    // TODO: we can remove this `Program` based constructor once the compiler integrates the
+    // `@transaction_script` attribute (https://github.com/0xMiden/compiler/issues/1190).
     pub fn new(code: Program) -> Self {
         Self::from_parts(code.mast_forest().clone(), code.entrypoint())
     }
@@ -364,6 +370,37 @@ impl TransactionScript {
         Ok(TransactionScript::new(program))
     }
 
+    /// Returns a new [TransactionScript] instantiated from the provided library.
+    ///
+    /// The library must contain exactly one procedure with the `@transaction_script` attribute,
+    /// which will be used as the entrypoint.
+    ///
+    /// # Errors
+    /// Returns an error if:
+    /// - The library does not contain a procedure with the `@transaction_script` attribute.
+    /// - The library contains multiple procedures with the `@transaction_script` attribute.
+    pub fn from_library(library: &Library) -> Result<Self, TransactionScriptError> {
+        let mut entrypoint = None;
+
+        for export in library.exports() {
+            if let Some(proc_export) = export.as_procedure()
+                && proc_export.attributes.has(TRANSACTION_SCRIPT_ATTRIBUTE)
+            {
+                if entrypoint.is_some() {
+                    return Err(TransactionScriptError::MultipleProceduresWithAttribute);
+                }
+                entrypoint = Some(proc_export.node);
+            }
+        }
+
+        let entrypoint = entrypoint.ok_or(TransactionScriptError::NoProcedureWithAttribute)?;
+
+        Ok(Self {
+            mast: library.mast_forest().clone(),
+            entrypoint,
+        })
+    }
+
     // PUBLIC ACCESSORS
     // --------------------------------------------------------------------------------------------
 
@@ -461,4 +498,48 @@ mod tests {
         let stored = mast.advice_map().get(&key).expect("entry should be present");
         assert_eq!(stored.as_ref(), value.as_slice());
     }
+
+    #[test]
+    fn test_transaction_script_from_library() {
+        use assert_matches::assert_matches;
+
+        use super::TransactionScript;
+        use crate::assembly::Assembler;
+        use crate::errors::TransactionScriptError;
+        use crate::utils::serde::{Deserializable, Serializable};
+
+        let source = "
+            @transaction_script
+            pub proc main
+                push.1 drop
+            end
+        ";
+        let library = Assembler::default().assemble_library([source]).unwrap();
+
+        let script = TransactionScript::from_library(&library).unwrap();
+
+        // the script must round-trip through serialization unchanged
+        let bytes = script.to_bytes();
+        let decoded = TransactionScript::read_from_bytes(&bytes).unwrap();
+        assert_eq!(script, decoded);
+
+        // a library without the attribute is rejected
+        let no_attr = Assembler::default()
+            .assemble_library(["pub proc main push.1 drop end"])
+            .unwrap();
+        assert_matches!(
+            TransactionScript::from_library(&no_attr),
+            Err(TransactionScriptError::NoProcedureWithAttribute)
+        );
+
+        // a library with multiple tagged procedures is rejected
+        let multiple = Assembler::default()
+            .assemble_library(["@transaction_script pub proc main_a push.1 drop end
+                 @transaction_script pub proc main_b push.2 drop end"])
+            .unwrap();
+        assert_matches!(
+            TransactionScript::from_library(&multiple),
+            Err(TransactionScriptError::MultipleProceduresWithAttribute)
+        );
+    }
 }

crates/miden-standards/src/code_builder/mod.rs

@@ -63,7 +63,7 @@ use crate::standards_lib::StandardsLib;
 /// # use miden_protocol::CoreLibrary;
 /// # fn example() -> anyhow::Result<()> {
 /// # let module_code = "pub proc test push.1 add end";
-/// # let script_code = "begin nop end";
+/// # let script_code = "@transaction_script pub proc main nop end";
 /// # // Create sample libraries for the example
 /// # let my_lib: Library = CoreLibrary::default().into(); // Convert CoreLibrary to Library
 /// # let fpi_lib: Library = CoreLibrary::default().into();
@@ -293,20 +293,6 @@ impl CodeBuilder {
     // PRIVATE HELPERS
     // --------------------------------------------------------------------------------------------
 
-    /// Applies the advice map to a program if it's non-empty.
-    ///
-    /// This avoids cloning the MAST forest when there are no advice map entries.
-    fn apply_advice_map(
-        advice_map: AdviceMap,
-        program: miden_protocol::vm::Program,
-    ) -> miden_protocol::vm::Program {
-        if advice_map.is_empty() {
-            program
-        } else {
-            program.with_advice_map(advice_map)
-        }
-    }
-
     /// Applies the advice map to a library if it's non-empty.
     ///
     /// This avoids cloning the MAST forest when there are no advice map entries.
@@ -363,7 +349,8 @@ impl CodeBuilder {
     /// The parsed script will have access to all modules that have been added to this builder.
     ///
     /// # Arguments
-    /// * `tx_script` - The transaction script source code
+    /// - `tx_script` - the transaction script source code which is expected to have a single public
+    ///   procedure marked with the @transaction_script attribute.
     ///
     /// # Errors
     /// Returns an error if:
@@ -374,11 +361,23 @@ impl CodeBuilder {
     ) -> Result<TransactionScript, CodeBuilderError> {
         let CodeBuilder { assembler, advice_map, .. } = self;
 
-        let program = assembler.assemble_program(tx_script).map_err(|err| {
-            CodeBuilderError::build_error_with_report("failed to parse transaction script", err)
+        let tx_script_lib = assembler.assemble_library([tx_script]).map_err(|err| {
+            CodeBuilderError::build_error_with_report(
+                "failed to parse transaction script library",
+                err,
+            )
         })?;
 
-        Ok(TransactionScript::new(Self::apply_advice_map(advice_map, program)))
+        TransactionScript::from_library(&Self::apply_advice_map_to_library(
+            advice_map,
+            Arc::unwrap_or_clone(tx_script_lib),
+        ))
+        .map_err(|err| {
+            CodeBuilderError::build_error_with_source(
+                "failed to create transaction script from library",
+                err,
+            )
+        })
     }
 
     /// Compiles the provided MASM code into a [`NoteScript`].
@@ -525,7 +524,7 @@ mod tests {
     fn test_code_builder_basic_script_compiling() -> anyhow::Result<()> {
         let builder = CodeBuilder::default();
         builder
-            .compile_tx_script("begin nop end")
+            .compile_tx_script("@transaction_script pub proc main nop end")
             .context("failed to parse basic tx script")?;
         Ok(())
     }
@@ -535,7 +534,8 @@ mod tests {
         let script_code = "
             use external_contract::counter_contract
 
-            begin
+            @transaction_script
+            pub proc main
                 call.counter_contract::increment
             end
         ";
@@ -573,7 +573,8 @@ mod tests {
         let script_code = "
             use external_contract::counter_contract
 
-            begin
+            @transaction_script
+            pub proc main
                 call.counter_contract::increment
             end
         ";
@@ -624,7 +625,8 @@ mod tests {
         let script_code = "
             use external_contract::counter_contract
 
-            begin
+            @transaction_script
+            pub proc main
                 call.counter_contract::increment
             end
         ";
@@ -656,8 +658,7 @@ mod tests {
 
     #[test]
     fn test_multiple_chained_modules() -> anyhow::Result<()> {
-        let script_code =
-            "use test::lib1 use test::lib2 begin exec.lib1::test1 exec.lib2::test2 end";
+        let script_code = "use test::lib1 use test::lib2 @transaction_script pub proc main exec.lib1::test1 exec.lib2::test2 end";
 
         // Test chaining multiple modules
         let builder = CodeBuilder::default()
@@ -676,7 +677,8 @@ mod tests {
         let script_code = "
             use contracts::static_contract
 
-            begin
+            @transaction_script
+            pub proc main
                 call.static_contract::increment_1
             end
         ";
@@ -732,7 +734,7 @@ mod tests {
 
         let script = CodeBuilder::default()
             .with_advice_map_entry(key, value.clone())
-            .compile_tx_script("begin nop end")
+            .compile_tx_script("@transaction_script pub proc main nop end")
             .context("failed to compile tx script with advice map")?;
 
         let mast = script.mast();
@@ -753,7 +755,7 @@ mod tests {
 
         let script = CodeBuilder::default()
             .with_extended_advice_map(advice_map)
-            .compile_tx_script("begin nop end")
+            .compile_tx_script("@transaction_script pub proc main nop end")
             .context("failed to compile tx script")?;
 
         let mast = script.mast();

crates/miden-standards/src/tx_script/expiration_script.rs

@@ -22,7 +22,8 @@ use miden::protocol::tx
 #! - delta is 0 or not a u32 in the range 1..=0xFFFF (ERR_TX_INVALID_EXPIRATION_DELTA).
 #!
 #! Invocation: call
-begin
+@transaction_script
+pub proc main
     exec.tx::update_expiration_block_delta
     # => [pad(16)]
 end

crates/miden-standards/src/tx_script/send_notes_script.rs

@@ -37,7 +37,8 @@ use crate::errors::CodeBuilderError;
 /// [`FungibleFaucet`]:
 ///
 /// ```masm
-/// begin
+/// @transaction_script
+/// pub proc main
 ///     push.{expiration_delta} exec.::miden::protocol::tx::update_expiration_block_delta
 ///
 ///     push.{note information}
@@ -101,7 +102,8 @@ impl SendNotesTransactionScript {
             return Err(SendNotesTransactionScriptError::UnsupportedAccountInterface);
         };
 
-        let script = format!("begin\n{expiration_prelude}\n{body}\nend");
+        let script =
+            format!("@transaction_script\npub proc main\n{expiration_prelude}\n{body}\nend");
 
         let mut code_builder = CodeBuilder::new();
         for note in output_notes {

crates/miden-testing/src/kernel_tests/block/utils.rs

@@ -103,7 +103,8 @@ fn update_expiration_tx_script(expiration_delta: u16) -> TransactionScript {
         "
         use miden::protocol::tx
 
-        begin
+        @transaction_script
+        pub proc main
             push.{expiration_delta}
             exec.tx::update_expiration_block_delta
         end