mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2025-01-05 01:04:29 +00:00
ef21d3adf8
* `EpochFromString`: Use already defined `Uint64FromString` function. * `Test_uint64FromString` => `Test_FromString` This test function tests more functions than `Uint64FromString`. * Slashing protection history: Remove unreachable code. The function `NewKVStore` creates, via `kv.UpdatePublicKeysBuckets`, a new item in the `proposal-history-bucket-interchange`. IMO there is no real reason to prefer `proposal` than `attestation` as a prefix for this bucket, but this is the way it is done right now and renaming the bucket will probably be backward incompatible. An `attestedPublicKey` cannot exist without the corresponding `proposedPublicKey`. Thus, the `else` portion of code removed in this commit is not reachable. We raise an error if we get there. This is also probably the reason why the removed `else` portion was not tested. * `NewKVStore`: Switch items in `createBuckets`. So the order corresponds to `schema.go` * `slashableAttestationCheck`: Fix comments and logs. * `ValidatorClient.db`: Use `iface.ValidatorDB`. * BoltDB database: Implement `GraffitiFileHash`. * Filesystem database: Creates `db.go`. This file defines the following structs: - `Store` - `Graffiti` - `Configuration` - `ValidatorSlashingProtection` This files implements the following public functions: - `NewStore` - `Close` - `Backup` - `DatabasePath` - `ClearDB` - `UpdatePublicKeysBuckets` This files implements the following private functions: - `slashingProtectionDirPath` - `configurationFilePath` - `configuration` - `saveConfiguration` - `validatorSlashingProtection` - `saveValidatorSlashingProtection` - `publicKeys` * Filesystem database: Creates `genesis.go`. This file defines the following public functions: - `GenesisValidatorsRoot` - `SaveGenesisValidatorsRoot` * Filesystem database: Creates `graffiti.go`. This file defines the following public functions: - `SaveGraffitiOrderedIndex` - `GraffitiOrderedIndex` * Filesystem database: Creates `migration.go`. This file defines the following public functions: - `RunUpMigrations` - `RunDownMigrations` * Filesystem database: Creates proposer_settings.go. This file defines the following public functions: - `ProposerSettings` - `ProposerSettingsExists` - `SaveProposerSettings` * Filesystem database: Creates `attester_protection.go`. This file defines the following public functions: - `EIPImportBlacklistedPublicKeys` - `SaveEIPImportBlacklistedPublicKeys` - `SigningRootAtTargetEpoch` - `LowestSignedTargetEpoch` - `LowestSignedSourceEpoch` - `AttestedPublicKeys` - `CheckSlashableAttestation` - `SaveAttestationForPubKey` - `SaveAttestationsForPubKey` - `AttestationHistoryForPubKey` * Filesystem database: Creates `proposer_protection.go`. This file defines the following public functions: - `HighestSignedProposal` - `LowestSignedProposal` - `ProposalHistoryForPubKey` - `ProposalHistoryForSlot` - `ProposedPublicKeys` * Ensure that the filesystem store implements the `ValidatorDB` interface. * `slashableAttestationCheck`: Check the database type. * `slashableProposalCheck`: Check the database type. * `slashableAttestationCheck`: Allow usage of minimal slashing protection. * `slashableProposalCheck`: Allow usage of minimal slashing protection. * `ImportStandardProtectionJSON`: Check the database type. * `ImportStandardProtectionJSON`: Allow usage of min slashing protection. * Implement `RecursiveDirFind`. * Implement minimal<->complete DB conversion. 3 public functions are implemented: - `IsCompleteDatabaseExisting` - `IsMinimalDatabaseExisting` - `ConvertDatabase` * `setupDB`: Add `isSlashingProtectionMinimal` argument. The feature addition is located in `validator/node/node_test.go`. The rest of this commit consists in minimal slashing protection testing. * `setupWithKey`: Add `isSlashingProtectionMinimal` argument. The feature addition is located in `validator/client/propose_test.go`. The rest of this commit consists in tests wrapping. * `setup`: Add `isSlashingProtectionMinimal` argument. The added feature is located in the `validator/client/propose_test.go` file. The rest of this commit consists in tests wrapping. * `initializeFromCLI` and `initializeForWeb`: Factorize db init. * Add `convert-complete-to-minimal` command. * Creates `--enable-minimal-slashing-protection` flag. * `importSlashingProtectionJSON`: Check database type. * `exportSlashingProtectionJSON`: Check database type. * `TestClearDB`: Test with minimal slashing protection. * KeyManager: Test with minimal slashing protection. * RPC: KeyManager: Test with minimal slashing protection. * `convert-complete-to-minimal`: Change option names. Options were: - `--source` (for source data directory), and - `--target` (for target data directory) However, since this command deals with slashing protection, which has source (epochs) and target (epochs), the initial option names may confuse the user. In this commit: `--source` ==> `--source-data-dir` `--target` ==> `--target-data-dir` * Set `SlashableAttestationCheck` as an iface method. And delete `CheckSlashableAttestation` from iface. * Move helpers functions in a more general directory. No functional change. * Extract common structs out of `kv`. ==> `filesystem` does not depend anymore on `kv`. ==> `iface` does not depend anymore on `kv`. ==> `slashing-protection` does not depend anymore on `kv`. * Move `ValidateMetadata` in `validator/helpers`. * `ValidateMetadata`: Test with mock. This way, we can: - Avoid any circular import for tests. - Implement once for all `iface.ValidatorDB` implementations the `ValidateMetadata`function. - Have tests (and coverage) of `ValidateMetadata`in its own package. The ideal solution would have been to implement `ValidateMetadata` as a method with the `iface.ValidatorDB`receiver. Unfortunately, golang does not allow that. * `iface.ValidatorDB`: Implement ImportStandardProtectionJSON. The whole purpose of this commit is to avoid the `switch validatorDB.(type)` in `ImportStandardProtectionJSON`. * `iface.ValidatorDB`: Implement `SlashableProposalCheck`. * Remove now useless `slashableProposalCheck`. * Delete useless `ImportStandardProtectionJSON`. * `file.Exists`: Detect directories and return an error. Before, `Exists` was only able to detect if a file exists. Now, this function takes an extra `File` or `Directory` argument. It detects either if a file or a directory exists. Before, if an error was returned by `os.Stat`, the the file was considered as non existing. Now, it is treated as a real error. * Replace `os.Stat` by `file.Exists`. * Remove `Is{Complete,Minimal}DatabaseExisting`. * `publicKeys`: Add log if unexpected file found. * Move `{Source,Target}DataDirFlag`in `db.go`. * `failedAttLocalProtectionErr`: `var`==> `const` * `signingRoot`: `32`==> `fieldparams.RootLength`. * `validatorClientData`==> `validator-client-data`. To be consistent with `slashing-protection`. * Add progress bars for `import` and `convert`. * `parseBlocksForUniquePublicKeys`: Move in `db/kv`. * helpers: Remove unused `initializeProgressBar` function.
114 lines
3.6 KiB
Go
114 lines
3.6 KiB
Go
package historycmd
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
|
|
"github.com/pkg/errors"
|
|
"github.com/prysmaticlabs/prysm/v5/cmd"
|
|
"github.com/prysmaticlabs/prysm/v5/cmd/validator/flags"
|
|
"github.com/prysmaticlabs/prysm/v5/config/features"
|
|
"github.com/prysmaticlabs/prysm/v5/io/file"
|
|
"github.com/prysmaticlabs/prysm/v5/validator/accounts/userprompt"
|
|
"github.com/prysmaticlabs/prysm/v5/validator/db/filesystem"
|
|
"github.com/prysmaticlabs/prysm/v5/validator/db/iface"
|
|
"github.com/prysmaticlabs/prysm/v5/validator/db/kv"
|
|
"github.com/urfave/cli/v2"
|
|
)
|
|
|
|
// Reads an input slashing protection EIP-3076
|
|
// standard JSON file and attempts to insert its data into our validator DB.
|
|
//
|
|
// Steps:
|
|
// 1. Parse a path to the validator's datadir from the CLI context.
|
|
// 2. Open the validator database.
|
|
// 3. Read the JSON file from user input.
|
|
// 4. Call the function which actually imports the data from
|
|
// the standard slashing protection JSON file into our database.
|
|
func importSlashingProtectionJSON(cliCtx *cli.Context) error {
|
|
var (
|
|
valDB iface.ValidatorDB
|
|
found bool
|
|
err error
|
|
)
|
|
|
|
// Check if a minimal database is requested
|
|
isDatabaseMimimal := cliCtx.Bool(features.EnableMinimalSlashingProtection.Name)
|
|
|
|
// Get the data directory from the CLI context.
|
|
dataDir := cliCtx.String(cmd.DataDirFlag.Name)
|
|
if !cliCtx.IsSet(cmd.DataDirFlag.Name) {
|
|
dataDir, err = userprompt.InputDirectory(cliCtx, userprompt.DataDirDirPromptText, cmd.DataDirFlag)
|
|
if err != nil {
|
|
return errors.Wrapf(err, "could not read directory value from input")
|
|
}
|
|
}
|
|
|
|
// Ensure that the database is found under the specified directory or its subdirectories
|
|
if isDatabaseMimimal {
|
|
found, _, err = file.RecursiveDirFind(filesystem.DatabaseDirName, dataDir)
|
|
} else {
|
|
found, _, err = file.RecursiveFileFind(kv.ProtectionDbFileName, dataDir)
|
|
}
|
|
|
|
if err != nil {
|
|
return errors.Wrapf(err, "error finding validator database at path %s", dataDir)
|
|
}
|
|
|
|
message := "Found existing database inside of %s"
|
|
if !found {
|
|
message = "Did not find existing database inside of %s, creating a new one"
|
|
}
|
|
|
|
log.Infof(message, dataDir)
|
|
|
|
// Open the validator database.
|
|
if isDatabaseMimimal {
|
|
valDB, err = filesystem.NewStore(dataDir, nil)
|
|
} else {
|
|
valDB, err = kv.NewKVStore(cliCtx.Context, dataDir, nil)
|
|
}
|
|
|
|
if err != nil {
|
|
return errors.Wrapf(err, "could not access validator database at path: %s", dataDir)
|
|
}
|
|
|
|
// Close the database when we're done.
|
|
defer func() {
|
|
if err := valDB.Close(); err != nil {
|
|
log.WithError(err).Errorf("Could not close validator DB")
|
|
}
|
|
}()
|
|
|
|
// Get the path to the slashing protection JSON file from the CLI context.
|
|
protectionFilePath, err := userprompt.InputDirectory(cliCtx, userprompt.SlashingProtectionJSONPromptText, flags.SlashingProtectionJSONFileFlag)
|
|
if err != nil {
|
|
return errors.Wrap(err, "could not get slashing protection json file")
|
|
}
|
|
if protectionFilePath == "" {
|
|
return fmt.Errorf(
|
|
"no path to a slashing_protection.json file specified, please retry or "+
|
|
"you can also specify it with the %s flag",
|
|
flags.SlashingProtectionJSONFileFlag.Name,
|
|
)
|
|
}
|
|
|
|
// Read the JSON file from user input.
|
|
enc, err := file.ReadFileAsBytes(protectionFilePath)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Import the data from the standard slashing protection JSON file into our database.
|
|
log.Infof("Starting import of slashing protection file %s", protectionFilePath)
|
|
buf := bytes.NewBuffer(enc)
|
|
|
|
if err := valDB.ImportStandardProtectionJSON(cliCtx.Context, buf); err != nil {
|
|
return errors.Wrapf(err, "could not import slashing protection JSON file %s", protectionFilePath)
|
|
}
|
|
|
|
log.Infof("Slashing protection JSON successfully imported into %s", dataDir)
|
|
|
|
return nil
|
|
}
|