Query wasm contract state #NTRN-476 #96

foxpy · 2023-05-30T11:35:12Z

This PR adds wasm contract state query helper and example test on how to query wasm state using ICQ module.

How to review:

navigate to scripts/test_icq_wasm_juno_testnet/
read README.md
follow instructions and see whether everything works

pr0n00gler · 2023-06-15T13:11:35Z

contracts/neutron_interchain_queries/src/contract.rs

+    let mut storage_key = vec![0u8, 7u8];
+
+    storage_key.extend_from_slice("balance".as_bytes());
+    storage_key.extend_from_slice(account_address.as_bytes());


This stuff definitely should be in the SDK helpers not here

Unfortunately, it shouldn't be there, because these values are contract-dependent. I wish I could make a cw20 balance helper, but it is impossible to do.

I think Mike means that it's not only new_register_wasm_contract_store_query_msg should be in the helpers package as the most generic helper for interacting with contract's storage, but a more specific helper to register cw20 balance query as well (e.g. new_register_cw20_balance_query_msg analogically to new_register_delegator_delegations_query_msg). the helper can have contract and holder addresses as parameters and assemble the needed key inside with these vec![0u8, 7u8] and balance reused from constants defined here: https://github.com/neutron-org/neutron-sdk/blob/main/packages/neutron-sdk/src/interchain_queries/v045/types.rs

but now I wonder if we need such a helper — to query a cw20 balance

yeah, I like it how it is now, a general new_register_wasm_contract_store_query_msg is what we need here whereas cw20 balance stuff is a too specific case to be in the sdk helpers package

I could implement some kind of storage key factory like this:

let key: Vec<u8> = StorageKeyFactory::new() .push_bytes([0, 7]) .push_string("balance") .push_string(account_address) .into_bytes();

I am very hesitant creating even some kind of "general helper which works for canonical cw20-base contract" because users will definitely try to use it and it won't work in some cases.

I could implement some kind of storage key factory like this:

To be honest it doesn't make anything easier to use, I think I should abandon this idea.

contracts/neutron_interchain_queries/src/contract.rs

packages/neutron-sdk/src/interchain_queries/v045/helpers.rs

foxpy · 2023-06-15T16:50:25Z

I have no idea what's wrong about this pesky clippy workflow, everything works on my machine locally 🤷

sotnikov-s · 2023-06-16T08:07:34Z

contracts/neutron_interchain_queries/src/contract.rs

+    let mut storage_key = vec![0u8, 7u8];
+
+    storage_key.extend_from_slice("balance".as_bytes());
+    storage_key.extend_from_slice(account_address.as_bytes());


I think Mike means that it's not only new_register_wasm_contract_store_query_msg should be in the helpers package as the most generic helper for interacting with contract's storage, but a more specific helper to register cw20 balance query as well (e.g. new_register_cw20_balance_query_msg analogically to new_register_delegator_delegations_query_msg). the helper can have contract and holder addresses as parameters and assemble the needed key inside with these vec![0u8, 7u8] and balance reused from constants defined here: https://github.com/neutron-org/neutron-sdk/blob/main/packages/neutron-sdk/src/interchain_queries/v045/types.rs

sotnikov-s · 2023-06-16T08:14:26Z

contracts/neutron_interchain_queries/src/contract.rs

@@ -241,6 +283,19 @@ fn query_recipient_txs(deps: Deps<NeutronQuery>, recipient: String) -> NeutronRe
    Ok(to_binary(&GetRecipientTxsResponse { transfers: txs })?)
 }

+pub fn query_cw20_balance(


if we create a new_register_cw20_balance_query_msg in the helpers package, we should move this one to the helpers package as well

sotnikov-s · 2023-06-16T08:17:44Z

contracts/neutron_interchain_queries/src/msg.rs

    GetRegisteredQuery { query_id: u64 },
    GetRecipientTxs { recipient: String },
 }

