test(v2.9): burn unused tx fees

app/app_test/test_helpers.go

@@ -16,6 +16,7 @@ import (
 	"github.com/stretchr/testify/suite"
 	terra_app "github.com/terra-money/core/v2/app"
 	appparams "github.com/terra-money/core/v2/app/params"
+	feeburntypes "github.com/terra-money/core/v2/x/feeburn/types"
 	feesharetypes "github.com/terra-money/core/v2/x/feeshare/types"
 	tokenfactorytypes "github.com/terra-money/core/v2/x/tokenfactory/types"
 
@@ -80,6 +81,9 @@ func (s *AppTestSuite) Setup() {
 	err = s.App.Keepers.TokenFactoryKeeper.SetParams(s.Ctx, tokenfactorytypes.DefaultParams())
 	s.Require().NoError(err)
 
+	err = s.App.Keepers.FeeBurnKeeper.SetParams(s.Ctx, feeburntypes.DefaultParams())
+	s.Require().NoError(err)
+
 	err = s.FundModule(authtypes.FeeCollectorName, sdk.NewCoins(sdk.NewCoin("uluna", sdk.NewInt(1000)), sdk.NewCoin("utoken", sdk.NewInt(500))))
 	s.Require().NoError(err)
 

app/genesis_test.go

@@ -104,6 +104,11 @@ func TestGenesis(t *testing.T) {
 		"evidence": {
 			"evidence": []
 		},
+		"feeburn": {
+		  "params": {
+			"enable_fee_burn": true
+		  }
+		},
 		"feegrant": {
 			"allowances": []
 		},

integration-tests/package.json

@@ -35,7 +35,7 @@
     "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@terra-money/feather.js": "^2.0.0-beta.15",
+    "@terra-money/feather.js": "^2.0.0-beta.16",
     "moment": "^2.29.4"
   }
 }

integration-tests/src/modules/feeburn/feeburn.test.ts

@@ -0,0 +1,51 @@
+import { Coins, Fee, MnemonicKey, MsgSend } from "@terra-money/feather.js";
+import { getMnemonics, getLCDClient, blockInclusion } from "../../helpers";
+
+describe("FeeBurn Module (https://github.com/terra-money/core/tree/release/v2.9/x/feeburn) ", () => {
+    // Prepare environment clients, accounts and wallets
+    const LCD = getLCDClient();
+    const accounts = getMnemonics();
+    const wallet = LCD.chain1.wallet(accounts.mnemonic2);
+    const randomAddress = new MnemonicKey().accAddress("terra");
+
+    test('Must burn unused TX Fees', async () => {
+        const sendTx = await wallet.createAndSignTx({
+            msgs: [new MsgSend(
+                wallet.key.accAddress("terra"),
+                randomAddress,
+                new Coins({ uluna: 1 }),
+            )],
+            chainID: "test-1",
+            fee: new Fee(200_000, new Coins({ uluna: 3_000 })),
+        });
+
+        const result = await LCD.chain1.tx.broadcastSync(sendTx, "test-1");
+        await blockInclusion();
+        const txResult = await LCD.chain1.tx.txInfo(result.txhash, "test-1");
+        const eventsLength = txResult.events.length;
+        expect([txResult.events[eventsLength - 2], txResult.events[eventsLength - 1]])
+            .toStrictEqual([{
+                "type": "burn",
+                "attributes": [{
+                    "key": "burner",
+                    "value": "terra17xpfvakm2amg962yls6f84z3kell8c5lkaeqfa",
+                    "index": true
+                }, {
+                    "key": "amount",
+                    "value": "1768uluna",
+                    "index": true
+                }]
+            }, {
+                "type": "terra.feeburn.v1.FeeBurnEvent",
+                "attributes": [{
+                    "key": "burn_rate",
+                    "value": "\"0.589615000000000000\"",
+                    "index": true
+                }, {
+                    "key": "fees_burn",
+                    "value": "[{\"denom\":\"uluna\",\"amount\":\"1768\"}]",
+                    "index": true
+                }]
+            }]);
+    });
+});

proto/terra/feeburn/v1/events.proto

@@ -8,8 +8,12 @@ option go_package = "github.com/terra-money/core/v2/x/feeburn/types";
 
 // Event fired when fees are burned with the amount of fees burned
 message FeeBurnEvent {
-    // Amount of the payout
-    repeated cosmos.base.v1beta1.Coin fees_burn = 1 [
+  // Amount of the payout
+  repeated cosmos.base.v1beta1.Coin fees_burn = 1 [(gogoproto.nullable) = false];
+
+  // Calculated % of the fees burned before truncating the decimal
+  string burn_rate = 2 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
     (gogoproto.nullable) = false
   ];
 }

x/feeburn/post/post.go

@@ -1,6 +1,8 @@
 package post
 
 import (
+	"fmt"
+
 	errorsmod "cosmossdk.io/errors"
 	"cosmossdk.io/math"
 	sdk "github.com/cosmos/cosmos-sdk/types"
@@ -18,9 +20,9 @@ func NewFeeBurnDecorator(feeBurnKeeper FeeBurnKeeper, bankkeeper BankKeeper) Fee
 	return FeeBurnDecorator{feeBurnKeeper, bankkeeper}
 }
 
-func (bd FeeBurnDecorator) PostHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, success bool, next sdk.PostHandler) (newCtx sdk.Context, err error) {
+func (fbd FeeBurnDecorator) PostHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, success bool, next sdk.PostHandler) (newCtx sdk.Context, err error) {
 	// if the feeburn is not enabled then just continue with the next decorator
-	if !bd.feeBurnKeeper.GetParams(ctx).EnableFeeBurn {
+	if !fbd.feeBurnKeeper.GetParams(ctx).EnableFeeBurn {
 		return next(ctx, tx, simulate, success)
 	}
 
@@ -49,22 +51,27 @@ func (bd FeeBurnDecorator) PostHandle(ctx sdk.Context, tx sdk.Tx, simulate bool,
 	}
 	gasLimit := math.LegacyNewDecFromInt(sdk.NewInt(int64(gasMeter.Limit())))
 	remainingGas := math.LegacyNewDecFromInt(sdk.NewInt(int64(gasMeter.GasRemaining())))
+	// Percentage of unused gas for this specific denom
+	burnRate := remainingGas.Quo(gasLimit)
+	fmt.Printf("remainingGas: %s\n", remainingGas)
+	fmt.Printf("gasLimit: %s\n", gasLimit)
+	fmt.Printf("burnRate: %s\n", burnRate)
 
 	var toBurn sdk.Coins
 	// Iterate over the transaction fees and calculate the proportional part
 	// of the unused fees denominated in the tokens used to pay fo the fees
 	// and add it to the toBurn variable that will be sent to the user.
 	for _, txFee := range txFees {
-		// Percentage of unused gas for this specific denom
-		remainingGasProportion := remainingGas.Quo(gasLimit)
 
 		// Given the percentage of unused gas, calculate the
 		// proportional part of the fees that will be refunded
 		// to the user in this specific denom.
 		unusedFees := math.LegacyNewDecFromInt(txFee.Amount).
-			Mul(remainingGasProportion).
+			Mul(burnRate).
 			TruncateInt()
 
+		fmt.Printf("math.LegacyNewDecFromInt(txFee.Amount) %s\n", math.LegacyNewDecFromInt(txFee.Amount))
+
 		// When the unused fees are positive it means that the user
 		// will receive a refund in this specific denom to its wallet.
 		if unusedFees.IsPositive() {
@@ -77,17 +84,23 @@ func (bd FeeBurnDecorator) PostHandle(ctx sdk.Context, tx sdk.Tx, simulate bool,
 
 	// Execute the refund to the user, if there is an error
 	// return the error otherwise continue with the execution
-	err = bd.bankkeeper.BurnCoins(ctx, authtypes.FeeCollectorName, toBurn)
+	err = fbd.bankkeeper.BurnCoins(ctx, authtypes.FeeCollectorName, toBurn)
 	if err != nil {
 		return ctx, err
 	}
 
+	// Emit an event to be able to track the fees burned
+	// because there can be a little bit of discrepancy
+	// between fees used and burned, because the proportional
+	// part of the fees is truncated to an integer.
 	err = ctx.EventManager().EmitTypedEvent(
-		&types.FeeBurnEvent{FeesBurn: toBurn},
+		&types.FeeBurnEvent{
+			FeesBurn: toBurn,
+			BurnRate: burnRate,
+		},
 	)
 	if err != nil {
 		return ctx, err
 	}
-
 	return next(ctx, tx, simulate, success)
 }