mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2025-01-03 00:27:38 +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.
237 lines
7.9 KiB
Go
237 lines
7.9 KiB
Go
package rpc
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
|
|
"github.com/prysmaticlabs/prysm/v5/testing/require"
|
|
"github.com/prysmaticlabs/prysm/v5/validator/accounts"
|
|
"github.com/prysmaticlabs/prysm/v5/validator/db/common"
|
|
"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/prysmaticlabs/prysm/v5/validator/keymanager"
|
|
"github.com/prysmaticlabs/prysm/v5/validator/slashing-protection-history/format"
|
|
mocks "github.com/prysmaticlabs/prysm/v5/validator/testing"
|
|
)
|
|
|
|
func TestImportSlashingProtection_Preconditions(t *testing.T) {
|
|
for _, isSlashingProtectionMinimal := range []bool{false, true} {
|
|
t.Run(fmt.Sprintf("slashing protection minimal: %v", isSlashingProtectionMinimal), func(t *testing.T) {
|
|
ctx := context.Background()
|
|
localWalletDir := setupWalletDir(t)
|
|
defaultWalletPath = localWalletDir
|
|
|
|
// Empty JSON.
|
|
s := &Server{
|
|
walletDir: defaultWalletPath,
|
|
}
|
|
|
|
request := &ImportSlashingProtectionRequest{
|
|
SlashingProtectionJson: "",
|
|
}
|
|
var buf bytes.Buffer
|
|
err := json.NewEncoder(&buf).Encode(request)
|
|
require.NoError(t, err)
|
|
|
|
req := httptest.NewRequest(http.MethodPost, "/v2/validator/slashing-protection/import", &buf)
|
|
wr := httptest.NewRecorder()
|
|
wr.Body = &bytes.Buffer{}
|
|
// No validator DB provided.
|
|
s.ImportSlashingProtection(wr, req)
|
|
require.Equal(t, http.StatusInternalServerError, wr.Code)
|
|
require.StringContains(t, "could not find validator database", wr.Body.String())
|
|
|
|
// Create Wallet and add to server for more realistic testing.
|
|
opts := []accounts.Option{
|
|
accounts.WithWalletDir(defaultWalletPath),
|
|
accounts.WithKeymanagerType(keymanager.Local),
|
|
accounts.WithWalletPassword(strongPass),
|
|
accounts.WithSkipMnemonicConfirm(true),
|
|
}
|
|
acc, err := accounts.NewCLIManager(opts...)
|
|
require.NoError(t, err)
|
|
w, err := acc.WalletCreate(ctx)
|
|
require.NoError(t, err)
|
|
s.wallet = w
|
|
|
|
numValidators := 1
|
|
// Create public keys for the mock validator DB.
|
|
pubKeys, err := mocks.CreateRandomPubKeys(numValidators)
|
|
require.NoError(t, err)
|
|
|
|
// Create a validator database.
|
|
var validatorDB iface.ValidatorDB
|
|
if isSlashingProtectionMinimal {
|
|
validatorDB, err = filesystem.NewStore(defaultWalletPath, &filesystem.Config{
|
|
PubKeys: pubKeys,
|
|
})
|
|
} else {
|
|
validatorDB, err = kv.NewKVStore(ctx, defaultWalletPath, &kv.Config{
|
|
PubKeys: pubKeys,
|
|
})
|
|
}
|
|
require.NoError(t, err)
|
|
s.valDB = validatorDB
|
|
|
|
// Have to close it after import is done otherwise it complains db is not open.
|
|
defer func() {
|
|
require.NoError(t, validatorDB.Close())
|
|
}()
|
|
|
|
// Test empty JSON.
|
|
wr = httptest.NewRecorder()
|
|
wr.Body = &bytes.Buffer{}
|
|
s.ImportSlashingProtection(wr, req)
|
|
require.Equal(t, http.StatusBadRequest, wr.Code)
|
|
require.StringContains(t, "empty slashing_protection_json specified", wr.Body.String())
|
|
|
|
// Generate mock slashing history.
|
|
attestingHistory := make([][]*common.AttestationRecord, 0)
|
|
proposalHistory := make([]common.ProposalHistoryForPubkey, len(pubKeys))
|
|
for i := 0; i < len(pubKeys); i++ {
|
|
proposalHistory[i].Proposals = make([]common.Proposal, 0)
|
|
}
|
|
mockJSON, err := mocks.MockSlashingProtectionJSON(pubKeys, attestingHistory, proposalHistory)
|
|
require.NoError(t, err)
|
|
|
|
// JSON encode the protection JSON and save it in rpc req.
|
|
encoded, err := json.Marshal(mockJSON)
|
|
require.NoError(t, err)
|
|
request.SlashingProtectionJson = string(encoded)
|
|
err = json.NewEncoder(&buf).Encode(request)
|
|
require.NoError(t, err)
|
|
|
|
req = httptest.NewRequest(http.MethodPost, "/v2/validator/slashing-protection/import", &buf)
|
|
wr = httptest.NewRecorder()
|
|
wr.Body = &bytes.Buffer{}
|
|
s.ImportSlashingProtection(wr, req)
|
|
require.Equal(t, http.StatusOK, wr.Code)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestExportSlashingProtection_Preconditions(t *testing.T) {
|
|
for _, isSlashingProtectionMinimal := range []bool{false, true} {
|
|
t.Run(fmt.Sprintf("slashing protection minimal: %v", isSlashingProtectionMinimal), func(t *testing.T) {
|
|
ctx := context.Background()
|
|
localWalletDir := setupWalletDir(t)
|
|
defaultWalletPath = localWalletDir
|
|
|
|
s := &Server{
|
|
walletDir: defaultWalletPath,
|
|
}
|
|
req := httptest.NewRequest(http.MethodGet, "/v2/validator/slashing-protection/export", nil)
|
|
wr := httptest.NewRecorder()
|
|
wr.Body = &bytes.Buffer{}
|
|
// No validator DB provided.
|
|
s.ExportSlashingProtection(wr, req)
|
|
require.Equal(t, http.StatusInternalServerError, wr.Code)
|
|
require.StringContains(t, "could not find validator database", wr.Body.String())
|
|
|
|
numValidators := 10
|
|
// Create public keys for the mock validator DB.
|
|
pubKeys, err := mocks.CreateRandomPubKeys(numValidators)
|
|
require.NoError(t, err)
|
|
|
|
// We create a validator database.
|
|
var validatorDB iface.ValidatorDB
|
|
if isSlashingProtectionMinimal {
|
|
validatorDB, err = filesystem.NewStore(t.TempDir(), &filesystem.Config{
|
|
PubKeys: pubKeys,
|
|
})
|
|
} else {
|
|
validatorDB, err = kv.NewKVStore(context.Background(), t.TempDir(), &kv.Config{
|
|
PubKeys: pubKeys,
|
|
})
|
|
}
|
|
require.NoError(t, err)
|
|
s.valDB = validatorDB
|
|
|
|
// Have to close it after export is done otherwise it complains db is not open.
|
|
defer func() {
|
|
require.NoError(t, validatorDB.Close())
|
|
}()
|
|
genesisValidatorsRoot := [32]byte{1}
|
|
err = validatorDB.SaveGenesisValidatorsRoot(ctx, genesisValidatorsRoot[:])
|
|
require.NoError(t, err)
|
|
wr = httptest.NewRecorder()
|
|
wr.Body = &bytes.Buffer{}
|
|
s.ExportSlashingProtection(wr, req)
|
|
require.Equal(t, http.StatusOK, wr.Code)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestImportExportSlashingProtection_RoundTrip(t *testing.T) {
|
|
// Round trip is only suitable with complete slashing protection, since
|
|
// minimal slashing protections only keep latest attestation and proposal.
|
|
ctx := context.Background()
|
|
localWalletDir := setupWalletDir(t)
|
|
defaultWalletPath = localWalletDir
|
|
|
|
s := &Server{
|
|
walletDir: defaultWalletPath,
|
|
}
|
|
|
|
numValidators := 10
|
|
// Create public keys for the mock validator DB.
|
|
pubKeys, err := mocks.CreateRandomPubKeys(numValidators)
|
|
require.NoError(t, err)
|
|
|
|
// Create a validator database.
|
|
validatorDB, err := kv.NewKVStore(ctx, defaultWalletPath, &kv.Config{
|
|
PubKeys: pubKeys,
|
|
})
|
|
require.NoError(t, err)
|
|
s.valDB = validatorDB
|
|
|
|
// Have to close it after import is done otherwise it complains db is not open.
|
|
defer func() {
|
|
require.NoError(t, validatorDB.Close())
|
|
}()
|
|
|
|
// Generate mock slashing history.
|
|
attestingHistory := make([][]*common.AttestationRecord, 0)
|
|
proposalHistory := make([]common.ProposalHistoryForPubkey, len(pubKeys))
|
|
for i := 0; i < len(pubKeys); i++ {
|
|
proposalHistory[i].Proposals = make([]common.Proposal, 0)
|
|
}
|
|
mockJSON, err := mocks.MockSlashingProtectionJSON(pubKeys, attestingHistory, proposalHistory)
|
|
require.NoError(t, err)
|
|
|
|
// JSON encode the protection JSON and save it in rpc req.
|
|
encoded, err := json.Marshal(mockJSON)
|
|
require.NoError(t, err)
|
|
request := &ImportSlashingProtectionRequest{
|
|
SlashingProtectionJson: string(encoded),
|
|
}
|
|
var buf bytes.Buffer
|
|
err = json.NewEncoder(&buf).Encode(request)
|
|
require.NoError(t, err)
|
|
|
|
req := httptest.NewRequest(http.MethodPost, "/v2/validator/slashing-protection/import", &buf)
|
|
wr := httptest.NewRecorder()
|
|
s.ImportSlashingProtection(wr, req)
|
|
|
|
req = httptest.NewRequest(http.MethodGet, "/v2/validator/slashing-protection/export", nil)
|
|
wr = httptest.NewRecorder()
|
|
s.ExportSlashingProtection(wr, req)
|
|
require.Equal(t, http.StatusOK, wr.Code)
|
|
resp := &ExportSlashingProtectionResponse{}
|
|
require.NoError(t, json.Unmarshal(wr.Body.Bytes(), resp))
|
|
// Attempt to read the exported data and convert from string to EIP-3076.
|
|
enc := []byte(resp.File)
|
|
|
|
receivedJSON := &format.EIPSlashingProtectionFormat{}
|
|
err = json.Unmarshal(enc, receivedJSON)
|
|
require.NoError(t, err)
|
|
|
|
require.DeepEqual(t, mockJSON.Metadata, receivedJSON.Metadata)
|
|
}
|