feat: dynamic kernel procedure invocation (#803)

0xPolygonMiden · Sep 13, 2024 · bb73449 · bb73449
1 parent f4fce94
commit bb73449
Show file tree

Hide file tree

Showing 23 changed files with 1,481 additions and 168 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
 - Implemented offset based storage access (#843).
 - [BREAKING] `AccountStorageType` enum was renamed to `AccountStorageMode` along with its variants (#854).
 - [BREAKING] `AccountStub` structure was renamed to `AccountHeader` (#855).
+- [BREAKING] Kernel procedures now have to be invoked using `dynexec` instruction (#803).
 - Refactored `AccountStorage` from `Smt` to `sequential hash` (#846)
 
 ## 0.5.1 (2024-08-28) - `miden-objects` crate only

diff --git a/bench-tx/bench-tx.json b/bench-tx/bench-tx.json
@@ -1,21 +1,21 @@
 {
   "simple": {
-    "prologue": 3833,
-    "notes_processing": 2178,
+    "prologue": 4065,
+    "notes_processing": 2526,
     "note_execution": {
-      "0x8cb51db3dbec8fab6c0ce3ac3e332aaa28fc99de07ae5a52dd93047a1fe459c2": 1401,
-      "0xed95b651bebd558f84ece32c4e7b8ac7b0fff9d845d3bff86037b64e9f9c7245": 735
+      "0x5c5e81a3c7b9950283a3e63e3526cdf189728a8f63d5459c6e43567ff22cc683": 851,
+      "0x8c3f1ace49f9b66d75c27e4b38a0082ddb8b8c5d1475e02399188c54eed5df32": 1633
     },
     "tx_script_processing": 44,
     "epilogue": 2287
   },
   "p2id": {
-    "prologue": 2141,
-    "notes_processing": 1012,
+    "prologue": 2373,
+    "notes_processing": 1357,
     "note_execution": {
-      "0xc1299ce481078310e6b4cf09f005bd898468019bb4cf7a03f5ded4b9e518790f": 977
+      "0x0105f1a0142b9ebc6bfba0b09de88807eac595b46b70f0fea403ce01aee1fe54": 1322
     },
-    "tx_script_processing": 88460,
+    "tx_script_processing": 88989,
     "epilogue": 291
   }
 }
diff --git a/docs/architecture/transactions/contexts.md b/docs/architecture/transactions/contexts.md
@@ -64,13 +64,14 @@ export.receive_asset
 end
 ```
 
-The [account API](https://github.com/0xPolygonMiden/miden-base/blob/main/miden-lib/asm/miden/account.masm#L162) exposes procedures to manage accounts. This particular procedure that was called by the wallet invokes a `syscall` to return back to the root context **(3)**, where the account vault is stored in memory (see prologue). `syscall` can invoke all procedures defined in the [Kernel API](https://github.com/0xPolygonMiden/miden-base/blob/main/miden-lib/asm/kernels/transaction/api.masm).
+The [account API](https://github.com/0xPolygonMiden/miden-base/blob/main/miden-lib/asm/miden/account.masm#L162) exposes procedures to manage accounts. This particular procedure that was called by the wallet invokes a `syscall` to return back to the root context **(3)**, where the account vault is stored in memory (see prologue). Procedures defined in the [Kernel API](https://github.com/0xPolygonMiden/miden-base/blob/main/miden-lib/asm/kernels/transaction/api.masm) should be invoked with `syscall` using the corresponding [procedure offset](https://github.com/0xPolygonMiden/miden-base/blob/main/miden-lib/asm/miden/kernel_proc_offsets.masm) and the `exec_kernel_proc` kernel procedure.
 
 ```arduino
 #! Add the specified asset to the vault.
 #! ...
 export.add_asset
-    syscall.account_vault_add_asset
+    exec.kernel_proc_offsets::account_vault_add_asset_offset
+    syscall.exec_kernel_proc
 end
 ```