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.
118 lines
4.3 KiB
Go
118 lines
4.3 KiB
Go
package testing
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
fieldparams "github.com/prysmaticlabs/prysm/v5/config/fieldparams"
|
|
"github.com/prysmaticlabs/prysm/v5/config/params"
|
|
"github.com/prysmaticlabs/prysm/v5/consensus-types/primitives"
|
|
"github.com/prysmaticlabs/prysm/v5/crypto/bls"
|
|
"github.com/prysmaticlabs/prysm/v5/crypto/rand"
|
|
"github.com/prysmaticlabs/prysm/v5/encoding/bytesutil"
|
|
"github.com/prysmaticlabs/prysm/v5/validator/db/common"
|
|
"github.com/prysmaticlabs/prysm/v5/validator/slashing-protection-history/format"
|
|
)
|
|
|
|
// MockSlashingProtectionJSON creates a mock, full slashing protection JSON struct
|
|
// using attesting and proposing histories provided.
|
|
func MockSlashingProtectionJSON(
|
|
publicKeys [][fieldparams.BLSPubkeyLength]byte,
|
|
attestingHistories [][]*common.AttestationRecord,
|
|
proposalHistories []common.ProposalHistoryForPubkey,
|
|
) (*format.EIPSlashingProtectionFormat, error) {
|
|
standardProtectionFormat := &format.EIPSlashingProtectionFormat{}
|
|
standardProtectionFormat.Metadata.GenesisValidatorsRoot = fmt.Sprintf("%#x", bytesutil.PadTo([]byte{32}, 32))
|
|
standardProtectionFormat.Metadata.InterchangeFormatVersion = format.InterchangeFormatVersion
|
|
for i := 0; i < len(publicKeys); i++ {
|
|
data := &format.ProtectionData{
|
|
Pubkey: fmt.Sprintf("%#x", publicKeys[i]),
|
|
}
|
|
if len(attestingHistories) > 0 {
|
|
for _, att := range attestingHistories[i] {
|
|
data.SignedAttestations = append(data.SignedAttestations, &format.SignedAttestation{
|
|
TargetEpoch: fmt.Sprintf("%d", att.Target),
|
|
SourceEpoch: fmt.Sprintf("%d", att.Source),
|
|
SigningRoot: fmt.Sprintf("%#x", att.SigningRoot),
|
|
})
|
|
}
|
|
}
|
|
if len(proposalHistories) > 0 {
|
|
for _, proposal := range proposalHistories[i].Proposals {
|
|
block := &format.SignedBlock{
|
|
Slot: fmt.Sprintf("%d", proposal.Slot),
|
|
SigningRoot: fmt.Sprintf("%#x", proposal.SigningRoot),
|
|
}
|
|
data.SignedBlocks = append(data.SignedBlocks, block)
|
|
}
|
|
}
|
|
standardProtectionFormat.Data = append(standardProtectionFormat.Data, data)
|
|
}
|
|
return standardProtectionFormat, nil
|
|
}
|
|
|
|
// MockAttestingAndProposalHistories given a number of validators, creates mock attesting
|
|
// and proposing histories within WEAK_SUBJECTIVITY_PERIOD bounds.
|
|
func MockAttestingAndProposalHistories(pubkeys [][fieldparams.BLSPubkeyLength]byte) ([][]*common.AttestationRecord, []common.ProposalHistoryForPubkey) {
|
|
// deduplicate and transform them into our internal format.
|
|
numValidators := len(pubkeys)
|
|
attData := make([][]*common.AttestationRecord, numValidators)
|
|
proposalData := make([]common.ProposalHistoryForPubkey, numValidators)
|
|
gen := rand.NewGenerator()
|
|
for v := 0; v < numValidators; v++ {
|
|
latestTarget := primitives.Epoch(gen.Intn(int(params.BeaconConfig().WeakSubjectivityPeriod) / 1000))
|
|
// If 0, we change the value to 1 as the we compute source by doing (target-1)
|
|
// to prevent any underflows in this setup helper.
|
|
if latestTarget == 0 {
|
|
latestTarget = 1
|
|
}
|
|
historicalAtts := make([]*common.AttestationRecord, 0)
|
|
proposals := make([]common.Proposal, 0)
|
|
for i := primitives.Epoch(1); i < latestTarget; i++ {
|
|
var signingRoot [32]byte
|
|
signingRootStr := fmt.Sprintf("%d", i)
|
|
copy(signingRoot[:], signingRootStr)
|
|
historicalAtts = append(historicalAtts, &common.AttestationRecord{
|
|
Source: i - 1,
|
|
Target: i,
|
|
SigningRoot: signingRoot[:],
|
|
PubKey: pubkeys[v],
|
|
})
|
|
}
|
|
for i := primitives.Epoch(1); i <= latestTarget; i++ {
|
|
var signingRoot [32]byte
|
|
signingRootStr := fmt.Sprintf("%d", i)
|
|
copy(signingRoot[:], signingRootStr)
|
|
proposals = append(proposals, common.Proposal{
|
|
Slot: primitives.Slot(i),
|
|
SigningRoot: signingRoot[:],
|
|
})
|
|
}
|
|
proposalData[v] = common.ProposalHistoryForPubkey{Proposals: proposals}
|
|
attData[v] = historicalAtts
|
|
}
|
|
return attData, proposalData
|
|
}
|
|
|
|
// CreateRandomPubKeys --
|
|
func CreateRandomPubKeys(numValidators int) ([][fieldparams.BLSPubkeyLength]byte, error) {
|
|
pubKeys := make([][fieldparams.BLSPubkeyLength]byte, numValidators)
|
|
for i := 0; i < numValidators; i++ {
|
|
randKey, err := bls.RandKey()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
copy(pubKeys[i][:], randKey.PublicKey().Marshal())
|
|
}
|
|
return pubKeys, nil
|
|
}
|
|
|
|
// CreateMockRoots --
|
|
func CreateMockRoots(numRoots int) [][32]byte {
|
|
roots := make([][32]byte, numRoots)
|
|
for i := 0; i < numRoots; i++ {
|
|
var rt [32]byte
|
|
copy(rt[:], fmt.Sprintf("%d", i))
|
|
}
|
|
return roots
|
|
}
|