@agoric/cosmos 0.35.0-upgrade-14-dev-8be87aa.0 → 0.35.0-upgrade-14-dev-c8f9e7b.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/cosmos",
-  "version": "0.35.0-upgrade-14-dev-8be87aa.0+8be87aa",
+  "version": "0.35.0-upgrade-14-dev-c8f9e7b.0+c8f9e7b",
   "description": "Connect JS to the Cosmos blockchain SDK",
   "parsers": {
     "js": "mjs"
@@ -35,5 +35,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8be87aadde1b9161fdd958ca487f4e9c7cf6c650"
+  "gitHead": "c8f9e7be1645e0be23f47de197409a7d4874add5"
 }

package/proto/agoric/vstorage/query.proto

@@ -9,11 +9,18 @@ option go_package = "github.com/Agoric/agoric-sdk/golang/cosmos/x/vstorage/types
 
 // Query defines the gRPC querier service
 service Query {
-  // Return an arbitrary vstorage datum.
+  // Return the raw string value of an arbitrary vstorage datum.
   rpc Data(QueryDataRequest) returns (QueryDataResponse) {
     option (google.api.http).get = "/agoric/vstorage/data/{path}";
   }
 
+  // Return a formatted representation of a vstorage datum that must be
+  // a valid StreamCell with CapData values, or standalone CapData.
+  rpc CapData(QueryCapDataRequest)
+    returns (QueryCapDataResponse) {
+      option (google.api.http).get = "/agoric/vstorage/capdata/{path}";
+  }
+
   // Return the children of a given vstorage path.
   rpc Children(QueryChildrenRequest)
     returns (QueryChildrenResponse) {
@@ -37,6 +44,51 @@ message QueryDataResponse {
   ];
 }
 
+// QueryCapDataRequest contains a path and formatting configuration.
+message QueryCapDataRequest {
+  string path = 1 [
+    (gogoproto.jsontag)    = "path",
+    (gogoproto.moretags)   = "yaml:\"path\""
+  ];
+  // mediaType must be an actual media type in the registry at
+  // https://www.iana.org/assignments/media-types/media-types.xhtml
+  // or a special value that does not conflict with the media type syntax.
+  // The only valid value is "JSON Lines", which is also the default.
+  string media_type = 2 [
+    (gogoproto.jsontag)    = "mediaType",
+    (gogoproto.moretags)   = "yaml:\"mediaType\""
+  ];
+  // itemFormat, if present, must be the special value "flat" to indicate that
+  // the deep structure of each item should be flattened into a single level
+  // with kebab-case keys (e.g., `{ "metrics": { "min": 0, "max": 88 } }` as
+  // `{ "metrics-min": 0, "metrics-max": 88 }`).
+  string item_format = 3 [
+    (gogoproto.jsontag)    = "itemFormat",
+    (gogoproto.moretags)   = "yaml:\"itemFormat\""
+  ];
+  // remotableValueFormat indicates how to transform references to opaque but
+  // distinguishable Remotables into readable embedded representations.
+  // * "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\""
+  ];
+}
+
+// QueryCapDataResponse represents the result with the requested formatting,
+// reserving space for future metadata such as media type.
+message QueryCapDataResponse {
+  string block_height = 1 [
+    (gogoproto.jsontag)    = "blockHeight",
+    (gogoproto.moretags)   = "yaml:\"blockHeight\""
+  ];
+  string value = 10 [
+    (gogoproto.jsontag)    = "value",
+    (gogoproto.moretags)   = "yaml:\"value\""
+  ];
+}
+
 // QueryChildrenRequest is the vstorage path children query.
 message QueryChildrenRequest {
   string path = 1 [

package/scripts/protocgen.sh

@@ -2,6 +2,17 @@
 
 set -eo pipefail
 
+protoc_gen_gocosmos() {
+  if ! grep "github.com/gogo/protobuf => github.com/regen-network/protobuf" go.mod &>/dev/null ; then
+    echo -e "\tPlease run this command from somewhere inside the ibc-go folder."
+    return 1
+  fi
+
+  go get github.com/regen-network/cosmos-proto/protoc-gen-gocosmos@latest 2>/dev/null
+}
+
+protoc_gen_gocosmos
+
 proto_dirs=$(find . -path ./third_party -prune -o -name '*.proto' -print0 | xargs -0 -n1 dirname | sort | uniq)
 for dir in $proto_dirs; do
   # NOTE: when migrating to grpc-gateway v2, we will need to remove the
@@ -10,7 +21,7 @@ for dir in $proto_dirs; do
   protoc \
   -I proto \
   -I third_party/proto \
-  --gocosmos_out=plugins=interfacetype+grpc,\
+  --gocosmos_out=plugins=grpc,\
 Mgoogle/protobuf/any.proto=github.com/cosmos/cosmos-sdk/codec/types:. \
   --grpc-gateway_out=logtostderr=true,allow_colon_final_segments=true:. \
   $(find "${dir}" -maxdepth 1 -name '*.proto')

package/third_party/proto/buf.yaml

@@ -20,5 +20,6 @@ lint:
     - PACKAGE_VERSION_SUFFIX
     - RPC_REQUEST_STANDARD_NAME
   ignore:
+    - cosmos_proto
     - gogoproto
     - google

package/third_party/proto/cosmos/base/query/v1beta1/pagination.proto

@@ -32,6 +32,8 @@ message PageRequest {
   bool count_total = 4;
 
   // reverse is set to true if results are to be returned in the descending order.
+  //
+  // Since: cosmos-sdk 0.43
   bool reverse = 5;
 }
 
@@ -44,7 +46,8 @@ message PageRequest {
 //  }
 message PageResponse {
   // next_key is the key to be passed to PageRequest.key to
-  // query the next page most efficiently
+  // query the next page most efficiently. It will be empty if
+  // there are no more results.
   bytes next_key = 1;
 
   // total is total number of results available if PageRequest.count_total

package/third_party/proto/cosmos/base/v1beta1/coin.proto

@@ -2,6 +2,7 @@ syntax = "proto3";
 package cosmos.base.v1beta1;
 
 import "gogoproto/gogo.proto";
+import "cosmos_proto/cosmos.proto";
 
 option go_package                       = "github.com/cosmos/cosmos-sdk/types";
 option (gogoproto.goproto_stringer_all) = false;
@@ -15,7 +16,8 @@ message Coin {
   option (gogoproto.equal) = true;
 
   string denom  = 1;
-  string amount = 2 [(gogoproto.customtype) = "Int", (gogoproto.nullable) = false];
+  string amount = 2
+      [(cosmos_proto.scalar) = "cosmos.Int", (gogoproto.customtype) = "Int", (gogoproto.nullable) = false];
 }
 
 // DecCoin defines a token with a denomination and a decimal amount.
@@ -26,15 +28,16 @@ message DecCoin {
   option (gogoproto.equal) = true;
 
   string denom  = 1;
-  string amount = 2 [(gogoproto.customtype) = "Dec", (gogoproto.nullable) = false];
+  string amount = 2
+      [(cosmos_proto.scalar) = "cosmos.Dec", (gogoproto.customtype) = "Dec", (gogoproto.nullable) = false];
 }
 
 // IntProto defines a Protobuf wrapper around an Int object.
 message IntProto {
-  string int = 1 [(gogoproto.customtype) = "Int", (gogoproto.nullable) = false];
+  string int = 1 [(cosmos_proto.scalar) = "cosmos.Int", (gogoproto.customtype) = "Int", (gogoproto.nullable) = false];
 }
 
 // DecProto defines a Protobuf wrapper around a Dec object.
 message DecProto {
-  string dec = 1 [(gogoproto.customtype) = "Dec", (gogoproto.nullable) = false];
+  string dec = 1 [(cosmos_proto.scalar) = "cosmos.Dec", (gogoproto.customtype) = "Dec", (gogoproto.nullable) = false];
 }

package/third_party/proto/cosmos/upgrade/v1beta1/upgrade.proto

@@ -4,6 +4,7 @@ package cosmos.upgrade.v1beta1;
 import "google/protobuf/any.proto";
 import "gogoproto/gogo.proto";
 import "google/protobuf/timestamp.proto";
+import "cosmos_proto/cosmos.proto";
 
 option go_package                      = "github.com/cosmos/cosmos-sdk/x/upgrade/types";
 option (gogoproto.goproto_getters_all) = false;
@@ -38,15 +39,18 @@ message Plan {
   // Deprecated: UpgradedClientState field has been deprecated. IBC upgrade logic has been
   // moved to the IBC module in the sub module 02-client.
   // If this field is not empty, an error will be thrown.
-  google.protobuf.Any upgraded_client_state = 5
-      [deprecated = true, (gogoproto.moretags) = "yaml:\"upgraded_client_state\""];
+  google.protobuf.Any upgraded_client_state = 5 [deprecated = true];
 }
 
 // SoftwareUpgradeProposal is a gov Content type for initiating a software
 // upgrade.
+// Deprecated: This legacy proposal is deprecated in favor of Msg-based gov
+// proposals, see MsgSoftwareUpgrade.
 message SoftwareUpgradeProposal {
-  option (gogoproto.equal)            = true;
-  option (gogoproto.goproto_stringer) = false;
+  option deprecated                          = true;
+  option (cosmos_proto.implements_interface) = "cosmos.gov.v1beta1.Content";
+  option (gogoproto.equal)                   = true;
+  option (gogoproto.goproto_stringer)        = false;
 
   string title       = 1;
   string description = 2;
@@ -55,15 +59,21 @@ message SoftwareUpgradeProposal {
 
 // CancelSoftwareUpgradeProposal is a gov Content type for cancelling a software
 // upgrade.
+// Deprecated: This legacy proposal is deprecated in favor of Msg-based gov
+// proposals, see MsgCancelUpgrade.
 message CancelSoftwareUpgradeProposal {
-  option (gogoproto.equal)            = true;
-  option (gogoproto.goproto_stringer) = false;
+  option deprecated                          = true;
+  option (cosmos_proto.implements_interface) = "cosmos.gov.v1beta1.Content";
+  option (gogoproto.equal)                   = true;
+  option (gogoproto.goproto_stringer)        = false;
 
   string title       = 1;
   string description = 2;
 }
 
 // ModuleVersion specifies a module and its consensus version.
+//
+// Since: cosmos-sdk 0.43
 message ModuleVersion {
   option (gogoproto.equal)            = true;
   option (gogoproto.goproto_stringer) = true;

package/third_party/proto/cosmos_proto/cosmos.proto

@@ -0,0 +1,97 @@
+syntax = "proto3";
+package cosmos_proto;
+
+import "google/protobuf/descriptor.proto";
+
+option go_package = "github.com/cosmos/cosmos-proto;cosmos_proto";
+
+extend google.protobuf.MessageOptions {
+
+    // implements_interface is used to indicate the type name of the interface
+    // that a message implements so that it can be used in google.protobuf.Any
+    // fields that accept that interface. A message can implement multiple
+    // interfaces. Interfaces should be declared using a declare_interface
+    // file option.
+    repeated string implements_interface = 93001;
+}
+
+extend google.protobuf.FieldOptions {
+
+    // accepts_interface is used to annotate that a google.protobuf.Any
+    // field accepts messages that implement the specified interface.
+    // Interfaces should be declared using a declare_interface file option.
+    string accepts_interface = 93001;
+
+    // scalar is used to indicate that this field follows the formatting defined
+    // by the named scalar which should be declared with declare_scalar. Code
+    // generators may choose to use this information to map this field to a
+    // language-specific type representing the scalar.
+    string scalar = 93002;
+}
+
+extend google.protobuf.FileOptions {
+
+    // declare_interface declares an interface type to be used with
+    // accepts_interface and implements_interface. Interface names are
+    // expected to follow the following convention such that their declaration
+    // can be discovered by tools: for a given interface type a.b.C, it is
+    // expected that the declaration will be found in a protobuf file named
+    // a/b/interfaces.proto in the file descriptor set.
+    repeated InterfaceDescriptor declare_interface = 793021;
+
+    // declare_scalar declares a scalar type to be used with
+    // the scalar field option. Scalar names are
+    // expected to follow the following convention such that their declaration
+    // can be discovered by tools: for a given scalar type a.b.C, it is
+    // expected that the declaration will be found in a protobuf file named
+    // a/b/scalars.proto in the file descriptor set.
+    repeated ScalarDescriptor declare_scalar = 793022;
+}
+
+// InterfaceDescriptor describes an interface type to be used with
+// accepts_interface and implements_interface and declared by declare_interface.
+message InterfaceDescriptor {
+
+    // name is the name of the interface. It should be a short-name (without
+    // a period) such that the fully qualified name of the interface will be
+    // package.name, ex. for the package a.b and interface named C, the
+    // fully-qualified name will be a.b.C.
+    string name = 1;
+
+    // description is a human-readable description of the interface and its
+    // purpose.
+    string description = 2;
+}
+
+// ScalarDescriptor describes an scalar type to be used with
+// the scalar field option and declared by declare_scalar.
+// Scalars extend simple protobuf built-in types with additional
+// syntax and semantics, for instance to represent big integers.
+// Scalars should ideally define an encoding such that there is only one
+// valid syntactical representation for a given semantic meaning,
+// i.e. the encoding should be deterministic.
+message ScalarDescriptor {
+
+    // name is the name of the scalar. It should be a short-name (without
+    // a period) such that the fully qualified name of the scalar will be
+    // package.name, ex. for the package a.b and scalar named C, the
+    // fully-qualified name will be a.b.C.
+    string name = 1;
+
+    // description is a human-readable description of the scalar and its
+    // encoding format. For instance a big integer or decimal scalar should
+    // specify precisely the expected encoding format.
+    string description = 2;
+
+    // field_type is the type of field with which this scalar can be used.
+    // Scalars can be used with one and only one type of field so that
+    // encoding standards and simple and clear. Currently only string and
+    // bytes fields are supported for scalars.
+    repeated ScalarType field_type = 3;
+}
+
+enum ScalarType {
+    SCALAR_TYPE_UNSPECIFIED = 0;
+    SCALAR_TYPE_STRING = 1;
+    SCALAR_TYPE_BYTES = 2;
+}

package/third_party/proto/google/api/annotations.proto

@@ -1,4 +1,4 @@
-// Copyright (c) 2015, Google Inc.
+// Copyright 2015 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.