mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2025-01-12 04:30:04 +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.
122 lines
4.0 KiB
Go
122 lines
4.0 KiB
Go
package kv
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
fieldparams "github.com/prysmaticlabs/prysm/v5/config/fieldparams"
|
|
ethpb "github.com/prysmaticlabs/prysm/v5/proto/prysm/v1alpha1"
|
|
"github.com/prysmaticlabs/prysm/v5/testing/require"
|
|
"github.com/prysmaticlabs/prysm/v5/validator/db/common"
|
|
)
|
|
|
|
func TestStore_Backup(t *testing.T) {
|
|
db := setupDB(t, nil)
|
|
ctx := context.Background()
|
|
root := [32]byte{1}
|
|
require.NoError(t, db.SaveGenesisValidatorsRoot(ctx, root[:]))
|
|
require.NoError(t, db.Backup(ctx, "", true))
|
|
|
|
backupsPath := filepath.Join(db.databasePath, backupsDirectoryName)
|
|
files, err := os.ReadDir(backupsPath)
|
|
require.NoError(t, err)
|
|
require.NotEqual(t, 0, len(files), "No backups created")
|
|
require.NoError(t, db.Close(), "Failed to close database")
|
|
|
|
oldFilePath := filepath.Join(backupsPath, files[0].Name())
|
|
newFilePath := filepath.Join(backupsPath, ProtectionDbFileName)
|
|
// We rename the file to match the database file name
|
|
// our NewKVStore function expects when opening a database.
|
|
require.NoError(t, os.Rename(oldFilePath, newFilePath))
|
|
|
|
backedDB, err := NewKVStore(ctx, backupsPath, &Config{})
|
|
require.NoError(t, err, "Failed to instantiate DB")
|
|
t.Cleanup(func() {
|
|
require.NoError(t, backedDB.Close(), "Failed to close database")
|
|
})
|
|
genesisRoot, err := backedDB.GenesisValidatorsRoot(ctx)
|
|
require.NoError(t, err)
|
|
require.DeepEqual(t, root[:], genesisRoot)
|
|
}
|
|
|
|
func TestStore_NestedBackup(t *testing.T) {
|
|
keys := [][fieldparams.BLSPubkeyLength]byte{{'A'}, {'B'}}
|
|
db := setupDB(t, keys)
|
|
ctx := context.Background()
|
|
root := [32]byte{1}
|
|
idxAtt := ðpb.IndexedAttestation{
|
|
AttestingIndices: nil,
|
|
Data: ðpb.AttestationData{
|
|
Slot: 0,
|
|
CommitteeIndex: 0,
|
|
BeaconBlockRoot: root[:],
|
|
Source: ðpb.Checkpoint{
|
|
Epoch: 10,
|
|
Root: root[:],
|
|
},
|
|
Target: ðpb.Checkpoint{
|
|
Epoch: 0,
|
|
Root: root[:],
|
|
},
|
|
},
|
|
Signature: make([]byte, 96),
|
|
}
|
|
require.NoError(t, db.SaveGenesisValidatorsRoot(ctx, root[:]))
|
|
require.NoError(t, db.SaveAttestationForPubKey(context.Background(), keys[0], [32]byte{'C'}, idxAtt))
|
|
require.NoError(t, db.SaveAttestationForPubKey(context.Background(), keys[1], [32]byte{'C'}, idxAtt))
|
|
require.NoError(t, db.Backup(ctx, "", true))
|
|
|
|
backupsPath := filepath.Join(db.databasePath, backupsDirectoryName)
|
|
files, err := os.ReadDir(backupsPath)
|
|
require.NoError(t, err)
|
|
require.NotEqual(t, 0, len(files), "No backups created")
|
|
require.NoError(t, db.Close(), "Failed to close database")
|
|
|
|
oldFilePath := filepath.Join(backupsPath, files[0].Name())
|
|
newFilePath := filepath.Join(backupsPath, ProtectionDbFileName)
|
|
// We rename the file to match the database file name
|
|
// our NewKVStore function expects when opening a database.
|
|
require.NoError(t, os.Rename(oldFilePath, newFilePath))
|
|
|
|
backedDB, err := NewKVStore(ctx, backupsPath, &Config{})
|
|
require.NoError(t, err, "Failed to instantiate DB")
|
|
t.Cleanup(func() {
|
|
require.NoError(t, backedDB.Close(), "Failed to close database")
|
|
})
|
|
genesisRoot, err := backedDB.GenesisValidatorsRoot(ctx)
|
|
require.NoError(t, err)
|
|
require.DeepEqual(t, root[:], genesisRoot)
|
|
|
|
signingRoot32 := [32]byte{'C'}
|
|
|
|
hist, err := backedDB.AttestationHistoryForPubKey(context.Background(), keys[0])
|
|
require.NoError(t, err)
|
|
require.DeepEqual(t, &common.AttestationRecord{
|
|
PubKey: keys[0],
|
|
Source: 10,
|
|
Target: 0,
|
|
SigningRoot: signingRoot32[:],
|
|
}, hist[0])
|
|
|
|
hist, err = backedDB.AttestationHistoryForPubKey(context.Background(), keys[1])
|
|
require.NoError(t, err)
|
|
require.DeepEqual(t, &common.AttestationRecord{
|
|
PubKey: keys[1],
|
|
Source: 10,
|
|
Target: 0,
|
|
SigningRoot: signingRoot32[:],
|
|
}, hist[0])
|
|
|
|
ep, exists, err := backedDB.LowestSignedSourceEpoch(context.Background(), keys[0])
|
|
require.NoError(t, err)
|
|
require.Equal(t, true, exists)
|
|
require.Equal(t, 10, int(ep))
|
|
|
|
ep, exists, err = backedDB.LowestSignedSourceEpoch(context.Background(), keys[1])
|
|
require.NoError(t, err)
|
|
require.Equal(t, true, exists)
|
|
require.Equal(t, 10, int(ep))
|
|
}
|