llama/feat-add-fee-denom-change-proposal

CHANGELOG.md

@@ -39,6 +39,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## Unreleased
 
+* Add functionality to update denom metadata via gov proposal [#270](https://github.com/provenance-io/cosmos-sdk/pull/270)
 * nothing
 
 ---

proto/cosmos/bank/v1beta1/tx.proto

@@ -16,6 +16,9 @@ service Msg {
 
   // MultiSend defines a method for sending coins from some accounts to other accounts.
   rpc MultiSend(MsgMultiSend) returns (MsgMultiSendResponse);
+
+  // UpdateDenomMetadata defines a method for updating the fee denom metadata. Only usable in x/gov proposal.
+  rpc UpdateDenomMetadata(MsgUpdateDenomMetadata) returns (MsgUpdateDenomMetadataResponse);
 }
 
 // MsgSend represents a message to send coins from one account to another.
@@ -47,3 +50,17 @@ message MsgMultiSend {
 // MsgMultiSendResponse defines the Msg/MultiSend response type.
 message MsgMultiSendResponse {}
 
+message MsgUpdateDenomMetadata {
+  option (cosmos.msg.v1.signer) = "from_address";
+
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string   from_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+  string   title        = 2;
+  string   description  = 3;
+  Metadata metadata     = 4;
+}
+
+// MsgUpdateDenomMetadataResponse defines the Msg/UpdateDenomMetadata response type.
+message MsgUpdateDenomMetadataResponse {}

simapp/app.go

@@ -259,6 +259,8 @@ func NewSimApp(
 	app.AccountKeeper = authkeeper.NewAccountKeeper(
 		appCodec, keys[authtypes.StoreKey], app.GetSubspace(authtypes.ModuleName), authtypes.ProtoBaseAccount, maccPerms, sdk.Bech32MainPrefix,
 	)
+
+	// set the governance module account as the authority
 	app.BankKeeper = bankkeeper.NewBaseKeeper(
 		appCodec, keys[banktypes.StoreKey], app.AccountKeeper, app.GetSubspace(banktypes.ModuleName), app.ModuleAccountAddrs(),
 	)

x/bank/keeper/keeper.go

@@ -18,6 +18,8 @@ import (
 
 var _ Keeper = (*BaseKeeper)(nil)
 
+const govModuleName = "gov"
+
 // Keeper defines a module interface that facilitates the transfer of coins
 // between accounts.
 type Keeper interface {
@@ -47,6 +49,8 @@ type Keeper interface {
 	DelegateCoins(ctx sdk.Context, delegatorAddr, moduleAccAddr sdk.AccAddress, amt sdk.Coins) error
 	UndelegateCoins(ctx sdk.Context, moduleAccAddr, delegatorAddr sdk.AccAddress, amt sdk.Coins) error
 
+	GetAuthority() string
+
 	types.QueryServer
 }
 
@@ -59,6 +63,7 @@ type BaseKeeper struct {
 	storeKey               storetypes.StoreKey
 	paramSpace             paramtypes.Subspace
 	mintCoinsRestrictionFn MintingRestrictionFn
+	authority  			   string
 }
 
 type MintingRestrictionFn func(ctx sdk.Context, coins sdk.Coins) error
@@ -113,6 +118,7 @@ func NewBaseKeeper(
 		storeKey:               storeKey,
 		paramSpace:             paramSpace,
 		mintCoinsRestrictionFn: func(ctx sdk.Context, coins sdk.Coins) error { return nil },
+		authority: 				authtypes.NewModuleAddress(govModuleName).String(), // hardcoded till all transitive dependencies can be updated to pass in the constructor instead
 	}
 }
 
@@ -550,3 +556,7 @@ func (k BaseViewKeeper) IterateTotalSupply(ctx sdk.Context, cb func(sdk.Coin) bo
 		}
 	}
 }
+
+func (k BaseKeeper) GetAuthority() string {
+	return k.authority
+}

x/bank/keeper/msg_server.go

@@ -2,19 +2,29 @@ package keeper
 
 import (
 	"context"
-
+	"cosmossdk.io/errors"
 	"github.com/armon/go-metrics"
-
 	"github.com/cosmos/cosmos-sdk/telemetry"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 	"github.com/cosmos/cosmos-sdk/x/bank/types"
+	gov "github.com/cosmos/cosmos-sdk/x/gov/types"
 )
 
 type msgServer struct {
 	Keeper
 }
 
+func (k msgServer) UpdateDenomMetadata(goCtx context.Context, msg *types.MsgUpdateDenomMetadata) (*types.MsgUpdateDenomMetadataResponse, error) {
+	if k.GetAuthority() != msg.FromAddress {
+		return nil, errors.Wrapf(gov.ErrInvalidSigner, "expected %s got %s", k.GetAuthority(), msg.FromAddress)
+	}
+
+	ctx := sdk.UnwrapSDKContext(goCtx)
+	k.Keeper.SetDenomMetaData(ctx, *msg.Metadata)
+	return &types.MsgUpdateDenomMetadataResponse{}, nil
+}
+
 // NewMsgServerImpl returns an implementation of the bank MsgServer interface
 // for the provided Keeper.
 func NewMsgServerImpl(keeper Keeper) types.MsgServer {
@@ -102,3 +112,4 @@ func (k msgServer) MultiSend(goCtx context.Context, msg *types.MsgMultiSend) (*t
 
 	return &types.MsgMultiSendResponse{}, nil
 }
+

x/bank/keeper/send.go

@@ -200,7 +200,7 @@ func (k BaseSendKeeper) subUnlockedCoins(ctx sdk.Context, addr sdk.AccAddress, a
 
 		_, hasNeg := sdk.Coins{spendable}.SafeSub(coin)
 		if hasNeg {
-			return sdkerrors.Wrapf(sdkerrors.ErrInsufficientFunds, "%s is smaller than %s", spendable, coin)
+			return sdkerrors.Wrapf(sdkerrors.ErrInsufficientFunds, "%s is smaller than %s", spendable, balance)
 		}
 
 		newBalance := balance.Sub(coin)

x/bank/types/codec.go

@@ -16,13 +16,15 @@ import (
 func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino) {
 	legacy.RegisterAminoMsg(cdc, &MsgSend{}, "cosmos-sdk/MsgSend")
 	legacy.RegisterAminoMsg(cdc, &MsgMultiSend{}, "cosmos-sdk/MsgMultiSend")
+	legacy.RegisterAminoMsg(cdc, &MsgUpdateDenomMetadata{}, "cosmos-sdk/MsgUpdateDenomMetadata")
 	cdc.RegisterConcrete(&SendAuthorization{}, "cosmos-sdk/SendAuthorization", nil)
 }
 
 func RegisterInterfaces(registry types.InterfaceRegistry) {
 	registry.RegisterImplementations((*sdk.Msg)(nil),
 		&MsgSend{},
 		&MsgMultiSend{},
+		&MsgUpdateDenomMetadata{},
 	)
 	registry.RegisterImplementations(
 		(*authz.Authorization)(nil),

x/bank/types/msgs.go

@@ -7,8 +7,9 @@ import (
 
 // bank message types
 const (
-	TypeMsgSend      = "send"
-	TypeMsgMultiSend = "multisend"
+	TypeMsgSend      			= "send"
+	TypeMsgMultiSend 			= "multisend"
+	TypeMsgUpdateDenomMetadata 	= "updatedenommetada"
 )
 
 var _ sdk.Msg = &MsgSend{}
@@ -184,3 +185,46 @@ func ValidateInputsOutputs(inputs []Input, outputs []Output) error {
 
 	return nil
 }
+
+
+var _ sdk.Msg = &MsgUpdateDenomMetadata{}
+
+// NewMsgUpdateDenomMetadata - construct a message to update denom metadata
+func NewMsgUpdateDenomMetadata(fromAddr, title string, description string, metadata *Metadata) *MsgUpdateDenomMetadata {
+	return &MsgUpdateDenomMetadata{
+		FromAddress: fromAddr,
+		Title: title,
+		Description: description,
+		Metadata: metadata,
+	}
+}
+
+// Route Implements Msg
+func (msg MsgUpdateDenomMetadata) Route() string {
+	return RouterKey
+}
+
+// Type Implements Msg
+func (msg MsgUpdateDenomMetadata) Type() string {
+	return TypeMsgUpdateDenomMetadata
+}
+
+// ValidateBasic Implements Msg.
+func (msg MsgUpdateDenomMetadata) ValidateBasic() error {
+	err := msg.Metadata.Validate()
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+// GetSignBytes Implements Msg.
+func (msg MsgUpdateDenomMetadata) GetSignBytes() []byte {
+	return sdk.MustSortJSON(ModuleCdc.MustMarshalJSON(&msg))
+}
+
+// GetSigners Implements Msg.
+func (msg MsgUpdateDenomMetadata) GetSigners() []sdk.AccAddress {
+	fromAddress, _ := sdk.AccAddressFromBech32(msg.FromAddress)
+	return []sdk.AccAddress{fromAddress}
+}

x/bank/types/msgs_test.go

@@ -275,3 +275,35 @@ func TestMsgSendGetSigners(t *testing.T) {
 	require.Equal(t, 1, len(res))
 	require.True(t, from.Equals(res[0]))
 }
+
+func TestUpdateDenomMetadataGetSignBytes(t *testing.T) {
+	//from := sdk.AccAddress("input")
+	//coins := sdk.NewCoins(sdk.NewInt64Coin("atom", 10))
+	msg := MsgUpdateDenomMetadata{
+		Title: "title",
+		Description: "description",
+		Metadata: &Metadata {
+			Name:        "Cosmos Hub Atom",
+			Symbol:      "ATOM",
+			Description: "The native staking token of the Cosmos Hub.",
+			DenomUnits: []*DenomUnit{
+				{"uatom", uint32(0), []string{"microatom"}},
+			},
+		},
+	}
+	res := msg.GetSignBytes()
+
+	expected := `{"type":"cosmos-sdk/MsgUpdateDenomMetadata","value":{"description":"description","metadata":{"denom_units":[{"aliases":["microatom"],"denom":"uatom"}],"description":"The native staking token of the Cosmos Hub.","name":"Cosmos Hub Atom","symbol":"ATOM"},"title":"title"}}`
+	require.Equal(t, expected, string(res))
+}
+
+func TestUpdateDenomMetadataGetSigners(t *testing.T) {
+	from := sdk.AccAddress("input111111111111111")
+	title := "Proposal Title"
+	description := "Proposal description"
+	metadata := Metadata{}
+	msg := NewMsgUpdateDenomMetadata(from.String(), title, description, &metadata)
+	res := msg.GetSigners()
+	require.Equal(t, 1, len(res))
+	require.True(t, from.Equals(res[0]))
+}