From e21d830edfdda5a60e96b27d0d70b63857e37bc0 Mon Sep 17 00:00:00 2001 From: dubbelosix Date: Mon, 8 Jan 2024 11:45:01 +0530 Subject: [PATCH 1/3] simple archival rpc --- examples/demo-rollup/stf/src/tests/stf_tests.rs | 6 +++--- .../demo-rollup/stf/src/tests/tx_revert_tests.rs | 1 + examples/demo-rollup/tests/bank/mod.rs | 1 + module-system/RPC_WALKTHROUGH.md | 10 ++++++++++ .../module-implementations/sov-bank/src/query.rs | 8 ++++++++ .../sov-bank/tests/burn_test.rs | 3 ++- .../sov-bank/tests/freeze_test.rs | 12 ++++++------ .../sov-bank/tests/mint_test.rs | 12 ++++++------ .../sov-bank/tests/transfer_test.rs | 6 ++++-- .../sov-sequencer-registry/tests/helpers/mod.rs | 2 ++ module-system/sov-cli/src/workflows/rpc.rs | 1 + 11 files changed, 44 insertions(+), 18 deletions(-) diff --git a/examples/demo-rollup/stf/src/tests/stf_tests.rs b/examples/demo-rollup/stf/src/tests/stf_tests.rs index 1df44283a..438abb9e5 100644 --- a/examples/demo-rollup/stf/src/tests/stf_tests.rs +++ b/examples/demo-rollup/stf/src/tests/stf_tests.rs @@ -81,7 +81,7 @@ fn test_demo_values_in_db() { let mut working_set = WorkingSet::new(storage); let resp = runtime .bank - .supply_of(get_default_token_address(), &mut working_set) + .supply_of(None, get_default_token_address(), &mut working_set) .unwrap(); assert_eq!(resp, sov_bank::TotalSupplyResponse { amount: Some(1000) }); @@ -143,7 +143,7 @@ fn test_demo_values_in_cache() { let resp = runtime .bank - .supply_of(get_default_token_address(), &mut working_set) + .supply_of(None, get_default_token_address(), &mut working_set) .unwrap(); assert_eq!(resp, sov_bank::TotalSupplyResponse { amount: Some(1000) }); @@ -210,7 +210,7 @@ fn test_demo_values_not_in_db() { let resp = runtime .bank - .supply_of(get_default_token_address(), &mut working_set) + .supply_of(None, get_default_token_address(), &mut working_set) .unwrap(); assert_eq!(resp, sov_bank::TotalSupplyResponse { amount: Some(1000) }); diff --git a/examples/demo-rollup/stf/src/tests/tx_revert_tests.rs b/examples/demo-rollup/stf/src/tests/tx_revert_tests.rs index a998388bd..1591e8c38 100644 --- a/examples/demo-rollup/stf/src/tests/tx_revert_tests.rs +++ b/examples/demo-rollup/stf/src/tests/tx_revert_tests.rs @@ -91,6 +91,7 @@ fn test_tx_revert() { let resp = runtime .bank .balance_of( + None, get_default_private_key().default_address(), get_default_token_address(), &mut working_set, diff --git a/examples/demo-rollup/tests/bank/mod.rs b/examples/demo-rollup/tests/bank/mod.rs index b0317d04c..e637d6e40 100644 --- a/examples/demo-rollup/tests/bank/mod.rs +++ b/examples/demo-rollup/tests/bank/mod.rs @@ -96,6 +96,7 @@ async fn send_test_create_token_tx(rpc_address: SocketAddr) -> Result<(), anyhow let balance_response = sov_bank::BankRpcClient::::balance_of( client.http(), + None, user_address, token_address, ) diff --git a/module-system/RPC_WALKTHROUGH.md b/module-system/RPC_WALKTHROUGH.md index 2e6373a03..c851e294d 100644 --- a/module-system/RPC_WALKTHROUGH.md +++ b/module-system/RPC_WALKTHROUGH.md @@ -126,3 +126,13 @@ fn main() { } ``` + +## Enabling Archival queries for RPC +We use `working_set: &mut WorkingSet` in order to query state. `WorkingSet` has a function `set_archival_version` +```rust + /// Sets archival version for a working set + pub fn set_archival_version(&mut self, version: Version) { + self.archival_working_set = Some(self.archival_state(version)); + self.archival_accessory_working_set = Some(self.archival_accessory_state(version)); + } +``` \ No newline at end of file diff --git a/module-system/module-implementations/sov-bank/src/query.rs b/module-system/module-implementations/sov-bank/src/query.rs index 70df33f09..1e17a84ff 100644 --- a/module-system/module-implementations/sov-bank/src/query.rs +++ b/module-system/module-implementations/sov-bank/src/query.rs @@ -26,10 +26,14 @@ impl Bank { /// stored at the address `token_address`. pub fn balance_of( &self, + version: Option, user_address: C::Address, token_address: C::Address, working_set: &mut WorkingSet, ) -> RpcResult { + if let Some(v) = version { + working_set.set_archival_version(v) + } Ok(BalanceResponse { amount: self.get_balance_of(user_address, token_address, working_set), }) @@ -39,9 +43,13 @@ impl Bank { /// Rpc method that returns the supply of a token stored at the address `token_address`. pub fn supply_of( &self, + version: Option, token_address: C::Address, working_set: &mut WorkingSet, ) -> RpcResult { + if let Some(v) = version { + working_set.set_archival_version(v) + } Ok(TotalSupplyResponse { amount: self.get_total_supply_of(&token_address, working_set), }) diff --git a/module-system/module-implementations/sov-bank/tests/burn_test.rs b/module-system/module-implementations/sov-bank/tests/burn_test.rs index 29a153ab4..3d519a279 100644 --- a/module-system/module-implementations/sov-bank/tests/burn_test.rs +++ b/module-system/module-implementations/sov-bank/tests/burn_test.rs @@ -48,7 +48,8 @@ fn burn_deployed_tokens() { assert!(working_set.events().is_empty()); let query_total_supply = |working_set: &mut WorkingSet| -> Option { - let total_supply: TotalSupplyResponse = bank.supply_of(token_address, working_set).unwrap(); + let total_supply: TotalSupplyResponse = + bank.supply_of(None, token_address, working_set).unwrap(); total_supply.amount }; diff --git a/module-system/module-implementations/sov-bank/tests/freeze_test.rs b/module-system/module-implementations/sov-bank/tests/freeze_test.rs index a1e6441ec..8f23d0663 100644 --- a/module-system/module-implementations/sov-bank/tests/freeze_test.rs +++ b/module-system/module-implementations/sov-bank/tests/freeze_test.rs @@ -132,12 +132,12 @@ fn freeze_token() { minter_address: new_holder, }; - let query_total_supply = |token_address: Address, - working_set: &mut WorkingSet| - -> Option { - let total_supply: TotalSupplyResponse = bank.supply_of(token_address, working_set).unwrap(); - total_supply.amount - }; + let query_total_supply = + |token_address: Address, working_set: &mut WorkingSet| -> Option { + let total_supply: TotalSupplyResponse = + bank.supply_of(None, token_address, working_set).unwrap(); + total_supply.amount + }; let minted = bank.call(mint_message, &minter_context, &mut working_set); assert!(minted.is_err()); diff --git a/module-system/module-implementations/sov-bank/tests/mint_test.rs b/module-system/module-implementations/sov-bank/tests/mint_test.rs index 0708ba926..d3799aec4 100644 --- a/module-system/module-implementations/sov-bank/tests/mint_test.rs +++ b/module-system/module-implementations/sov-bank/tests/mint_test.rs @@ -42,12 +42,12 @@ fn mint_token() { // No events at the moment. If there are, needs to be checked assert!(working_set.events().is_empty()); - let query_total_supply = |token_address: Address, - working_set: &mut WorkingSet| - -> Option { - let total_supply: TotalSupplyResponse = bank.supply_of(token_address, working_set).unwrap(); - total_supply.amount - }; + let query_total_supply = + |token_address: Address, working_set: &mut WorkingSet| -> Option { + let total_supply: TotalSupplyResponse = + bank.supply_of(None, token_address, working_set).unwrap(); + total_supply.amount + }; let query_user_balance = |user_address: Address, working_set: &mut WorkingSet| -> Option { diff --git a/module-system/module-implementations/sov-bank/tests/transfer_test.rs b/module-system/module-implementations/sov-bank/tests/transfer_test.rs index 6af81b538..2c825b55b 100644 --- a/module-system/module-implementations/sov-bank/tests/transfer_test.rs +++ b/module-system/module-implementations/sov-bank/tests/transfer_test.rs @@ -40,7 +40,8 @@ fn transfer_initial_token() { }; let query_total_supply = |working_set: &mut WorkingSet| -> Option { - let total_supply: TotalSupplyResponse = bank.supply_of(token_address, working_set).unwrap(); + let total_supply: TotalSupplyResponse = + bank.supply_of(None, token_address, working_set).unwrap(); total_supply.amount }; @@ -282,7 +283,8 @@ fn transfer_deployed_token() { }; let query_total_supply = |working_set: &mut WorkingSet| -> Option { - let total_supply: TotalSupplyResponse = bank.supply_of(token_address, working_set).unwrap(); + let total_supply: TotalSupplyResponse = + bank.supply_of(None, token_address, working_set).unwrap(); total_supply.amount }; diff --git a/module-system/module-implementations/sov-sequencer-registry/tests/helpers/mod.rs b/module-system/module-implementations/sov-sequencer-registry/tests/helpers/mod.rs index 7e4efbb82..b8457b6a8 100644 --- a/module-system/module-implementations/sov-sequencer-registry/tests/helpers/mod.rs +++ b/module-system/module-implementations/sov-sequencer-registry/tests/helpers/mod.rs @@ -45,6 +45,7 @@ impl TestSequencer { working_set: &mut WorkingSet, ) -> RpcResult { self.bank.balance_of( + None, self.sequencer_config.seq_rollup_address, self.sequencer_config.coins_to_lock.token_address, working_set, @@ -58,6 +59,7 @@ impl TestSequencer { working_set: &mut WorkingSet, ) -> RpcResult { self.bank.balance_of( + None, user_address, self.sequencer_config.coins_to_lock.token_address, working_set, diff --git a/module-system/sov-cli/src/workflows/rpc.rs b/module-system/sov-cli/src/workflows/rpc.rs index 212437a0e..5fde51828 100644 --- a/module-system/sov-cli/src/workflows/rpc.rs +++ b/module-system/sov-cli/src/workflows/rpc.rs @@ -129,6 +129,7 @@ impl R } => { let BalanceResponse { amount } = BankRpcClient::::balance_of( &client, + None, account.address.clone(), token_address.clone(), ) From 3cd557d4831ce6047a581e883320a7cdb048a1c4 Mon Sep 17 00:00:00 2001 From: dubbelosix Date: Mon, 8 Jan 2024 18:43:59 +0530 Subject: [PATCH 2/3] archival rpc test --- examples/demo-rollup/tests/bank/mod.rs | 155 ++++++++++++++++++++++--- module-system/RPC_WALKTHROUGH.md | 37 +++++- 2 files changed, 173 insertions(+), 19 deletions(-) diff --git a/examples/demo-rollup/tests/bank/mod.rs b/examples/demo-rollup/tests/bank/mod.rs index e637d6e40..dcb6fc74c 100644 --- a/examples/demo-rollup/tests/bank/mod.rs +++ b/examples/demo-rollup/tests/bank/mod.rs @@ -5,11 +5,12 @@ use demo_stf::genesis_config::GenesisPaths; use demo_stf::runtime::RuntimeCall; use jsonrpsee::core::client::{Subscription, SubscriptionClientT}; use jsonrpsee::rpc_params; +use sov_bank::Coins; use sov_mock_da::MockDaSpec; use sov_modules_api::default_context::DefaultContext; use sov_modules_api::default_signature::private_key::DefaultPrivateKey; use sov_modules_api::transaction::Transaction; -use sov_modules_api::{PrivateKey, Spec}; +use sov_modules_api::{Address, PrivateKey, Spec}; use sov_modules_stf_blueprint::kernels::basic::BasicKernelGenesisPaths; use sov_sequencer::utils::SimpleClient; use sov_stf_runner::RollupProverConfig; @@ -40,21 +41,13 @@ async fn bank_tx_tests() -> Result<(), anyhow::Error> { // If the rollup throws an error, return it and stop trying to send the transaction tokio::select! { err = rollup_task => err?, - res = send_test_create_token_tx(port) => res?, + res = send_test_bank_txs(port) => res?, }; Ok(()) } -async fn send_test_create_token_tx(rpc_address: SocketAddr) -> Result<(), anyhow::Error> { - let key = DefaultPrivateKey::generate(); +async fn build_create_token_tx(key: &DefaultPrivateKey, nonce: u64) -> Transaction { let user_address: ::Address = key.to_address(); - - let token_address = sov_bank::get_token_address::( - TOKEN_NAME, - user_address.as_ref(), - TOKEN_SALT, - ); - let msg = RuntimeCall::::bank(sov_bank::CallMessage::< DefaultContext, >::CreateToken { @@ -67,16 +60,57 @@ async fn send_test_create_token_tx(rpc_address: SocketAddr) -> Result<(), anyhow let chain_id = 0; let gas_tip = 0; let gas_limit = 0; - let nonce = 0; - let tx = Transaction::::new_signed_tx( + Transaction::::new_signed_tx( &key, msg.try_to_vec().unwrap(), chain_id, gas_tip, gas_limit, nonce, + ) +} + +async fn build_transfer_token_tx( + key: &DefaultPrivateKey, + token_address: Address, + recipient: ::Address, + amount: u64, + nonce: u64, +) -> Transaction { + let msg = RuntimeCall::::bank(sov_bank::CallMessage::< + DefaultContext, + >::Transfer { + to: recipient, + coins: Coins { + amount, + token_address, + }, + }); + let chain_id = 0; + let gas_tip = 0; + let gas_limit = 0; + Transaction::::new_signed_tx( + &key, + msg.try_to_vec().unwrap(), + chain_id, + gas_tip, + gas_limit, + nonce, + ) +} + +async fn send_test_bank_txs(rpc_address: SocketAddr) -> Result<(), anyhow::Error> { + let key = DefaultPrivateKey::generate(); + let user_address: ::Address = key.to_address(); + + let token_address = sov_bank::get_token_address::( + TOKEN_NAME, + user_address.as_ref(), + TOKEN_SALT, ); + let tx = build_create_token_tx(&key, 0).await; + let port = rpc_address.port(); let client = SimpleClient::new("localhost", port).await?; @@ -102,5 +136,100 @@ async fn send_test_create_token_tx(rpc_address: SocketAddr) -> Result<(), anyhow ) .await?; assert_eq!(balance_response.amount.unwrap_or_default(), 1000); + + let recipient_key = DefaultPrivateKey::generate(); + let recipient_address: ::Address = recipient_key.to_address(); + + let tx = build_transfer_token_tx( + &key, + token_address.clone(), + recipient_address.clone(), + 100, + 1, + ) + .await; + + let mut slot_processed_subscription: Subscription = client + .ws() + .subscribe( + "ledger_subscribeSlots", + rpc_params![], + "ledger_unsubscribeSlots", + ) + .await?; + + client.send_transaction(tx).await?; + + // Wait until the rollup has processed the next slot + let _ = slot_processed_subscription.next().await; + + let balance_response = sov_bank::BankRpcClient::::balance_of( + client.http(), + None, + user_address, + token_address, + ) + .await?; + assert_eq!(balance_response.amount.unwrap_or_default(), 900); + + let tx = build_transfer_token_tx( + &key, + token_address.clone(), + recipient_address.clone(), + 200, + 2, + ) + .await; + + let mut slot_processed_subscription: Subscription = client + .ws() + .subscribe( + "ledger_subscribeSlots", + rpc_params![], + "ledger_unsubscribeSlots", + ) + .await?; + + client.send_transaction(tx).await?; + + // Wait until the rollup has processed the next slot + let _ = slot_processed_subscription.next().await; + + let balance_response = sov_bank::BankRpcClient::::balance_of( + client.http(), + None, + user_address, + token_address, + ) + .await?; + assert_eq!(balance_response.amount.unwrap_or_default(), 700); + + let balance_response = sov_bank::BankRpcClient::::balance_of( + client.http(), + Some(3), + user_address, + token_address, + ) + .await?; + assert_eq!(balance_response.amount.unwrap_or_default(), 900); + + let balance_response = sov_bank::BankRpcClient::::balance_of( + client.http(), + Some(4), + user_address, + token_address, + ) + .await?; + assert_eq!(balance_response.amount.unwrap_or_default(), 700); + + let balance_response = sov_bank::BankRpcClient::::balance_of( + client.http(), + Some(2), + user_address, + token_address, + ) + .await?; + assert_eq!(balance_response.amount.unwrap_or_default(), 1000); + Ok(()) } diff --git a/module-system/RPC_WALKTHROUGH.md b/module-system/RPC_WALKTHROUGH.md index c851e294d..99be244bb 100644 --- a/module-system/RPC_WALKTHROUGH.md +++ b/module-system/RPC_WALKTHROUGH.md @@ -128,11 +128,36 @@ fn main() { ``` ## Enabling Archival queries for RPC -We use `working_set: &mut WorkingSet` in order to query state. `WorkingSet` has a function `set_archival_version` +* We use `working_set: &mut WorkingSet` in order to query state. `WorkingSet` has a function `working_set.set_archival_version(v)` where v is of type `u64` and represents the block height. +* Once the `set_archival_version` is called, the working_set is configured to query against the state at height `v`. +* To modify an RPC query of the form ```rust - /// Sets archival version for a working set - pub fn set_archival_version(&mut self, version: Version) { - self.archival_working_set = Some(self.archival_state(version)); - self.archival_accessory_working_set = Some(self.archival_accessory_state(version)); +pub fn balance_of( + &self, + user_address: C::Address, + token_address: C::Address, + working_set: &mut WorkingSet, + ) -> RpcResult { + Ok(BalanceResponse { + amount: self.get_balance_of(user_address, token_address, working_set), + }) +} +``` +We need to make the following changes +```rust +pub fn balance_of( + &self, + version: Option, + user_address: C::Address, + token_address: C::Address, + working_set: &mut WorkingSet, + ) -> RpcResult { + if let Some(v) = version { + working_set.set_archival_version(v) } -``` \ No newline at end of file + Ok(BalanceResponse { + amount: self.get_balance_of(user_address, token_address, working_set), + }) +} +``` +* NOTE: `set_archival_version` handles configuring `WorkingSet` for both JMT state as well as accessory state \ No newline at end of file From db84955517a6db14561871429298c8db3d94749a Mon Sep 17 00:00:00 2001 From: dubbelosix Date: Tue, 9 Jan 2024 17:02:53 +0530 Subject: [PATCH 3/3] try to fix readme with using dict params --- examples/demo-rollup/README.md | 2 +- examples/demo-rollup/README_CELESTIA.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/demo-rollup/README.md b/examples/demo-rollup/README.md index 5b13a5b69..0bb54aeaa 100644 --- a/examples/demo-rollup/README.md +++ b/examples/demo-rollup/README.md @@ -253,7 +253,7 @@ $ cargo run --bin sov-cli rpc submit-batch by-address sov1l6n2cku82yfqld30lanm2n #### Verify the Token Supply ```bash,test-ci,bashtestmd:compare-output -$ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","method":"bank_supplyOf","params":["sov1zdwj8thgev2u3yyrrlekmvtsz4av4tp3m7dm5mx5peejnesga27svq9m72"],"id":1}' http://127.0.0.1:12345 +$ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","method":"bank_supplyOf","params":{"token_address":"sov1zdwj8thgev2u3yyrrlekmvtsz4av4tp3m7dm5mx5peejnesga27svq9m72"},"id":1}' http://127.0.0.1:12345 {"jsonrpc":"2.0","result":{"amount":1000},"id":1} ``` diff --git a/examples/demo-rollup/README_CELESTIA.md b/examples/demo-rollup/README_CELESTIA.md index 6aae7ef37..eaefe6fc9 100644 --- a/examples/demo-rollup/README_CELESTIA.md +++ b/examples/demo-rollup/README_CELESTIA.md @@ -299,7 +299,7 @@ This command will use your default private key. #### 4. Verify the Token Supply ```bash,test-ci,bashtestmd:compare-output -$ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","method":"bank_supplyOf","params":["sov1zdwj8thgev2u3yyrrlekmvtsz4av4tp3m7dm5mx5peejnesga27svq9m72"],"id":1}' http://127.0.0.1:12345 +$ curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","method":"bank_supplyOf","params":{"token_address":"sov1zdwj8thgev2u3yyrrlekmvtsz4av4tp3m7dm5mx5peejnesga27svq9m72"},"id":1}' http://127.0.0.1:12345 {"jsonrpc":"2.0","result":{"amount":1000},"id":1} ```