From 3f69fac6871a690af414cd7e09e5d26d5564e567 Mon Sep 17 00:00:00 2001 From: sotnikov-s Date: Thu, 28 Nov 2024 16:18:50 +0300 Subject: [PATCH] improve ambiguous wording in KVKey and StorageValue --- proto/neutron/interchainqueries/genesis.proto | 8 ++++---- proto/neutron/interchainqueries/tx.proto | 8 ++++---- x/interchainqueries/types/genesis.pb.go | 8 ++++---- x/interchainqueries/types/tx.pb.go | 8 ++++---- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/proto/neutron/interchainqueries/genesis.proto b/proto/neutron/interchainqueries/genesis.proto index 49e083370..fc01fc66c 100644 --- a/proto/neutron/interchainqueries/genesis.proto +++ b/proto/neutron/interchainqueries/genesis.proto @@ -48,12 +48,12 @@ message RegisteredQuery { uint64 registered_at_height = 12; } -// A path to an IAVL storage node. +// Represents a path to an IAVL storage node. message KVKey { - // The first half of the storage path. It is supposed to be a substore name for the query - // (e.g. bank, staking, etc.). + // The substore name used in an Interchain Query. Typically, this corresponds to the keeper's + // storeKey, usually the module's name, such as "bank", "staking", etc. string path = 1; - // The second half of the storage path. The remaining part of the full path to an IAVL storage node. + // A hexadecimal-encoded byte array representing the key for specific data in the module's storage. bytes key = 2; } diff --git a/proto/neutron/interchainqueries/tx.proto b/proto/neutron/interchainqueries/tx.proto index 175ee3736..3c70f44fc 100644 --- a/proto/neutron/interchainqueries/tx.proto +++ b/proto/neutron/interchainqueries/tx.proto @@ -112,12 +112,12 @@ message QueryResult { // A verifiable result of performing a single KVKey read. message StorageValue { - // The first half of the storage path. It is supposed to be a substore name for the query - // (e.g. bank, staking, etc.). + // The substore name used in the read operation. Typically, this corresponds to the keeper's + // storeKey, usually the module's name, such as "bank", "staking", etc. string storage_prefix = 1; - // The second half of the storage path. The remaining part of the full path to an IAVL storage node. + // Hexadecimal-encoded bytes representing the key of the data read from the module's storage. bytes key = 2; - // A base64-encoded value read from the given storage path. + // A bytes field containing the value associated with the key in the store. bytes value = 3; // The Merkle Proof which proves existence/nonexistence of key-value pair in IAVL storage. Is // used to verify diff --git a/x/interchainqueries/types/genesis.pb.go b/x/interchainqueries/types/genesis.pb.go index b97fa175e..684aa0297 100644 --- a/x/interchainqueries/types/genesis.pb.go +++ b/x/interchainqueries/types/genesis.pb.go @@ -180,12 +180,12 @@ func (m *RegisteredQuery) GetRegisteredAtHeight() uint64 { return 0 } -// A path to an IAVL storage node. +// Represents a path to an IAVL storage node. type KVKey struct { - // The first half of the storage path. It is supposed to be a substore name for the query - // (e.g. bank, staking, etc.). + // The substore name used in an Interchain Query. Typically, this corresponds to the keeper's + // storeKey, usually the module's name, such as "bank", "staking", etc. Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"` - // The second half of the storage path. The remaining part of the full path to an IAVL storage node. + // A hexadecimal-encoded byte array representing the key for specific data in the module's storage. Key []byte `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"` } diff --git a/x/interchainqueries/types/tx.pb.go b/x/interchainqueries/types/tx.pb.go index 3dd981da0..c11339f80 100644 --- a/x/interchainqueries/types/tx.pb.go +++ b/x/interchainqueries/types/tx.pb.go @@ -348,12 +348,12 @@ func (m *QueryResult) GetAllowKvCallbacks() bool { // A verifiable result of performing a single KVKey read. type StorageValue struct { - // The first half of the storage path. It is supposed to be a substore name for the query - // (e.g. bank, staking, etc.). + // The substore name used in the read operation. Typically, this corresponds to the keeper's + // storeKey, usually the module's name, such as "bank", "staking", etc. StoragePrefix string `protobuf:"bytes,1,opt,name=storage_prefix,json=storagePrefix,proto3" json:"storage_prefix,omitempty"` - // The second half of the storage path. The remaining part of the full path to an IAVL storage node. + // Hexadecimal-encoded bytes representing the key of the data read from the module's storage. Key []byte `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"` - // A base64-encoded value read from the given storage path. + // A bytes field containing the value associated with the key in the store. Value []byte `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"` // The Merkle Proof which proves existence/nonexistence of key-value pair in IAVL storage. Is // used to verify