mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2024-12-22 11:32:09 +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.
194 lines
6.7 KiB
Go
194 lines
6.7 KiB
Go
package client
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/hex"
|
|
"encoding/json"
|
|
"fmt"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/bazelbuild/rules_go/go/tools/bazel"
|
|
fieldparams "github.com/prysmaticlabs/prysm/v5/config/fieldparams"
|
|
"github.com/prysmaticlabs/prysm/v5/consensus-types/blocks"
|
|
"github.com/prysmaticlabs/prysm/v5/io/file"
|
|
ethpb "github.com/prysmaticlabs/prysm/v5/proto/prysm/v1alpha1"
|
|
"github.com/prysmaticlabs/prysm/v5/testing/require"
|
|
"github.com/prysmaticlabs/prysm/v5/testing/util"
|
|
"github.com/prysmaticlabs/prysm/v5/validator/helpers"
|
|
)
|
|
|
|
type eip3076TestCase struct {
|
|
Name string `json:"name"`
|
|
GenesisValidatorsRoot string `json:"genesis_validators_root"`
|
|
Steps []struct {
|
|
ShouldSucceed bool `json:"should_succeed"`
|
|
AllowPartialImport bool `json:"allow_partial_import"`
|
|
Interchange struct {
|
|
Metadata struct {
|
|
InterchangeFormatVersion string `json:"interchange_format_version"`
|
|
GenesisValidatorsRoot string `json:"genesis_validators_root"`
|
|
} `json:"metadata"`
|
|
Data []struct {
|
|
Pubkey string `json:"pubkey"`
|
|
SignedBlocks []struct {
|
|
Slot string `json:"slot"`
|
|
SigningRoot string `json:"signing_root"`
|
|
} `json:"signed_blocks"`
|
|
SignedAttestations []struct {
|
|
SourceEpoch string `json:"source_epoch"`
|
|
TargetEpoch string `json:"target_epoch"`
|
|
SigningRoot string `json:"signing_root"`
|
|
} `json:"signed_attestations"`
|
|
} `json:"data"`
|
|
} `json:"interchange"`
|
|
Blocks []struct {
|
|
Pubkey string `json:"pubkey"`
|
|
Slot string `json:"slot"`
|
|
SigningRoot string `json:"signing_root"`
|
|
ShouldSucceedMinimal bool `json:"should_succeed"`
|
|
ShouldSucceedComplete bool `json:"should_succeed_complete"`
|
|
} `json:"blocks"`
|
|
Attestations []struct {
|
|
Pubkey string `json:"pubkey"`
|
|
SourceEpoch string `json:"source_epoch"`
|
|
TargetEpoch string `json:"target_epoch"`
|
|
SigningRoot string `json:"signing_root"`
|
|
ShouldSucceedMinimal bool `json:"should_succeed"`
|
|
ShouldSucceedComplete bool `json:"should_succeed_complete"`
|
|
} `json:"attestations"`
|
|
} `json:"steps"`
|
|
}
|
|
|
|
func setupEIP3076SpecTests(t *testing.T) []*eip3076TestCase {
|
|
testFolders, err := bazel.ListRunfiles()
|
|
require.NoError(t, err)
|
|
testCases := make([]*eip3076TestCase, 0)
|
|
for _, ff := range testFolders {
|
|
if strings.Contains(ff.ShortPath, "eip3076_spec_tests") &&
|
|
strings.Contains(ff.ShortPath, "generated/") {
|
|
enc, err := file.ReadFileAsBytes(ff.Path)
|
|
require.NoError(t, err)
|
|
testCase := &eip3076TestCase{}
|
|
require.NoError(t, json.Unmarshal(enc, testCase))
|
|
testCases = append(testCases, testCase)
|
|
}
|
|
}
|
|
return testCases
|
|
}
|
|
|
|
func TestEIP3076SpecTests(t *testing.T) {
|
|
for _, isMinimal := range []bool{false, true} {
|
|
slashingProtectionType := "complete"
|
|
if isMinimal {
|
|
slashingProtectionType = "minimal"
|
|
}
|
|
|
|
for _, tt := range setupEIP3076SpecTests(t) {
|
|
t.Run(fmt.Sprintf("%s-%s", slashingProtectionType, tt.Name), func(t *testing.T) {
|
|
if tt.Name == "" {
|
|
t.Skip("Skipping eip3076TestCase with empty name")
|
|
}
|
|
|
|
// Set up validator client, one new validator client per eip3076TestCase.
|
|
// This ensures we initialize a new (empty) slashing protection database.
|
|
validator, _, _, _ := setup(t, isMinimal)
|
|
|
|
for _, step := range tt.Steps {
|
|
if tt.GenesisValidatorsRoot != "" {
|
|
r, err := helpers.RootFromHex(tt.GenesisValidatorsRoot)
|
|
require.NoError(t, validator.db.SaveGenesisValidatorsRoot(context.Background(), r[:]))
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
// The eip3076TestCase config contains the interchange config in json.
|
|
// This loads the interchange data via ImportStandardProtectionJSON.
|
|
interchangeBytes, err := json.Marshal(step.Interchange)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
b := bytes.NewBuffer(interchangeBytes)
|
|
if err := validator.db.ImportStandardProtectionJSON(context.Background(), b); err != nil {
|
|
if step.ShouldSucceed {
|
|
t.Fatal(err)
|
|
}
|
|
} else if !step.ShouldSucceed {
|
|
require.NotNil(t, err, "import standard protection json should have failed")
|
|
}
|
|
|
|
// This loops through a list of block signings to attempt after importing the interchange data above.
|
|
for _, sb := range step.Blocks {
|
|
shouldSucceed := sb.ShouldSucceedComplete
|
|
if isMinimal {
|
|
shouldSucceed = sb.ShouldSucceedMinimal
|
|
}
|
|
|
|
bSlot, err := helpers.SlotFromString(sb.Slot)
|
|
require.NoError(t, err)
|
|
pk, err := helpers.PubKeyFromHex(sb.Pubkey)
|
|
require.NoError(t, err)
|
|
b := util.NewBeaconBlock()
|
|
b.Block.Slot = bSlot
|
|
|
|
var signingRoot [32]byte
|
|
if sb.SigningRoot != "" {
|
|
signingRootBytes, err := hex.DecodeString(strings.TrimPrefix(sb.SigningRoot, "0x"))
|
|
require.NoError(t, err)
|
|
copy(signingRoot[:], signingRootBytes)
|
|
}
|
|
|
|
wsb, err := blocks.NewSignedBeaconBlock(b)
|
|
require.NoError(t, err)
|
|
err = validator.db.SlashableProposalCheck(context.Background(), pk, wsb, signingRoot, validator.emitAccountMetrics, ValidatorProposeFailVec)
|
|
if shouldSucceed {
|
|
require.NoError(t, err)
|
|
} else {
|
|
require.NotEqual(t, nil, err, "pre validation should have failed for block")
|
|
}
|
|
}
|
|
|
|
// This loops through a list of attestation signings to attempt after importing the interchange data above.
|
|
for _, sa := range step.Attestations {
|
|
shouldSucceed := sa.ShouldSucceedComplete
|
|
if isMinimal {
|
|
shouldSucceed = sa.ShouldSucceedMinimal
|
|
}
|
|
|
|
target, err := helpers.EpochFromString(sa.TargetEpoch)
|
|
require.NoError(t, err)
|
|
source, err := helpers.EpochFromString(sa.SourceEpoch)
|
|
require.NoError(t, err)
|
|
pk, err := helpers.PubKeyFromHex(sa.Pubkey)
|
|
require.NoError(t, err)
|
|
ia := ðpb.IndexedAttestation{
|
|
Data: ðpb.AttestationData{
|
|
BeaconBlockRoot: make([]byte, 32),
|
|
Target: ðpb.Checkpoint{Epoch: target, Root: make([]byte, 32)},
|
|
Source: ðpb.Checkpoint{Epoch: source, Root: make([]byte, 32)},
|
|
},
|
|
Signature: make([]byte, fieldparams.BLSSignatureLength),
|
|
}
|
|
|
|
var signingRoot [32]byte
|
|
if sa.SigningRoot != "" {
|
|
signingRootBytes, err := hex.DecodeString(strings.TrimPrefix(sa.SigningRoot, "0x"))
|
|
require.NoError(t, err)
|
|
copy(signingRoot[:], signingRootBytes)
|
|
}
|
|
|
|
err = validator.db.SlashableAttestationCheck(context.Background(), ia, pk, signingRoot, false, nil)
|
|
if shouldSucceed {
|
|
require.NoError(t, err)
|
|
} else {
|
|
require.NotNil(t, err, "pre validation should have failed for attestation")
|
|
}
|
|
}
|
|
}
|
|
|
|
require.NoError(t, validator.db.Close(), "failed to close slashing protection database")
|
|
})
|
|
}
|
|
}
|
|
}
|