mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2025-01-03 08:37:37 +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.
103 lines
3.2 KiB
Go
103 lines
3.2 KiB
Go
package filesystem
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
|
|
"github.com/prysmaticlabs/prysm/v5/testing/require"
|
|
)
|
|
|
|
func TestStore_GenesisValidatorsRoot(t *testing.T) {
|
|
ctx := context.Background()
|
|
|
|
genesisValidatorRootString := "0x0100"
|
|
genesisValidatorRootBytes := []byte{1, 0}
|
|
|
|
for _, tt := range []struct {
|
|
name string
|
|
savedConfiguration *Configuration
|
|
expectedGenesisValidatorRoot []byte
|
|
}{
|
|
{
|
|
name: "configuration is nil",
|
|
savedConfiguration: nil,
|
|
expectedGenesisValidatorRoot: nil,
|
|
},
|
|
{
|
|
name: "configuration.GenesisValidatorsRoot is nil",
|
|
savedConfiguration: &Configuration{GenesisValidatorsRoot: nil},
|
|
expectedGenesisValidatorRoot: nil,
|
|
},
|
|
{
|
|
name: "configuration.GenesisValidatorsRoot is something",
|
|
savedConfiguration: &Configuration{GenesisValidatorsRoot: &genesisValidatorRootString},
|
|
expectedGenesisValidatorRoot: genesisValidatorRootBytes,
|
|
},
|
|
} {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
// Create a new store.
|
|
store, err := NewStore(t.TempDir(), nil)
|
|
require.NoError(t, err)
|
|
|
|
// Save the configuration.
|
|
err = store.saveConfiguration(tt.savedConfiguration)
|
|
require.NoError(t, err, "save configuration should not error")
|
|
|
|
// Get genesis validators root.
|
|
actualGenesisValidatorRoot, err := store.GenesisValidatorsRoot(ctx)
|
|
require.NoError(t, err, "get genesis validators root should not error")
|
|
require.DeepEqual(t, tt.expectedGenesisValidatorRoot, actualGenesisValidatorRoot, "genesis validators root should be equal")
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestStore_SaveGenesisValidatorsRoot(t *testing.T) {
|
|
ctx := context.Background()
|
|
genesisValidatorRootString := "0x0100"
|
|
|
|
for _, tt := range []struct {
|
|
name string
|
|
initialConfiguration *Configuration
|
|
genesisValidatorRoot []byte
|
|
expectedConfiguration *Configuration
|
|
}{
|
|
{
|
|
name: "genValRoot is nil",
|
|
initialConfiguration: nil,
|
|
genesisValidatorRoot: nil,
|
|
expectedConfiguration: nil,
|
|
},
|
|
{
|
|
name: "initial configuration is nil",
|
|
initialConfiguration: nil,
|
|
genesisValidatorRoot: []byte{1, 0},
|
|
expectedConfiguration: &Configuration{GenesisValidatorsRoot: &genesisValidatorRootString},
|
|
},
|
|
{
|
|
name: "initial configuration exists",
|
|
initialConfiguration: &Configuration{},
|
|
genesisValidatorRoot: []byte{1, 0},
|
|
expectedConfiguration: &Configuration{GenesisValidatorsRoot: &genesisValidatorRootString},
|
|
},
|
|
} {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
// Create a new store.
|
|
store, err := NewStore(t.TempDir(), nil)
|
|
require.NoError(t, err)
|
|
|
|
// Save the initial configuration.
|
|
err = store.saveConfiguration(tt.initialConfiguration)
|
|
require.NoError(t, err, "save configuration should not error")
|
|
|
|
// Save genesis validators root.
|
|
err = store.SaveGenesisValidatorsRoot(ctx, tt.genesisValidatorRoot)
|
|
require.NoError(t, err, "save genesis validators root should not error")
|
|
|
|
// Get configuration.
|
|
actualConfiguration, err := store.configuration()
|
|
require.NoError(t, err, "get configuration should not error")
|
|
require.DeepEqual(t, tt.expectedConfiguration, actualConfiguration, "configuration should be equal")
|
|
})
|
|
}
|
|
}
|