Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Parameterize finality parameters in prepare-genesis cmd #210

Merged
merged 2 commits into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
* [#207](https://github.com/babylonlabs-io/babylon/pull/207) Rename total voting power
to total bonded sat

### Improvements

* [#210](https://github.com/babylonlabs-io/babylon/pull/210) Parameterize finality parameters in prepare-genesis cmd

## v0.13.0

### API Breaking
Expand Down
39 changes: 35 additions & 4 deletions cmd/babylond/cmd/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ package cmd

import (
"encoding/hex"
"fmt"
"strings"
"time"

"cosmossdk.io/math"

tmrand "github.com/cometbft/cometbft/libs/rand"
"github.com/cosmos/cosmos-sdk/client/flags"
"github.com/spf13/cobra"
Expand All @@ -15,6 +15,7 @@ import (
btcctypes "github.com/babylonlabs-io/babylon/x/btccheckpoint/types"
btcltypes "github.com/babylonlabs-io/babylon/x/btclightclient/types"
btcstypes "github.com/babylonlabs-io/babylon/x/btcstaking/types"
ftypes "github.com/babylonlabs-io/babylon/x/finality/types"
)

const (
Expand Down Expand Up @@ -47,6 +48,10 @@ const (
flagMinSlashingFee = "min-slashing-fee-sat"
flagSlashingRate = "slashing-rate"
flagMinCommissionRate = "min-commission-rate"
flagSignedBlocksWindow = "signed-blocks-window"
flagMinSignedPerWindow = "min-signed-per-window"
flagFinalitySigTimeout = "finality-sig-timeout"
flagJailDuration = "jail-duration"
)

type GenesisCLIArgs struct {
Expand Down Expand Up @@ -80,6 +85,10 @@ type GenesisCLIArgs struct {
MinUnbondingTime uint16
UnbondingFeeSat int64
MinCommissionRate math.LegacyDec
SignedBlocksWindow int64
MinSignedPerWindow math.LegacyDec
FinalitySigTimeout int64
JailDuration time.Duration
}

func addGenesisFlags(cmd *cobra.Command) {
Expand Down Expand Up @@ -122,9 +131,13 @@ func addGenesisFlags(cmd *cobra.Command) {
// blocks args
cmd.Flags().Int64(flagBlockGasLimit, babylonApp.DefaultGasLimit, "Block gas limit")
cmd.Flags().Int64(flagVoteExtensionEnableHeight, babylonApp.DefaultVoteExtensionsEnableHeight, "Vote extension enable height")
cmd.Flags().Int64(flagSignedBlocksWindow, ftypes.DefaultSignedBlocksWindow, "Size of the sliding window for tracking finality provider liveness")
cmd.Flags().String(flagMinSignedPerWindow, ftypes.DefaultMinSignedPerWindow.String(), "Minimum number of blocks that a finality provider is required to sign within the sliding window to avoid being jailed")
cmd.Flags().Int64(flagFinalitySigTimeout, ftypes.DefaultFinalitySigTimeout, "How much time (in terms of blocks) finality providers have to cast a finality vote before being judged as missing their voting turn on the given block")
cmd.Flags().String(flagJailDuration, ftypes.DefaultJailDuration.String(), "Minimum period of time that a finality provider remains jailed")
}

func parseGenesisFlags(cmd *cobra.Command) *GenesisCLIArgs {
func parseGenesisFlags(cmd *cobra.Command) (*GenesisCLIArgs, error) {
chainID, _ := cmd.Flags().GetString(flags.FlagChainID)
maxActiveValidators, _ := cmd.Flags().GetUint32(flagMaxActiveValidators)
btcConfirmationDepth, _ := cmd.Flags().GetUint32(flagBtcConfirmationDepth)
Expand Down Expand Up @@ -155,18 +168,32 @@ func parseGenesisFlags(cmd *cobra.Command) *GenesisCLIArgs {
blocksPerYear, _ := cmd.Flags().GetUint64(flagBlocksPerYear)
blockGasLimit, _ := cmd.Flags().GetInt64(flagBlockGasLimit)
voteExtensionEnableHeight, _ := cmd.Flags().GetInt64(flagVoteExtensionEnableHeight)
signedBlocksWindow, _ := cmd.Flags().GetInt64(flagSignedBlocksWindow)
minSignedPerWindowStr, _ := cmd.Flags().GetString(flagMinSignedPerWindow)
finalitySigTimeout, _ := cmd.Flags().GetInt64(flagFinalitySigTimeout)
jailDurationStr, _ := cmd.Flags().GetString(flagJailDuration)

if chainID == "" {
chainID = "chain-" + tmrand.NewRand().Str(6)
}

var allowedReporterAddresses []string = make([]string, 0)
var allowedReporterAddresses = make([]string, 0)
if reporterAddresses != "" {
allowedReporterAddresses = strings.Split(reporterAddresses, ",")
}

genesisTime := time.Unix(genesisTimeUnix, 0)

minSignedPerWindow, err := math.LegacyNewDecFromStr(minSignedPerWindowStr)
if err != nil {
return nil, fmt.Errorf("invalid min-signed-per-window %s: %w", minSignedPerWindowStr, err)
}

jailDuration, err := time.ParseDuration(jailDurationStr)
if err != nil {
return nil, fmt.Errorf("invalid jail-duration %s: %w", jailDurationStr, err)
}

return &GenesisCLIArgs{
ChainID: chainID,
MaxActiveValidators: maxActiveValidators,
Expand Down Expand Up @@ -198,5 +225,9 @@ func parseGenesisFlags(cmd *cobra.Command) *GenesisCLIArgs {
BlocksPerYear: blocksPerYear,
BlockGasLimit: blockGasLimit,
VoteExtensionEnableHeight: voteExtensionEnableHeight,
}
SignedBlocksWindow: signedBlocksWindow,
MinSignedPerWindow: minSignedPerWindow,
FinalitySigTimeout: finalitySigTimeout,
JailDuration: jailDuration,
}, nil
}
30 changes: 24 additions & 6 deletions cmd/babylond/cmd/genesis.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ import (
"time"

sdkmath "cosmossdk.io/math"

btcstakingtypes "github.com/babylonlabs-io/babylon/x/btcstaking/types"
finalitytypes "github.com/babylonlabs-io/babylon/x/finality/types"

comettypes "github.com/cometbft/cometbft/types"
"github.com/cosmos/cosmos-sdk/client"
"github.com/cosmos/cosmos-sdk/client/flags"
Expand All @@ -36,8 +32,10 @@ import (
bbn "github.com/babylonlabs-io/babylon/types"
btccheckpointtypes "github.com/babylonlabs-io/babylon/x/btccheckpoint/types"
btclightclienttypes "github.com/babylonlabs-io/babylon/x/btclightclient/types"
btcstakingtypes "github.com/babylonlabs-io/babylon/x/btcstaking/types"
checkpointingtypes "github.com/babylonlabs-io/babylon/x/checkpointing/types"
epochingtypes "github.com/babylonlabs-io/babylon/x/epoching/types"
finalitytypes "github.com/babylonlabs-io/babylon/x/finality/types"
)

func PrepareGenesisCmd(defaultNodeHome string, mbm module.BasicManager) *cobra.Command {
Expand All @@ -57,13 +55,16 @@ Example:
serverCtx := server.GetServerContextFromCmd(cmd)
config := serverCtx.Config

genesisCliArgs := parseGenesisFlags(cmd)
genesisCliArgs, err := parseGenesisFlags(cmd)
if err != nil {
return fmt.Errorf("failed to parse genesis flags: %w", err)
}

genFile := config.GenesisFile()

genesisState, genesis, err := genutiltypes.GenesisStateFromGenFile(genFile)
if err != nil {
return fmt.Errorf("failed to unmarshal genesis state: %s", err)
return fmt.Errorf("failed to unmarshal genesis state: %w", err)
}

network := args[0]
Expand Down Expand Up @@ -101,6 +102,10 @@ Example:
genesisCliArgs.GenesisTime,
genesisCliArgs.BlockGasLimit,
genesisCliArgs.VoteExtensionEnableHeight,
genesisCliArgs.SignedBlocksWindow,
genesisCliArgs.MinSignedPerWindow,
genesisCliArgs.FinalitySigTimeout,
genesisCliArgs.JailDuration,
)
} else if network == "mainnet" {
panic("Mainnet params not implemented.")
Expand Down Expand Up @@ -293,6 +298,10 @@ func TestnetGenesisParams(
genesisTime time.Time,
blockGasLimit int64,
voteExtensionEnableHeight int64,
signedBlocksWindow int64,
minSignedPerWindow sdkmath.LegacyDec,
finalitySigTimeout int64,
jailDuration time.Duration,
) GenesisParams {

genParams := GenesisParams{}
Expand Down Expand Up @@ -424,5 +433,14 @@ func TestnetGenesisParams(

genParams.BlockGasLimit = blockGasLimit
genParams.VoteExtensionsEnableHeight = voteExtensionEnableHeight

genParams.FinalityParams.SignedBlocksWindow = signedBlocksWindow
genParams.FinalityParams.MinSignedPerWindow = minSignedPerWindow
genParams.FinalityParams.FinalitySigTimeout = finalitySigTimeout
genParams.FinalityParams.JailDuration = jailDuration
if err := genParams.FinalityParams.Validate(); err != nil {
panic(err)
}

return genParams
}
12 changes: 10 additions & 2 deletions cmd/babylond/cmd/testnet.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import (
"time"

"cosmossdk.io/math"
appkeepers "github.com/babylonlabs-io/babylon/app/keepers"
cmtconfig "github.com/cometbft/cometbft/config"
cmtos "github.com/cometbft/cometbft/libs/os"
cmttime "github.com/cometbft/cometbft/types/time"
Expand All @@ -35,6 +34,8 @@ import (
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
"github.com/spf13/cobra"

appkeepers "github.com/babylonlabs-io/babylon/app/keepers"

appparams "github.com/babylonlabs-io/babylon/app/params"
"github.com/babylonlabs-io/babylon/privval"
"github.com/babylonlabs-io/babylon/testutil/datagen"
Expand Down Expand Up @@ -74,7 +75,10 @@ Example:

serverCtx := server.GetServerContextFromCmd(cmd)
config := serverCtx.Config
genesisCliArgs := parseGenesisFlags(cmd)
genesisCliArgs, err := parseGenesisFlags(cmd)
if err != nil {
return err
}

outputDir, _ := cmd.Flags().GetString(flagOutputDir)
keyringBackend, _ := cmd.Flags().GetString(flags.FlagKeyringBackend)
Expand Down Expand Up @@ -118,6 +122,10 @@ Example:
genesisCliArgs.GenesisTime,
genesisCliArgs.BlockGasLimit,
genesisCliArgs.VoteExtensionEnableHeight,
genesisCliArgs.SignedBlocksWindow,
genesisCliArgs.MinSignedPerWindow,
genesisCliArgs.FinalitySigTimeout,
genesisCliArgs.JailDuration,
)

return InitTestnet(
Expand Down
Loading