+#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
+#[serde(rename_all = "snake_case")]
+pub struct Cw20BalanceResponse {


if we create a new_register_cw20_balance_query_msg in the helpers package, we should move this one to the helpers package as well

sotnikov-s · 2023-06-16T08:20:32Z

packages/neutron-sdk/src/interchain_queries/queries.rs

@@ -40,7 +40,7 @@ pub fn query_kv_result<T: KVReconstruct>(
 }

 /// Queries interchain query result (raw KV storage values or transactions) from Interchain Queries Module
-fn get_interchain_query_result(
+pub fn get_interchain_query_result(


why you decided to make it pub? if we want to expose it, we should make it more obvious how it's different from the query_kv_result above and highlight use cases for both funcs. I mean in this case we need to give it a better naming which will reflect that it returns a raw kv storage value for example and elaborate description

Alright, I agree, I think I will add "raw" to the name of this function and cover it with some decent documentation.

pr0n00gler · 2023-06-16T08:55:30Z

contracts/neutron_interchain_queries/src/contract.rs

+    cw20_contract_address: String,
+    account_address: String,
+) -> NeutronResult<Response<NeutronMsg>> {
+    // cw_storage_plus uses this prefix for maps


There must be an instruction how did you get this prefix, it's not obvious

~~Bold of you to assume I remember how I did that.~~

Okay, I will write some extensive docs on how to examine contract storage paths.

I have added some docs, please check them out

…ntract_state_icq

MrTalecky · 2023-06-26T15:41:20Z

@foxpy hi!
A few additions to the readme file:

there is no make build command
It's not clear what directory to run the scripts from

Perhaps the instructions should be added for users with M1 processors, which will have problems with the build.
You just need to do three things:

Remove the file cargo.lock
Run rm -rf target/
Re-run make build

But it's up to you)

foxpy closed this May 30, 2023

foxpy force-pushed the feat/NTRN-476_wasm_contract_state_icq branch from e9d4ae2 to 3841c59 Compare May 30, 2023 11:38

foxpy reopened this May 30, 2023

foxpy force-pushed the feat/NTRN-476_wasm_contract_state_icq branch 2 times, most recently from b3b537b to 45ef7ce Compare June 6, 2023 06:02

foxpy changed the title ~~wip #NTRN-476~~ Query wasm contract state #NTRN-476 Jun 6, 2023

foxpy marked this pull request as ready for review June 6, 2023 06:05

foxpy marked this pull request as draft June 6, 2023 06:14

foxpy force-pushed the feat/NTRN-476_wasm_contract_state_icq branch 2 times, most recently from ced6feb to 8f4e96d Compare June 6, 2023 11:48

feat: query wasm contract state

f4e855d

foxpy marked this pull request as ready for review June 6, 2023 12:05

foxpy force-pushed the feat/NTRN-476_wasm_contract_state_icq branch from 8f4e96d to f4e855d Compare June 6, 2023 12:07

pr0n00gler requested review from pr0n00gler and sotnikov-s June 14, 2023 09:19

pr0n00gler requested changes Jun 15, 2023

View reviewed changes

review-fix: better documentation link

3d616ab

foxpy requested a review from pr0n00gler June 15, 2023 15:53

review-fix: implement KVReconstruct for Uint128

4b5067f

sotnikov-s reviewed Jun 16, 2023

View reviewed changes

pr0n00gler reviewed Jun 16, 2023

View reviewed changes

foxpy added 4 commits June 16, 2023 15:44

Merge remote-tracking branch 'origin/main' into feat/NTRN-476_wasm_co…

dc2cabb

…ntract_state_icq

review-fix: document get_raw_icq_result()

03b004c

chore: fix cargo doc warning

3ce6204

review-fix: add docs on how to obtain storage keys

d685b79

pr0n00gler previously approved these changes Jun 19, 2023

View reviewed changes

sotnikov-s previously approved these changes Jun 20, 2023

View reviewed changes

review-fix: better README instructions

4cf3899

foxpy dismissed stale reviews from sotnikov-s and pr0n00gler via 4cf3899 June 28, 2023 12:11

foxpy requested review from pr0n00gler, sotnikov-s and MrTalecky June 28, 2023 12:12

sotnikov-s approved these changes Jun 28, 2023

View reviewed changes

pr0n00gler approved these changes Jun 30, 2023

View reviewed changes

pr0n00gler merged commit 141d4b7 into main Jun 30, 2023
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Query wasm contract state #NTRN-476 #96

Query wasm contract state #NTRN-476 #96

foxpy commented May 30, 2023 •

edited

Loading

pr0n00gler Jun 15, 2023

foxpy Jun 15, 2023

sotnikov-s Jun 16, 2023

sotnikov-s Jun 16, 2023

sotnikov-s Jun 16, 2023

foxpy Jun 16, 2023

foxpy Jun 16, 2023

foxpy Jun 16, 2023

foxpy commented Jun 15, 2023

sotnikov-s Jun 16, 2023

sotnikov-s Jun 16, 2023

sotnikov-s Jun 16, 2023

sotnikov-s Jun 16, 2023

foxpy Jun 16, 2023

foxpy Jun 16, 2023

pr0n00gler Jun 16, 2023

foxpy Jun 16, 2023

foxpy Jun 19, 2023

MrTalecky commented Jun 26, 2023

Query wasm contract state #NTRN-476 #96

Query wasm contract state #NTRN-476 #96

Conversation

foxpy commented May 30, 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

Choose a reason for hiding this comment

foxpy commented Jun 15, 2023

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MrTalecky commented Jun 26, 2023

foxpy commented May 30, 2023 •

edited

Loading