feat(finality): move voting power table to finality module (#217)

Resolves #24 

This PR moves voting power table to finality module, including all
relevant KV stores, APIs and functions. This ensures that

- BTC staking module becomes the "staking hub" for storing all FPs and
BTC delegations of Babylon and consumer chains
- Finality module becomes the 1st use case of this staking hub, namely
providing BTC staking finality for Babylon chain

CHANGELOG.md

@@ -53,6 +53,7 @@ power during expiry
 ### State Machine Breaking
 
 * [#224](https://github.com/babylonlabs-io/babylon/pull/224) Make injected checkpoint a standard tx
+* [#217](https://github.com/babylonlabs-io/babylon/pull/217) Move voting power table to finality module
 * [#207](https://github.com/babylonlabs-io/babylon/pull/207) Rename total voting power
 to total bonded sat
 * [#204](https://github.com/babylonlabs-io/babylon/pull/204) Add babylon finality

app/keepers/keepers.go

@@ -496,9 +496,6 @@ func (ak *AppKeepers) InitKeepers(
 		runtime.NewKVStoreService(keys[btcstakingtypes.StoreKey]),
 		&btclightclientKeeper,
 		&btcCheckpointKeeper,
-		// setting the finality keeper as nil for now
-		// need to set it after finality keeper is initiated
-		nil,
 		&ak.IncentiveKeeper,
 		btcNetParams,
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
@@ -513,11 +510,6 @@ func (ak *AppKeepers) InitKeepers(
 		ak.CheckpointingKeeper,
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
 	)
-	ak.BTCStakingKeeper = *ak.BTCStakingKeeper.SetHooks(btcstakingtypes.NewMultiBtcStakingHooks(ak.FinalityKeeper.Hooks()))
-	ak.FinalityKeeper = *ak.FinalityKeeper.SetHooks(finalitytypes.NewMultiFinalityHooks(ak.BTCStakingKeeper.Hooks()))
-	// TODO this introduces circular dependency between the finality module and
-	// the btcstaking modules, need refactoring
-	ak.BTCStakingKeeper.FinalityKeeper = ak.FinalityKeeper
 
 	// create evidence keeper with router
 	evidenceKeeper := evidencekeeper.NewKeeper(

app/upgrades/v1/mainnet/btcstaking_params.go

@@ -21,6 +21,5 @@ const BtcStakingParamStr = `
   "slashing_rate": "0.100000000000000000",
   "min_unbonding_time_blocks": 0,
   "unbonding_fee_sat": "1000",
-  "min_commission_rate": "0.03",
-  "max_active_finality_providers": 100
+  "min_commission_rate": "0.03"
 }`

app/upgrades/v1/mainnet/finality_params.go

@@ -3,6 +3,7 @@ package mainnet
 // TODO Some default parameters. Consider how to switch those depending on network:
 // mainnet, testnet, devnet etc.
 const FinalityParamStr = `{
+  "max_active_finality_providers": 100,
   "signed_blocks_window": 100,
   "finality_sig_timeout": 3,
   "min_signed_per_window": "0.1",

app/upgrades/v1/testnet/btcstaking_params.go

@@ -22,6 +22,5 @@ const BtcStakingParamStr = `
   "min_unbonding_time_blocks": 0,
   "unbonding_fee_sat": "1000",
   "min_commission_rate": "0.03",
-  "max_active_finality_providers": 100,
   "delegation_creation_base_gas_fee": 1000
 }`

app/upgrades/v1/testnet/finality_params.go

@@ -3,6 +3,7 @@ package testnet
 // TODO Some default parameters. Consider how to switch those depending on network:
 // mainnet, testnet, devnet etc.
 const FinalityParamStr = `{
+  "max_active_finality_providers": 100,
   "signed_blocks_window": 100,
   "finality_sig_timeout": 3,
   "min_signed_per_window": "0.1",

client/query/btcstaking.go

@@ -121,48 +121,3 @@ func (c *QueryClient) BTCDelegation(stakingTxHashHex string) (*btcstakingtypes.Q
 
 	return resp, err
 }
-
-// ActiveFinalityProvidersAtHeight queries the BTCStaking module for all finality providers
-// with non-zero voting power at a given height
-func (c *QueryClient) ActiveFinalityProvidersAtHeight(height uint64, pagination *sdkquerytypes.PageRequest) (*btcstakingtypes.QueryActiveFinalityProvidersAtHeightResponse, error) {
-	var resp *btcstakingtypes.QueryActiveFinalityProvidersAtHeightResponse
-	err := c.QueryBTCStaking(func(ctx context.Context, queryClient btcstakingtypes.QueryClient) error {
-		var err error
-		req := &btcstakingtypes.QueryActiveFinalityProvidersAtHeightRequest{
-			Height:     height,
-			Pagination: pagination,
-		}
-		resp, err = queryClient.ActiveFinalityProvidersAtHeight(ctx, req)
-		return err
-	})
-
-	return resp, err
-}
-
-// FinalityProviderPowerAtHeight queries the BTCStaking module for the power of a finality provider at a given height
-func (c *QueryClient) FinalityProviderPowerAtHeight(fpBtcPkHex string, height uint64) (*btcstakingtypes.QueryFinalityProviderPowerAtHeightResponse, error) {
-	var resp *btcstakingtypes.QueryFinalityProviderPowerAtHeightResponse
-	err := c.QueryBTCStaking(func(ctx context.Context, queryClient btcstakingtypes.QueryClient) error {
-		var err error
-		req := &btcstakingtypes.QueryFinalityProviderPowerAtHeightRequest{
-			FpBtcPkHex: fpBtcPkHex,
-			Height:     height,
-		}
-		resp, err = queryClient.FinalityProviderPowerAtHeight(ctx, req)
-		return err
-	})
-
-	return resp, err
-}
-
-func (c *QueryClient) ActivatedHeight() (*btcstakingtypes.QueryActivatedHeightResponse, error) {
-	var resp *btcstakingtypes.QueryActivatedHeightResponse
-	err := c.QueryBTCStaking(func(ctx context.Context, queryClient btcstakingtypes.QueryClient) error {
-		var err error
-		req := &btcstakingtypes.QueryActivatedHeightRequest{}
-		resp, err = queryClient.ActivatedHeight(ctx, req)
-		return err
-	})
-
-	return resp, err
-}

client/query/finality.go

@@ -19,6 +19,51 @@ func (c *QueryClient) QueryFinality(f func(ctx context.Context, queryClient fina
 	return f(ctx, queryClient)
 }
 
+// ActiveFinalityProvidersAtHeight queries the BTCStaking module for all finality providers
+// with non-zero voting power at a given height
+func (c *QueryClient) ActiveFinalityProvidersAtHeight(height uint64, pagination *sdkquerytypes.PageRequest) (*finalitytypes.QueryActiveFinalityProvidersAtHeightResponse, error) {
+	var resp *finalitytypes.QueryActiveFinalityProvidersAtHeightResponse
+	err := c.QueryFinality(func(ctx context.Context, queryClient finalitytypes.QueryClient) error {
+		var err error
+		req := &finalitytypes.QueryActiveFinalityProvidersAtHeightRequest{
+			Height:     height,
+			Pagination: pagination,
+		}
+		resp, err = queryClient.ActiveFinalityProvidersAtHeight(ctx, req)
+		return err
+	})
+
+	return resp, err
+}
+
+// FinalityProviderPowerAtHeight queries the BTCStaking module for the power of a finality provider at a given height
+func (c *QueryClient) FinalityProviderPowerAtHeight(fpBtcPkHex string, height uint64) (*finalitytypes.QueryFinalityProviderPowerAtHeightResponse, error) {
+	var resp *finalitytypes.QueryFinalityProviderPowerAtHeightResponse
+	err := c.QueryFinality(func(ctx context.Context, queryClient finalitytypes.QueryClient) error {
+		var err error
+		req := &finalitytypes.QueryFinalityProviderPowerAtHeightRequest{
+			FpBtcPkHex: fpBtcPkHex,
+			Height:     height,
+		}
+		resp, err = queryClient.FinalityProviderPowerAtHeight(ctx, req)
+		return err
+	})
+
+	return resp, err
+}
+
+func (c *QueryClient) ActivatedHeight() (*finalitytypes.QueryActivatedHeightResponse, error) {
+	var resp *finalitytypes.QueryActivatedHeightResponse
+	err := c.QueryFinality(func(ctx context.Context, queryClient finalitytypes.QueryClient) error {
+		var err error
+		req := &finalitytypes.QueryActivatedHeightRequest{}
+		resp, err = queryClient.ActivatedHeight(ctx, req)
+		return err
+	})
+
+	return resp, err
+}
+
 // FinalityParams queries the finality module parameters
 func (c *QueryClient) FinalityParams() (*finalitytypes.Params, error) {
 	var resp *finalitytypes.QueryParamsResponse

cmd/babylond/cmd/genesis.go

@@ -412,7 +412,6 @@ func TestnetGenesisParams(
 	genParams.BtcstakingParams.MinSlashingTxFeeSat = minSlashingFee
 	genParams.BtcstakingParams.MinCommissionRate = minCommissionRate
 	genParams.BtcstakingParams.SlashingRate = slashingRate
-	genParams.BtcstakingParams.MaxActiveFinalityProviders = maxActiveFinalityProviders
 	genParams.BtcstakingParams.MinUnbondingTimeBlocks = uint32(minUnbondingTime)
 	genParams.BtcstakingParams.UnbondingFeeSat = unbondingFeeSat
 	if err := genParams.BtcstakingParams.Validate(); err != nil {
@@ -436,6 +435,7 @@ func TestnetGenesisParams(
 	genParams.BlockGasLimit = blockGasLimit
 	genParams.VoteExtensionsEnableHeight = voteExtensionEnableHeight
 
+	genParams.FinalityParams.MaxActiveFinalityProviders = maxActiveFinalityProviders
 	genParams.FinalityParams.SignedBlocksWindow = signedBlocksWindow
 	genParams.FinalityParams.MinSignedPerWindow = minSignedPerWindow
 	genParams.FinalityParams.FinalitySigTimeout = finalitySigTimeout

proto/babylon/btcstaking/v1/genesis.proto

@@ -4,7 +4,6 @@ package babylon.btcstaking.v1;
 import "gogoproto/gogo.proto";
 import "babylon/btcstaking/v1/params.proto";
 import "babylon/btcstaking/v1/btcstaking.proto";
-import "babylon/btcstaking/v1/incentive.proto";
 import "babylon/btcstaking/v1/events.proto";
 
 option go_package = "github.com/babylonlabs-io/babylon/x/btcstaking/types";
@@ -17,36 +16,12 @@ message GenesisState {
   repeated FinalityProvider finality_providers = 2;
   // btc_delegations all the btc delegations in the state.
   repeated BTCDelegation btc_delegations = 3;
-  // voting_powers the voting power of every finality provider at every block height.
-  repeated VotingPowerFP voting_powers = 4;
   // block_height_chains the block height of babylon and bitcoin.
   repeated BlockHeightBbnToBtc block_height_chains = 5;
   // btc_delegators contains all the btc delegators with the associated finality provider.
   repeated BTCDelegator btc_delegators = 6;
   // all the events and its indexes.
   repeated EventIndex events = 7;
-  // vp_dst_cache is the table of all providers voting power with the total at one specific block.
-  // TODO: remove this after not storing in the keeper store it anymore.
-  repeated VotingPowerDistCacheBlkHeight vp_dst_cache = 8;
-}
-
-// VotingPowerFP contains the information about the voting power
-// of an finality provider in a specific block height.
-message VotingPowerFP {
-  // block_height is the height of the block the voting power was stored.
-  uint64 block_height = 1;
-  // fp_btc_pk the finality provider btc public key.
-  bytes fp_btc_pk = 2 [ (gogoproto.customtype) = "github.com/babylonlabs-io/babylon/types.BIP340PubKey" ];
-  // voting_power is the power of the finality provider at this specific block height.
-  uint64 voting_power = 3;
-}
-
-// VotingPowerDistCacheBlkHeight the total voting power of the finality providers at one specific block height
-message VotingPowerDistCacheBlkHeight {
-  // block_height is the height of the block the voting power distribution cached was stored.
-  uint64 block_height = 1;
-  // vp_distribution the finality providers distribution cache at that height.
-  VotingPowerDistCache vp_distribution = 2;
 }
 
 // BlockHeightBbnToBtc stores the btc <-> bbn block.

proto/babylon/btcstaking/v1/params.proto

@@ -53,10 +53,8 @@ message Params {
     (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec",
     (gogoproto.nullable)   = false
   ];
-  // max_active_finality_providers is the maximum number of active finality providers in the BTC staking protocol
-  uint32 max_active_finality_providers = 13;
   // base gas fee for delegation creation
-  uint64 delegation_creation_base_gas_fee = 14;
+  uint64 delegation_creation_base_gas_fee = 13;
 }
 
 // StoredParams attach information about the version of stored parameters