feat(tokenfactory): burn native method (#1832)

* refactor: move Burn rpc method to x/tokenfactory

* Update tx_msgs.go

* feat: add burn native method to tokenfactory msg server

* feat: add cli cmd

* fix: validate msg

* feat: add v1.2.0 upgrade handler

* Update CHANGELOG.md

* fix: register codec for MsgBurnNative

* fix: test

---------

Co-authored-by: Unique-Divine <realuniquedivine@gmail.com>

CHANGELOG.md

@@ -49,7 +49,7 @@ Nibiru v1.2.0 adds a burn method to the x/inflation module that allows senders t
 
 ### Features
 
-* [#1823](https://github.com/NibiruChain/nibiru/pull/1823) - feat(inflation): add burn method
+* [#1832](https://github.com/NibiruChain/nibiru/pull/1832) - feat(tokenfactory): add burn method for native tokens
 
 ## [v1.1.0](https://github.com/NibiruChain/nibiru/releases/tag/v1.1.0) - 2024-03-19
 

app/upgrades.go

@@ -11,13 +11,15 @@ import (
 	"github.com/NibiruChain/nibiru/app/upgrades/v1_0_1"
 	"github.com/NibiruChain/nibiru/app/upgrades/v1_0_2"
 	"github.com/NibiruChain/nibiru/app/upgrades/v1_1_0"
+	"github.com/NibiruChain/nibiru/app/upgrades/v1_2_0"
 )
 
 var Upgrades = []upgrades.Upgrade{
 	v1_0_1.Upgrade,
 	v1_0_2.Upgrade,
 	v1_0_3.Upgrade,
 	v1_1_0.Upgrade,
+	v1_2_0.Upgrade,
 }
 
 func (app *NibiruApp) setupUpgrades() {

app/upgrades/v1_2_0/constants.go

@@ -0,0 +1,22 @@
+package v1_2_0
+
+import (
+	"github.com/cosmos/cosmos-sdk/store/types"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/types/module"
+	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
+
+	"github.com/NibiruChain/nibiru/app/upgrades"
+)
+
+const UpgradeName = "v1.2.0"
+
+var Upgrade = upgrades.Upgrade{
+	UpgradeName: UpgradeName,
+	CreateUpgradeHandler: func(mm *module.Manager, cfg module.Configurator) upgradetypes.UpgradeHandler {
+		return func(ctx sdk.Context, plan upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
+			return mm.RunMigrations(ctx, cfg, fromVM)
+		}
+	},
+	StoreUpgrades: types.StoreUpgrades{},
+}

proto/nibiru/inflation/v1/tx.proto

@@ -19,10 +19,6 @@ service Msg {
       returns (MsgEditInflationParamsResponse) {
     option (google.api.http).post = "/nibiru/inflation/edit-inflation-params";
   };
-
-  rpc Burn(MsgBurn) returns (MsgBurnResponse) {
-    option (google.api.http).post = "/nibiru/inflation/v1/burn";
-  };
 }
 
 // MsgToggleInflation defines a message to enable or disable inflation.

proto/nibiru/tokenfactory/v1/tx.proto

@@ -24,6 +24,9 @@ service Msg {
   rpc Burn(MsgBurn) returns (MsgBurnResponse);
   rpc SetDenomMetadata(MsgSetDenomMetadata)
       returns (MsgSetDenomMetadataResponse);
+
+  // burns a native token such as unibi
+  rpc BurnNative(MsgBurnNative) returns (MsgBurnNativeResponse) {};
 }
 
 // MsgCreateDenom: sdk.Msg that registers an a token factory denom.
@@ -114,3 +117,12 @@ message MsgSetDenomMetadata {
 }
 
 message MsgSetDenomMetadataResponse {}
+
+// Burn a native token such as unibi
+message MsgBurnNative {
+  string sender = 1 [ (gogoproto.moretags) = "yaml:\"sender\"" ];
+  cosmos.base.v1beta1.Coin coin = 2
+      [ (gogoproto.moretags) = "yaml:\"coin\"", (gogoproto.nullable) = false ];
+}
+
+message MsgBurnNativeResponse {}

x/inflation/keeper/msg_server.go

@@ -46,17 +46,3 @@ func (ms msgServer) ToggleInflation(
 	resp = &types.MsgToggleInflationResponse{}
 	return resp, err
 }
-
-func (ms msgServer) Burn(
-	goCtx context.Context, msg *types.MsgBurn,
-) (resp *types.MsgBurnResponse, err error) {
-	ctx := sdk.UnwrapSDKContext(goCtx)
-
-	sender, err := sdk.AccAddressFromBech32(msg.Sender)
-	if err != nil {
-		return nil, err
-	}
-
-	err = ms.Keeper.Burn(ctx, sdk.NewCoins(msg.Coin), sender)
-	return &types.MsgBurnResponse{}, err
-}

x/inflation/keeper/msg_server_test.go

@@ -70,45 +70,3 @@ func TestMsgEditInflationParams(t *testing.T) {
 	params = app.InflationKeeper.GetParams(ctx)
 	require.EqualValues(t, params.EpochsPerPeriod, 42)
 }
-
-func TestMsgBurn(t *testing.T) {
-	app, ctx := testapp.NewNibiruTestAppAndContext()
-	sender := testutil.AccAddress()
-	err := app.BankKeeper.MintCoins(ctx, types.ModuleName, sdk.NewCoins(sdk.NewCoin("unibi", sdk.NewInt(100))))
-	require.NoError(t, err)
-	err = app.BankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, sender, sdk.NewCoins(sdk.NewCoin("unibi", sdk.NewInt(100))))
-	require.NoError(t, err)
-
-	msgServer := keeper.NewMsgServerImpl(app.InflationKeeper)
-
-	msg := types.MsgBurn{
-		Sender: sender.String(),
-		Coin:   sdk.NewCoin("unibi", sdk.NewInt(100)),
-	}
-
-	_, err = msgServer.Burn(ctx, &msg)
-	require.NoError(t, err)
-	supply := app.BankKeeper.GetSupply(ctx, "unibi")
-	require.Equal(t, sdk.ZeroInt(), supply.Amount)
-}
-
-func TestMsgBurn_NotEnoughCoins(t *testing.T) {
-	app, ctx := testapp.NewNibiruTestAppAndContext()
-	sender := testutil.AccAddress()
-	err := app.BankKeeper.MintCoins(ctx, types.ModuleName, sdk.NewCoins(sdk.NewCoin("unibi", sdk.NewInt(100))))
-	require.NoError(t, err)
-	err = app.BankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, sender, sdk.NewCoins(sdk.NewCoin("unibi", sdk.NewInt(100))))
-	require.NoError(t, err)
-
-	msgServer := keeper.NewMsgServerImpl(app.InflationKeeper)
-
-	msg := types.MsgBurn{
-		Sender: sender.String(),
-		Coin:   sdk.NewCoin("unibi", sdk.NewInt(101)),
-	}
-
-	_, err = msgServer.Burn(ctx, &msg)
-	require.EqualError(t, err, "spendable balance 100unibi is smaller than 101unibi: insufficient funds")
-	supply := app.BankKeeper.GetSupply(ctx, "unibi")
-	require.Equal(t, sdk.NewInt(100), supply.Amount)
-}