feat: merge base branch to main #402

SebastianElvis · 2025-01-14T11:23:46Z

This PR merges the base branch with phase-3 codebase to main.

Comparison between base and main: https://babylonlabs.atlassian.net/wiki/spaces/BABYLON/pages/5905879

* Add chain register struct * Add chain registry * Add chain registry test * Add chain registry queries * Add chain registry queries tests * Add register chain msg * Add register chain msg routing / impl * Update proto/babylon/zoneconcierge/v1/tx.proto * Flatten chain register proto * Remove authority from register chain msg * Add chain not registered check * Add chain already registered check * Update / fix comment * Add registry related queries to rpc server * Fix indentation * Fix: Add signer field to register chain msg * Fix: Own / unique query param / response for list registry

* Move btcstkconsumer proto files under v1/ for consistency * Move register chain protos from zoneconcierge to btcstkconsumer * Refactor chain registry into btcstkconsumer * Fix: proto / code lints * Pass chain register pointer Co-authored-by: Runchao Han <[email protected]>

* Register zoneconcierge msg codecs * Register btcstkconsumer msg codecs

* Add chain id to finality provider * Add finality provider registry * Update fps per chain id registry * Remove commented line * FP registers only non-canonical chains * Add FP registry test * Add registered chain check * Add registration check to fp registry test * Remove optional from chain id * Add own CZ chains FPs store * Store CZ chains FPs in their own store * Adjust names / tests * Refactor fp consumer registry * Adapt tests * Rename for clarity * Add FP CZ chains registry queries * Add FP consumer query tests * Adapt test * Add chain id to fp query response * Remove useless slash condition check * Improve error msg * Move type builder to types package

* Add chains per FP BTC PubKey store * Ensure CZ chains FP does not already exist * Fix: Return err explicitly instead of nil

* Fix typos * Add register chain cli tx * Add chain id to btcstaking create-finality-provider * Add get finality provider by chain queries * Add registered chains cli queries * Add FZ FP chain id query type * Add get CZ FP chain getter / query * Add grpc query. Adjust grpc query paths * Add CZ FP registered chain cli query cmd * Fix: Add tx flags for register chain cmd * Turn consumer chain id into a flag instead of a param * Fix params module import * Add hook to query consumer fps through btcstaking

* Rename consumer keys for clarity * Rename btc staking consumer methods * Rename consumer delegation private methods * Move consumer delegations to btcstaking * Refactor BTC delegations into one store * Simplify logic * Improve comments

…232)

…248)

* Add needed (for babylon as Consumer) staking capability * Upgrade contracts from latest babylon-contract * Support Mac arm64 arch in passing for copy local wasm * Fix: FP fields protobuf sequence numbers * Update contracts to latest * Fix: make proto-gen * Trim unused fields from new finality provider IBC msg * Update protobuf gens * Update code refs

RafilxTenfen · 2025-01-20T14:38:16Z

x/btcstaking/keeper/msg_server.go

