Implements Account balance list cli #760

baichuan3 · 2023-09-06T14:47:48Z

resolve #744

Problems
1, It is hard to support converting from AnnotatedMoveValueView to AnnotatedMoveValue, mainly because of it hard to support convert SpecificStruct to AnnotatedMoveStruct. As a result, parsing AnnotatedCoinStoreView from the RPC API is very tedious. relative of #758
2, The current implementation of AnnotatedMoveValueView may be flawed. Coin balance defines the U256 type, but the type obtained from AnnotatedMoveValueView is U64(StrView(10000), and the expected type is U256(StrView(10000). May return U128(StrView(value) type.
3, Type_table exposes the method of obtaining the handle, is it reasonable to expose the handle, and will this method have security problems?

// Returns table handle of `table`.
public fun handle(table: &TypeTable): &ObjectID {
      &table.handle
}

value: {Identifier("value"): U64(StrView(10000))} })

TODO
1, Coin balance needs to depend on CoinInfo to display the decimal point after processing decimals
2，Add test case for the balance command

Example

Publish coin examples

rooch move publish -p examples/coins --sender-account 0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7  --named-addresses coins=0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7

Call faucet to get test coin

rooch move run --function 0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7::fixed_supply_coin::faucet  --sender-account 0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7

Call Account balance cli

rooch account balance -a 0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7

Result

                                              Coin Type                                                |             Balance
------------------------------------------------
0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7::fixed_supply_coin::FSC |              10000
0x3::gas_coin::GasCoin |            9996919761

Call Account balance cli with coin-type

rooch account balance -a 0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7 --coin-type "0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7::fixed_supply_coin::FSC"

Result

Coin Type                                                |             Balance
------------------------------------------------
0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7::fixed_supply_coin::FSC |              10000

vercel · 2023-09-06T14:47:52Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
rooch	⬜️ Ignored (Inspect)	Visit Preview		Sep 7, 2023 7:10am

jolestar · 2023-09-06T15:38:20Z

crates/rooch/src/commands/account/commands/balance.rs

+        let coin_store_handle_opt: Option<ObjectID> = client
+            .call_function(&ctx, call)?
+            .into_result()
+            .map(|values| {
+                let value = values.get(0).expect("Expected return value");
+                let result = MoveOption::<ObjectID>::from_bytes(&value.value)
+                    .expect("Expected Option<ObjectID>");
+                result.into()
+            })?;
+        let coin_store_handle = coin_store_handle_opt
+            // .expect(format!("Failed to get coin store handle via {}", addr).as_str());
+            .unwrap_or_else(|| panic!("Failed to get coin store handle via {}", addr));


Directly call the coin_module::coin_store_handle?

I tried it before, but there are some problems.

After binding coin_mudule, await occurs here, with coin_mudule maybe used later.

the trait Sync is not implemented for dyn MoveFunctionCaller, future is not Send as this value is used across an await.

The client has already implemented the MoveFunctionCaller.

rooch/crates/rooch/src/commands/session_key/commands/create.rs

Lines 71 to 79 in a635258

let session_key_module = client.as_module_binding::<SessionKeyModule>();

let session_key = session_key_module

.get_session_key(sender.into(), &session_auth_key)?

.ok_or_else(|| {

RoochError::ViewFunctionError(format!(

"Failed to get session key via {}",

session_auth_key

))

})?;

The difference is whether MoveFunctionCaller is called by async/await.

You can open these two lines of comments, cargo build to see the specific error.

rooch/crates/rooch/src/commands/account/commands/balance.rs

Lines 73 to 74 in 370bb0e

// let coin_module = client.as_module_binding::<CoinModule>();

// let coin_store_handle_opt = coin_module.coin_store_handle(addr)?;

jolestar · 2023-09-06T15:42:40Z

crates/rooch/src/commands/account/commands/balance.rs

+    /// Struct name as `<ADDRESS>::<MODULE_ID>::<STRUCT_NAME><TypeParam1?, TypeParam2?>`
+    /// Example: `0x123::counter::Counter`, `0x123::counter::Box<0x123::counter::Counter>`
+    #[clap(long = "coin_type")]
+    /// The block number or block hash for get state, if absent, use latest block state_root.


This line of code comment is probably a copying error

This line of code comment is probably a copying error

fixed

jolestar · 2023-09-06T15:44:03Z

crates/rooch/src/commands/account/commands/balance.rs

+    address: Option<AccountAddressView>,
+
+    /// Struct name as `<ADDRESS>::<MODULE_ID>::<STRUCT_NAME><TypeParam1?, TypeParam2?>`
+    /// Example: `0x123::counter::Counter`, `0x123::counter::Box<0x123::counter::Counter>`


Give a coin struct_tag example

jolestar · 2023-09-06T15:46:57Z

rooch account balance -a 0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7 --coin_type "0x3::coin::CoinStore<0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7::fixed_supply_coin::FSC>"

The coin-type arg should be 0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7::fixed_supply_coin::FSC, remove the 0x3::coin::CoinStore?

and

Coin Type                                                |             Balance
------------------------------------------------
0x3::coin::Coin<0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7::fixed_supply_coin::FSC> |              10000

We can remove the 0x3::coin::Coin from the result Coin Type.

jolestar · 2023-09-06T15:50:08Z

crates/rooch/src/commands/account/commands/balance.rs

+
+    /// Struct name as `<ADDRESS>::<MODULE_ID>::<STRUCT_NAME><TypeParam1?, TypeParam2?>`
+    /// Example: `0x123::counter::Counter`, `0x123::counter::Box<0x123::counter::Counter>`
+    #[clap(long = "coin_type")]


Just use #[clap(long)]. The CLI option should use - instead of _.

baichuan3 · 2023-09-07T03:47:00Z

rooch account balance -a 0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7 --coin_type "0x3::coin::CoinStore<0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7::fixed_supply_coin::FSC>"
The coin-type arg should be 0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7::fixed_supply_coin::FSC, remove the 0x3::coin::CoinStore?

and
Coin Type                                                |             Balance
------------------------------------------------
0x3::coin::Coin<0xe1176537c0175d336353dad12f7eb60c658ce526eeb3cd08409e6fd8c2dfa1d7::fixed_supply_coin::FSC> |              10000
We can remove the 0x3::coin::Coin from the result Coin Type.

already remove

jolestar · 2023-09-07T06:32:19Z

crates/rooch-rpc-api/src/jsonrpc_types/rooch_types.rs

@@ -256,7 +256,7 @@ impl AnnotatedCoinStoreView {
        }
    }

