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

feat: add feature to track every validators in the pool #94

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ GLOBAL OPTIONS:
--start-timeout value timeout to wait on startup for one node to be ready (default: 10s)
--stop-timeout value timeout to wait on stop (default: 10s)
--validator value [ --validator value ] validator address(es) to track (use :my-label to add a custom label in metrics & ouput)
--enable-all-validators enable to track all validators in the pool. (to track every validators, the chain should have staking module)
--webhook-url value endpoint where to send upgrade webhooks (experimental)
--webhook-custom-block value [ --webhook-custom-block value ] trigger a custom webhook at a given block number (experimental)
--x-gov value version of the gov module to use (v1|v1beta1) (default: "v1")
Expand Down
4 changes: 4 additions & 0 deletions pkg/app/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ var Flags = []cli.Flag{
Name: "validator",
Usage: "validator address(es) to track (use :my-label to add a custom label in metrics & ouput)",
},
&cli.BoolFlag{
Name: "enable-all-validators",
Usage: "enable to track all validators in the pool. (to track every validators, the chain should have staking module)",
},
&cli.StringFlag{
Name: "webhook-url",
Usage: "endpoint where to send upgrade webhooks (experimental)",
Expand Down
89 changes: 60 additions & 29 deletions pkg/app/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ func RunFunc(cCtx *cli.Context) error {
startTimeout = cCtx.Duration("start-timeout")
stopTimeout = cCtx.Duration("stop-timeout")
validators = cCtx.StringSlice("validator")
enableAllValidators = cCtx.Bool("enable-all-validators")
webhookURL = cCtx.String("webhook-url")
webhookCustomBlocks = cCtx.StringSlice("webhook-custom-block")
xGov = cCtx.String("x-gov")
Expand Down Expand Up @@ -106,7 +107,7 @@ func RunFunc(cCtx *cli.Context) error {
Msg("cosmos modules features status")

// Parse validators into name & address
trackedValidators, err := createTrackedValidators(ctx, pool, validators, noStaking)
trackedValidators, err := createTrackedValidators(ctx, pool, validators, noStaking, enableAllValidators)
if err != nil {
return err
}
Expand Down Expand Up @@ -362,7 +363,7 @@ func ensureCosmosModule(name string, modules []*upgrade.ModuleVersion) bool {
return false
}

func createTrackedValidators(ctx context.Context, pool *rpc.Pool, validators []string, noStaking bool) ([]watcher.TrackedValidator, error) {
func createTrackedValidators(ctx context.Context, pool *rpc.Pool, validators []string, noStaking, trackAll bool) ([]watcher.TrackedValidator, error) {
var stakingValidators []staking.Validator
if !noStaking {
node := pool.GetSyncedNode()
Expand All @@ -380,35 +381,65 @@ func createTrackedValidators(ctx context.Context, pool *rpc.Pool, validators []s
stakingValidators = resp.Validators
}

trackedValidators := lo.Map(validators, func(v string, _ int) watcher.TrackedValidator {
val := watcher.ParseValidator(v)

for _, stakingVal := range stakingValidators {
address := crypto.PubKeyAddress(stakingVal.ConsensusPubkey)
if address == val.Address {
hrp := crypto.GetHrpPrefix(stakingVal.OperatorAddress) + "valcons"
val.Moniker = stakingVal.Description.Moniker
val.OperatorAddress = stakingVal.OperatorAddress
val.ConsensusAddress = crypto.PubKeyBech32Address(stakingVal.ConsensusPubkey, hrp)
var trackedValidators []watcher.TrackedValidator

if trackAll {
log.Info().Msg("tracking all validators")

trackedValidators = lo.Map(stakingValidators, func(stakingVal staking.Validator, index int) watcher.TrackedValidator {
val := watcher.ParseValidator(fmt.Sprintf("%s:%s", crypto.PubKeyAddress(stakingVal.ConsensusPubkey), stakingVal.Description.Moniker))
hrp := crypto.GetHrpPrefix(stakingVal.OperatorAddress) + "valcons"
val.Moniker = stakingVal.Description.Moniker
val.OperatorAddress = stakingVal.OperatorAddress
val.ConsensusAddress = crypto.PubKeyBech32Address(stakingVal.ConsensusPubkey, hrp)

log.Info().
Str("alias", val.Name).
Str("moniker", val.Moniker).
Msgf("tracking validator %s", val.Address)

log.Debug().
Str("account", val.AccountAddress()).
Str("address", val.Address).
Str("alias", val.Name).
Str("moniker", val.Moniker).
Str("operator", val.OperatorAddress).
Str("consensus", val.ConsensusAddress).
Msgf("validator info")

return val
})
} else {
trackedValidators = lo.Map(validators, func(v string, _ int) watcher.TrackedValidator {
val := watcher.ParseValidator(v)

for _, stakingVal := range stakingValidators {
address := crypto.PubKeyAddress(stakingVal.ConsensusPubkey)
if address == val.Address {
hrp := crypto.GetHrpPrefix(stakingVal.OperatorAddress) + "valcons"
val.Moniker = stakingVal.Description.Moniker
val.OperatorAddress = stakingVal.OperatorAddress
val.ConsensusAddress = crypto.PubKeyBech32Address(stakingVal.ConsensusPubkey, hrp)
}
}
}

log.Info().
Str("alias", val.Name).
Str("moniker", val.Moniker).
Msgf("tracking validator %s", val.Address)

log.Debug().
Str("account", val.AccountAddress()).
Str("address", val.Address).
Str("alias", val.Name).
Str("moniker", val.Moniker).
Str("operator", val.OperatorAddress).
Str("consensus", val.ConsensusAddress).
Msgf("validator info")

return val
})
log.Info().
Str("alias", val.Name).
Str("moniker", val.Moniker).
Msgf("tracking validator %s", val.Address)

log.Debug().
Str("account", val.AccountAddress()).
Str("address", val.Address).
Str("alias", val.Name).
Str("moniker", val.Moniker).
Str("operator", val.OperatorAddress).
Str("consensus", val.ConsensusAddress).
Msgf("validator info")

return val
})
}

return trackedValidators, nil
}