On-chain accounts protobuf & domain objects (#287)

* feat: add `account_details` table to the DB

* refactor: rename `block_number` column in nullifiers table to `block_num`

* refactor: use `BETWEEN` in interval comparison checks

* feat: implement account details protobuf messages, domain objects and conversions

* feat: (WIP) implement account details support

* feat: (WIP) implement account details support

* feat: (WIP) implement account details support

* feat: (WIP) implement account details support

* fix: db creation

* docs: remove TODO

* refactor: apply formatting

* feat: implement endpoint for getting public account details

* tests: add test for storage

* feat: add rpc endpoint for getting account details

* refactor: keep only domain object changes

* fix: compilation errors

* fix: use note tag conversion from `u64`

* refactor: remove account details protobuf messages

* fix: remove unused error invariants

* refactor: introduce `UpdatedAccount` struct

* fix: rollback details conversion

* fix: compilation error

* format: reformat using rustfmt

.gitignore

@@ -16,6 +16,11 @@ target/
 # VS Code
 .vscode/
 
+# JetBrains IDEs
+.idea/
+.code/
+.fleet/
+
 # Genesis files
 /accounts
 genesis.dat
@@ -26,12 +31,10 @@ genesis.dat
 *.sqlite3-wal
 
 # Docs ignore
-.code
-.idea
 site/
 venv/
 env/
 *.out
 node_modules/
 *DS_Store
-*.iml
+*.iml

block-producer/src/batch_builder/batch.rs

@@ -1,5 +1,6 @@
 use std::collections::BTreeMap;
 
+use miden_node_proto::domain::accounts::UpdatedAccount;
 use miden_objects::{
     accounts::AccountId,
     batches::BatchNoteTree,
@@ -108,10 +109,14 @@ impl TransactionBatch {
 
     /// Returns an iterator over (account_id, new_state_hash) tuples for accounts that were
     /// modified in this transaction batch.
-    pub fn updated_accounts(&self) -> impl Iterator<Item = (AccountId, Digest)> + '_ {
+    pub fn updated_accounts(&self) -> impl Iterator<Item = UpdatedAccount> + '_ {
         self.updated_accounts
             .iter()
-            .map(|(account_id, account_states)| (*account_id, account_states.final_state))
+            .map(|(&account_id, account_states)| UpdatedAccount {
+                account_id,
+                final_state_hash: account_states.final_state,
+                details: None, // TODO: In the next PR: account_states.details.clone(),
+            })
     }
 
     /// Returns an iterator over produced nullifiers for all consumed notes.

block-producer/src/block.rs

@@ -1,7 +1,8 @@
 use std::collections::BTreeMap;
 
 use miden_node_proto::{
-    errors::{MissingFieldHelper, ParseError},
+    domain::accounts::UpdatedAccount,
+    errors::{ConversionError, MissingFieldHelper},
     generated::responses::GetBlockInputsResponse,
     AccountInputRecord, NullifierWitness,
 };
@@ -17,7 +18,7 @@ use crate::store::BlockInputsError;
 #[derive(Debug, Clone)]
 pub struct Block {
     pub header: BlockHeader,
-    pub updated_accounts: Vec<(AccountId, Digest)>,
+    pub updated_accounts: Vec<UpdatedAccount>,
     pub created_notes: Vec<(usize, usize, NoteEnvelope)>,
     pub produced_nullifiers: Vec<Nullifier>,
     // TODO:
@@ -94,7 +95,7 @@ impl TryFrom<GetBlockInputsResponse> for BlockInputs {
                 };
                 Ok((domain.account_id, witness))
             })
-            .collect::<Result<BTreeMap<_, _>, ParseError>>()?;
+            .collect::<Result<BTreeMap<_, _>, ConversionError>>()?;
 
         let nullifiers = get_block_inputs
             .nullifiers
@@ -103,7 +104,7 @@ impl TryFrom<GetBlockInputsResponse> for BlockInputs {
                 let witness: NullifierWitness = entry.try_into()?;
                 Ok((witness.nullifier, witness.proof))
             })