-    pub fn get_coin_type(&self) -> StructTagView {
+    pub fn get_coin_type_(&self) -> StructTagView {


Why need _?

This coin type contains 0x3::coin::Coin<>, corresponding to the type of filed_value, in order to distinguish the cointype in BalanceInfo.

rooch/crates/rooch-types/src/framework/coin.rs

Line 79 in 467707e

let coin_type_ = filed_value.type_;

jolestar · 2023-09-07T06:40:51Z

crates/rooch-types/src/framework/coin.rs

+        Ok(annotated_coin_store)
+    }
+
+    pub fn get_coin_type__(&self) -> StructTag {


there two _

baichuan3 · 2023-09-07T08:00:43Z

I will merge the pr first

baichuan3 added 3 commits September 4, 2023 19:05

implements account balance cli

a1d1dc9

support annotaed coin state parse from anotated move value

452f388

finish account balance cli

c55fb95

baichuan3 requested review from jolestar, wow-sven and pause125 as code owners September 6, 2023 14:47

jolestar reviewed Sep 6, 2023

View reviewed changes

remove the 0x3::coin::Coin from the result Coin Type and other fixup

467707e

baichuan3 mentioned this pull request Sep 7, 2023

[Type] The field type returned by AnnotatedMoveValueView is inconsistent with the actual type #762

Open

jolestar reviewed Sep 7, 2023

View reviewed changes

jolestar approved these changes Sep 7, 2023

View reviewed changes

add as_module_binding code

370bb0e

baichuan3 merged commit 6fc4471 into main Sep 7, 2023

baichuan3 deleted the account_balance_list branch September 7, 2023 08:00

baichuan3 mentioned this pull request Sep 10, 2023

Refactor account balance for support balance API and add some test case #774

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implements Account balance list cli #760

Implements Account balance list cli #760

baichuan3 commented Sep 6, 2023 •

edited

Loading

vercel bot commented Sep 6, 2023 •

edited

Loading

jolestar Sep 6, 2023

baichuan3 Sep 7, 2023

jolestar Sep 7, 2023

baichuan3 Sep 7, 2023

jolestar Sep 6, 2023

baichuan3 Sep 7, 2023

jolestar Sep 6, 2023

jolestar commented Sep 6, 2023

jolestar Sep 6, 2023

baichuan3 commented Sep 7, 2023

jolestar Sep 7, 2023

baichuan3 Sep 7, 2023

jolestar Sep 7, 2023

baichuan3 commented Sep 7, 2023

	let session_key_module = client.as_module_binding::<SessionKeyModule>();
	let session_key = session_key_module
	.get_session_key(sender.into(), &session_auth_key)?
	.ok_or_else(\|\| {
	RoochError::ViewFunctionError(format!(
	"Failed to get session key via {}",
	session_auth_key
	))
	})?;

	// let coin_module = client.as_module_binding::<CoinModule>();
	// let coin_store_handle_opt = coin_module.coin_store_handle(addr)?;

Implements Account balance list cli #760

Implements Account balance list cli #760

Conversation

baichuan3 commented Sep 6, 2023 • edited Loading

vercel bot commented Sep 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jolestar commented Sep 6, 2023

Choose a reason for hiding this comment

baichuan3 commented Sep 7, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

baichuan3 commented Sep 7, 2023

baichuan3 commented Sep 6, 2023 •

edited

Loading

vercel bot commented Sep 6, 2023 •

edited

Loading