feat: Add note execution_hint to store

CHANGELOG.md

@@ -16,6 +16,7 @@
 - Support multiple inflight transactions on the same account (#407).
 - Added `SyncNotes` endpoint (#424).
 - Cache sql statements (#427).
+- Added `execution_hint` field to `Notes` table.
 
 ### Fixes
 

bin/faucet/src/handlers.rs

@@ -73,7 +73,14 @@ pub async fn get_tokens(
         .expect("failed to build note tag for local execution");
 
     // Serialize note into bytes
-    let bytes = NoteFile::NoteDetails(note_details, Some(note_tag)).to_bytes();
+    // NOTE: Because this client does not sync, it always effectively executes against block 0.
+    // Ideally, we should export these note details with a more sensible `after_block_num`
+    let bytes = NoteFile::NoteDetails {
+        details: note_details,
+        after_block_num: 0,
+        tag: Some(note_tag),
+    }
+    .to_bytes();
 
     info!("A new note has been created: {}", note_id);
 

crates/block-producer/src/block_builder/prover/tests.rs

@@ -13,7 +13,7 @@ use miden_objects::{
         EmptySubtreeRoots, LeafIndex, MerklePath, Mmr, MmrPeaks, SimpleSmt, Smt, SmtLeaf, SmtProof,
         SMT_DEPTH,
     },
-    notes::{NoteHeader, NoteMetadata, NoteTag, NoteType},
+    notes::{NoteExecutionHint, NoteHeader, NoteMetadata, NoteTag, NoteType},
     transaction::{OutputNote, ProvenTransaction},
     Felt, BLOCK_NOTES_TREE_DEPTH, ONE, ZERO,
 };
@@ -515,6 +515,7 @@ async fn test_compute_note_root_success() {
                 account_id,
                 NoteType::Private,
                 NoteTag::for_local_use_case(0u16, 0u16).unwrap(),
+                NoteExecutionHint::none(),
                 ONE,
             )
             .unwrap(),

crates/block-producer/src/test_utils/proven_tx.rs

@@ -3,7 +3,7 @@ use std::ops::Range;
 use miden_air::HashFunction;
 use miden_objects::{
     accounts::AccountId,
-    notes::{Note, NoteHeader, NoteMetadata, NoteType, Nullifier},
+    notes::{Note, NoteExecutionHint, NoteHeader, NoteMetadata, NoteType, Nullifier},
     transaction::{InputNote, OutputNote, ProvenTransaction, ProvenTransactionBuilder},
     vm::ExecutionProof,
     Digest, Felt, Hasher, ONE,
@@ -77,8 +77,14 @@ impl MockProvenTxBuilder {
         let notes = range
             .map(|note_index| {
                 let note_id = Hasher::hash(&note_index.to_be_bytes());
-                let note_metadata =
-                    NoteMetadata::new(self.account_id, NoteType::Private, 0.into(), ONE).unwrap();
+                let note_metadata = NoteMetadata::new(
+                    self.account_id,
+                    NoteType::Private,
+                    0.into(),
+                    NoteExecutionHint::none(),
+                    ONE,
+                )
+                .unwrap();
 
                 OutputNote::Header(NoteHeader::new(note_id.into(), note_metadata))
             })

crates/proto/src/domain/notes.rs

@@ -1,5 +1,5 @@
 use miden_objects::{
-    notes::{NoteMetadata, NoteTag, NoteType},
+    notes::{NoteExecutionHint, NoteMetadata, NoteTag, NoteType},
     Felt,
 };
 
@@ -15,9 +15,12 @@ impl TryFrom<crate::generated::note::NoteMetadata> for NoteMetadata {
             .try_into()?;
         let note_type = NoteType::try_from(value.note_type as u64)?;
         let tag = NoteTag::from(value.tag);
+
+        let execution_hint = NoteExecutionHint::try_from(value.execution_hint)?;
+
         let aux = Felt::try_from(value.aux).map_err(|_| ConversionError::NotAValidFelt)?;
 
-        Ok(NoteMetadata::new(sender, note_type, tag, aux)?)
+        Ok(NoteMetadata::new(sender, note_type, tag, execution_hint, aux)?)
     }
 }
 
@@ -26,8 +29,15 @@ impl From<NoteMetadata> for crate::generated::note::NoteMetadata {
         let sender = Some(val.sender().into());
         let note_type = val.note_type() as u32;
         let tag = val.tag().into();
+        let execution_hint: u64 = val.execution_hint().into();
         let aux = val.aux().into();
 
-        crate::generated::note::NoteMetadata { sender, note_type, tag, aux }
+        crate::generated::note::NoteMetadata {
+            sender,
+            note_type,
+            tag,
+            execution_hint,
+            aux,
+        }
     }
 }

crates/proto/src/generated/note.rs

@@ -9,6 +9,8 @@ pub struct NoteMetadata {
     #[prost(fixed32, tag = "3")]
     pub tag: u32,
     #[prost(fixed64, tag = "4")]
+    pub execution_hint: u64,
+    #[prost(fixed64, tag = "5")]
     pub aux: u64,
 }
 #[allow(clippy::derive_partial_eq_without_eq)]

crates/rpc-proto/proto/note.proto

@@ -9,7 +9,8 @@ message NoteMetadata {
     account.AccountId sender = 1;
     uint32 note_type = 2;
     fixed32 tag = 3;
-    fixed64 aux = 4;
+    fixed64 execution_hint = 4;
+    fixed64 aux = 5;
 }
 
 message Note {

crates/store/src/db/migrations/001-init.sql

@@ -23,16 +23,17 @@ CREATE TABLE
 CREATE TABLE
     notes
 (
-    block_num   INTEGER NOT NULL,
-    batch_index INTEGER NOT NULL, -- Index of batch in block, starting from 0
-    note_index  INTEGER NOT NULL, -- Index of note in batch, starting from 0
-    note_id     BLOB    NOT NULL,
-    note_type   INTEGER NOT NULL, -- 1-Public (0b01), 2-Private (0b10), 3-Encrypted (0b11)
-    sender      INTEGER NOT NULL,
-    tag         INTEGER NOT NULL,
-    aux         INTEGER NOT NULL,
-    merkle_path BLOB    NOT NULL,
-    details     BLOB,
+    block_num      INTEGER NOT NULL,
+    batch_index    INTEGER NOT NULL, -- Index of batch in block, starting from 0
+    note_index     INTEGER NOT NULL, -- Index of note in batch, starting from 0
+    note_id        BLOB    NOT NULL,
+    note_type      INTEGER NOT NULL, -- 1-Public (0b01), 2-Private (0b10), 3-Encrypted (0b11)
+    sender         INTEGER NOT NULL,
+    tag            INTEGER NOT NULL,
+    aux            INTEGER NOT NULL,
+    execution_hint INTEGER NOT NULL,
+    merkle_path    BLOB    NOT NULL,
+    details        BLOB,
 
     PRIMARY KEY (block_num, batch_index, note_index),
     FOREIGN KEY (block_num) REFERENCES block_headers(block_num),