Merge pull request #8119 from Agoric/gibson-8056-followup

chore(cosmos): Update doc comments for accuracy
Agoric · Aug 7, 2023 · e2c5b5a · e2c5b5a
2 parents dbae0f3 + ceec7b6
commit e2c5b5a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/golang/cosmos/proto/agoric/vstorage/query.proto b/golang/cosmos/proto/agoric/vstorage/query.proto
@@ -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\""

diff --git a/golang/cosmos/x/vstorage/README.md b/golang/cosmos/x/vstorage/README.md
@@ -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

diff --git a/golang/cosmos/x/vstorage/types/query.pb.go b/golang/cosmos/x/vstorage/types/query.pb.go