refactor: Implementing sigs.k8s.io YAML to remove .proto yaml annotations

CHANGELOG.md

@@ -39,6 +39,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Features
 
+* [\#9780](https://github.com/cosmos/cosmos-sdk/pull/9780) Remove gogoproto `moretags` YAML annotations and add `sigs.k8s.io/yaml` for YAML marshalling.
 * [\#9860](https://github.com/cosmos/cosmos-sdk/pull/9860) Emit transaction fee in ante handler fee decorator. The event type is `tx` and the attribute is `fee`.
 * [\#9776](https://github.com/cosmos/cosmos-sdk/pull/9776) Add flag `staking-bond-denom` to specify the staking bond denomination value when initializing a new chain.
 * [\#9533](https://github.com/cosmos/cosmos-sdk/pull/9533) Added a new gRPC method, `DenomOwners`, in `x/bank` to query for all account holders of a specific denomination.

client/context.go

@@ -2,13 +2,12 @@ package client
 
 import (
 	"bufio"
-	"encoding/json"
 	"io"
 	"os"
 
 	"github.com/spf13/viper"
 
-	"gopkg.in/yaml.v2"
+	"sigs.k8s.io/yaml"
 
 	"github.com/gogo/protobuf/proto"
 	"github.com/pkg/errors"
@@ -280,16 +279,9 @@ func (ctx Context) PrintObjectLegacy(toPrint interface{}) error {
 }
 
 func (ctx Context) printOutput(out []byte) error {
+	var err error
 	if ctx.OutputFormat == "text" {
-		// handle text format by decoding and re-encoding JSON as YAML
-		var j interface{}
-
-		err := json.Unmarshal(out, &j)
-		if err != nil {
-			return err
-		}
-
-		out, err = yaml.Marshal(j)
+		out, err = yaml.JSONToYAML(out)
 		if err != nil {
 			return err
 		}
@@ -300,7 +292,7 @@ func (ctx Context) printOutput(out []byte) error {
 		writer = os.Stdout
 	}
 
-	_, err := writer.Write(out)
+	_, err = writer.Write(out)
 	if err != nil {
 		return err
 	}

client/keys/parse.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/spf13/cobra"
 	"github.com/tendermint/tendermint/libs/cli"
-	yaml "gopkg.in/yaml.v2"
+	"sigs.k8s.io/yaml"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/bech32"

client/keys/utils.go

@@ -5,7 +5,7 @@ import (
 	"io"
 	"path/filepath"
 
-	yaml "gopkg.in/yaml.v2"
+	"sigs.k8s.io/yaml"
 
 	cryptokeyring "github.com/cosmos/cosmos-sdk/crypto/keyring"
 )

codec/yaml.go

@@ -1,10 +1,8 @@
 package codec
 
 import (
-	"encoding/json"
-
 	"github.com/gogo/protobuf/proto"
-	"gopkg.in/yaml.v2"
+	"sigs.k8s.io/yaml"
 )
 
 // MarshalYAML marshals toPrint using JSONCodec to leverage specialized MarshalJSON methods
@@ -18,12 +16,5 @@ func MarshalYAML(cdc JSONCodec, toPrint proto.Message) ([]byte, error) {
 		return nil, err
 	}
 
-	// generate YAML by decoding JSON and re-encoding to YAML
-	var j interface{}
-	err = json.Unmarshal(bz, &j)
-	if err != nil {
-		return nil, err
-	}
-
-	return yaml.Marshal(j)
+	return yaml.JSONToYAML(bz)
 }

docs/core/proto-docs.md

@@ -966,7 +966,7 @@ Query defines the gRPC querier service.
 | `Accounts` | [QueryAccountsRequest](#cosmos.auth.v1beta1.QueryAccountsRequest) | [QueryAccountsResponse](#cosmos.auth.v1beta1.QueryAccountsResponse) | Accounts returns all the existing accounts | GET|/cosmos/auth/v1beta1/accounts|
 | `Account` | [QueryAccountRequest](#cosmos.auth.v1beta1.QueryAccountRequest) | [QueryAccountResponse](#cosmos.auth.v1beta1.QueryAccountResponse) | Account returns account details based on address. | GET|/cosmos/auth/v1beta1/accounts/{address}|
 | `Params` | [QueryParamsRequest](#cosmos.auth.v1beta1.QueryParamsRequest) | [QueryParamsResponse](#cosmos.auth.v1beta1.QueryParamsResponse) | Params queries all parameters. | GET|/cosmos/auth/v1beta1/params|
-| `ModuleAccounts` | [QueryModuleAccountsRequest](#cosmos.auth.v1beta1.QueryModuleAccountsRequest) | [QueryModuleAccountsResponse](#cosmos.auth.v1beta1.QueryModuleAccountsResponse) | ModuleAccounts returns all the existing Module Accounts. | GET|/cosmos/auth/v1beta1/module_accounts|
+| `ModuleAccounts` | [QueryModuleAccountsRequest](#cosmos.auth.v1beta1.QueryModuleAccountsRequest) | [QueryModuleAccountsResponse](#cosmos.auth.v1beta1.QueryModuleAccountsResponse) | ModuleAccounts returns all the existing module accounts. | GET|/cosmos/auth/v1beta1/module_accounts|
 
  <!-- end services -->
 

go.mod

@@ -50,8 +50,8 @@ require (
 	google.golang.org/genproto v0.0.0-20210602131652-f16073e35f0c
 	google.golang.org/grpc v1.39.1
 	google.golang.org/protobuf v1.27.1
-	gopkg.in/yaml.v2 v2.4.0
 	nhooyr.io/websocket v1.8.6 // indirect
+	sigs.k8s.io/yaml v1.2.0
 )
 
 replace google.golang.org/grpc => google.golang.org/grpc v1.33.2

go.sum

@@ -1241,4 +1241,6 @@ rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8
 rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
 rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=
 sigs.k8s.io/yaml v1.1.0/go.mod h1:UJmg0vDUVViEyp3mgSv9WPwZCDxu4rQW1olrI1uml+o=
+sigs.k8s.io/yaml v1.2.0 h1:kr/MCeFWJWTwyaHoR9c8EjH9OumOmoF9YGiZd7lFm/Q=
+sigs.k8s.io/yaml v1.2.0/go.mod h1:yfXDCHCao9+ENCvLSE62v9VSji2MKu5jeNfTrofGhJc=
 sourcegraph.com/sourcegraph/appdash v0.0.0-20190731080439-ebfcffb1b5c0/go.mod h1:hI742Nqp5OhwiqlzhgfbWU4mW4yO10fP+LoT9WOswdU=

proto/cosmos/auth/v1beta1/auth.proto

@@ -19,8 +19,8 @@ message BaseAccount {
 
   string              address = 1;
   google.protobuf.Any pub_key = 2
-      [(gogoproto.jsontag) = "public_key,omitempty", (gogoproto.moretags) = "yaml:\"public_key\""];
-  uint64 account_number = 3 [(gogoproto.moretags) = "yaml:\"account_number\""];
+      [(gogoproto.jsontag) = "public_key,omitempty"];
+  uint64 account_number = 3;
   uint64 sequence       = 4;
 }
 
@@ -30,7 +30,7 @@ message ModuleAccount {
   option (gogoproto.goproto_stringer)        = false;
   option (cosmos_proto.implements_interface) = "ModuleAccountI";
 
-  BaseAccount     base_account = 1 [(gogoproto.embed) = true, (gogoproto.moretags) = "yaml:\"base_account\""];
+  BaseAccount     base_account = 1 [(gogoproto.embed) = true];
   string          name         = 2;
   repeated string permissions  = 3;
 }
@@ -40,11 +40,11 @@ message Params {
   option (gogoproto.equal)            = true;
   option (gogoproto.goproto_stringer) = false;
 
-  uint64 max_memo_characters     = 1 [(gogoproto.moretags) = "yaml:\"max_memo_characters\""];
-  uint64 tx_sig_limit            = 2 [(gogoproto.moretags) = "yaml:\"tx_sig_limit\""];
-  uint64 tx_size_cost_per_byte   = 3 [(gogoproto.moretags) = "yaml:\"tx_size_cost_per_byte\""];
+  uint64 max_memo_characters     = 1;
+  uint64 tx_sig_limit            = 2;
+  uint64 tx_size_cost_per_byte   = 3;
   uint64 sig_verify_cost_ed25519 = 4
-      [(gogoproto.customname) = "SigVerifyCostED25519", (gogoproto.moretags) = "yaml:\"sig_verify_cost_ed25519\""];
+      [(gogoproto.customname) = "SigVerifyCostED25519"];
   uint64 sig_verify_cost_secp256k1 = 5
-      [(gogoproto.customname) = "SigVerifyCostSecp256k1", (gogoproto.moretags) = "yaml:\"sig_verify_cost_secp256k1\""];
+      [(gogoproto.customname) = "SigVerifyCostSecp256k1"];
 }

proto/cosmos/bank/v1beta1/bank.proto

@@ -10,8 +10,8 @@ option go_package = "github.com/cosmos/cosmos-sdk/x/bank/types";
 // Params defines the parameters for the bank module.
 message Params {
   option (gogoproto.goproto_stringer)       = false;
-  repeated SendEnabled send_enabled         = 1 [(gogoproto.moretags) = "yaml:\"send_enabled,omitempty\""];
-  bool                 default_send_enabled = 2 [(gogoproto.moretags) = "yaml:\"default_send_enabled,omitempty\""];
+  repeated SendEnabled send_enabled         = 1;
+  bool                 default_send_enabled = 2;
 }
 
 // SendEnabled maps coin denom to a send_enabled status (whether a denom is

proto/cosmos/bank/v1beta1/genesis.proto

@@ -21,7 +21,7 @@ message GenesisState {
       [(gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins", (gogoproto.nullable) = false];
 
   // denom_metadata defines the metadata of the differents coins.
-  repeated Metadata denom_metadata = 4 [(gogoproto.moretags) = "yaml:\"denom_metadata\"", (gogoproto.nullable) = false];
+  repeated Metadata denom_metadata = 4 [(gogoproto.nullable) = false];
 }
 
 // Balance defines an account address and balance pair used in the bank module's

proto/cosmos/bank/v1beta1/tx.proto

@@ -21,8 +21,8 @@ message MsgSend {
   option (gogoproto.equal)           = false;
   option (gogoproto.goproto_getters) = false;
 
-  string   from_address                    = 1 [(gogoproto.moretags) = "yaml:\"from_address\""];
-  string   to_address                      = 2 [(gogoproto.moretags) = "yaml:\"to_address\""];
+  string   from_address                    = 1;
+  string   to_address                      = 2;
   repeated cosmos.base.v1beta1.Coin amount = 3
       [(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"];
 }

proto/cosmos/base/abci/v1beta1/abci.proto

@@ -72,10 +72,10 @@ message Attribute {
 // GasInfo defines tx execution gas context.
 message GasInfo {
   // GasWanted is the maximum units of work we allow this tx to perform.
-  uint64 gas_wanted = 1 [(gogoproto.moretags) = "yaml:\"gas_wanted\""];
+  uint64 gas_wanted = 1;
 
   // GasUsed is the amount of gas actually consumed.
-  uint64 gas_used = 2 [(gogoproto.moretags) = "yaml:\"gas_used\""];
+  uint64 gas_used = 2;
 }
 
 // Result is the union of ResponseFormat and ResponseCheckTx.
@@ -123,13 +123,13 @@ message SearchTxsResult {
   option (gogoproto.stringer) = true;
 
   // Count of all txs
-  uint64 total_count = 1 [(gogoproto.moretags) = "yaml:\"total_count\"", (gogoproto.jsontag) = "total_count"];
+  uint64 total_count = 1 [(gogoproto.jsontag) = "total_count"];
   // Count of txs in current page
   uint64 count = 2;
   // Index of current page, start from 1
-  uint64 page_number = 3 [(gogoproto.moretags) = "yaml:\"page_number\"", (gogoproto.jsontag) = "page_number"];
+  uint64 page_number = 3 [(gogoproto.jsontag) = "page_number"];
   // Count of total pages
-  uint64 page_total = 4 [(gogoproto.moretags) = "yaml:\"page_total\"", (gogoproto.jsontag) = "page_total"];
+  uint64 page_total = 4 [(gogoproto.jsontag) = "page_total"];
   // Max count txs per page
   uint64 limit = 5;
   // List of txs in current page

proto/cosmos/capability/v1beta1/capability.proto

@@ -10,7 +10,7 @@ import "gogoproto/gogo.proto";
 message Capability {
   option (gogoproto.goproto_stringer) = false;
 
-  uint64 index = 1 [(gogoproto.moretags) = "yaml:\"index\""];
+  uint64 index = 1;
 }
 
 // Owner defines a single capability owner. An owner is defined by the name of
@@ -19,8 +19,8 @@ message Owner {
   option (gogoproto.goproto_stringer) = false;
   option (gogoproto.goproto_getters)  = false;
 
-  string module = 1 [(gogoproto.moretags) = "yaml:\"module\""];
-  string name   = 2 [(gogoproto.moretags) = "yaml:\"name\""];
+  string module = 1;
+  string name   = 2;
 }
 
 // CapabilityOwners defines a set of owners of a single Capability. The set of

proto/cosmos/capability/v1beta1/genesis.proto

@@ -12,7 +12,7 @@ message GenesisOwners {
   uint64 index = 1;
 
   // index_owners are the owners at the given index.
-  CapabilityOwners index_owners = 2 [(gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"index_owners\""];
+  CapabilityOwners index_owners = 2 [(gogoproto.nullable) = false];
 }
 
 // GenesisState defines the capability module's genesis state.

proto/cosmos/crisis/v1beta1/genesis.proto

@@ -11,5 +11,5 @@ message GenesisState {
   // constant_fee is the fee used to verify the invariant in the crisis
   // module.
   cosmos.base.v1beta1.Coin constant_fee = 3
-      [(gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"constant_fee\""];
+      [(gogoproto.nullable) = false];
 }

proto/cosmos/crisis/v1beta1/tx.proto

@@ -17,8 +17,8 @@ message MsgVerifyInvariant {
   option (gogoproto.goproto_getters) = false;
 
   string sender                = 1;
-  string invariant_module_name = 2 [(gogoproto.moretags) = "yaml:\"invariant_module_name\""];
-  string invariant_route       = 3 [(gogoproto.moretags) = "yaml:\"invariant_route\""];
+  string invariant_module_name = 2;
+  string invariant_route       = 3;
 }
 
 // MsgVerifyInvariantResponse defines the Msg/VerifyInvariant response type.

proto/cosmos/crypto/multisig/keys.proto

@@ -12,7 +12,7 @@ option go_package = "github.com/cosmos/cosmos-sdk/crypto/keys/multisig";
 message LegacyAminoPubKey {
   option (gogoproto.goproto_getters) = false;
 
-  uint32   threshold                       = 1 [(gogoproto.moretags) = "yaml:\"threshold\""];
+  uint32   threshold                       = 1;
   repeated google.protobuf.Any public_keys = 2
-      [(gogoproto.customname) = "PubKeys", (gogoproto.moretags) = "yaml:\"pubkeys\""];
+      [(gogoproto.customname) = "PubKeys"];
 }