feat: rename note inputs to note storage by varun-doshi · Pull Request #2008 · 0xMiden/protocol

varun-doshi · 2025-10-20T20:10:24Z

Copilot

Pull Request Overview

This PR renames the NoteInputs type to NoteStorage throughout the codebase to better reflect that these values represent storage associated with a note rather than inputs. The renaming includes updating all references in code, comments, documentation, error messages, and assembly files.

Key Changes

Renamed NoteInputs struct to NoteStorage across all Rust code
Updated related constants from MAX_INPUTS_PER_NOTE to MAX_STORAGE_VALUE_PER_NOTE
Renamed error variants to reflect the new terminology
Updated all assembly code comments and error messages to use "note storage" terminology

Reviewed Changes

Copilot reviewed 37 out of 37 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
crates/miden-tx/src/host/note_builder.rs	Updated type imports and error variants from NoteInputs to NoteStorage
crates/miden-tx/src/errors/mod.rs	Renamed error variants and messages to use "note storage" terminology
crates/miden-objects/src/note/storage.rs	New file containing the renamed NoteStorage struct (previously inputs.rs)
crates/miden-objects/src/note/inputs.rs	Deleted file, replaced by storage.rs
crates/miden-objects/src/note/mod.rs	Updated module imports and documentation
crates/miden-objects/src/note/recipient.rs	Updated type references and comments
crates/miden-objects/src/note/details.rs	Updated type references and documentation
crates/miden-objects/src/note/partial.rs	Updated documentation comments
crates/miden-objects/src/errors.rs	Renamed error variant from TooManyInputs to TooManyStorageValues
crates/miden-objects/src/constants.rs	Renamed constant from MAX_INPUTS_PER_NOTE to MAX_STORAGE_VALUE_PER_NOTE
crates/miden-objects/src/transaction/tx_args.rs	Updated comment to use "note storage" terminology
crates/miden-testing/*	Updated test files to use NoteStorage type
crates/miden-lib/src/testing/note.rs	Renamed method from note_inputs to note_storage_values
crates/miden-lib/src/note/utils.rs	Updated variable names from note_inputs to note_storage
crates/miden-lib/src/errors/*.rs	Updated error messages and constants
crates/miden-lib/asm/*	Updated assembly code comments and constants
CHANGELOG.md	Added entry documenting the breaking change

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-22T07:41:16Z

crates/miden-lib/src/errors/tx_kernel_errors.rs

+/// Error Message: "note storage length exceeded the maximum limit of 128"
+pub const ERR_PROLOGUE_NOTE_STORAGE_LEN_EXCEEDED_LIMIT: MasmError = MasmError::from_static_str("note storage length exceeded the maximum limit of 128");


Two constants ERR_PROLOGUE_NOTE_STORAGE_LENGTH_EXCEEDED_LIMIT and ERR_PROLOGUE_NOTE_STORAGE_LEN_EXCEEDED_LIMIT have identical error messages and appear to be duplicates. Consider removing one to avoid confusion and maintain cleaner code.

Suggested change

/// Error Message: "note storage length exceeded the maximum limit of 128"

pub const ERR_PROLOGUE_NOTE_STORAGE_LEN_EXCEEDED_LIMIT: MasmError = MasmError::from_static_str("note storage length exceeded the maximum limit of 128");

Copilot

Pull Request Overview

Copilot reviewed 37 out of 37 changed files in this pull request and generated 5 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

crates/miden-objects/src/note/storage.rs

crates/miden-lib/asm/miden/note.masm

PhilippGackstatter

Thank you for working on this!

This is a good start, but in general, we should update all variable and field names of structs and functions to be "storage" instead of "inputs".
Try searching for these strings in the codebase and update if necessary:

note's inputs
note inputs
INPUTS_COMMITMENT
inputs: (to find places where we previously had inputs: NoteInputs)

PhilippGackstatter · 2025-10-27T02:39:33Z

crates/miden-lib/asm/note_scripts/P2ID.masm

 # =================================================================================================

-const.ERR_P2ID_WRONG_NUMBER_OF_INPUTS="P2ID note expects exactly 2 note inputs"
+const.ERR_P2ID_WRONG_NUMBER_OF_STORAGE_VALUES="P2ID note expects exactly 2 note storage values"


Suggested change

const.ERR_P2ID_WRONG_NUMBER_OF_STORAGE_VALUES="P2ID note expects exactly 2 note storage values"

const.ERR_P2ID_UNEXPECTED_STORAGE_LENGTH="P2ID note expects storage of length 2"

Nit: For the standards notes, P2ID, P2IDE, SWAP, I would rephrase this error to ERR_{NOTE_NAME}_UNEXPECTED_STORAGE_LENGTH="{NOTE_NAME} note expects storage of length X", e.g. for P2ID, the above suggestion.

PhilippGackstatter · 2025-10-27T02:40:39Z

crates/miden-lib/asm/note_scripts/P2IDE.masm

 #! Outputs: []
 #!
-#! Note inputs are assumed to be as follows:
+#! Note storage values are assumed to be as follows:


Suggested change

#! Note storage values are assumed to be as follows:

#! Note storage must be laid out as follows:

This also applies to the other notes.

PhilippGackstatter · 2025-10-27T02:41:00Z

crates/miden-lib/asm/note_scripts/P2IDE.masm

    push.0 exec.active_note::get_inputs
    # => [num_inputs, inputs_ptr]

    # make sure the number of inputs is 4


Suggested change

# make sure the number of inputs is 4

# check the length of note storage

PhilippGackstatter · 2025-10-27T02:42:13Z

crates/miden-lib/asm/note_scripts/SWAP.masm

 # =================================================================================================

-const.SWAP_NOTE_INPUTS_NUMBER=12
+const.SWAP_NOTE_STORAGE_NUMBER=12


Suggested change

const.SWAP_NOTE_STORAGE_NUMBER=12

const.SWAP_NOTE_STORAGE_LENGTH=12

PhilippGackstatter · 2025-10-27T02:43:22Z

crates/miden-lib/src/testing/note.rs

    /// Set the note's input to `inputs`.
    ///
    /// Note: This overwrite the inputs, the previous input values are discarded.
-    pub fn note_inputs(
+    pub fn note_storage_values(


The docs need a "note inputs" -> "note storage" update.

Also, I would just call this note_storage because "values" is quite generic, so it doesn't make things much clearer.

PhilippGackstatter · 2025-10-27T02:51:19Z

crates/miden-objects/src/note/mod.rs

 /// account of a P2ID or conditions of a SWAP, and the effects of the note. The serial number has
 /// a double duty of preventing double spend, and providing unlikability to the consumer of a note.
-/// The note's inputs allow for customization of its script.
+/// The note's storage values allow for customization of its script.


In this file, there are ~5 occurences of "inputs" left which still need to be replaced with "note storage" or "storage".

In general, try searching for "inputs" in the directory ./crates/miden-objects/src/note and you'll find more occurences that need to be updated.

PhilippGackstatter · 2025-10-27T02:51:42Z

crates/miden-objects/src/note/mod.rs

    /// Returns the note's recipient inputs which customizes the script's behavior.
-    pub fn inputs(&self) -> &NoteInputs {
+    pub fn inputs(&self) -> &NoteStorage {


Suggested change

/// Returns the note's recipient inputs which customizes the script's behavior.

pub fn inputs(&self) -> &NoteInputs {

pub fn inputs(&self) -> &NoteStorage {

/// Returns the note recipient's [`NoteStorage`].

pub fn storage(&self) -> &NoteStorage {

PhilippGackstatter · 2025-10-27T02:53:10Z

crates/miden-objects/src/note/recipient.rs

    serial_num: Word,
    script: NoteScript,
-    inputs: NoteInputs,
+    inputs: NoteStorage,


Suggested change

inputs: NoteStorage,

storage: NoteStorage,

PhilippGackstatter · 2025-10-27T02:53:30Z

crates/miden-objects/src/note/recipient.rs


 impl NoteRecipient {
-    pub fn new(serial_num: Word, script: NoteScript, inputs: NoteInputs) -> Self {
+    pub fn new(serial_num: Word, script: NoteScript, inputs: NoteStorage) -> Self {


Suggested change

pub fn new(serial_num: Word, script: NoteScript, inputs: NoteStorage) -> Self {

pub fn new(serial_num: Word, script: NoteScript, storage: NoteStorage) -> Self {

All of the variable names should also be updated (applies to the entire PR),

PhilippGackstatter · 2025-10-27T02:54:16Z

crates/miden-objects/src/note/storage.rs

+    }
+
+    /// Returns a reference to the storage values.
+    pub fn values(&self) -> &[Felt] {


Suggested change

pub fn values(&self) -> &[Felt] {

pub fn items(&self) -> &[Felt] {

As mentioned in another comment, I'd call the individual elements "items".

PhilippGackstatter · 2025-11-04T08:13:45Z

@varun-doshi Could you merge latest next and address the open review comments?

varun-doshi · 2025-11-04T18:07:11Z

@varun-doshi Could you merge latest next and address the open review comments?

On it

varun-doshi · 2025-11-04T20:22:35Z

Some note input note's input are left out because I'm not sure if we want those to be changed

PhilippGackstatter

Thanks for the updates!

There are still many occurrences of inputs left that need to be renamed. Searching for num_inputs should show you a lot of places that need an update, not only replacing num_inputs itself, but also any other inputs that refer to note inputs surrounding it.

PhilippGackstatter · 2025-11-05T06:51:29Z

crates/miden-lib/asm/miden/active_note.masm

+#!   Advice Map: { NOTE_STORAGE_COMMITMENT: [INPUTS] }
 #! Outputs:
 #!   Stack: [num_inputs, dest_ptr]
 #!
 #! Where:
-#! - dest_ptr is the memory address to write the note inputs.
-#! - NOTE_INPUTS_COMMITMENT is the sequential hash of the padded note's inputs.
-#! - INPUTS is the data corresponding to the note's inputs.
+#! - dest_ptr is the memory address to write the note storage.
+#! - NOTE_STORAGE_COMMITMENT is the sequential hash of the padded note's storage items.
+#! - INPUTS is the data corresponding to the note's storage items.


Here we need to rename INPUTS to STORAGE_ITEMS, e.g.:

#! Advice Map: { NOTE_STORAGE_COMMITMENT: [STORAGE_ITEMS] }

And also in the Where section.

PhilippGackstatter · 2025-11-05T06:55:11Z

crates/miden-lib/asm/miden/active_note.masm

    swapdw dropw dropw
    movup.5 drop movup.5 drop movup.5 drop
-    # => [NOTE_INPUTS_COMMITMENT, num_inputs, dest_ptr]
+    # => [NOTE_STORAGE_COMMITMENT, num_inputs, dest_ptr]


Below this line we should also rename inputs to storage, e.g. the comments and exec.write_storage_to_memory. That write_inputs_to_memory procedure also needs a rename of many "inputs" occurrences.

crates/miden-lib/asm/miden/active_note.masm

PhilippGackstatter · 2025-11-05T07:01:02Z

crates/miden-lib/asm/miden/active_note.masm

-#!   Advice Map: { NOTE_INPUTS_COMMITMENT: [INPUTS] }
+#!   Advice Map: { NOTE_STORAGE_COMMITMENT: [INPUTS] }
 #! Outputs:
 #!   Stack: [num_inputs, dest_ptr]


Suggested change

#! Stack: [num_inputs, dest_ptr]

#! Stack: [storage_len, dest_ptr]

Search for num_inputs and replace with storage_len or something appropriate. There will be a lot of occurences, and it requires renaming some procedures as well, e.g. input_note_get_inputs_info -> input_note_get_storage_info or exec.input_note::get_inputs_info -> exec.input_note::get_storage_info.

PhilippGackstatter · 2025-11-05T07:04:02Z

crates/miden-lib/asm/note_scripts/MINT.masm

 # =================================================================================================

-const.MINT_NOTE_INPUTS_NUMBER=9
+const.MINT_NOTE_STORAGE_NUMBER=9


Suggested change

const.MINT_NOTE_STORAGE_NUMBER=9

const.MINT_NOTE_STORAGE_LENGTH=9

Generally, I'd replace "num inputs" with "storage length" instead of "storage number".

PhilippGackstatter · 2025-11-05T07:04:32Z

crates/miden-lib/asm/miden/note.masm

@@ -33,11 +33,11 @@ const.ERR_PROLOGUE_NOTE_INPUTS_LEN_EXCEEDED_LIMIT="number of note inputs exceede
 #! Invocation: exec
 export.compute_inputs_commitment


Suggested change

export.compute_inputs_commitment

export.compute_storage_commitment

crates/miden-lib/asm/miden/note.masm

varun-doshi · 2025-11-05T20:51:08Z

Few remaining num_inputs are in the context of advice map. If i'm not mistaken, that should not be changed right?

PhilippGackstatter

Thanks! I think we're getting closer 🙂

The advice_num_inputs and rounded_up_num_inputs also represent number of inputs and so we should also rename these to storage length.

Also, search for INPUTS_COMMITMENT, there are still a few that need to be renamed.

PhilippGackstatter · 2025-11-06T02:47:06Z

crates/miden-lib/asm/miden/input_note.masm

 #! - note_index is the index of the input note whose data should be returned.
-#! - NOTE_INPUTS_COMMITMENT is the inputs commitment of the specified input note.
-#! - num_inputs is the number of input values of the specified input note.
+#! - NOTE_STORAGE_COMMITMENT is the inputs commitment of the specified input note.


Suggested change

#! - NOTE_STORAGE_COMMITMENT is the inputs commitment of the specified input note.

#! - NOTE_STORAGE_COMMITMENT is the storage commitment of the specified input note.

PhilippGackstatter · 2025-11-06T02:48:07Z

crates/miden-lib/asm/miden/note.masm

 #!   Operand stack: [RECIPIENT]
 #!   Advice map: {
-#!      INPUTS_COMMITMENT: [INPUTS],
+#!      INPUTS_COMMITMENT: [STORAGE],


Suggested change

#! INPUTS_COMMITMENT: [STORAGE],

#! STORAGE_COMMITMENT: [STORAGE],

PhilippGackstatter · 2025-11-06T02:51:12Z

crates/miden-lib/asm/miden/input_note.masm

 #!
 #! Invocation: exec
-export.get_inputs_info
+export.get_storage_info


Following this rename, we should also rename input_note_get_inputs_info_offset -> input_note_get_storage_info_offset and the constants as well in crates/miden-lib/asm/miden/kernel_proc_offsets.masm.

PhilippGackstatter · 2025-11-06T02:53:41Z

crates/miden-lib/asm/kernels/transaction/lib/prologue.masm

@@ -652,18 +652,18 @@ end
 #! Where:
 #! - note_ptr is the memory location for the input note.
 #! - inputs_len is the note's input count.


Suggested change

#! - inputs_len is the note's input count.

#! - storage_len is the length of the note's storage.

And update this also a couple of lines above.

PhilippGackstatter · 2025-11-06T02:55:10Z

crates/miden-objects/src/note/storage.rs

+    ///
+    /// # Errors
+    /// Returns an error if the number of provided storage is greater than 128.
+    pub fn new(values: Vec<Felt>) -> Result<Self, NoteError> {


In this file, I'd also rename value to item so it matches the items field.

PhilippGackstatter · 2025-11-06T02:55:22Z

crates/miden-objects/src/note/storage.rs

+    /// Returns the number of storage items.
+    ///
+    /// The returned value is guaranteed to be smaller than or equal to 128.
+    pub fn num_values(&self) -> u8 {


Suggested change

pub fn num_values(&self) -> u8 {

pub fn num_items(&self) -> u8 {

PhilippGackstatter · 2025-11-06T02:55:47Z

crates/miden-objects/src/note/storage.rs

+// ================================================================================================
+
+impl From<NoteStorage> for Vec<Felt> {
+    fn from(value: NoteStorage) -> Self {


Suggested change

fn from(value: NoteStorage) -> Self {

fn from(storage: NoteStorage) -> Self {

Nit

PhilippGackstatter · 2025-11-06T02:57:25Z

crates/miden-objects/src/errors.rs

+    #[error("note contains {0} storage items which exceeds the maximum of {max}", max = MAX_STORAGE_VALUE_PER_NOTE)]
+    TooManyStorageValues(usize),


Suggested change

#[error("note contains {0} storage items which exceeds the maximum of {max}", max = MAX_STORAGE_VALUE_PER_NOTE)]

TooManyStorageValues(usize),

#[error("note contains {0} storage items which exceeds the maximum of {max}", max = MAX_NOTE_STORAGE_LENGTH)]

TooManyStorageItems(usize),

PhilippGackstatter · 2025-11-06T02:58:46Z

crates/miden-testing/src/kernel_tests/tx/test_active_note.rs

+/// the `get_storage` procedure, see the [issue #1363](https://github.com/0xMiden/miden-base/issues/1363)
 /// for more details.
 #[tokio::test]
 async fn test_active_note_get_exactly_8_inputs() -> anyhow::Result<()> {


Suggested change

async fn test_active_note_get_exactly_8_inputs() -> anyhow::Result<()> {

async fn test_active_note_get_exactly_8_storage_items() -> anyhow::Result<()> {

PhilippGackstatter · 2025-11-06T02:59:57Z

crates/miden-testing/src/kernel_tests/tx/test_input_note.rs

-/// obtained from the `input_note::get_inputs_info` procedure is correct.
+/// obtained from the `input_note::get_storage_info` procedure is correct.
 #[tokio::test]
 async fn test_get_inputs_info() -> anyhow::Result<()> {


Suggested change

async fn test_get_inputs_info() -> anyhow::Result<()> {

async fn test_get_storage_info() -> anyhow::Result<()> {

varun-doshi · 2025-11-12T07:20:56Z

The following are cleared (among others):

num_inputs
inputs_commitment
inputs_ptr
input_ptr
note input
note_inputs
note's inputs
num_values
advice_num_inputs

PhilippGackstatter

Thank you! Looks great now. I merged in next, in particular to resolve the conflicts introduced by merging #2071.

I left a few more comments, but after these I'd personally just merge this PR and do smaller cleanups in follow-ups, since this PR has gotten pretty large.

Since starting this PR, we've merged some PRs that moved around a few things and so now we have quite a few occurrences of num_inputs again in the codebase, but I would address those in a follow-up.

Small follow-ups I would consider for separate PRs:

active_note::get_storage is a bit clearer when renamed to active_note::get_storage_items
Updated the changed kernel procedure in docs/src/protocol_library.md.
Maybe rename "storage length" into "storage size" or "number of storage items" alternatively. Depends on what others think as well.
- Example: MINT_NOTE_STORAGE_SIZE reads pretty good while MINT_NOTE_NUM_STORAGE_ITEMS is a bit verbose, but still fine. It would be a bit more consistent with "num storage slots" as an analog to account storage. I'd slightly prefer "size" still.

It would be nice if you could avoid force-pushing once reviews have started, since it sometimes means there are more files to re-review on every iteration than necessary. Thank you 🙏!

PhilippGackstatter · 2025-11-23T03:06:40Z

crates/miden-lib/asm/kernels/transaction/api.masm

 #! Where:
 #! - note_index is the index of the output note whose recipient should be returned.
-#! - RECIPIENT is the commitment to the output note's script, inputs, the serial number.
+#! - RECIPIENT is the commitment to the input note's script, storage, the serial number.


The change from output to input needs to be reversed I think.

PhilippGackstatter · 2025-11-23T03:07:53Z

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

@@ -1594,14 +1594,14 @@ end
 #! Returns the inputs commitment of an input note located at the specified memory address.


This needs to be something like "Returns the note storage commitment..."

PhilippGackstatter · 2025-11-23T03:16:35Z

crates/miden-lib/asm/kernels/transaction/lib/prologue.masm

+#!      STORAGE_COMMITMENT,
 #!      ASSETS_COMMITMENT,
 #!      ARGS,
 #!      NOTE_METADATA,


The advice stack comment here looks outdated. We should have

... NOTE_METADATA, storage_len, assets_count, ...

according to:

https://github.com/0xMiden/miden-base/blob/8592b0367c6ddb57a65b0773e348c3ea35c7bf0a/crates/miden-lib/src/transaction/inputs.rs#L356-358

PhilippGackstatter · 2025-11-23T03:35:22Z

crates/miden-lib/asm/miden/active_note.masm

-    # OS => [NOTE_INPUTS_COMMITMENT, num_inputs, dest_ptr]
-    # AS => [advice_num_inputs, [INPUT_VALUES]]
+    # OS => [NOTE_STORAGE_COMMITMENT, storage_len, dest_ptr]
+    # AS => [advice_storage_len, [INPUT_VALUES]]


Suggested change

# AS => [advice_storage_len, [INPUT_VALUES]]

# AS => [advice_storage_len, [STORAGE_ITEMS]]

PhilippGackstatter · 2025-11-23T03:35:28Z

crates/miden-lib/asm/miden/active_note.masm

-proc.write_inputs_to_memory
+#!   Operand stack: [storage_len, dest_ptr]
+proc.write_storage_to_memory
    # load the inputs from the advice map to the advice stack


Suggested change

# load the inputs from the advice map to the advice stack

# load the storage items from the advice map to the advice stack

PhilippGackstatter · 2025-11-23T03:46:13Z

crates/miden-lib/src/note/well_known_note.rs

+/// Returns the receiver account ID parsed from the provided P2ID check that note storage has
+/// correct length..


Suggested change

/// Returns the receiver account ID parsed from the provided P2ID check that note storage has

/// correct length..

/// Returns the receiver account ID parsed from the provided P2ID note storage.

I think this is sufficient.

PhilippGackstatter · 2025-11-23T03:47:58Z

crates/miden-lib/src/note/well_known_note.rs

-fn parse_p2ide_inputs(note_inputs: &[Felt]) -> Result<(AccountId, u32, u32), StaticAnalysisError> {
-    if note_inputs.len() != WellKnownNote::P2IDE.num_expected_inputs() {
+/// - the note storage length is not equal to the expected inputs number of the P2IDE note.
+/// - first two elements of the note storage array does not form the valid account ID.


Suggested change

/// - first two elements of the note storage array does not form the valid account ID.

/// - first two elements of the note storage are not a valid account ID.

Nit: I'd avoid "array" here. (Also applies to the other function above)

Also the function names still refer to "inputs" instead of "storage".

PhilippGackstatter · 2025-11-23T03:48:31Z

crates/miden-lib/src/note/well_known_note.rs

-/// Returns None if the note input values used to construct the account ID are invalid.
-fn try_read_account_id_from_inputs(note_inputs: &[Felt]) -> Result<AccountId, StaticAnalysisError> {
-    if note_inputs.len() < 2 {
+/// Returns None if the note storage items used to construct the account ID are invalid.


Suggested change

/// Returns None if the note storage items used to construct the account ID are invalid.

/// Returns an error if the note storage items used to construct the account ID are invalid.

Nit: This was outdated.

PhilippGackstatter · 2025-11-23T03:49:49Z

crates/miden-lib/src/transaction/memory.rs

-// `INPUTS_COMMITMENT -> INPUTS || PADDING`.
+// Notice that note storage items are not loaded to the memory, only their length. In order to obtain
+// the storage items the advice map should be used: they are stored there as
+// `STORAGE_COMMITMENT -> STORAGE || PADDING`.


Suggested change

// `STORAGE_COMMITMENT -> STORAGE || PADDING`.

// `STORAGE_COMMITMENT -> STORAGE_ITEMS || PADDING`.

Nit

PhilippGackstatter · 2025-11-23T04:07:40Z

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

    /// - SERIAL_HASH: [SERIAL_NUM, EMPTY_WORD]
-    /// - inputs_commitment |-> inputs.
+    /// - storage_commitment |-> inputs.


Two things:

Not from this PR, but we should fix the inconsistency of using lower case for keys, they should be uppercase.

inputs should be replaced

So overall:

/// - SCRIPT_ROOT |-> script_data. /// - STORAGE_COMMITMENT |-> storage_items.

varun-doshi · 2025-11-24T14:14:18Z

Small follow-ups I would consider for separate PRs:

Understood; I will make a follow PR after this to get these fixed.

It would be nice if you could avoid force-pushing once reviews have started, since it sometimes means there are more files to re-review on every iteration than necessary.

Ahh got it. I will keep this in mind

PhilippGackstatter

Looks good to me!

I think we got most inputs renamed to storage, and any leftovers can be done in follow-ups (see previous comment).

Will also tag @mmagician for a review.

PhilippGackstatter · 2025-12-04T05:58:48Z

@varun-doshi Could you merge latest next into this PR and update any "note inputs" to "note storage" while we're finishing the review of the PR? Thank you very much 🙏

varun-doshi · 2025-12-04T19:41:16Z

@varun-doshi Could you merge latest next into this PR and update any "note inputs" to "note storage" while we're finishing the review of the PR? Thank you very much 🙏

Done!

Fumuran

Looks good, thank you!

I agree with @PhilippGackstatter, it will be better to merge this PR and open the second part, which will address the comments I left here and changes which Philipp requested in his comment.

Fumuran · 2025-12-05T14:16:52Z

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

-#! - num_inputs is the number of inputs in in the input note.
-export.get_input_note_num_inputs
-    add.INPUT_NOTE_NUM_INPUTS_OFFSET
+#! - storage_len is the storage length in in the input note.


typo:

Suggested change

#! - storage_len is the storage length in in the input note.

#! - storage_len is the length of the input note's storage.

Fumuran · 2025-12-05T14:25:09Z

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

-#! - num_inputs is the number of inputs in the input note.
-export.set_input_note_num_inputs
-    add.INPUT_NOTE_NUM_INPUTS_OFFSET
+#! - storage_len is the storage length in the input note.


Just for the consistency, let's update this line as well:

Suggested change

#! - storage_len is the storage length in the input note.

#! - storage_len is the length of the input note's storage.

Fumuran · 2025-12-05T14:28:12Z

crates/miden-lib/asm/kernels/transaction/lib/prologue.masm

-    # => [inputs_len, note_ptr]
+    # => [storage_len, note_ptr]

    # validate the input length


overlooked:

Suggested change

# validate the input length

# validate the storage length

Fumuran · 2025-12-05T14:32:01Z

crates/miden-lib/asm/kernels/transaction/lib/prologue.masm

+    # => [storage_len, note_ptr]

    # validate the input length
    dup exec.::$kernel::util::note::get_max_inputs_per_note lte


shared_utils/util/note.masm file should be updated as well: we store there the MAX_INPUTS_PER_NOTE constant and its getter, which is used here.

Fumuran · 2025-12-05T14:44:37Z

crates/miden-lib/asm/kernels/transaction/api.masm

+#! - is_active_note is 1 and no input note is not being processed (attempted to access note storage
 #!   from incorrect context).


It seems like we overseen this previously: this line (and all similar ones) should explain the error reason according to the specific error used in the proc body. For example, in that case we use ERR_NOTE_ATTEMPT_TO_ACCESS_NOTE_ASSETS_WHILE_NO_NOTE_BEING_PROCESSED, so this line should use assets instead of storage.

Suggested change

#! - is_active_note is 1 and no input note is not being processed (attempted to access note storage

#! from incorrect context).

#! - is_active_note is 1 and no input note is not being processed (attempted to access note assets

#! from incorrect context).

Fumuran · 2025-12-05T15:34:20Z

crates/miden-testing/src/kernel_tests/tx/test_input_note.rs

+            exec.input_note::get_storage_info
+            # => [NOTE_STORAGE_COMMITMENT, storage_len]

            # assert the correctness of the inputs commitment


Suggested change

# assert the correctness of the inputs commitment

# assert the correctness of the storage commitment

Fumuran · 2025-12-05T15:34:33Z

crates/miden-testing/src/kernel_tests/tx/test_input_note.rs

+            assert_eqw.err="note 0 has incorrect storage commitment"
+            # => [storage_len]

            # assert the inputs have correct length


Suggested change

# assert the inputs have correct length

# assert the storage have correct length

Fumuran · 2025-12-05T15:38:42Z

crates/miden-testing/src/kernel_tests/tx/test_note.rs

 /// This test checks the scenario when some public key, which is provided to the RPO component of
 /// the target account, is also provided as an input to the input note.


Suggested change

/// This test checks the scenario when some public key, which is provided to the RPO component of

/// the target account, is also provided as a storage item to the input note.

Fumuran · 2025-12-05T15:39:39Z

crates/miden-testing/src/kernel_tests/tx/test_note.rs

    let mut rng = ChaCha20Rng::from_seed(Default::default());
    let sec_key = SecretKey::with_rng(&mut rng);
    // this value will be used both as public key in the RPO component of the target account and as
    // well as the input of the input note


Suggested change

// well as the storage value of the input note

Fumuran · 2025-12-05T15:40:02Z

crates/miden-testing/src/kernel_tests/tx/test_output_note.rs

@@ -650,12 +651,12 @@ async fn test_build_recipient_hash() -> anyhow::Result<()> {
            padw

            # input


Suggested change

# input

# storage

PhilippGackstatter · 2025-12-08T00:26:21Z

@varun-doshi Let's also merge next one more time and then we'll merge after addressing @Fumuran's comments 👍

PhilippGackstatter · 2025-12-15T01:28:13Z

Hi @varun-doshi, would you be able to update this PR to latest next? After that, we should be able to merge. Thank you very much!

bobbinth · 2026-01-16T18:28:32Z

Closing this as stale and potentially superseded by #2282.

varun-doshi added 3 commits October 21, 2025 01:38

feat: rename note inputs to note storage

f19aaf8

fix: add changelog

4f7b658

fix: spelling

6e91ffe

varun-doshi force-pushed the varun/rename-inputs branch from eee1355 to 6e91ffe Compare October 20, 2025 20:14

mmagician requested a review from Copilot October 22, 2025 07:40

Copilot AI reviewed Oct 22, 2025

View reviewed changes

mmagician requested a review from Copilot October 24, 2025 19:00

Copilot AI reviewed Oct 24, 2025

View reviewed changes

fix: apply review

f49d688

varun-doshi force-pushed the varun/rename-inputs branch from 9953bab to f49d688 Compare October 24, 2025 19:09

mmagician requested a review from Copilot October 26, 2025 08:06

This comment was marked as resolved.

Sign in to view

PhilippGackstatter reviewed Oct 27, 2025

View reviewed changes

fix: apply review 0xMiden#2

a88be87

varun-doshi force-pushed the varun/rename-inputs branch from 8dc2940 to a88be87 Compare November 4, 2025 19:26

Merge branch 'next' of miden-base into varun/rename-inputs

2be75cb

varun-doshi force-pushed the varun/rename-inputs branch 2 times, most recently from 52bf1de to 2be75cb Compare November 4, 2025 20:19

varun-doshi requested a review from PhilippGackstatter November 4, 2025 20:23

PhilippGackstatter reviewed Nov 5, 2025

View reviewed changes

PhilippGackstatter reviewed Nov 6, 2025

View reviewed changes

varun-doshi force-pushed the varun/rename-inputs branch from db76210 to da83d62 Compare November 6, 2025 10:59

fix: rename all occurences

39022fe

varun-doshi force-pushed the varun/rename-inputs branch from da83d62 to 39022fe Compare November 6, 2025 10:59

Merge branch 'next' of miden-base into varun/rename-inputs

e06af4a

varun-doshi force-pushed the varun/rename-inputs branch from ebf50b0 to e06af4a Compare November 12, 2025 07:21

varun-doshi requested a review from PhilippGackstatter November 12, 2025 07:26

PhilippGackstatter added 2 commits November 23, 2025 10:33

Merge remote-tracking branch 'origin/next' into varun/rename-inputs

37149cb

fix: note_inputs after merge in exec_host

03238ca

PhilippGackstatter reviewed Nov 23, 2025

View reviewed changes

fix: apply review changes

d1ce2f4

varun-doshi requested a review from PhilippGackstatter November 24, 2025 14:14

PhilippGackstatter approved these changes Nov 26, 2025

View reviewed changes

PhilippGackstatter requested a review from mmagician November 26, 2025 02:46

Merge branch 'next' of miden-base into varun/rename-inputs

6261543

Fumuran reviewed Dec 5, 2025

View reviewed changes

mmagician marked this pull request as draft January 5, 2026 16:17

PhilippGackstatter mentioned this pull request Jan 15, 2026

Compute attachment_size during output_note::set_attachment #2266

Open

Farukest mentioned this pull request Jan 15, 2026

feat: rename NoteInputs to NoteStorage #2282

Merged

bobbinth closed this Jan 16, 2026

		/// Error Message: "note storage length exceeded the maximum limit of 128"
		pub const ERR_PROLOGUE_NOTE_STORAGE_LEN_EXCEEDED_LIMIT: MasmError = MasmError::from_static_str("note storage length exceeded the maximum limit of 128");

	const.ERR_P2ID_WRONG_NUMBER_OF_STORAGE_VALUES="P2ID note expects exactly 2 note storage values"
	const.ERR_P2ID_UNEXPECTED_STORAGE_LENGTH="P2ID note expects storage of length 2"

	#! Note storage values are assumed to be as follows:
	#! Note storage must be laid out as follows:

	# make sure the number of inputs is 4
	# check the length of note storage

	const.SWAP_NOTE_STORAGE_NUMBER=12
	const.SWAP_NOTE_STORAGE_LENGTH=12

	pub fn new(serial_num: Word, script: NoteScript, inputs: NoteStorage) -> Self {
	pub fn new(serial_num: Word, script: NoteScript, storage: NoteStorage) -> Self {

	pub fn values(&self) -> &[Felt] {
	pub fn items(&self) -> &[Felt] {

	#! Stack: [num_inputs, dest_ptr]
	#! Stack: [storage_len, dest_ptr]

	const.MINT_NOTE_STORAGE_NUMBER=9
	const.MINT_NOTE_STORAGE_LENGTH=9

		@@ -33,11 +33,11 @@ const.ERR_PROLOGUE_NOTE_INPUTS_LEN_EXCEEDED_LIMIT="number of note inputs exceede
		#! Invocation: exec
		export.compute_inputs_commitment

	export.compute_inputs_commitment
	export.compute_storage_commitment

	#! - NOTE_STORAGE_COMMITMENT is the inputs commitment of the specified input note.
	#! - NOTE_STORAGE_COMMITMENT is the storage commitment of the specified input note.

	#! INPUTS_COMMITMENT: [STORAGE],
	#! STORAGE_COMMITMENT: [STORAGE],

	#! - inputs_len is the note's input count.
	#! - storage_len is the length of the note's storage.

	pub fn num_values(&self) -> u8 {
	pub fn num_items(&self) -> u8 {

	fn from(value: NoteStorage) -> Self {
	fn from(storage: NoteStorage) -> Self {

		#[error("note contains {0} storage items which exceeds the maximum of {max}", max = MAX_STORAGE_VALUE_PER_NOTE)]
		TooManyStorageValues(usize),

	async fn test_active_note_get_exactly_8_inputs() -> anyhow::Result<()> {
	async fn test_active_note_get_exactly_8_storage_items() -> anyhow::Result<()> {

	async fn test_get_inputs_info() -> anyhow::Result<()> {
	async fn test_get_storage_info() -> anyhow::Result<()> {

		@@ -1594,14 +1594,14 @@ end
		#! Returns the inputs commitment of an input note located at the specified memory address.

Conversation

varun-doshi commented Oct 20, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

Copilot AI Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

PhilippGackstatter left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PhilippGackstatter commented Nov 4, 2025

Uh oh!

varun-doshi commented Nov 4, 2025

Uh oh!

varun-doshi commented Nov 4, 2025

Uh oh!

PhilippGackstatter left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

varun-doshi commented Nov 5, 2025

Uh oh!

PhilippGackstatter left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

varun-doshi commented Nov 12, 2025 •

edited

Loading

PhilippGackstatter Nov 23, 2025 •

edited

Loading

	# AS => [advice_storage_len, [INPUT_VALUES]]
	# AS => [advice_storage_len, [STORAGE_ITEMS]]

	# load the inputs from the advice map to the advice stack
	# load the storage items from the advice map to the advice stack

		/// Returns the receiver account ID parsed from the provided P2ID check that note storage has
		/// correct length..

	/// - first two elements of the note storage array does not form the valid account ID.
	/// - first two elements of the note storage are not a valid account ID.

	/// Returns None if the note storage items used to construct the account ID are invalid.
	/// Returns an error if the note storage items used to construct the account ID are invalid.

	// `STORAGE_COMMITMENT -> STORAGE \|\| PADDING`.
	// `STORAGE_COMMITMENT -> STORAGE_ITEMS \|\| PADDING`.

	#! - storage_len is the storage length in in the input note.
	#! - storage_len is the length of the input note's storage.

		#! - is_active_note is 1 and no input note is not being processed (attempted to access note storage
		#! from incorrect context).

	# assert the correctness of the inputs commitment
	# assert the correctness of the storage commitment

	# assert the inputs have correct length
	# assert the storage have correct length