-
Notifications
You must be signed in to change notification settings - Fork 185
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
2/2 chore(cli): improve tooling around deposits (#2392)
- Loading branch information
Showing
7 changed files
with
200 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| // SPDX-License-Identifier: BUSL-1.1 | ||
| // | ||
| // Copyright (C) 2025, Berachain Foundation. All rights reserved. | ||
| // Use of this software is governed by the Business Source License included | ||
| // in the LICENSE file of this repository and at www.mariadb.com/bsl11. | ||
| // | ||
| // ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY | ||
| // TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER | ||
| // VERSIONS OF THE LICENSED WORK. | ||
| // | ||
| // THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF | ||
| // LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF | ||
| // LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE). | ||
| // | ||
| // TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON | ||
| // AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, | ||
| // EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF | ||
| // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND | ||
| // TITLE. | ||
|
|
||
| package deposit | ||
|
|
||
| import ( | ||
| "github.com/berachain/beacon-kit/chain" | ||
| "github.com/berachain/beacon-kit/cli/utils/genesis" | ||
| "github.com/berachain/beacon-kit/cli/utils/parser" | ||
| "github.com/berachain/beacon-kit/errors" | ||
| "github.com/berachain/beacon-kit/primitives/common" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| // Get the genesis validator root. If the genesis validator root flag is not set, the genesis | ||
| // validator root is computed from the genesis file at the last argument (idx: maxArgs - 1). | ||
| func getGenesisValidatorRoot( | ||
| cmd *cobra.Command, chainSpec chain.Spec, args []string, maxArgs int, | ||
| ) (common.Root, error) { | ||
| var genesisValidatorRoot common.Root | ||
| genesisValidatorRootStr, err := cmd.Flags().GetString(useGenesisValidatorRoot) | ||
| if err != nil { | ||
| return common.Root{}, err | ||
| } | ||
|
|
||
| if genesisValidatorRootStr != defaultGenesisValidatorRoot { | ||
| genesisValidatorRoot, err = parser.ConvertGenesisValidatorRoot(genesisValidatorRootStr) | ||
| } else { | ||
| if len(args) != maxArgs { | ||
| return common.Root{}, errors.New( | ||
| "genesis validator root is required if not using the genesis file flag", | ||
| ) | ||
| } | ||
| genesisValidatorRoot, err = genesis.ComputeValidatorsRootFromFile(args[maxArgs-1], chainSpec) | ||
| } | ||
|
|
||
| return genesisValidatorRoot, err | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| // SPDX-License-Identifier: BUSL-1.1 | ||
| // | ||
| // Copyright (C) 2025, Berachain Foundation. All rights reserved. | ||
| // Use of this software is governed by the Business Source License included | ||
| // in the LICENSE file of this repository and at www.mariadb.com/bsl11. | ||
| // | ||
| // ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY | ||
| // TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER | ||
| // VERSIONS OF THE LICENSED WORK. | ||
| // | ||
| // THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF | ||
| // LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF | ||
| // LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE). | ||
| // | ||
| // TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON | ||
| // AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, | ||
| // EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF | ||
| // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND | ||
| // TITLE. | ||
|
|
||
| package genesis | ||
|
|
||
| import ( | ||
| "github.com/berachain/beacon-kit/chain" | ||
| "github.com/berachain/beacon-kit/consensus-types/types" | ||
| "github.com/berachain/beacon-kit/errors" | ||
| "github.com/berachain/beacon-kit/primitives/common" | ||
| "github.com/berachain/beacon-kit/primitives/encoding/json" | ||
| "github.com/berachain/beacon-kit/primitives/math" | ||
| "github.com/spf13/afero" | ||
| ) | ||
|
|
||
| // Beacon, AppState and Genesis are code duplications that | ||
| // collectively reproduce part of genesis file structure | ||
|
|
||
| type Beacon struct { | ||
| Deposits types.Deposits `json:"deposits"` | ||
| } | ||
|
|
||
| type AppState struct { | ||
| Beacon `json:"beacon"` | ||
| } | ||
|
|
||
| type Genesis struct { | ||
| AppState `json:"app_state"` | ||
| } | ||
|
|
||
| // ComputeValidatorsRootFromFile returns the validator root for a given genesis file and chain spec. | ||
| func ComputeValidatorsRootFromFile(genesisFile string, cs chain.Spec) (common.Root, error) { | ||
| genesisBz, err := afero.ReadFile(afero.NewOsFs(), genesisFile) | ||
| if err != nil { | ||
| return common.Root{}, errors.Wrap(err, "failed to genesis json file") | ||
| } | ||
|
|
||
| var appGenesis Genesis | ||
| err = json.Unmarshal(genesisBz, &appGenesis) | ||
| if err != nil { | ||
| return common.Root{}, errors.Wrap(err, "failed to unmarshal JSON") | ||
| } | ||
|
|
||
| return ComputeValidatorsRoot(appGenesis.Deposits, cs), nil | ||
| } | ||
|
|
||
| // ComputeValidatorsRoot returns the validator root for a given set of genesis deposits | ||
| // and a chain spec. | ||
| func ComputeValidatorsRoot(genesisDeposits types.Deposits, cs chain.Spec) common.Root { | ||
| validators := make(types.Validators, len(genesisDeposits)) | ||
| minEffectiveBalance := math.Gwei(cs.EjectionBalance() + cs.EffectiveBalanceIncrement()) | ||
|
|
||
| for i, deposit := range genesisDeposits { | ||
| val := types.NewValidatorFromDeposit( | ||
| deposit.Pubkey, | ||
| deposit.Credentials, | ||
| deposit.Amount, | ||
| math.Gwei(cs.EffectiveBalanceIncrement()), | ||
| math.Gwei(cs.MaxEffectiveBalance()), | ||
| ) | ||
|
|
||
| // mimic processGenesisActivation | ||
| if val.GetEffectiveBalance() >= minEffectiveBalance { | ||
| val.SetActivationEligibilityEpoch(0) | ||
| val.SetActivationEpoch(0) | ||
| } | ||
| validators[i] = val | ||
| } | ||
|
|
||
| return validators.HashTreeRoot() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters