Skip to content

Commit

Permalink
feat: support of BatchNoteTree and BlockNoteTree, use `batch_inde…
Browse files Browse the repository at this point in the history
…x` instead of encoding it into the note index
  • Loading branch information
polydez committed Apr 5, 2024
1 parent 238485c commit 7135167
Show file tree
Hide file tree
Showing 14 changed files with 118 additions and 89 deletions.
2 changes: 1 addition & 1 deletion block-producer/src/block.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use crate::store::BlockInputsError;
pub struct Block {
pub header: BlockHeader,
pub updated_accounts: Vec<(AccountId, Digest)>,
pub created_notes: BTreeMap<u64, NoteEnvelope>,
pub created_notes: Vec<(usize, usize, NoteEnvelope)>,
pub produced_nullifiers: Vec<Nullifier>,
// TODO:
// - full states for updated public accounts
Expand Down
10 changes: 5 additions & 5 deletions block-producer/src/block_builder/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use std::sync::Arc;

use async_trait::async_trait;
use miden_node_utils::formatting::{format_array, format_blake3_digest};
use miden_objects::{accounts::AccountId, notes::Nullifier, Digest, MAX_NOTES_PER_BATCH};
use miden_objects::{accounts::AccountId, notes::Nullifier, Digest};
use tracing::{debug, info, instrument};

use crate::{
Expand Down Expand Up @@ -83,10 +83,10 @@ where
.iter()
.enumerate()
.flat_map(|(batch_idx, batch)| {
batch.created_notes().enumerate().map(move |(note_idx_in_batch, note)| {
let note_idx_in_block = batch_idx * MAX_NOTES_PER_BATCH + note_idx_in_batch;
(note_idx_in_block as u64, *note)
})
batch
.created_notes()
.enumerate()
.map(move |(note_idx_in_batch, note)| (batch_idx, note_idx_in_batch, *note))
})
.collect();
let produced_nullifiers: Vec<Nullifier> =
Expand Down
39 changes: 16 additions & 23 deletions block-producer/src/test_utils/block.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
use std::collections::BTreeMap;

use miden_objects::{
accounts::AccountId,
block::BlockNoteTree,
crypto::merkle::{Mmr, SimpleSmt},
notes::{NoteEnvelope, Nullifier},
BlockHeader, Digest, ACCOUNT_TREE_DEPTH, BLOCK_OUTPUT_NOTES_TREE_DEPTH, MAX_NOTES_PER_BATCH,
ONE, ZERO,
BlockHeader, Digest, ACCOUNT_TREE_DEPTH, ONE, ZERO,
};

use super::MockStoreSuccess;
Expand Down Expand Up @@ -92,7 +90,7 @@ pub struct MockBlockBuilder {
last_block_header: BlockHeader,

updated_accounts: Option<Vec<(AccountId, Digest)>>,
created_notes: Option<BTreeMap<u64, NoteEnvelope>>,
created_notes: Option<Vec<(usize, usize, NoteEnvelope)>>,
produced_nullifiers: Option<Vec<Nullifier>>,
}

Expand Down Expand Up @@ -124,7 +122,7 @@ impl MockBlockBuilder {

pub fn created_notes(
mut self,
created_notes: BTreeMap<u64, NoteEnvelope>,
created_notes: Vec<(usize, usize, NoteEnvelope)>,
) -> Self {
self.created_notes = Some(created_notes);

Expand All @@ -149,7 +147,7 @@ impl MockBlockBuilder {
self.store_chain_mmr.peaks(self.store_chain_mmr.forest()).unwrap().hash_peaks(),
self.store_accounts.root(),
Digest::default(),
note_created_smt_from_envelopes(created_notes.iter()).root(),
note_created_smt_from_envelopes(created_notes.iter().cloned()).root(),
Digest::default(),
Digest::default(),
ZERO,
Expand All @@ -165,28 +163,23 @@ impl MockBlockBuilder {
}
}

pub(crate) fn note_created_smt_from_envelopes<'a>(
note_iterator: impl Iterator<Item = (&'a u64, &'a NoteEnvelope)>
) -> SimpleSmt<BLOCK_OUTPUT_NOTES_TREE_DEPTH> {
SimpleSmt::<BLOCK_OUTPUT_NOTES_TREE_DEPTH>::with_leaves(note_iterator.flat_map(
|(note_idx_in_block, note)| {
let index = note_idx_in_block * 2;
[(index, note.note_id().into()), (index + 1, note.metadata().into())]
},
))
pub(crate) fn note_created_smt_from_envelopes(
note_iterator: impl Iterator<Item = (usize, usize, NoteEnvelope)>
) -> BlockNoteTree {
BlockNoteTree::with_entries(note_iterator.map(|(batch_idx, note_idx_in_batch, note)| {
(batch_idx, note_idx_in_batch, (note.note_id().into(), *note.metadata()))
}))
.unwrap()
}

pub(crate) fn note_created_smt_from_batches<'a>(
batches: impl Iterator<Item = &'a TransactionBatch>
) -> SimpleSmt<BLOCK_OUTPUT_NOTES_TREE_DEPTH> {
let note_leaf_iterator = batches.enumerate().flat_map(|(batch_index, batch)| {
let subtree_index = batch_index * MAX_NOTES_PER_BATCH * 2;
batch.created_notes().enumerate().flat_map(move |(note_index, note)| {
let index = (subtree_index + note_index * 2) as u64;
[(index, note.note_id().into()), (index + 1, note.metadata().into())]
) -> BlockNoteTree {
let note_leaf_iterator = batches.enumerate().flat_map(|(batch_idx, batch)| {
batch.created_notes().enumerate().map(move |(note_idx_in_batch, note)| {
(batch_idx, note_idx_in_batch, (note.note_id().into(), *note.metadata()))
})
});

SimpleSmt::<BLOCK_OUTPUT_NOTES_TREE_DEPTH>::with_leaves(note_leaf_iterator).unwrap()
BlockNoteTree::with_entries(note_leaf_iterator).unwrap()
}
2 changes: 1 addition & 1 deletion block-producer/src/test_utils/proven_tx.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use miden_objects::{
notes::{NoteEnvelope, NoteMetadata, NoteType, Nullifier},
transaction::{ProvenTransaction, ProvenTransactionBuilder},
vm::ExecutionProof,
Digest, Felt, Hasher, ONE, ZERO,
Digest, Felt, Hasher, ONE,
};
use winterfell::StarkProof;

Expand Down
11 changes: 6 additions & 5 deletions block-producer/src/test_utils/store.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@ use std::collections::BTreeSet;

use async_trait::async_trait;
use miden_objects::{
block::BlockNoteTree,
crypto::merkle::{Mmr, SimpleSmt, Smt, ValuePath},
notes::{NoteEnvelope, Nullifier},
BlockHeader, ACCOUNT_TREE_DEPTH, BLOCK_OUTPUT_NOTES_TREE_DEPTH, EMPTY_WORD, ONE, ZERO,
BlockHeader, ACCOUNT_TREE_DEPTH, EMPTY_WORD, ONE, ZERO,
};

use super::*;
Expand All @@ -22,7 +23,7 @@ use crate::{
#[derive(Debug)]
pub struct MockStoreSuccessBuilder {
accounts: Option<SimpleSmt<ACCOUNT_TREE_DEPTH>>,
notes: Option<SimpleSmt<BLOCK_OUTPUT_NOTES_TREE_DEPTH>>,
notes: Option<BlockNoteTree>,
produced_nullifiers: Option<BTreeSet<Digest>>,
chain_mmr: Option<Mmr>,
block_num: Option<u32>,
Expand Down Expand Up @@ -68,9 +69,9 @@ impl MockStoreSuccessBuilder {
}
}

pub fn initial_notes<'a>(
pub fn initial_notes(
mut self,
notes: impl Iterator<Item = (&'a u64, &'a NoteEnvelope)>,
notes: impl Iterator<Item = (usize, usize, NoteEnvelope)>,
) -> Self {
self.notes = Some(note_created_smt_from_envelopes(notes));

Expand Down Expand Up @@ -107,7 +108,7 @@ impl MockStoreSuccessBuilder {
pub fn build(self) -> MockStoreSuccess {
let block_num = self.block_num.unwrap_or(1);
let accounts_smt = self.accounts.unwrap_or(SimpleSmt::new().unwrap());
let notes_smt = self.notes.unwrap_or(SimpleSmt::new().unwrap());
let notes_smt = self.notes.unwrap_or_default();
let chain_mmr = self.chain_mmr.unwrap_or_default();
let nullifiers_smt = self
.produced_nullifiers
Expand Down
9 changes: 5 additions & 4 deletions proto/proto/note.proto
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ message NoteSyncRecord {
}

message NoteCreated {
uint32 note_index = 1;
digest.Digest note_id = 2;
account.AccountId sender = 3;
fixed64 tag = 4;
uint32 batch_index = 1;
uint32 note_index = 2;
digest.Digest note_id = 3;
account.AccountId sender = 4;
fixed64 tag = 5;
}
7 changes: 4 additions & 3 deletions proto/src/domain/notes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,14 @@ impl From<note::Note> for note::NoteSyncRecord {
// NoteCreated
// ================================================================================================

impl From<(u64, NoteEnvelope)> for note::NoteCreated {
fn from((note_idx, note): (u64, NoteEnvelope)) -> Self {
impl From<(usize, usize, NoteEnvelope)> for note::NoteCreated {
fn from((batch_idx, note_idx, note): (usize, usize, NoteEnvelope)) -> Self {
Self {
batch_index: batch_idx as u32,
note_index: note_idx as u32,
note_id: Some(note.note_id().into()),
sender: Some(note.metadata().sender().into()),
tag: note.metadata().tag().into(),
note_index: note_idx as u32,
}
}
}
8 changes: 5 additions & 3 deletions proto/src/generated/note.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,13 @@ pub struct NoteSyncRecord {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NoteCreated {
#[prost(uint32, tag = "1")]
pub batch_index: u32,
#[prost(uint32, tag = "2")]
pub note_index: u32,
#[prost(message, optional, tag = "2")]
pub note_id: ::core::option::Option<super::digest::Digest>,
#[prost(message, optional, tag = "3")]
pub note_id: ::core::option::Option<super::digest::Digest>,
#[prost(message, optional, tag = "4")]
pub sender: ::core::option::Option<super::account::AccountId>,
#[prost(fixed64, tag = "4")]
#[prost(fixed64, tag = "5")]
pub tag: u64,
}
2 changes: 2 additions & 0 deletions store/src/db/migrations.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ pub static MIGRATIONS: Lazy<Migrations> = Lazy::new(|| {
notes
(
block_num INTEGER NOT NULL,
batch_index INTEGER NOT NULL,
note_index INTEGER NOT NULL,
note_hash BLOB NOT NULL,
sender INTEGER NOT NULL,
Expand All @@ -27,6 +28,7 @@ pub static MIGRATIONS: Lazy<Migrations> = Lazy::new(|| {
PRIMARY KEY (block_num, note_index),
CONSTRAINT fk_block_num FOREIGN KEY (block_num) REFERENCES block_headers (block_num),
CONSTRAINT notes_block_number_is_u32 CHECK (block_num >= 0 AND block_num < 4294967296),
CONSTRAINT notes_batch_index_is_u32 CHECK (batch_index BETWEEN 0 AND 0xFFFFFFFF)
CONSTRAINT notes_note_index_is_u32 CHECK (note_index >= 0 AND note_index < 4294967296)
) STRICT, WITHOUT ROWID;
Expand Down
1 change: 1 addition & 0 deletions store/src/db/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ pub struct NullifierInfo {

#[derive(Debug, Clone, PartialEq)]
pub struct NoteCreated {
pub batch_index: u32,
pub note_index: u32,
pub note_id: RpoDigest,
pub sender: AccountId,
Expand Down
45 changes: 33 additions & 12 deletions store/src/db/sql.rs
Original file line number Diff line number Diff line change
Expand Up @@ -248,24 +248,40 @@ pub fn select_nullifiers_by_block_range(
///
/// A vector with notes, or an error.
pub fn select_notes(conn: &mut Connection) -> Result<Vec<Note>> {
let mut stmt = conn.prepare("SELECT * FROM notes ORDER BY block_num ASC;")?;
let mut stmt = conn.prepare(
"
SELECT
block_num,
batch_index,
note_index,
note_hash,
sender,
tag,
merkle_path
FROM
notes
ORDER BY
block_num ASC;
",
)?;
let mut rows = stmt.query([])?;

let mut notes = vec![];
while let Some(row) = rows.next()? {
let note_id_data = row.get_ref(2)?.as_blob()?;
let note_id_data = row.get_ref(3)?.as_blob()?;
let note_id = deserialize(note_id_data)?;

let merkle_path_data = row.get_ref(5)?.as_blob()?;
let merkle_path_data = row.get_ref(6)?.as_blob()?;
let merkle_path = deserialize(merkle_path_data)?;

notes.push(Note {
block_num: row.get(0)?,
note_created: NoteCreated {
note_index: row.get(1)?,
batch_index: row.get(1)?,
note_index: row.get(2)?,
note_id,
sender: column_value_as_u64(row, 3)?,
tag: column_value_as_u64(row, 4)?,
sender: column_value_as_u64(row, 4)?,
tag: column_value_as_u64(row, 5)?,
},
merkle_path,
})
Expand Down Expand Up @@ -293,6 +309,7 @@ pub fn insert_notes(
notes
(
block_num,
batch_index,
note_index,
note_hash,
sender,
Expand All @@ -301,14 +318,15 @@ pub fn insert_notes(
)
VALUES
(
?1, ?2, ?3, ?4, ?5, ?6
?1, ?2, ?3, ?4, ?5, ?6, ?7
);",
)?;

let mut count = 0;
for note in notes.iter() {
count += stmt.execute(params![
note.block_num,
note.note_created.batch_index,
note.note_created.note_index,
note.note_created.note_id.to_bytes(),
u64_to_value(note.note_created.sender),
Expand Down Expand Up @@ -345,6 +363,7 @@ pub fn select_notes_since_block_by_tag_and_sender(
"
SELECT
block_num,
batch_index,
note_index,
note_hash,
sender,
Expand Down Expand Up @@ -376,17 +395,19 @@ pub fn select_notes_since_block_by_tag_and_sender(
let mut res = Vec::new();
while let Some(row) = rows.next()? {
let block_num = row.get(0)?;
let note_index = row.get(1)?;
let note_id_data = row.get_ref(2)?.as_blob()?;
let batch_index = row.get(1)?;
let note_index = row.get(2)?;
let note_id_data = row.get_ref(3)?.as_blob()?;
let note_id = deserialize(note_id_data)?;
let sender = column_value_as_u64(row, 3)?;
let tag = column_value_as_u64(row, 4)?;
let merkle_path_data = row.get_ref(5)?.as_blob()?;
let sender = column_value_as_u64(row, 4)?;
let tag = column_value_as_u64(row, 5)?;
let merkle_path_data = row.get_ref(6)?.as_blob()?;
let merkle_path = deserialize(merkle_path_data)?;

let note = Note {
block_num,
note_created: NoteCreated {
batch_index,
note_index,
note_id,
sender,
Expand Down
Loading

0 comments on commit 7135167

Please sign in to comment.