@@ -295,6 +294,13 @@ func (ms msgServer) CreateBTCDelegation(goCtx context.Context, req *types.MsgCre
 	if err := ms.AddBTCDelegation(ctx, newBTCDel); err != nil {


Here we are adding the BTC delegation normally as it is the same for BTC delegations to Babylon vs Consumers, that means for both cases events EventBTCDelegationStateUpdate are being added and later processed in ProcessAllPowerDistUpdateEvents -

babylon/x/finality/keeper/power_dist_change.go

Line 170 in be9eb6b

func (k Keeper) ProcessAllPowerDistUpdateEvents(

Since rewards of consumer chains will not be handled by the Babylon chain we should handle and do not store the changes of those finality providers in the incentive store (do not call processRewardTracker

babylon/x/finality/keeper/power_dist_change.go

Line 216 in be9eb6b

k.processRewardTracker(ctx, fpByBtcPkHex, btcDel, func(fp, del sdk.AccAddress, sats uint64) {

) for consumers BTC delegations and FPs

RafilxTenfen · 2025-01-20T14:52:13Z

x/btcstaking/keeper/finality_providers.go

+			if !exists {
+				// If not in map, check if it's a Babylon FP or get its consumer
+				if _, err := k.GetFinalityProvider(ctx, delegationFPBTCPK); err == nil {
+					continue // It's a Babylon FP, skip


we already know if the finality provider fpBTCPK is from the Babylon when querying HasFinalityProvider

It would reduce one read by FP in the list, can be addressed in a future task

RafilxTenfen · 2025-01-20T14:56:46Z

x/btcstaking/keeper/grpc_query.go

 	fp, err := k.GetFinalityProvider(ctx, key)
 	if err != nil {
+		// Try in the btcstkconsumer module
+		if k.BscKeeper.HasConsumerFinalityProvider(ctx, fpPK) {


if we are going to have 2 different stores with FPs we should return the same structure/interface and have a function to query a FP by their fpPK to avoid handling in the error case

RafilxTenfen · 2025-01-20T15:04:12Z

x/btcstaking/types/keys.go

@@ -27,4 +27,6 @@ var (
 	PowerDistUpdateKey        = []byte{0x08}             // key prefix for power distribution update events
 	AllowedStakingTxHashesKey = collections.NewPrefix(9) // key prefix for allowed staking tx hashes
 	HeightToVersionMapKey     = []byte{0x10}             // key prefix for height to version map
+	BTCConsumerDelegatorKey   = []byte{0x11}             // key prefix for the Consumer BTC delegators
+	BTCStakingEventKey        = []byte{0x12}             // key prefix for the BTC staking events


could we put this inside the x/btcstkconsumer ? @gusin13

RafilxTenfen · 2025-01-20T15:08:28Z

x/zoneconcierge/types/genesis.go

+
+// DefaultGenesis returns the default genesis state
+func DefaultGenesis() *GenesisState {
+	return &GenesisState{


We have a lot of keys

var ( PortKey = []byte{0x11} // PortKey defines the key to store the port ID in store ChainInfoKey = []byte{0x12} // ChainInfoKey defines the key to store the chain info for each CZ in store CanonicalChainKey = []byte{0x13} // CanonicalChainKey defines the key to store the canonical chain for each CZ in store ForkKey = []byte{0x14} // ForkKey defines the key to store the forks for each CZ in store EpochChainInfoKey = []byte{0x15} // EpochChainInfoKey defines the key to store each epoch's latests chain info for each CZ in store LastSentBTCSegmentKey = []byte{0x16} // LastSentBTCSegmentKey is key holding last btc light client segment sent to other cosmos zones ParamsKey = []byte{0x17} // key prefix for the parameters SealedEpochProofKey = []byte{0x18} // key prefix for proof of sealed epochs )

Every data that needs to be know in case of a chain failure should be inside the GenesisState, a few of our modules don't have that, but still we should take note and create issues

RafilxTenfen · 2025-01-20T16:23:36Z

x/btcstkconsumer/client/cli/tx.go

+		Args:  cobra.RangeArgs(2, 3),
+		Short: "Registers a CZ consumer",
+		Long: strings.TrimSpace(
+			`Registers a CZ consumer.`,


long is the same as short

RafilxTenfen · 2025-01-20T16:26:01Z

x/btcstkconsumer/genesis.go

+}
+
+// ExportGenesis returns the module's exported genesis.
+func ExportGenesis(ctx sdk.Context, k keeper.Keeper) *types.GenesisState {


Same, genesis state should have every data needed to relaunch the chain in case of failure

RafilxTenfen · 2025-01-20T16:26:58Z

x/btcstkconsumer/keeper/finality_provider_registry.go

+}
+
+// IterateFPs iterates over all finality providers for a given chain
+func (k Keeper) IterateFPs(ctx context.Context, chainId string, handler func(fp *btcstaking.FinalityProvider) bool) {


also not used

RafilxTenfen · 2025-01-20T16:33:43Z

x/btcstkconsumer/keeper/query.go

+	"github.com/babylonlabs-io/babylon/x/btcstkconsumer/types"
+)
+
+var _ types.QueryServer = Keeper{}


we already have this in grpc_query
File could be removed

RafilxTenfen · 2025-01-20T16:35:28Z

x/btcstkconsumer/types/chain_register.go

+	if len(m.ConsumerName) == 0 {
+		return fmt.Errorf("ConsumerName must be non-empty")
+	}
+	if len(m.ConsumerDescription) == 0 {


why do we allow not specify the description in CLI?

babylon/x/btcstkconsumer/client/cli/tx.go

Line 56 in ce31233

description := ""

RafilxTenfen · 2025-01-20T16:36:51Z

x/btcstkconsumer/types/errors.go

+var (
+	ErrInvalidSigner                = sdkerrors.Register(ModuleName, 1100, "expected gov account as only signer for proposal message")
+	ErrConsumerNotRegistered        = sdkerrors.Register(ModuleName, 1101, "consumer not registered")
+	ErrInvalidConsumerRegister      = sdkerrors.Register(ModuleName, 1102, "invalid consumer register")


RafilxTenfen · 2025-01-20T16:38:01Z

x/btcstkconsumer/types/expected_keepers.go

+type AccountKeeper interface {
+	GetAccount(context.Context, sdk.AccAddress) sdk.AccountI // only used for simulation
+	// Methods imported from account should be defined here
+}
+
+// BankKeeper defines the expected interface for the Bank module.
+type BankKeeper interface {
+	SpendableCoins(context.Context, sdk.AccAddress) sdk.Coins
+	// Methods imported from bank should be defined here
+}


RafilxTenfen · 2025-01-20T16:39:08Z

x/btcstkconsumer/keeper/keeper.go

+	accountKeeper types.AccountKeeper
+	bankKeeper    types.BankKeeper
+	clientKeeper  types.ClientKeeper
+	wasmKeeper    types.WasmKeeper


not being used

Suggested change

accountKeeper types.AccountKeeper

bankKeeper types.BankKeeper

clientKeeper types.ClientKeeper

wasmKeeper types.WasmKeeper

clientKeeper types.ClientKeeper

wasmKeeper types.WasmKeeper

RafilxTenfen · 2025-01-20T16:40:44Z

x/btcstkconsumer/types/genesis.go

+package types
+
+// DefaultIndex is the default global index
+const DefaultIndex uint64 = 1


RafilxTenfen · 2025-01-20T16:41:14Z

x/btcstkconsumer/types/keys.go

+	StoreKey = ModuleName
+
+	// MemStoreKey defines the in-memory store key
+	MemStoreKey = "mem_btcstkconsumer"


not being used

RafilxTenfen · 2025-01-20T16:41:39Z

x/btcstkconsumer/types/keys.go

+func KeyPrefix(p string) []byte {
+	return []byte(p)
+}


not being used

RafilxTenfen · 2025-01-20T16:43:04Z

x/btcstkconsumer/types/types.go

RafilxTenfen · 2025-01-20T16:43:48Z

x/finality/client/cli/tx.go

-
-func NewUnjailFinalityProviderCmd() *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "unjail-finality-provider [fp_btc_pk]",


why remove it? do we not have the unjail option @gitferry

RafilxTenfen · 2025-01-20T17:05:02Z

x/zoneconcierge/README.md

+- **Phase 1 integration:** Babylon receives PoS blockchain headers via standard
+  `MsgUpdateClient` messages in IBC light client protocol, timestamps them, and
+  functions as a canonical chain oracle for the PoS blockchain.
+  [Babylonscan](https://babylonscan.io/) shows PoS blockchains with phase 1
+  integration.
+- **Phase 2 integration:** In addition to phase 1, phase 2 allows a PoS
+  blockchain to receive BTC timestamps from Babylon via an IBC channel, such
+  that the PoS blockchain can use BTC timestamps to detect and resolve forks, as
+  well as other use cases such as Bitcoin-assisted fast unbonding.


is this still true?

RafilxTenfen · 2025-01-20T17:06:27Z

x/zoneconcierge/client/cli/tx.go

+	"github.com/spf13/cobra"
+
+	"github.com/cosmos/cosmos-sdk/client"
+	// "github.com/cosmos/cosmos-sdk/client/flags"


can we remove this file?

RafilxTenfen · 2025-01-20T17:16:32Z

x/zoneconcierge/keeper/grpc_query.go

+
+	// find the last finalised epoch
+	lastFinalizedEpoch := k.GetLastFinalizedEpoch(ctx)
+	for _, ConsumerId := range req.ConsumerIds {


Thinking if doing all of this to 100 consumers at once wouldn't it be too much?
Maybe we should only allow to query one by one

RafilxTenfen · 2025-01-20T17:18:31Z

x/zoneconcierge/keeper/header_handler.go

+		// chain info does not exist yet, initialise chain info for this chain
+		chainInfo, err = k.InitChainInfo(ctx, indexedHeader.ConsumerId)
+		if err != nil {
+			panic(fmt.Errorf("failed to initialize chain info of %s: %w", indexedHeader.ConsumerId, err))


all the panics here only can happens due to a programming error?

RafilxTenfen · 2025-01-20T17:20:30Z

x/zoneconcierge/keeper/ibc_header_decorator.go

+	}
+}
+
+func (d *IBCHeaderDecorator) getHeaderAndClientState(ctx sdk.Context, m sdk.Msg) (*types.HeaderInfo, *ibctmtypes.ClientState) {


can we add some documentation on this function on what it does? or maybe only to func (d *IBCHeaderDecorator) PostHandle

RafilxTenfen · 2025-01-20T17:26:21Z

x/zoneconcierge/keeper/keeper.go

+		connectionKeeper types.ConnectionKeeper
+		channelKeeper    types.ChannelKeeper
+		portKeeper       types.PortKeeper
+		authKeeper       types.AccountKeeper


authKeeper, bankKeeper not used

RafilxTenfen · 2025-01-20T17:29:03Z

x/zoneconcierge/module.go

+	accountKeeper types.AccountKeeper
+	bankKeeper    types.BankKeeper


remove unused keepers

RafilxTenfen · 2025-01-20T17:30:04Z

x/zoneconcierge/module_ibc.go

+	// // TODO (Babylon): Dispatch and process packet
+	// switch packet := modulePacketData.Packet.(type) {
+	// default:
+	// 	errMsg := fmt.Sprintf("unrecognized %s packet type: %T", types.ModuleName, packet)
+	// 	return errorsmod.Wrap(sdkerrors.ErrUnknownRequest, errMsg)
+	// }


RafilxTenfen · 2025-01-20T17:33:40Z

x/zoneconcierge/module_ibc.go

+	switch resp := ack.Response.(type) {
+	case *channeltypes.Acknowledgement_Result:
+		im.keeper.Logger(ctx).Info("received an Acknowledgement message", "result", string(resp.Result))
+		ctx.EventManager().EmitEvent(


should we emit typed events?

RafilxTenfen · 2025-01-20T17:41:52Z

x/zoneconcierge/README.md

+The Zone Concierge module keeps handling IBC headers of PoS blockchains, and
+maintains the following KV stores.
+
+### Parameters


structures are out of date with the protos

SebastianElvis and others added 30 commits July 4, 2024 15:42

integration: set up x/btcstkconsumer module (#206)

2207f55

F/register codecs (#210)

873cfce

* Register zoneconcierge msg codecs * Register btcstkconsumer msg codecs

F/consumer fp registry 2 (#220)

a4d244c

* Add chains per FP BTC PubKey store * Ensure CZ chains FP does not already exist * Fix: Return err explicitly instead of nil

handling restaked BTC delegations to consumer FPs (#222)

65657d1

Update CHANGELOG

76efc0d

fix: only calculating Babylon FPs for FP set rotation (#223)

ce164ea

Update CHANGELOG

5c15e74

fix

b98b20e

R/consumer chain 2 (#224)

0a6e9f8

* Rename consumer keys for clarity * Rename btc staking consumer methods * Rename consumer delegation private methods * Move consumer delegations to btcstaking * Refactor BTC delegations into one store * Simplify logic * Improve comments

linting validateRestakedFPs

c94b5f5

proto: define IBC packet formats for PoS integration (#229)

4c1e0d5

zoneconcierge: let zoneconcierge hold a pointer to btcstaking module (#…

56b21f4

…232)

tests: Add pos-integration E2E Tests (#225)

4601ff5

chore: fix some proto formats for IBC packets (#234)

27f7072

chore: rename chain to consumer for PoS integration (#233)

78120b3

btcstkconsumer: separate IBC packet for provider / consumer (#237)

038943a

feat: Store btcstaking events in kv store and send IBC packet (#235)

8f134e1

tests: btcstaking events e2e tests (#240)

1ed7149

release v0.2.0 rc0 (#245)

61ef003

cd: Allows base/consumer-chain-support branch to run push_docker job (#…

49663ec

…248)

btcstkconsumer: RPC functions for BTC staking consumer module (#247)

5f8413b

tests: Add undelegation and fp voting power test cases (#254)

a0ec504

feat: Add cosmwasm_2_0 to wasmCapabilities (#255)

5d00627

feat: Add Grpc querier (#257)

db66211

chore: remove aarch64 wasm (#261)

265678f

SebastianElvis requested review from Lazar955 and RafilxTenfen January 20, 2025 05:44

RafilxTenfen reviewed Jan 20, 2025

View reviewed changes

x/btcstkconsumer/types/types.go

Copy link

Contributor

RafilxTenfen Jan 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delete?

RafilxTenfen reviewed Jan 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: merge base branch to main #402

feat: merge base branch to main #402

SebastianElvis commented Jan 14, 2025 •

edited

Loading

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025 •

edited

Loading

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

RafilxTenfen Jan 20, 2025

		@@ -295,6 +294,13 @@ func (ms msgServer) CreateBTCDelegation(goCtx context.Context, req *types.MsgCre
		if err := ms.AddBTCDelegation(ctx, newBTCDel); err != nil {

		accountKeeper types.AccountKeeper
		bankKeeper types.BankKeeper

feat: merge base branch to main #402

Are you sure you want to change the base?

feat: merge base branch to main #402

Conversation

SebastianElvis commented Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RafilxTenfen Jan 20, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SebastianElvis commented Jan 14, 2025 •

edited

Loading

RafilxTenfen Jan 20, 2025 •

edited

Loading