feat: implement missing RPC endpoints (#1362)

Author: juan518munoz

CHANGELOG.md

@@ -17,6 +17,7 @@
 * Refactored code into their own files and added `ProvenTransaction` and `TransactionStoreUpdate` bindings for the WebClient ([#1408](https://github.com/0xMiden/miden-client/pull/1408)).
 * Added `NoteFile` type, used for exporting and importing `Notes`([#1378](https://github.com/0xMiden/miden-client/pull/1383))
 * Build `IndexedDB` code from a `build.rs` instead of pushing artifacts to the repo ([#1409](https://github.com/0xMiden/miden-client/pull/1409)).
+* Implemented missing RPC endpoints: `/SyncStorageMaps`, `/SyncAccountVault` & `/SyncTransactions` ([#1362](https://github.com/0xMiden/miden-client/pull/1362)).
 
 ### Changes
 

bin/integration-tests/src/tests/client.rs

@@ -2,8 +2,8 @@ use std::sync::Arc;
 use std::time::Duration;
 
 use anyhow::{Context, Result};
-use miden_client::ClientError;
-use miden_client::account::{AccountId, AccountStorageMode};
+use miden_client::account::{AccountId, AccountStorageMode, StorageMap, StorageSlot};
+use miden_client::assembly::{DefaultSourceManager, LibraryPath, Module, ModuleKind};
 use miden_client::asset::{Asset, FungibleAsset};
 use miden_client::builder::ClientBuilder;
 use miden_client::keystore::FilesystemKeyStore;
@@ -22,11 +22,13 @@ use miden_client::transaction::{
     PaymentNoteDescription,
     ProvenTransaction,
     TransactionInputs,
+    TransactionKernel,
     TransactionProver,
     TransactionProverError,
     TransactionRequestBuilder,
     TransactionStatus,
 };
+use miden_client::{ClientError, Felt, ScriptBuilder};
 use miden_client_sqlite_store::ClientBuilderSqliteExt;
 
 use crate::tests::config::ClientConfig;
@@ -1153,8 +1155,85 @@ pub async fn test_unused_rpc_api(client_config: ClientConfig) -> Result<()> {
         consume_notes(&mut client, first_basic_account.id(), std::slice::from_ref(&note)).await;
     wait_for_tx(&mut client, tx_id).await?;
 
+    // Define the account code for the custom library
+    let custom_code = "
+        use.miden::account
+
+        export.update_map
+            push.1.2.3.4
+            # => [VALUE]
+            push.0.0.0.0
+            # => [KEY, VALUE]
+            push.1
+            # => [index, KEY, VALUE]
+            exec.account::set_map_item
+            dropw dropw dropw dropw
+        end
+    ";
+
+    let mut storage_map = StorageMap::new();
+    storage_map.insert(
+        [Felt::new(1), Felt::new(2), Felt::new(3), Felt::new(4)].into(),
+        [Felt::new(0), Felt::new(0), Felt::new(0), Felt::new(1)].into(),
+    )?;
+
+    let storage_slots = vec![StorageSlot::empty_map(), StorageSlot::Map(storage_map)];
+    let (account_with_map_item, _) = insert_account_with_custom_component(
+        &mut client,
+        custom_code,
+        storage_slots,
+        AccountStorageMode::Public,
+        &keystore,
+    )
+    .await?;
+
     client.sync_state().await.unwrap();
 
+    let assembler = TransactionKernel::assembler();
+    let source_manager = Arc::new(DefaultSourceManager::default());
+    let module = Module::parser(ModuleKind::Library)
+        .parse_str(
+            LibraryPath::new("custom_library::set_map_item_library")
+                .context("failed to create library path for custom library")?,
+            custom_code,
+            &source_manager,
+        )
+        .unwrap();
+    let custom_lib = assembler.assemble_library([module]).unwrap();
+
+    let tx_script = ScriptBuilder::new(true)
+        .with_statically_linked_library(&custom_lib)?
+        .compile_tx_script(
+            "
+        use.custom_library::set_map_item_library
+
+        begin
+             call.set_map_item_library::update_map
+        end
+        ",
+        )?;
+
+    let tx_request = TransactionRequestBuilder::new().custom_script(tx_script).build()?;
+    execute_tx_and_sync(&mut client, account_with_map_item.id(), tx_request.clone()).await?;
+
+    // Mint a new fungible asset to check account vault changes
+    let faucet = insert_new_fungible_faucet(&mut client, AccountStorageMode::Private, &keystore)
+        .await?
+        .0;
+
+    let fungible_asset = FungibleAsset::new(faucet.id(), MINT_AMOUNT)?;
+    let tx_request = TransactionRequestBuilder::new().build_mint_fungible_asset(
+        fungible_asset,
+        first_basic_account.id(),
+        NoteType::Public,
+        client.rng(),
+    )?;
+    let note_id = tx_request.expected_output_own_notes().pop().unwrap().id();
+    execute_tx_and_sync(&mut client, fungible_asset.faucet_id(), tx_request.clone()).await?;
+
+    let tx_request = TransactionRequestBuilder::new().build_consume_notes(vec![note_id])?;
+    execute_tx_and_sync(&mut client, first_basic_account.id(), tx_request).await?;
+
     let nullifier = note.nullifier();
 
     let node_nullifier = client
@@ -1176,6 +1255,21 @@ pub async fn test_unused_rpc_api(client_config: ClientConfig) -> Result<()> {
         .get_note_script_by_root(note.script().root())
         .await
         .unwrap();
+    let sync_storage_maps = client
+        .test_rpc_api()
+        .sync_storage_maps(0.into(), None, account_with_map_item.id())
+        .await
+        .unwrap();
+    let account_vault_info = client
+        .test_rpc_api()
+        .sync_account_vault(0.into(), None, first_basic_account.id())
+        .await
+        .unwrap();
+    let transactions_info = client
+        .test_rpc_api()
+        .sync_transactions(0.into(), None, vec![first_basic_account.id()])
+        .await
+        .unwrap();
 
     // Remove debug decorators from original note script, as they are not persisted on submission
     // https://github.com/0xMiden/miden-base/issues/1812
@@ -1186,6 +1280,9 @@ pub async fn test_unused_rpc_api(client_config: ClientConfig) -> Result<()> {
     assert_eq!(node_nullifier.nullifier, nullifier);
     assert_eq!(node_nullifier_proof.leaf().entries().first().unwrap().0, nullifier.as_word());
     assert_eq!(note_script, retrieved_note_script);
+    assert!(!sync_storage_maps.updates.is_empty());
+    assert!(!account_vault_info.updates.is_empty());
+    assert!(!transactions_info.transaction_records.is_empty());
 
     Ok(())
 }

crates/rust-client/src/rpc/domain/account_vault.rs

@@ -0,0 +1,103 @@
+use alloc::string::ToString;
+use alloc::vec::Vec;
+
+use miden_objects::asset::Asset;
+use miden_objects::block::BlockNumber;
+use miden_objects::{AssetError, Word};
+
+use crate::rpc::domain::MissingFieldHelper;
+use crate::rpc::{RpcError, generated as proto};
+
+// ACCOUNT VAULT INFO
+// ================================================================================================
+
+/// Represents a `proto::rpc_store::SyncAccountVaultResponse` with fields converted into domain
+/// types. Contains information of asset updates in a given range of blocks specified on request.
+/// Also provides the current chain tip while processing the request.
+pub struct AccountVaultInfo {
+    /// Current chain tip
+    pub chain_tip: BlockNumber,
+    /// The block number of the last check included in this response.
+    pub block_number: BlockNumber,
+    /// List of asset updates for the account.
+    pub updates: Vec<AccountVaultUpdate>,
+}
+
+// ACCOUNT VAULT CONVERSION
+// ================================================================================================
+
+impl TryFrom<proto::rpc_store::SyncAccountVaultResponse> for AccountVaultInfo {
+    type Error = RpcError;
+
+    fn try_from(value: proto::rpc_store::SyncAccountVaultResponse) -> Result<Self, Self::Error> {
+        let pagination_info = value.pagination_info.ok_or(
+            proto::rpc_store::SyncAccountVaultResponse::missing_field(stringify!(pagination_info)),
+        )?;
+        let chain_tip = pagination_info.chain_tip;
+        let block_number = pagination_info.block_num;
+
+        let updates = value
+            .updates
+            .iter()
+            .map(|update| (*update).try_into())
+            .collect::<Result<Vec<_>, _>>()?;
+
+        Ok(Self {
+            chain_tip: chain_tip.into(),
+            block_number: block_number.into(),
+            updates,
+        })
+    }
+}
+
+// ACCOUNT VAULT UPDATE
+// ================================================================================================
+
+/// Represents an update to an account vault, including the vault key and asset value involved.
+pub struct AccountVaultUpdate {
+    /// Block number in which the slot was updated.
+    pub block_num: BlockNumber,
+    /// Asset value related to the vault key. If not present, the asset was removed from the vault.
+    pub asset: Option<Asset>,
+    /// Vault key associated with the asset.
+    pub vault_key: Word,
+}
+
+// ACCOUNT VAULT UPDATE CONVERSION
+// ================================================================================================
+
+impl TryFrom<proto::primitives::Asset> for Asset {
+    type Error = RpcError;
+
+    fn try_from(value: proto::primitives::Asset) -> Result<Self, Self::Error> {
+        let word: Word = value
+            .asset
+            .ok_or(proto::rpc_store::SyncAccountVaultResponse::missing_field(stringify!(asset)))?
+            .try_into()?;
+        word.try_into()
+            .map_err(|e: AssetError| RpcError::InvalidResponse(e.to_string()))
+    }
+}
+
+impl TryFrom<proto::rpc_store::AccountVaultUpdate> for AccountVaultUpdate {
+    type Error = RpcError;
+
+    fn try_from(value: proto::rpc_store::AccountVaultUpdate) -> Result<Self, Self::Error> {
+        let block_num = value.block_num;
+
+        let asset: Option<Asset> = value.asset.map(TryInto::try_into).transpose()?;
+
+        let vault_key = value
+            .vault_key
+            .ok_or(proto::rpc_store::SyncAccountVaultResponse::missing_field(stringify!(
+                vault_key
+            )))?
+            .try_into()?;
+
+        Ok(Self {
+            block_num: block_num.into(),
+            asset,
+            vault_key,
+        })
+    }
+}

crates/rust-client/src/rpc/domain/mod.rs

@@ -3,12 +3,14 @@ use core::any::type_name;
 use super::errors::RpcConversionError;
 
 pub mod account;
+pub mod account_vault;
 pub mod block;
 pub mod digest;
 pub mod merkle;
 pub mod note;
 pub mod nullifier;
 pub mod smt;
+pub mod storage_map;
 pub mod sync;
 pub mod transaction;
 

crates/rust-client/src/rpc/domain/storage_map.rs

@@ -0,0 +1,94 @@
+use alloc::vec::Vec;
+
+use miden_objects::Word;
+use miden_objects::block::BlockNumber;
+
+use crate::rpc::domain::MissingFieldHelper;
+use crate::rpc::{RpcConversionError, RpcError, generated as proto};
+
+// STORAGE MAP INFO
+// ================================================================================================
+
+/// Represents a `proto::rpc_store::SyncStorageMapsResponse` with fields converted into domain
+/// types. Contains information of updated map slots in a given range of blocks specified on
+/// request. Also provides the current chain tip while processing the request.
+pub struct StorageMapInfo {
+    /// Current chain tip
+    pub chain_tip: BlockNumber,
+    /// The block number of the last check included in this response.
+    pub block_number: BlockNumber,
+    /// The list of storage map updates.
+    pub updates: Vec<StorageMapUpdate>,
+}
+
+// STORAGE MAP INFO CONVERSION
+// ================================================================================================
+
+impl TryFrom<proto::rpc_store::SyncStorageMapsResponse> for StorageMapInfo {
+    type Error = RpcError;
+
+    fn try_from(value: proto::rpc_store::SyncStorageMapsResponse) -> Result<Self, Self::Error> {
+        let pagination_info = value.pagination_info.ok_or(
+            proto::rpc_store::SyncStorageMapsResponse::missing_field(stringify!(pagination_info)),
+        )?;
+        let chain_tip = pagination_info.chain_tip;
+        let block_number = pagination_info.block_num;
+
+        let updates = value
+            .updates
+            .iter()
+            .map(|update| (*update).try_into())
+            .collect::<Result<Vec<_>, _>>()?;
+
+        Ok(Self {
+            chain_tip: chain_tip.into(),
+            block_number: block_number.into(),
+            updates,
+        })
+    }
+}
+
+// STORAGE MAP UPDATE
+// ================================================================================================
+
+/// Represents a `proto::rpc_store::StorageMapUpdate`
+pub struct StorageMapUpdate {
+    /// Block number in which the slot was updated.
+    pub block_num: BlockNumber,
+    /// Slot index ([0..255]).
+    pub slot_index: u8,
+    /// The storage map key
+    pub key: Word,
+    /// The storage map value.
+    pub value: Word,
+}
+
+// STORAGE MAP UPDATE CONVERSION
+// ================================================================================================
+
+impl TryFrom<proto::rpc_store::StorageMapUpdate> for StorageMapUpdate {
+    type Error = RpcConversionError;
+
+    fn try_from(value: proto::rpc_store::StorageMapUpdate) -> Result<Self, Self::Error> {
+        let block_num = value.block_num;
+
+        let slot_index = value.slot_index;
+
+        let key: Word = value
+            .key
+            .ok_or(proto::rpc_store::StorageMapUpdate::missing_field(stringify!(key)))?
+            .try_into()?;
+
+        let value: Word = value
+            .value
+            .ok_or(proto::rpc_store::StorageMapUpdate::missing_field(stringify!(value)))?
+            .try_into()?;
+
+        Ok(Self {
+            block_num: block_num.into(),
+            slot_index: u8::try_from(slot_index)?,
+            key,
+            value,
+        })
+    }
+}