mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2024-12-22 03:30:35 +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.
266 lines
8.7 KiB
Go
266 lines
8.7 KiB
Go
package history
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"testing"
|
|
|
|
fieldparams "github.com/prysmaticlabs/prysm/v5/config/fieldparams"
|
|
"github.com/prysmaticlabs/prysm/v5/consensus-types/primitives"
|
|
ethpb "github.com/prysmaticlabs/prysm/v5/proto/prysm/v1alpha1"
|
|
"github.com/prysmaticlabs/prysm/v5/testing/assert"
|
|
"github.com/prysmaticlabs/prysm/v5/testing/require"
|
|
dbtest "github.com/prysmaticlabs/prysm/v5/validator/db/testing"
|
|
"github.com/prysmaticlabs/prysm/v5/validator/slashing-protection-history/format"
|
|
)
|
|
|
|
func TestExportStandardProtectionJSON_EmptyGenesisRoot(t *testing.T) {
|
|
for _, isSlashingProtectionMinimal := range [...]bool{false, true} {
|
|
t.Run(fmt.Sprintf("isSlashingProtectionMinimal=%v", isSlashingProtectionMinimal), func(t *testing.T) {
|
|
ctx := context.Background()
|
|
pubKeys := [][fieldparams.BLSPubkeyLength]byte{
|
|
{1},
|
|
}
|
|
validatorDB := dbtest.SetupDB(t, pubKeys, isSlashingProtectionMinimal)
|
|
_, err := ExportStandardProtectionJSON(ctx, validatorDB)
|
|
require.ErrorContains(t, "genesis validators root is empty", err)
|
|
genesisValidatorsRoot := [32]byte{1}
|
|
err = validatorDB.SaveGenesisValidatorsRoot(ctx, genesisValidatorsRoot[:])
|
|
require.NoError(t, err)
|
|
_, err = ExportStandardProtectionJSON(ctx, validatorDB)
|
|
require.NoError(t, err)
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_getSignedAttestationsByPubKey(t *testing.T) {
|
|
for _, isSlashingProtectionMinimal := range [...]bool{false, true} {
|
|
t.Run(fmt.Sprintf("OK/isSlashingProtectionMinimal:%v", isSlashingProtectionMinimal), func(t *testing.T) {
|
|
pubKeys := [][fieldparams.BLSPubkeyLength]byte{
|
|
{1},
|
|
}
|
|
ctx := context.Background()
|
|
validatorDB := dbtest.SetupDB(t, pubKeys, isSlashingProtectionMinimal)
|
|
|
|
// No attestation history stored should return empty.
|
|
signedAttestations, err := signedAttestationsByPubKey(ctx, validatorDB, pubKeys[0])
|
|
require.NoError(t, err)
|
|
assert.Equal(t, 0, len(signedAttestations))
|
|
|
|
// We write a real attesting history to disk for the public key.
|
|
lowestSourceEpoch := primitives.Epoch(0)
|
|
lowestTargetEpoch := primitives.Epoch(4)
|
|
|
|
require.NoError(t, validatorDB.SaveAttestationForPubKey(ctx, pubKeys[0], [32]byte{4}, createAttestation(
|
|
lowestSourceEpoch,
|
|
lowestTargetEpoch,
|
|
)))
|
|
require.NoError(t, validatorDB.SaveAttestationForPubKey(ctx, pubKeys[0], [32]byte{5}, createAttestation(
|
|
lowestSourceEpoch,
|
|
lowestTargetEpoch+1,
|
|
)))
|
|
|
|
// We then retrieve the signed attestations and expect a correct result.
|
|
signedAttestations, err = signedAttestationsByPubKey(ctx, validatorDB, pubKeys[0])
|
|
require.NoError(t, err)
|
|
|
|
wanted := []*format.SignedAttestation{
|
|
{
|
|
SourceEpoch: "0",
|
|
TargetEpoch: "4",
|
|
SigningRoot: "0x0400000000000000000000000000000000000000000000000000000000000000",
|
|
},
|
|
{
|
|
SourceEpoch: "0",
|
|
TargetEpoch: "5",
|
|
SigningRoot: "0x0500000000000000000000000000000000000000000000000000000000000000",
|
|
},
|
|
}
|
|
|
|
if isSlashingProtectionMinimal {
|
|
wanted = []*format.SignedAttestation{
|
|
{
|
|
SourceEpoch: "0",
|
|
TargetEpoch: "5",
|
|
},
|
|
}
|
|
}
|
|
assert.DeepEqual(t, wanted, signedAttestations)
|
|
})
|
|
}
|
|
|
|
// This test is specific to the old, complete slashing protection database schema bug.
|
|
// It is not needed for the new, minimal slashing protection database schema.
|
|
t.Run("old_schema_bug_edge_case_genesis", func(t *testing.T) {
|
|
pubKeys := [][fieldparams.BLSPubkeyLength]byte{
|
|
{1},
|
|
}
|
|
ctx := context.Background()
|
|
|
|
isSlashingProtectionMinimal := false
|
|
validatorDB := dbtest.SetupDB(t, pubKeys, isSlashingProtectionMinimal)
|
|
|
|
// No attestation history stored should return empty.
|
|
signedAttestations, err := signedAttestationsByPubKey(ctx, validatorDB, pubKeys[0])
|
|
require.NoError(t, err)
|
|
assert.Equal(t, 0, len(signedAttestations))
|
|
|
|
// We write a real attesting history to disk for the public key with
|
|
// source epoch 0 and target epoch 1000.
|
|
lowestSourceEpoch := primitives.Epoch(0)
|
|
lowestTargetEpoch := primitives.Epoch(1000)
|
|
|
|
// Next up, we simulate a DB affected by the bug where the next entry
|
|
// has a target epoch less than the previous one.
|
|
require.NoError(t, validatorDB.SaveAttestationForPubKey(ctx, pubKeys[0], [32]byte{4}, createAttestation(
|
|
lowestSourceEpoch,
|
|
lowestTargetEpoch,
|
|
)))
|
|
require.NoError(t, validatorDB.SaveAttestationForPubKey(ctx, pubKeys[0], [32]byte{5}, createAttestation(
|
|
1,
|
|
2,
|
|
)))
|
|
|
|
// We then retrieve the signed attestations and expect to have
|
|
// skipped the 0th, corrupted entry.
|
|
signedAttestations, err = signedAttestationsByPubKey(ctx, validatorDB, pubKeys[0])
|
|
require.NoError(t, err)
|
|
|
|
wanted := []*format.SignedAttestation{
|
|
{
|
|
SourceEpoch: "1",
|
|
TargetEpoch: "2",
|
|
SigningRoot: "0x0500000000000000000000000000000000000000000000000000000000000000",
|
|
},
|
|
}
|
|
assert.DeepEqual(t, wanted, signedAttestations)
|
|
})
|
|
|
|
// This test is specific to the old, complete slashing protection database schema bug.
|
|
// It is not needed for the new, minimal slashing protection database schema.
|
|
t.Run("old_schema_bug_edge_case_not_genesis", func(t *testing.T) {
|
|
pubKeys := [][fieldparams.BLSPubkeyLength]byte{
|
|
{1},
|
|
}
|
|
ctx := context.Background()
|
|
|
|
isSlashingProtectionMinimal := false
|
|
validatorDB := dbtest.SetupDB(t, pubKeys, isSlashingProtectionMinimal)
|
|
|
|
// No attestation history stored should return empty.
|
|
signedAttestations, err := signedAttestationsByPubKey(ctx, validatorDB, pubKeys[0])
|
|
require.NoError(t, err)
|
|
assert.Equal(t, 0, len(signedAttestations))
|
|
|
|
// We write a real attesting history to disk for the public key with
|
|
// source epoch 1 and target epoch 1000.
|
|
lowestSourceEpoch := primitives.Epoch(1)
|
|
lowestTargetEpoch := primitives.Epoch(1000)
|
|
|
|
// Next up, we simulate a DB affected by the bug where the next entry
|
|
// has a target epoch less than the previous one.
|
|
require.NoError(t, validatorDB.SaveAttestationForPubKey(ctx, pubKeys[0], [32]byte{4}, createAttestation(
|
|
lowestSourceEpoch,
|
|
lowestTargetEpoch,
|
|
)))
|
|
require.NoError(t, validatorDB.SaveAttestationForPubKey(ctx, pubKeys[0], [32]byte{5}, createAttestation(
|
|
1,
|
|
2,
|
|
)))
|
|
|
|
// We then retrieve the signed attestations and do not expect changes
|
|
// as the bug only manifests in the genesis epoch.
|
|
signedAttestations, err = signedAttestationsByPubKey(ctx, validatorDB, pubKeys[0])
|
|
require.NoError(t, err)
|
|
|
|
wanted := []*format.SignedAttestation{
|
|
{
|
|
SourceEpoch: "1",
|
|
TargetEpoch: "1000",
|
|
SigningRoot: "0x0400000000000000000000000000000000000000000000000000000000000000",
|
|
},
|
|
{
|
|
SourceEpoch: "1",
|
|
TargetEpoch: "2",
|
|
SigningRoot: "0x0500000000000000000000000000000000000000000000000000000000000000",
|
|
},
|
|
}
|
|
assert.DeepEqual(t, wanted, signedAttestations)
|
|
})
|
|
}
|
|
|
|
func Test_getSignedBlocksByPubKey(t *testing.T) {
|
|
for _, isSlashingProtectionMinimal := range [...]bool{false, true} {
|
|
t.Run(fmt.Sprintf("isSlashingProtectionMinimal:%v", isSlashingProtectionMinimal), func(t *testing.T) {
|
|
pubKeys := [][fieldparams.BLSPubkeyLength]byte{
|
|
{1},
|
|
}
|
|
ctx := context.Background()
|
|
validatorDB := dbtest.SetupDB(t, pubKeys, isSlashingProtectionMinimal)
|
|
|
|
// No highest and/or lowest signed blocks will return empty.
|
|
signedBlocks, err := signedBlocksByPubKey(ctx, validatorDB, pubKeys[0])
|
|
require.NoError(t, err)
|
|
assert.Equal(t, 0, len(signedBlocks))
|
|
|
|
// We mark slot 1 as proposed.
|
|
dummyRoot1 := [32]byte{1}
|
|
err = validatorDB.SaveProposalHistoryForSlot(ctx, pubKeys[0], 1, dummyRoot1[:])
|
|
require.NoError(t, err)
|
|
|
|
// We mark slot 3 as proposed but with empty signing root.
|
|
err = validatorDB.SaveProposalHistoryForSlot(ctx, pubKeys[0], 3, nil)
|
|
require.NoError(t, err)
|
|
|
|
// We mark slot 5 as proposed.
|
|
dummyRoot2 := [32]byte{2}
|
|
err = validatorDB.SaveProposalHistoryForSlot(ctx, pubKeys[0], 5, dummyRoot2[:])
|
|
require.NoError(t, err)
|
|
|
|
// We expect a valid proposal history containing slot 1 and slot 5 only
|
|
// when we attempt to retrieve it from disk.
|
|
signedBlocks, err = signedBlocksByPubKey(ctx, validatorDB, pubKeys[0])
|
|
require.NoError(t, err)
|
|
|
|
wanted := []*format.SignedBlock{
|
|
{
|
|
Slot: "1",
|
|
SigningRoot: fmt.Sprintf("%#x", dummyRoot1),
|
|
},
|
|
{
|
|
Slot: "3",
|
|
SigningRoot: "0x0000000000000000000000000000000000000000000000000000000000000000",
|
|
},
|
|
{
|
|
Slot: "5",
|
|
SigningRoot: fmt.Sprintf("%#x", dummyRoot2),
|
|
},
|
|
}
|
|
|
|
if isSlashingProtectionMinimal {
|
|
wanted = []*format.SignedBlock{
|
|
{
|
|
Slot: "5",
|
|
},
|
|
}
|
|
}
|
|
for i, blk := range wanted {
|
|
assert.DeepEqual(t, blk, signedBlocks[i])
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func createAttestation(source, target primitives.Epoch) *ethpb.IndexedAttestation {
|
|
return ðpb.IndexedAttestation{
|
|
Data: ðpb.AttestationData{
|
|
Source: ðpb.Checkpoint{
|
|
Epoch: source,
|
|
},
|
|
Target: ðpb.Checkpoint{
|
|
Epoch: target,
|
|
},
|
|
},
|
|
}
|
|
}
|