-            .collect::<Result<BTreeMap<_, _>, ParseError>>()?;
+            .collect::<Result<BTreeMap<_, _>, ConversionError>>()?;
 
         Ok(Self {
             block_header,

block-producer/src/block_builder/mod.rs

@@ -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};
+use miden_objects::notes::Nullifier;
 use tracing::{debug, info, instrument};
 
 use crate::{
@@ -77,7 +77,7 @@ where
             batches = %format_array(batches.iter().map(|batch| format_blake3_digest(batch.id()))),
         );
 
-        let updated_accounts: Vec<(AccountId, Digest)> =
+        let updated_accounts: Vec<_> =
             batches.iter().flat_map(TransactionBatch::updated_accounts).collect();
         let created_notes = batches
             .iter()
@@ -95,7 +95,7 @@ where
         let block_inputs = self
             .store
             .get_block_inputs(
-                updated_accounts.iter().map(|(account_id, _)| account_id),
+                updated_accounts.iter().map(|update| &update.account_id),
                 produced_nullifiers.iter(),
             )
             .await?;

block-producer/src/block_builder/prover/block_witness.rs

@@ -1,5 +1,6 @@
 use std::collections::{BTreeMap, BTreeSet};
 
+use miden_node_proto::domain::accounts::UpdatedAccount;
 use miden_objects::{
     accounts::AccountId,
     crypto::merkle::{EmptySubtreeRoots, MerklePath, MerkleStore, MmrPeaks, SmtProof},
@@ -48,23 +49,29 @@ impl BlockWitness {
             batches
                 .iter()
                 .flat_map(|batch| batch.updated_accounts())
-                .map(|(account_id, final_state_hash)| {
-                    let initial_state_hash = account_initial_states
-                        .remove(&account_id)
-                        .expect("already validated that key exists");
-                    let proof = account_merkle_proofs
-                        .remove(&account_id)
-                        .expect("already validated that key exists");
-
-                    (
-                        account_id,
-                        AccountUpdate {
-                            initial_state_hash,
-                            final_state_hash,
-                            proof,
-                        },
-                    )
-                })
+                .map(
+                    |UpdatedAccount {
+                         account_id,
+                         final_state_hash,
+                         ..
+                     }| {
+                        let initial_state_hash = account_initial_states
+                            .remove(&account_id)
+                            .expect("already validated that key exists");
+                        let proof = account_merkle_proofs
+                            .remove(&account_id)
+                            .expect("already validated that key exists");
+
+                        (
+                            account_id,
+                            AccountUpdate {
+                                initial_state_hash,
+                                final_state_hash,
+                                proof,
+                            },
+                        )
+                    },
+                )
                 .collect()
         };
 

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

@@ -1,5 +1,6 @@
 use std::{collections::BTreeMap, iter};
 
+use miden_node_proto::domain::accounts::UpdatedAccount;
 use miden_objects::{
     accounts::AccountId,
     crypto::merkle::{
@@ -235,7 +236,11 @@ async fn test_compute_account_root_success() {
             account_ids
                 .iter()
                 .zip(account_final_states.iter())
-                .map(|(&account_id, &account_hash)| (account_id, account_hash.into()))
+                .map(|(&account_id, &account_hash)| UpdatedAccount {
+                    account_id,
+                    final_state_hash: account_hash.into(),
+                    details: None,
+                })
                 .collect(),
         )
         .build();

block-producer/src/block_builder/tests.rs

@@ -1,9 +1,15 @@
 // block builder tests (higher level)
 // `apply_block()` is called
-use miden_objects::Felt;
 
-use super::*;
-use crate::test_utils::{MockProvenTxBuilder, MockStoreFailure, MockStoreSuccessBuilder};
+use std::sync::Arc;
+
+use miden_objects::{accounts::AccountId, Digest, Felt};
+
+use crate::{
+    batch_builder::TransactionBatch,
+    block_builder::{BlockBuilder, BuildBlockError, DefaultBlockBuilder},
+    test_utils::{MockProvenTxBuilder, MockStoreFailure, MockStoreSuccessBuilder},
+};
 
 /// Tests that `build_block()` succeeds when the transaction batches are not empty
 #[tokio::test]

block-producer/src/errors.rs

@@ -1,4 +1,4 @@
-use miden_node_proto::errors::ParseError;
+use miden_node_proto::errors::ConversionError;
 use miden_node_utils::formatting::format_opt;
 use miden_objects::{
     accounts::AccountId,
@@ -101,7 +101,7 @@ pub enum BlockProverError {
 #[derive(Debug, PartialEq, Eq, Error)]
 pub enum BlockInputsError {
     #[error("failed to parse protobuf message: {0}")]
-    ParseError(#[from] ParseError),
+    ConversionError(#[from] ConversionError),
     #[error("MmrPeaks error: {0}")]
     MmrPeaksError(#[from] MmrError),
     #[error("gRPC client failed with error: {0}")]
@@ -113,8 +113,6 @@ pub enum BlockInputsError {
 
 #[derive(Debug, PartialEq, Eq, Error)]
 pub enum ApplyBlockError {
-    #[error("Merkle error: {0}")]
-    MerkleError(#[from] MerkleError),
     #[error("gRPC client failed with error: {0}")]
     GrpcClientError(String),
 }
@@ -153,7 +151,7 @@ pub enum TxInputsError {
     #[error("malformed response from store: {0}")]
     MalformedResponse(String),
     #[error("failed to parse protobuf message: {0}")]
-    ParseError(#[from] ParseError),
+    ConversionError(#[from] ConversionError),
     #[error("dummy")]
     Dummy,
 }

block-producer/src/state_view/mod.rs

@@ -127,18 +127,13 @@ where
         let mut locked_nullifiers_in_flight = self.nullifiers_in_flight.write().await;
 
         // Remove account ids of transactions in block
-        let account_ids_in_block = block
-            .updated_accounts
-            .iter()
-            .map(|(account_id, _final_account_hash)| account_id);
-
-        for account_id in account_ids_in_block {
-            let was_in_flight = locked_accounts_in_flight.remove(account_id);
+        for update in &block.updated_accounts {
+            let was_in_flight = locked_accounts_in_flight.remove(&update.account_id);
             debug_assert!(was_in_flight);
         }
 
         // Remove new nullifiers of transactions in block
-        for nullifier in block.produced_nullifiers.iter() {
+        for nullifier in &block.produced_nullifiers {
             let was_in_flight = locked_nullifiers_in_flight.remove(nullifier);
             debug_assert!(was_in_flight);
         }

block-producer/src/state_view/tests/apply_block.rs

@@ -6,6 +6,8 @@
 
 use std::iter;
 
+use miden_node_proto::domain::accounts::UpdatedAccount;
+
 use super::*;
 use crate::test_utils::{block::MockBlockBuilder, MockStoreSuccessBuilder};
 
@@ -32,7 +34,11 @@ async fn test_apply_block_ab1() {
         .await
         .account_updates(
             std::iter::once(account)
-                .map(|mock_account| (mock_account.id, mock_account.states[1]))
+                .map(|mock_account| UpdatedAccount {
+                    account_id: mock_account.id,
+                    final_state_hash: mock_account.states[1],
+                    details: None,
+                })
                 .collect(),
         )
         .build();
@@ -75,7 +81,11 @@ async fn test_apply_block_ab2() {
         .account_updates(
             accounts_in_block
                 .into_iter()
-                .map(|mock_account| (mock_account.id, mock_account.states[1]))
+                .map(|mock_account| UpdatedAccount {
+                    account_id: mock_account.id,
+                    final_state_hash: mock_account.states[1],
+                    details: None,
+                })
                 .collect(),
         )
         .build();
@@ -120,7 +130,11 @@ async fn test_apply_block_ab3() {
             accounts
                 .clone()
                 .into_iter()
-                .map(|mock_account| (mock_account.id, mock_account.states[1]))
+                .map(|mock_account| UpdatedAccount {
+                    account_id: mock_account.id,
+                    final_state_hash: mock_account.states[1],
+                    details: None,
+                })
                 .collect(),
         )
         .build();

block-producer/src/store/mod.rs

@@ -6,7 +6,7 @@ use std::{
 use async_trait::async_trait;
 use miden_node_proto::{
     convert,
-    errors::{MissingFieldHelper, ParseError},
+    errors::{ConversionError, MissingFieldHelper},
     generated::{
         account, digest,
         requests::{ApplyBlockRequest, GetBlockInputsRequest, GetTransactionInputsRequest},
@@ -83,7 +83,7 @@ impl Display for TransactionInputs {
 }
 
 impl TryFrom<GetTransactionInputsResponse> for TransactionInputs {
-    type Error = ParseError;
+    type Error = ConversionError;
 
     fn try_from(response: GetTransactionInputsResponse) -> Result<Self, Self::Error> {
         let AccountState {
@@ -135,7 +135,7 @@ impl ApplyBlock for DefaultStore {
     ) -> Result<(), ApplyBlockError> {
         let request = tonic::Request::new(ApplyBlockRequest {
             block: Some(block.header.into()),
-            accounts: convert(block.updated_accounts),
+            accounts: convert(&block.updated_accounts),
             nullifiers: convert(block.produced_nullifiers),
             notes: convert(block.created_notes),
         });