refund btc header submission

app/keepers/keepers.go

@@ -432,6 +432,7 @@ func (ak *AppKeepers) InitKeepers(
  appCodec,
  runtime.NewKVStoreService(keys[btclightclienttypes.StoreKey]),
  *btcConfig,
+ &ak.IncentiveKeeper,
  authtypes.NewModuleAddress(govtypes.ModuleName).String(),
  )
 

test/e2e/configurer/chain/commands.go

@@ -232,9 +232,10 @@ func (n *NodeConfig) FinalizeSealedEpochs(startEpoch uint64, lastEpoch uint64) {
  tx2 := datagen.CreatOpReturnTransaction(r, p2)
  opReturn2 := datagen.CreateBlockWithTransaction(r, opReturn1.HeaderBytes.ToBlockHeader(), tx2)
 
- n.InsertHeader(&opReturn1.HeaderBytes)
- n.InsertHeader(&opReturn2.HeaderBytes)
-
+ n.SubmitRefundableTxWithAssertion(func() {
+ n.InsertHeader(&opReturn1.HeaderBytes)
+ n.InsertHeader(&opReturn2.HeaderBytes)
+ })
  n.SubmitRefundableTxWithAssertion(func() {
  n.InsertProofs(opReturn1.SpvProof, opReturn2.SpvProof)
  })

testutil/keeper/btclightclient.go

@@ -1,6 +1,7 @@
 package keeper
 
 import (
+ "context"
  "testing"
 
  "cosmossdk.io/core/header"
@@ -26,6 +27,10 @@ import (
  btclightclientt "github.com/babylonlabs-io/babylon/x/btclightclient/types"
 )
 
+type MockIncentiveKeeper struct{}
+
+func (mik MockIncentiveKeeper) IndexRefundableMsg(ctx context.Context, msg sdk.Msg) {}
+
 func BTCLightClientKeeper(t testing.TB) (*btclightclientk.Keeper, sdk.Context) {
  k, ctx, _ := BTCLightClientKeeperWithCustomParams(t, btclightclientt.DefaultParams())
  return k, ctx
@@ -40,7 +45,10 @@ func NewBTCHeaderBytesList(chain []*wire.BlockHeader) []bbn.BTCHeaderBytes {
  return chainBytes
 }
 
-func BTCLightClientKeeperWithCustomParams(t testing.TB, p btclightclientt.Params) (*btclightclientk.Keeper, sdk.Context, corestore.KVStoreService) {
+func BTCLightClientKeeperWithCustomParams(
+ t testing.TB,
+ p btclightclientt.Params,
+) (*btclightclientk.Keeper, sdk.Context, corestore.KVStoreService) {
  storeKey := storetypes.NewKVStoreKey(btclightclientt.StoreKey)
 
  db := dbm.NewMemDB()
@@ -52,12 +60,12 @@ func BTCLightClientKeeperWithCustomParams(t testing.TB, p btclightclientt.Params
  cdc := codec.NewProtoCodec(registry)
 
  testCfg := bbn.ParseBtcOptionsFromConfig(bapp.TmpAppOptions())
-
  stServ := runtime.NewKVStoreService(storeKey)
  k := btclightclientk.NewKeeper(
  cdc,
  stServ,
  testCfg,
+ &MockIncentiveKeeper{},
  authtypes.NewModuleAddress(govtypes.ModuleName).String(),
  )
 

x/btccheckpoint/keeper/msg_server.go

@@ -22,7 +22,7 @@ func NewMsgServerImpl(keeper Keeper) types.MsgServer {
 }
 
 // TODO at some point add proper logging of error
-// TODO emit some events for external consumers. Those should be probably emited
+// TODO emit some events for external consumers. Those should be probably emitted
 // at EndBlockerCallback
 func (ms msgServer) InsertBTCSpvProof(ctx context.Context, req *types.MsgInsertBTCSpvProof) (*types.MsgInsertBTCSpvProofResponse, error) {
 
@@ -92,7 +92,8 @@ func (ms msgServer) InsertBTCSpvProof(ctx context.Context, req *types.MsgInsertB
  return nil, err
  }
 
- // At this point, the BTC checkpoint is considered the first valid one for the epoch.
+ // At this point, the BTC checkpoint is considered the first valid submission
+ // for the epoch.
  // Thus, we can safely consider this message as refundable
  ms.k.incentiveKeeper.IndexRefundableMsg(sdkCtx, req)
 

x/btclightclient/keeper/keeper.go

@@ -22,6 +22,7 @@ type (
  cdc codec.BinaryCodec
  storeService corestoretypes.KVStoreService
  hooks types.BTCLightClientHooks
+ iKeeper types.IncentiveKeeper
  btcConfig bbn.BtcConfig
  bl *types.BtcLightClient
  authority string
@@ -34,6 +35,7 @@ func NewKeeper(
  cdc codec.BinaryCodec,
  storeService corestoretypes.KVStoreService,
  btcConfig bbn.BtcConfig,
+ iKeeper types.IncentiveKeeper,
  authority string,
 ) Keeper {
  bl := types.NewBtcLightClientFromParams(btcConfig.NetParams())
@@ -42,6 +44,7 @@ func NewKeeper(
  cdc: cdc,
  storeService: storeService,
  hooks: nil,
+ iKeeper: iKeeper,
  btcConfig: btcConfig,
  bl: bl,
  authority: authority,

x/btclightclient/keeper/msg_server.go

@@ -48,10 +48,16 @@ func (m msgServer) InsertHeaders(ctx context.Context, msg *types.MsgInsertHeader
  }
 
  err := m.k.InsertHeadersWithHookAndEvents(sdkCtx, msg.Headers)
-
  if err != nil {
  return nil, err
  }
+
+ // At this point, the headers have been inserted, and the inserted
+ // headers extend the current chain or a fork that is longer than
+ // the current chain.
+ // Thus, we can safely consider this message as refundable
+ m.k.iKeeper.IndexRefundableMsg(sdkCtx, msg)
+
  return &types.MsgInsertHeadersResponse{}, nil
 }
 

x/btclightclient/types/expected_keepers.go

@@ -2,10 +2,16 @@ package types
 
 import (
  "context"
+
+ sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
 type BTCLightClientHooks interface {
  AfterBTCRollBack(ctx context.Context, headerInfo *BTCHeaderInfo) // Must be called after the chain is rolled back
  AfterBTCRollForward(ctx context.Context, headerInfo *BTCHeaderInfo) // Must be called after the chain is rolled forward
  AfterBTCHeaderInserted(ctx context.Context, headerInfo *BTCHeaderInfo) // Must be called after a header is inserted
 }
+
+type IncentiveKeeper interface {
+ IndexRefundableMsg(ctx context.Context, msg sdk.Msg)
+}

x/btcstaking/keeper/msg_server.go

@@ -472,8 +472,10 @@ func (ms msgServer) AddCovenantSigs(goCtx context.Context, req *types.MsgAddCove
 
  // at this point, the covenant signatures are verified and are not duplicated.
  // Thus, we can safely consider this message as refundable
- // TODO: currently we refund tx fee for covenant signatures even if the BTC
- // delegation already has a covenant quorum. Should we refund in this case?
+ // NOTE: currently we refund tx fee for covenant signatures even if the BTC
+ // delegation already has a covenant quorum. This is to ensure that covenant
+ // members do not spend transaction fee, even if they submit covenant signatures
+ // late.
  ms.iKeeper.IndexRefundableMsg(ctx, req)
 
  return &types.MsgAddCovenantSigsResponse{}, nil

x/finality/keeper/msg_server.go

@@ -98,7 +98,7 @@ func (ms msgServer) AddFinalitySig(goCtx context.Context, req *types.MsgAddFinal
  existingSig, err := ms.GetSig(ctx, req.BlockHeight, fpPK)
  if err == nil && existingSig.Equals(req.FinalitySig) {
  ms.Logger(ctx).Debug("Received duplicated finiality vote", "block height", req.BlockHeight, "finality provider", req.FpBtcPk)
- // exactly same vote alreay exists, return success to the provider
+ // exactly same vote already exists, return success to the provider
  return &types.MsgAddFinalitySigResponse{}, nil
  }
 
@@ -178,7 +178,7 @@ func (ms msgServer) AddFinalitySig(goCtx context.Context, req *types.MsgAddFinal
  }
 
  // at this point, the finality signature is 1) valid, 2) over a canonical block,
- // and 3) not duplicated
+ // and 3) not duplicated.
  // Thus, we can safely consider this message as refundable
  ms.IncentiveKeeper.IndexRefundableMsg(ctx, req)