Set to 1 all faucet account storage offsets

CHANGELOG.md

@@ -8,8 +8,9 @@
 - [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)
+- Refactored `AccountStorage` from `Smt` to `sequential hash` (#846).
 - [BREAKING] Refactored batch/block note trees (#834).
+- Set all procedures storage offsets of faucet accounts to `1` (#875).
 
 ## 0.5.1 (2024-08-28) - `miden-objects` crate only
 

bench-tx/src/utils.rs

@@ -76,7 +76,7 @@ pub fn get_account_with_default_account_code(
     let account_code_src = DEFAULT_ACCOUNT_CODE;
     let assembler = TransactionKernel::assembler();
 
-    let account_code = AccountCode::compile(account_code_src, assembler).unwrap();
+    let account_code = AccountCode::compile(account_code_src, assembler, false).unwrap();
     let account_storage = AccountStorage::new(vec![StorageSlot::Value(public_key)]).unwrap();
 
     let account_vault = match assets {

miden-lib/asm/kernels/transaction/lib/account.masm

@@ -37,6 +37,9 @@ const.ERR_PROC_INDEX_OUT_OF_BOUNDS=0x0002004B
 # Provided storage slot index is out of bounds
 const.ERR_STORAGE_SLOT_INDEX_OUT_OF_BOUNDS=0x0002004E
 
+# Storage offset is invalid for a faucet account (0 is prohibited being the faucet reserved data slot)
+const.ERR_INVALID_FAUCET_STORAGE_OFFSET=0x0002004F
+
 # CONSTANTS
 # =================================================================================================
 
@@ -341,6 +344,81 @@ export.apply_storage_offset
     # => [offset_slot_index]
 end
 
+#! Validates all account procedures storage offsets
+#!
+#! Notes:
+#! - For faucets checks that no storage offset is 0 (preventing reserved storage slot access)
+#!
+#! Stack: []
+#! Output: []
+export.validate_storage_offsets
+    # get number of account procedures
+    exec.memory::get_num_procedures
+    # => [num_account_procedures]
+
+    # prepare stack for looping
+    push.0.1
+    # => [start_loop, index, num_account_procedures]
+
+    # check if the account is a faucet
+    exec.get_id exec.is_faucet
+    # => [is_faucet, start_loop, index, num_account_procedures]
+
+    # we do not check if num_account_procedures == 0 here because a valid
+    # account has between 1 and 256 procedures with associated offsets
+    if.true
+        while.true
+            # get storage offset from memory
+            dup exec.get_procedure_storage_offset
+            # => [storage_offset, index, num_account_procedures]
+
+            # assert that storage offset is not 0
+            dup push.0 neq assert.err=ERR_INVALID_FAUCET_STORAGE_OFFSET
+            # => [storage_offset, index, num_account_procedures]
+
+            # TODO: This is a temporary check for faucets. We add 1 to all faucet offsets
+            # to prevent access to the reserved faucet data slot. When the assembler
+            # will support storage offsets remove this check.
+            # check if the storage offset and the number of storage slots are 1
+            dup exec.memory::get_num_storage_slots eq.1 swap eq.1 and
+            # => [not_both_1, storage_offset, index, num_account_procedures]
+
+            if.false
+                # assert that storage offset is in bounds
+                exec.memory::get_num_storage_slots lt assert.err=ERR_STORAGE_SLOT_INDEX_OUT_OF_BOUNDS
+                # => [index, num_account_procedures]
+            else
+                # TODO: Remove this drop with the check above
+                # skip bound check and drop storage_offset
+                drop
+                # => [index, num_account_procedures]
+            end
+
+            # check if we should continue looping
+            add.1 dup dup.2 lt
+            # => [should_loop, index, num_account_procedures]
+        end
+    else
+        while.true
+            # get storage offset from memory
+            dup exec.get_procedure_storage_offset
+            # => [storage_offset, index, num_account_procedures]
+
+            # assert that storage offset is in bounds
+            exec.memory::get_num_storage_slots lt assert.err=ERR_STORAGE_SLOT_INDEX_OUT_OF_BOUNDS
+            # => [index, num_account_procedures]
+
+            # check if we should continue looping
+            add.1 dup dup.2 lt
+            # => [should_loop, index, num_account_procedures]
+        end
+    end
+
+    # clean stack
+    drop drop
+    # => []
+end
+
 #! Gets an item from the account storage
 #!
 #! Note:
@@ -533,17 +611,40 @@ end
 #! - index is out of bounds
 export.get_procedure_info
     # check that index < number of procedures contained in the account code
-    dup exec.memory::get_num_account_procedures lt assert.err=ERR_PROC_INDEX_OUT_OF_BOUNDS
+    dup exec.memory::get_num_procedures lt assert.err=ERR_PROC_INDEX_OUT_OF_BOUNDS
     # => [index]
 
-    # get procedure section ptr
-    push.2 mul exec.memory::get_acct_procedures_section_offset add dup push.1 add
-    # => [proc_ptr, offset_ptr]
+    # get procedure pointer
+    mul.2 exec.memory::get_acct_procedures_section_offset add dup add.1
+    # => [offset_ptr, proc_ptr]
 
     # load procedure information from memory
     mem_load swap padw movup.4 mem_loadw
     # => [PROC_ROOT, storage_offset]
- end
+end
+
+#! Returns the procedure storage offset
+#!
+#! Stack: [index, ...]
+#! Output: [storage_offset, ...]
+#!
+#! - storage_offset is the procedure storage offset.
+#!
+#! Panics if
+#! - index is out of bounds
+export.get_procedure_storage_offset
+    # check that index < number of procedures contained in the account code
+    dup exec.memory::get_num_procedures lt assert.err=ERR_PROC_INDEX_OUT_OF_BOUNDS
+    # => [index]
+
+    # get procedure storage offset pointer
+    mul.2 exec.memory::get_acct_procedures_section_offset add add.1
+    # => [storage_offset_ptr]
+
+    # load procedure storage offset from memory
+    mem_load
+    # => [storage_offset]
+end
 
 #! Verifies that the procedure root is part of the account code
 #!

miden-lib/asm/kernels/transaction/lib/memory.masm

@@ -730,7 +730,7 @@ end
 #!
 #! Where:
 #! - num_procedures is the number of procedures contained in the account code.
-export.get_num_account_procedures
+export.get_num_procedures
     push.NUM_ACCT_PROCEDURES_PTR mem_load
 end