proto: migrate x/distr to use hybrid codec

CHANGELOG.md

@@ -81,6 +81,14 @@ for JSON encoding.
   * Every reference of `crypto.Pubkey` in context of a `Validator` is now of type string. `GetPubKeyFromBech32` must be used to get the `crypto.Pubkey`.
   * The `Keeper` constructor now takes a `codec.Marshaler` instead of a concrete Amino codec. This exact type
   provided is specified by `ModuleCdc`.
+* (distr) [\#5610](https://github.com/cosmos/cosmos-sdk/pull/5610) Migrate the `x/distribution` module to use Protocol Buffer for state
+serialization instead of Amino. The exact codec used is `codec.HybridCodec` which utilizes Protobuf for binary encoding and Amino
+for JSON encoding.
+  * `ValidatorSlashEvents` is now a struct with `slashevents `.
+  * `ValidatorOutstandingRewards` is now a struct with `rewards`.
+  * `ValidatorAccumulatedCommission` is now a struct with `commission`.
+  * The `Keeper` constructor now takes a `codec.Marshaler` instead of a concrete Amino codec. This exact type
+  provided is specified by `ModuleCdc`.
 
 ### Improvements
 

Makefile

@@ -238,4 +238,23 @@ proto-lint:
 proto-check-breaking:
 	@buf check breaking --against-input '.git#branch=master'
 
-.PHONY: proto-all proto-gen proto-lint proto-check-breaking
+# Origin
+# TODO: Update to the version of Tendermint that is being used in go.mod
+version_branch = v0.33.0
+tendermint = https://raw.githubusercontent.com/tendermint/tendermint/$(version_branch)
+
+# Outputs
+tmkv = third_party/proto/tendermint/libs/kv/types.proto
+tmmerkle = third_party/proto/tendermint/crypto/merkle/merkle.proto
+tmabci = third_party/proto/tendermint/abci/types/types.proto
+
+# You *only* need to run this to rebuild protobufs from the tendermint source
+proto-update-tendermint:
+	# When running this command you will have to update the proto files with third_party imports instead of what is copied
+	@curl $(tendermint)/abci/types/types.proto > $(tmabci)
+	@curl $(tendermint)/libs/kv/types.proto > $(tmkv)
+	@curl $(tendermint)/crypto/merkle/merkle.proto > $(tmmerkle)
+	@sed 's@package types;@package abci;@' $(tmabci) > protobuf/abci.proto
+	@curl $(tendermint)/version/version.go | grep -F -eTMCoreSem -eABCISemVer > version.txt
+
+.PHONY: proto-all proto-gen proto-lint proto-check-breaking proto-update-tendermint

contrib/devtools/Makefile

@@ -48,7 +48,7 @@ UNAME_M ?= $(shell uname -m)
 GOPATH ?= $(shell $(GO) env GOPATH)
 GITHUBDIR := $(GOPATH)$(FS)src$(FS)github.com
 
-BUF_VERSION ?= 0.4.0
+BUF_VERSION ?= 0.7.0
 
 TOOLS_DESTDIR  ?= $(GOPATH)/bin
 STATIK         = $(TOOLS_DESTDIR)/statik

simapp/app.go

@@ -179,7 +179,7 @@ func NewSimApp(
 		app.SupplyKeeper, auth.FeeCollectorName,
 	)
 	app.DistrKeeper = distr.NewKeeper(
-		app.cdc, keys[distr.StoreKey], app.subspaces[distr.ModuleName], app.BankKeeper, &stakingKeeper,
+		appCodec.Distribution, keys[distr.StoreKey], app.subspaces[distr.ModuleName], app.BankKeeper, &stakingKeeper,
 		app.SupplyKeeper, auth.FeeCollectorName, app.ModuleAccountAddrs(),
 	)
 	app.SlashingKeeper = slashing.NewKeeper(

simapp/codec.go

@@ -4,6 +4,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/auth/vesting"
+	distr "github.com/cosmos/cosmos-sdk/x/distribution"
 	"github.com/cosmos/cosmos-sdk/x/staking"
 )
 
@@ -12,15 +13,17 @@ import (
 type AppCodec struct {
 	amino *codec.Codec
 
-	Staking *staking.Codec
+	Staking      *staking.Codec
+	Distribution *distr.Codec
 }
 
 func NewAppCodec() *AppCodec {
 	amino := MakeCodec()
 
 	return &AppCodec{
-		amino:   amino,
-		Staking: staking.NewCodec(amino),
+		amino:        amino,
+		Staking:      staking.NewCodec(amino),
+		Distribution: distr.NewCodec(amino),
 	}
 }
 

simapp/export.go

@@ -91,7 +91,7 @@ func (app *SimApp) prepForZeroHeightGenesis(ctx sdk.Context, jailWhiteList []str
 		// donate any unwithdrawn outstanding reward fraction tokens to the community pool
 		scraps := app.DistrKeeper.GetValidatorOutstandingRewards(ctx, val.GetOperator())
 		feePool := app.DistrKeeper.GetFeePool(ctx)
-		feePool.CommunityPool = feePool.CommunityPool.Add(scraps...)
+		feePool.CommunityPool = feePool.CommunityPool.Add(scraps.Rewards...)
 		app.DistrKeeper.SetFeePool(ctx, feePool)
 
 		app.DistrKeeper.Hooks().AfterValidatorCreated(ctx, val.GetOperator())

x/crisis/internal/types/codec.go

@@ -4,17 +4,32 @@ import (
 	"github.com/cosmos/cosmos-sdk/codec"
 )
 
-// Register concrete types on codec codec
+type Codec struct {
+	codec.Marshaler
+
+	// Keep reference to the amino codec to allow backwards compatibility along
+	// with type, and interface registration.
+	amino *codec.Codec
+}
+
+func NewCodec(amino *codec.Codec) *Codec {
+	return &Codec{Marshaler: codec.NewHybridCodec(amino), amino: amino}
+}
+
+// ----------------------------------------------------------------------------
+
+// RegisterCodec registers all the necessary crisis module concrete types and
+// interfaces with the provided codec reference.
 func RegisterCodec(cdc *codec.Codec) {
 	cdc.RegisterConcrete(MsgVerifyInvariant{}, "cosmos-sdk/MsgVerifyInvariant", nil)
 }
 
-// generic sealed codec to be used throughout module
-var ModuleCdc *codec.Codec
+// ModuleCdc defines a crisis module global Amino codec.
+var ModuleCdc *Codec
 
 func init() {
-	ModuleCdc = codec.New()
-	RegisterCodec(ModuleCdc)
-	codec.RegisterCrypto(ModuleCdc)
-	ModuleCdc.Seal()
+	ModuleCdc = NewCodec(codec.New())
+	RegisterCodec(ModuleCdc.amino)
+	codec.RegisterCrypto(ModuleCdc.amino)
+	ModuleCdc.amino.Seal()
 }

x/crisis/internal/types/msgs.go

@@ -4,13 +4,6 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
-// MsgVerifyInvariant - message struct to verify a particular invariance
-type MsgVerifyInvariant struct {
-	Sender              sdk.AccAddress `json:"sender" yaml:"sender"`
-	InvariantModuleName string         `json:"invariant_module_name" yaml:"invariant_module_name"`
-	InvariantRoute      string         `json:"invariant_route" yaml:"invariant_route"`
-}
-
 // ensure Msg interface compliance at compile time
 var _ sdk.Msg = &MsgVerifyInvariant{}