Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add clarifications to the order of list response in query #103

Merged
merged 6 commits into from
Aug 25, 2023
Merged

docs: add clarifications to the order of list response in query #103

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
af9b259
docs: add clarification to the order of list response in query
170210 Aug 25, 2023
af96b8f
chore: make proto-gen and format
170210 Aug 25, 2023
72a9a47
chore: add this pr to CHANGELOG
170210 Aug 25, 2023
32258b3
fixup: fix for comment
170210 Aug 25, 2023
9f96275
fixup: merge main
170210 Aug 25, 2023
19c61d4
fixup: fix for comment
170210 Aug 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
### Document Updates
* [\#54](https://github.com/Finschia/wasmd/pull/54) add documentation about errors (codespace and codes)
* [\#92](https://github.com/Finschia/wasmd/pull/92) modify links in x/wasmplus README.md
* [\#103](https://github.com/Finschia/wasmd/pull/103) add clarifications to the order of list response in query


## [v0.1.4](https://github.com/Finschia/wasmd/releases/tag/v0.1.4) - 2023.05.22
Expand Down
10 changes: 5 additions & 5 deletions docs/proto/proto-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -985,7 +985,7 @@ Query/AllContractState RPC method

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `models` | [Model](#cosmwasm.wasm.v1.Model) | repeated | |
| `models` | [Model](#cosmwasm.wasm.v1.Model) | repeated | return in alphabetical order of the state's keys |
| `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | pagination defines the pagination in the response. |


Expand Down Expand Up @@ -1047,7 +1047,7 @@ QueryCodesResponse is the response type for the Query/Codes RPC method

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `code_infos` | [CodeInfoResponse](#cosmwasm.wasm.v1.CodeInfoResponse) | repeated | |
| `code_infos` | [CodeInfoResponse](#cosmwasm.wasm.v1.CodeInfoResponse) | repeated | return in the order of code_id |
| `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | pagination defines the pagination in the response. |


Expand Down Expand Up @@ -1081,7 +1081,7 @@ Query/ContractHistory RPC method

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `entries` | [ContractCodeHistoryEntry](#cosmwasm.wasm.v1.ContractCodeHistoryEntry) | repeated | |
| `entries` | [ContractCodeHistoryEntry](#cosmwasm.wasm.v1.ContractCodeHistoryEntry) | repeated | return in the order of contract execution |
loloicci marked this conversation as resolved.
Show resolved Hide resolved
| `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | pagination defines the pagination in the response. |


Expand Down Expand Up @@ -1148,7 +1148,7 @@ Query/ContractsByCode RPC method

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `contracts` | [string](#string) | repeated | contracts are a set of contract addresses |
| `contracts` | [string](#string) | repeated | contracts are a set of contract addresses return in the order of instantiation |
loloicci marked this conversation as resolved.
Show resolved Hide resolved
| `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | pagination defines the pagination in the response. |


Expand Down Expand Up @@ -1206,7 +1206,7 @@ Query/PinnedCodes RPC method

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| `code_ids` | [uint64](#uint64) | repeated | |
| `code_ids` | [uint64](#uint64) | repeated | return in the order of code_id |
| `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | pagination defines the pagination in the response. |


Expand Down
5 changes: 5 additions & 0 deletions proto/cosmwasm/wasm/v1/query.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ message QueryContractHistoryRequest {
// QueryContractHistoryResponse is the response type for the
// Query/ContractHistory RPC method
message QueryContractHistoryResponse {
// return in the order of contract execution
repeated ContractCodeHistoryEntry entries = 1
[ (gogoproto.nullable) = false ];
// pagination defines the pagination in the response.
Expand All @@ -115,6 +116,7 @@ message QueryContractsByCodeRequest {
// Query/ContractsByCode RPC method
message QueryContractsByCodeResponse {
// contracts are a set of contract addresses
// return in the order of instantiation
repeated string contracts = 1;

// pagination defines the pagination in the response.
Expand All @@ -133,6 +135,7 @@ message QueryAllContractStateRequest {
// QueryAllContractStateResponse is the response type for the
// Query/AllContractState RPC method
message QueryAllContractStateResponse {
// return in alphabetical order of the state's keys
repeated Model models = 1 [ (gogoproto.nullable) = false ];
// pagination defines the pagination in the response.
cosmos.base.query.v1beta1.PageResponse pagination = 2;
Expand Down Expand Up @@ -207,6 +210,7 @@ message QueryCodesRequest {

// QueryCodesResponse is the response type for the Query/Codes RPC method
message QueryCodesResponse {
// return in the order of code_id
repeated CodeInfoResponse code_infos = 1 [ (gogoproto.nullable) = false ];
// pagination defines the pagination in the response.
cosmos.base.query.v1beta1.PageResponse pagination = 2;
Expand All @@ -222,6 +226,7 @@ message QueryPinnedCodesRequest {
// QueryPinnedCodesResponse is the response type for the
// Query/PinnedCodes RPC method
message QueryPinnedCodesResponse {
// return in the order of code_id
repeated uint64 code_ids = 1
[ (gogoproto.nullable) = false, (gogoproto.customname) = "CodeIDs" ];
// pagination defines the pagination in the response.
Expand Down
5 changes: 5 additions & 0 deletions x/wasm/types/query.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.