prysm-pulse/validator/helpers/converts_test.go
Manu NALEPA ef21d3adf8
Implement EIP-3076 minimal slashing protection, using a filesystem database (#13360)
* `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.
2024-03-05 15:27:15 +00:00

284 lines
7.3 KiB
Go

package helpers
import (
"fmt"
"math"
"reflect"
"testing"
fieldparams "github.com/prysmaticlabs/prysm/v5/config/fieldparams"
"github.com/prysmaticlabs/prysm/v5/consensus-types/primitives"
)
func Test_fromString(t *testing.T) {
tests := []struct {
name string
str string
want uint64
wantErr bool
}{
{
name: "Overflow uint64 gets MaxUint64",
str: "29348902839048290384902839048290384902938748278934789273984728934789273894798273498",
want: math.MaxUint64,
wantErr: true,
},
{
name: "Max Uint64 works",
str: "18446744073709551615",
want: math.MaxUint64,
wantErr: false,
},
{
name: "Negative number fails",
str: "-3",
wantErr: true,
},
{
name: "Junk fails",
str: "alksjdkjasd",
wantErr: true,
},
{
name: "0 works",
str: "0",
want: 0,
},
{
name: "Normal uint64 works",
str: "23980",
want: 23980,
},
}
for _, tt := range tests {
t.Run(fmt.Sprintf("Uint64/%s", tt.name), func(t *testing.T) {
got, err := Uint64FromString(tt.str)
if (err != nil) != tt.wantErr {
t.Errorf("Uint64FromString() error = %v, wantErr %v", err, tt.wantErr)
return
}
if got != tt.want {
t.Errorf("Uint64FromString() got = %v, want %v", got, tt.want)
}
})
t.Run(fmt.Sprintf("Epoch/%s", tt.name), func(t *testing.T) {
got, err := EpochFromString(tt.str)
if (err != nil) != tt.wantErr {
t.Errorf("EpochFromString() error = %v, wantErr %v", err, tt.wantErr)
return
}
if got != primitives.Epoch(tt.want) {
t.Errorf("EpochFromString() got = %v, want %v", got, tt.want)
}
})
t.Run(fmt.Sprintf("Slot/%s", tt.name), func(t *testing.T) {
got, err := SlotFromString(tt.str)
if (err != nil) != tt.wantErr {
t.Errorf("SlotFromString() error = %v, wantErr %v", err, tt.wantErr)
return
}
if got != primitives.Slot(tt.want) {
t.Errorf("SlotFromString() got = %v, want %v", got, tt.want)
}
})
}
}
func Test_pubKeyFromHex(t *testing.T) {
tests := []struct {
name string
str string
want [fieldparams.BLSPubkeyLength]byte
wantErr bool
}{
{
name: "Empty value fails due to wrong length",
str: "",
wantErr: true,
},
{
name: "Junk fails",
str: "alksjdkjasd",
wantErr: true,
},
{
name: "Empty value with 0x prefix fails due to wrong length",
str: "0x",
wantErr: true,
},
{
name: "Works with 0x prefix and good public key",
str: "0xb845089a1457f811bfc000588fbb4e713669be8ce060ea6be3c6ece09afc3794106c91ca73acda5e5457122d58723bed",
want: [fieldparams.BLSPubkeyLength]byte{184, 69, 8, 154, 20, 87, 248, 17, 191, 192, 0, 88, 143, 187, 78, 113, 54, 105, 190, 140, 224, 96, 234, 107, 227, 198, 236, 224, 154, 252, 55, 148, 16, 108, 145, 202, 115, 172, 218, 94, 84, 87, 18, 45, 88, 114, 59, 237},
},
{
name: "Works without 0x prefix and good public key",
str: "b845089a1457f811bfc000588fbb4e713669be8ce060ea6be3c6ece09afc3794106c91ca73acda5e5457122d58723bed",
want: [fieldparams.BLSPubkeyLength]byte{184, 69, 8, 154, 20, 87, 248, 17, 191, 192, 0, 88, 143, 187, 78, 113, 54, 105, 190, 140, 224, 96, 234, 107, 227, 198, 236, 224, 154, 252, 55, 148, 16, 108, 145, 202, 115, 172, 218, 94, 84, 87, 18, 45, 88, 114, 59, 237},
},
{
name: "0x prefix and wrong length public key fails",
str: "0xb845089a1457f811bfc000588fbb4e713669be8",
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := PubKeyFromHex(tt.str)
if (err != nil) != tt.wantErr {
t.Errorf("PubKeyFromHex() error = %v, wantErr %v", err, tt.wantErr)
return
}
if !reflect.DeepEqual(got, tt.want) {
t.Errorf("PubKeyFromHex() got = %v, want %v", got, tt.want)
}
})
}
}
func Test_rootFromHex(t *testing.T) {
tests := []struct {
name string
str string
want [32]byte
wantErr bool
}{
{
name: "Empty value fails due to wrong length",
str: "",
wantErr: true,
},
{
name: "Junk fails",
str: "alksjdkjasd",
wantErr: true,
},
{
name: "Empty value with 0x prefix fails due to wrong length",
str: "0x",
wantErr: true,
},
{
name: "Works with 0x prefix and good root",
str: "0x4ff6f743a43f3b4f95350831aeaf0a122a1a392922c45d804280284a69eb850b",
want: [32]byte{79, 246, 247, 67, 164, 63, 59, 79, 149, 53, 8, 49, 174, 175, 10, 18, 42, 26, 57, 41, 34, 196, 93, 128, 66, 128, 40, 74, 105, 235, 133, 11},
},
{
name: "Works without 0x prefix and good root",
str: "4ff6f743a43f3b4f95350831aeaf0a122a1a392922c45d804280284a69eb850b",
want: [32]byte{79, 246, 247, 67, 164, 63, 59, 79, 149, 53, 8, 49, 174, 175, 10, 18, 42, 26, 57, 41, 34, 196, 93, 128, 66, 128, 40, 74, 105, 235, 133, 11},
},
{
name: "0x prefix and wrong length root fails",
str: "0xb845089a14",
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := RootFromHex(tt.str)
if (err != nil) != tt.wantErr {
t.Errorf("rootFromHex() error = %v, wantErr %v", err, tt.wantErr)
return
}
if !reflect.DeepEqual(got, tt.want) {
t.Errorf("rootFromHex() got = %v, want %v", got, tt.want)
}
})
}
}
func Test_rootToHexString(t *testing.T) {
mockRoot := [32]byte{1}
tests := []struct {
name string
root []byte
want string
wantErr bool
}{
{
name: "nil roots return empty string",
root: nil,
want: "",
wantErr: false,
},
{
name: "len(root) == 0 returns empty string",
root: make([]byte, 0),
want: "",
wantErr: false,
},
{
name: "non-empty root with incorrect size returns error",
root: make([]byte, 20),
want: "",
wantErr: true,
},
{
name: "non-empty root with correct size returns expected value",
root: mockRoot[:],
want: "0x0100000000000000000000000000000000000000000000000000000000000000",
wantErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := RootToHexString(tt.root)
if (err != nil) != tt.wantErr {
t.Errorf("rootToHexString() error = %v, wantErr %v", err, tt.wantErr)
return
}
if got != tt.want {
t.Errorf("rootToHexString() got = %v, want %v", got, tt.want)
}
})
}
}
func Test_pubKeyToHexString(t *testing.T) {
mockPubKey := [fieldparams.BLSPubkeyLength]byte{1}
tests := []struct {
name string
pubKey []byte
want string
wantErr bool
}{
{
name: "nil pubkey should return error",
pubKey: nil,
want: "",
wantErr: true,
},
{
name: "empty pubkey should return error",
pubKey: make([]byte, 0),
want: "",
wantErr: true,
},
{
name: "wrong length pubkey should return error",
pubKey: make([]byte, 3),
want: "",
wantErr: true,
},
{
name: "non-empty pubkey with correct size returns expected value",
pubKey: mockPubKey[:],
want: "0x010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
wantErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := PubKeyToHexString(tt.pubKey)
if (err != nil) != tt.wantErr {
t.Errorf("pubKeyToHexString() error = %v, wantErr %v", err, tt.wantErr)
return
}
if got != tt.want {
t.Errorf("pubKeyToHexString() got = %v, want %v", got, tt.want)
}
})
}
}