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

chore(cosmos): Update doc comments for accuracy #8119

Merged
merged 2 commits into from
Jul 31, 2023
Merged

chore(cosmos): Update doc comments for accuracy #8119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1cb453
chore(cosmos): Update doc comments for accuracy
gibson042 Jul 31, 2023
749a737
docs(cosmos): Fix hyperlinks
gibson042 Jul 31, 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
4 changes: 2 additions & 2 deletions golang/cosmos/proto/agoric/vstorage/query.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ message QueryCapDataRequest {
];
// remotableValueFormat indicates how to transform references to opaque but
// distinguishable Remotables into readable embedded representations.
// * "object" represents each Remotable as an `{ id, allegedName }` object.
// * "string" represents each Remotable as a bracketed string such as `[Alleged: IST brand {}]`.
// * "object" represents each Remotable as an `{ id, allegedName }` object, e.g. `{ "id": "board007", "allegedName": "IST brand" }`.
// * "string" represents each Remotable as a string with bracket-wrapped contents including its alleged name and id, e.g. "[Alleged: IST brand <board007>]".
string remotable_value_format = 10 [
(gogoproto.jsontag) = "remotableValueFormat",
(gogoproto.moretags) = "yaml:\"remotableValueFormat\""
Expand Down
6 changes: 4 additions & 2 deletions golang/cosmos/x/vstorage/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ This is used by the SwingSet "bridge".

## External protobuf interface

gRPC via [Querier](./keeper/keeper.go)
and CometBFT method "abci_query" with params `{ "path": "/agoric.vstorage.Query/...", "data": "<hexadecimal representation of serialized protobuf>" }` via the same
RPC via [Querier](./keeper/grpc_query.go)
and [CometBFT method "abci_query"](https://docs.cometbft.com/v0.37/rpc/#/ABCI/abci_query)
with params `{ "path": "/agoric.vstorage.Query/...", "data": "<hexadecimal representation of serialized protobuf>" }`
via the same
* /agoric.vstorage.Query/CapData
* /agoric.vstorage.Query/Children
* /agoric.vstorage.Query/Data
Expand Down
4 changes: 2 additions & 2 deletions golang/cosmos/x/vstorage/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.