mirror of
https://github.com/OffchainLabs/prysm.git
synced 2026-01-09 15:37:56 -05:00
c5135f6995
* enforce schedule alignment when next_fork_epoch matches * lint & typo * James feedback --------- Co-authored-by: Kasey Kirkham <kasey@users.noreply.github.com>
319 lines
11 KiB
Go
319 lines
11 KiB
Go
package p2p
|
|
|
|
import (
|
|
"math/rand"
|
|
"os"
|
|
"path"
|
|
"strconv"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/OffchainLabs/prysm/v6/beacon-chain/startup"
|
|
"github.com/OffchainLabs/prysm/v6/config/params"
|
|
pb "github.com/OffchainLabs/prysm/v6/proto/prysm/v1alpha1"
|
|
"github.com/OffchainLabs/prysm/v6/testing/assert"
|
|
"github.com/OffchainLabs/prysm/v6/testing/require"
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
"github.com/ethereum/go-ethereum/p2p/enode"
|
|
"github.com/ethereum/go-ethereum/p2p/enr"
|
|
)
|
|
|
|
func TestCompareForkENR(t *testing.T) {
|
|
params.SetupTestConfigCleanup(t)
|
|
params.BeaconConfig().FuluForkEpoch = params.BeaconConfig().ElectraForkEpoch + 4096
|
|
params.BeaconConfig().InitializeForkSchedule()
|
|
|
|
db, err := enode.OpenDB("")
|
|
assert.NoError(t, err)
|
|
_, k := createAddrAndPrivKey(t)
|
|
clock := startup.NewClock(time.Now(), params.BeaconConfig().GenesisValidatorsRoot)
|
|
current := params.GetNetworkScheduleEntry(clock.CurrentEpoch())
|
|
next := params.NextNetworkScheduleEntry(clock.CurrentEpoch())
|
|
self := enode.NewLocalNode(db, k)
|
|
require.NoError(t, updateENR(self, current, next))
|
|
|
|
cases := []struct {
|
|
name string
|
|
expectErr error
|
|
expectLog string
|
|
node func(t *testing.T) *enode.Node
|
|
}{
|
|
{
|
|
name: "match",
|
|
node: func(t *testing.T) *enode.Node {
|
|
// Create a peer with the same current fork digest and next fork version/epoch.
|
|
peer := enode.NewLocalNode(db, k)
|
|
require.NoError(t, updateENR(peer, current, next))
|
|
return peer.Node()
|
|
},
|
|
},
|
|
{
|
|
name: "current digest mismatch",
|
|
node: func(t *testing.T) *enode.Node {
|
|
// Create a peer with the same current fork digest and next fork version/epoch.
|
|
peer := enode.NewLocalNode(db, k)
|
|
testDigest := [4]byte{0xFF, 0xFF, 0xFF, 0xFF}
|
|
require.NotEqual(t, current.ForkDigest, testDigest, "ensure test fork digest is unique")
|
|
currentCopy := current
|
|
currentCopy.ForkDigest = testDigest
|
|
require.NoError(t, updateENR(peer, currentCopy, next))
|
|
return peer.Node()
|
|
},
|
|
expectErr: errCurrentDigestMismatch,
|
|
},
|
|
{
|
|
name: "next_fork_epoch match, next_fork_version mismatch",
|
|
node: func(t *testing.T) *enode.Node {
|
|
// Create a peer with the same current fork digest and next fork version/epoch.
|
|
peer := enode.NewLocalNode(db, k)
|
|
testVersion := [4]byte{0xFF, 0xFF, 0xFF, 0xFF}
|
|
require.NotEqual(t, next.ForkVersion, testVersion, "ensure test fork version is unique")
|
|
nextCopy := next
|
|
nextCopy.ForkVersion = testVersion
|
|
require.NoError(t, updateENR(peer, current, nextCopy))
|
|
return peer.Node()
|
|
},
|
|
expectErr: errNextVersionMismatch,
|
|
},
|
|
{
|
|
name: "next fork epoch mismatch, next fork digest mismatch",
|
|
node: func(t *testing.T) *enode.Node {
|
|
// Create a peer with the same current fork digest and next fork version/epoch.
|
|
peer := enode.NewLocalNode(db, k)
|
|
nextCopy := next
|
|
// next epoch does not match, and neither does the next fork digest.
|
|
nextCopy.Epoch = nextCopy.Epoch + 1
|
|
nfd := [4]byte{0xFF, 0xFF, 0xFF, 0xFF}
|
|
require.NotEqual(t, next.ForkDigest, nfd)
|
|
//peer.Set(enr.WithEntry(nfdEnrKey, nfd[:]))
|
|
nextCopy.ForkDigest = nfd
|
|
require.NoError(t, updateENR(peer, current, nextCopy))
|
|
return peer.Node()
|
|
},
|
|
// no error because we allow a different next fork version / digest if the next fork epoch does not match
|
|
},
|
|
{
|
|
name: "next fork epoch -match-, next fork digest mismatch",
|
|
node: func(t *testing.T) *enode.Node {
|
|
peer := enode.NewLocalNode(db, k)
|
|
nextCopy := next
|
|
nfd := [4]byte{0xFF, 0xFF, 0xFF, 0xFF}
|
|
// next epoch *does match*, but the next fork digest doesn't - so we should get an error.
|
|
require.NotEqual(t, next.ForkDigest, nfd)
|
|
nextCopy.ForkDigest = nfd
|
|
//peer.Set(enr.WithEntry(nfdEnrKey, nfd[:]))
|
|
require.NoError(t, updateENR(peer, current, nextCopy))
|
|
return peer.Node()
|
|
},
|
|
expectErr: errNextDigestMismatch,
|
|
},
|
|
}
|
|
|
|
for _, c := range cases {
|
|
t.Run(c.name, func(t *testing.T) {
|
|
peer := c.node(t)
|
|
err := compareForkENR(self.Node().Record(), peer.Record())
|
|
if c.expectErr != nil {
|
|
require.ErrorIs(t, err, c.expectErr, "Expected error to match")
|
|
} else {
|
|
require.NoError(t, err, "Expected no error comparing fork ENRs")
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestNfdSetAndLoad(t *testing.T) {
|
|
params.SetupTestConfigCleanup(t)
|
|
params.BeaconConfig().FuluForkEpoch = params.BeaconConfig().ElectraForkEpoch + 4096
|
|
params.BeaconConfig().InitializeForkSchedule()
|
|
db, err := enode.OpenDB("")
|
|
assert.NoError(t, err)
|
|
_, k := createAddrAndPrivKey(t)
|
|
clock := startup.NewClock(time.Now(), params.BeaconConfig().GenesisValidatorsRoot)
|
|
current := params.GetNetworkScheduleEntry(clock.CurrentEpoch())
|
|
next := params.NextNetworkScheduleEntry(clock.CurrentEpoch())
|
|
next.ForkDigest = [4]byte{0xFF, 0xFF, 0xFF, 0xFF} // Ensure a unique digest for testing.
|
|
self := enode.NewLocalNode(db, k)
|
|
require.NoError(t, updateENR(self, current, next))
|
|
n := nfd(self.Node().Record())
|
|
assert.Equal(t, next.ForkDigest, n, "Expected nfd to match next fork digest")
|
|
}
|
|
|
|
func TestDiscv5_AddRetrieveForkEntryENR(t *testing.T) {
|
|
params.SetupTestConfigCleanup(t)
|
|
params.BeaconConfig().InitializeForkSchedule()
|
|
|
|
clock := startup.NewClock(time.Now(), params.BeaconConfig().GenesisValidatorsRoot)
|
|
current := params.GetNetworkScheduleEntry(clock.CurrentEpoch())
|
|
next := params.NextNetworkScheduleEntry(clock.CurrentEpoch())
|
|
enrForkID := &pb.ENRForkID{
|
|
CurrentForkDigest: current.ForkDigest[:],
|
|
NextForkVersion: next.ForkVersion[:],
|
|
NextForkEpoch: next.Epoch,
|
|
}
|
|
enc, err := enrForkID.MarshalSSZ()
|
|
require.NoError(t, err)
|
|
entry := enr.WithEntry(eth2EnrKey, enc)
|
|
temp := t.TempDir()
|
|
randNum := rand.Int()
|
|
tempPath := path.Join(temp, strconv.Itoa(randNum))
|
|
require.NoError(t, os.Mkdir(tempPath, 0700))
|
|
pkey, err := privKey(&Config{DataDir: tempPath})
|
|
require.NoError(t, err, "Could not get private key")
|
|
db, err := enode.OpenDB("")
|
|
require.NoError(t, err)
|
|
localNode := enode.NewLocalNode(db, pkey)
|
|
localNode.Set(entry)
|
|
|
|
resp, err := forkEntry(localNode.Node().Record())
|
|
require.NoError(t, err)
|
|
assert.Equal(t, hexutil.Encode(current.ForkDigest[:]), hexutil.Encode(resp.CurrentForkDigest))
|
|
assert.Equal(t, hexutil.Encode(next.ForkVersion[:]), hexutil.Encode(resp.NextForkVersion))
|
|
assert.Equal(t, next.Epoch, resp.NextForkEpoch, "Unexpected next fork epoch")
|
|
}
|
|
|
|
func TestAddForkEntry_NextForkVersion(t *testing.T) {
|
|
params.SetupTestConfigCleanup(t)
|
|
params.BeaconConfig().InitializeForkSchedule()
|
|
temp := t.TempDir()
|
|
randNum := rand.Int()
|
|
tempPath := path.Join(temp, strconv.Itoa(randNum))
|
|
require.NoError(t, os.Mkdir(tempPath, 0700))
|
|
pkey, err := privKey(&Config{DataDir: tempPath})
|
|
require.NoError(t, err, "Could not get private key")
|
|
db, err := enode.OpenDB("")
|
|
require.NoError(t, err)
|
|
|
|
localNode := enode.NewLocalNode(db, pkey)
|
|
clock := startup.NewClock(time.Now(), params.BeaconConfig().GenesisValidatorsRoot)
|
|
current := params.GetNetworkScheduleEntry(clock.CurrentEpoch())
|
|
next := params.NextNetworkScheduleEntry(clock.CurrentEpoch())
|
|
// Add the fork entry to the local node's ENR.
|
|
require.NoError(t, updateENR(localNode, current, next))
|
|
fe, err := forkEntry(localNode.Node().Record())
|
|
require.NoError(t, err)
|
|
assert.Equal(t,
|
|
hexutil.Encode(params.BeaconConfig().AltairForkVersion), hexutil.Encode(fe.NextForkVersion),
|
|
"Wanted Next Fork Version to be equal to genesis fork version")
|
|
|
|
last := params.LastForkEpoch()
|
|
current = params.GetNetworkScheduleEntry(last)
|
|
next = params.NextNetworkScheduleEntry(last)
|
|
require.NoError(t, updateENR(localNode, current, next))
|
|
entry := params.NextNetworkScheduleEntry(last)
|
|
fe, err = forkEntry(localNode.Node().Record())
|
|
require.NoError(t, err)
|
|
assert.Equal(t,
|
|
hexutil.Encode(entry.ForkVersion[:]), hexutil.Encode(fe.NextForkVersion),
|
|
"Wanted Next Fork Version to be equal to last entry in schedule")
|
|
|
|
}
|
|
|
|
func TestUpdateENR_FuluForkDigest(t *testing.T) {
|
|
setupTest := func(t *testing.T, fuluEnabled bool) (*enode.LocalNode, func()) {
|
|
params.SetupTestConfigCleanup(t)
|
|
|
|
cfg := params.BeaconConfig().Copy()
|
|
if fuluEnabled {
|
|
cfg.FuluForkEpoch = 100
|
|
} else {
|
|
cfg.FuluForkEpoch = cfg.FarFutureEpoch
|
|
}
|
|
cfg.FuluForkVersion = []byte{5, 0, 0, 0}
|
|
params.OverrideBeaconConfig(cfg)
|
|
cfg.InitializeForkSchedule()
|
|
|
|
pkey, err := privKey(&Config{DataDir: t.TempDir()})
|
|
require.NoError(t, err, "Could not get private key")
|
|
db, err := enode.OpenDB("")
|
|
require.NoError(t, err)
|
|
|
|
localNode := enode.NewLocalNode(db, pkey)
|
|
cleanup := func() {
|
|
db.Close()
|
|
}
|
|
|
|
return localNode, cleanup
|
|
}
|
|
|
|
tests := []struct {
|
|
name string
|
|
fuluEnabled bool
|
|
currentEntry params.NetworkScheduleEntry
|
|
nextEntry params.NetworkScheduleEntry
|
|
validateNFD func(t *testing.T, localNode *enode.LocalNode, nextEntry params.NetworkScheduleEntry)
|
|
}{
|
|
{
|
|
name: "different digests sets nfd to next digest",
|
|
fuluEnabled: true,
|
|
currentEntry: params.NetworkScheduleEntry{
|
|
Epoch: 50,
|
|
ForkDigest: [4]byte{1, 2, 3, 4},
|
|
ForkVersion: [4]byte{1, 0, 0, 0},
|
|
},
|
|
nextEntry: params.NetworkScheduleEntry{
|
|
Epoch: 100,
|
|
ForkDigest: [4]byte{5, 6, 7, 8}, // Different from current
|
|
ForkVersion: [4]byte{2, 0, 0, 0},
|
|
},
|
|
validateNFD: func(t *testing.T, localNode *enode.LocalNode, nextEntry params.NetworkScheduleEntry) {
|
|
var nfdValue []byte
|
|
err := localNode.Node().Record().Load(enr.WithEntry(nfdEnrKey, &nfdValue))
|
|
require.NoError(t, err)
|
|
assert.DeepEqual(t, nextEntry.ForkDigest[:], nfdValue, "nfd entry should equal next fork digest")
|
|
},
|
|
},
|
|
{
|
|
name: "same digests sets nfd to empty",
|
|
fuluEnabled: true,
|
|
currentEntry: params.NetworkScheduleEntry{
|
|
Epoch: 50,
|
|
ForkDigest: [4]byte{1, 2, 3, 4},
|
|
ForkVersion: [4]byte{1, 0, 0, 0},
|
|
},
|
|
nextEntry: params.NetworkScheduleEntry{
|
|
Epoch: 100,
|
|
ForkDigest: [4]byte{1, 2, 3, 4}, // Same as current
|
|
ForkVersion: [4]byte{2, 0, 0, 0},
|
|
},
|
|
validateNFD: func(t *testing.T, localNode *enode.LocalNode, nextEntry params.NetworkScheduleEntry) {
|
|
var nfdValue []byte
|
|
err := localNode.Node().Record().Load(enr.WithEntry(nfdEnrKey, &nfdValue))
|
|
require.NoError(t, err)
|
|
assert.DeepEqual(t, make([]byte, len(nextEntry.ForkDigest)), nfdValue, "nfd entry should be empty bytes when digests are same")
|
|
},
|
|
},
|
|
{
|
|
name: "fulu disabled does not add nfd field",
|
|
fuluEnabled: false,
|
|
currentEntry: params.NetworkScheduleEntry{
|
|
Epoch: 50,
|
|
ForkDigest: [4]byte{1, 2, 3, 4},
|
|
ForkVersion: [4]byte{1, 0, 0, 0},
|
|
},
|
|
nextEntry: params.NetworkScheduleEntry{
|
|
Epoch: 100,
|
|
ForkDigest: [4]byte{5, 6, 7, 8}, // Different from current
|
|
ForkVersion: [4]byte{2, 0, 0, 0},
|
|
},
|
|
validateNFD: func(t *testing.T, localNode *enode.LocalNode, nextEntry params.NetworkScheduleEntry) {
|
|
var nfdValue []byte
|
|
err := localNode.Node().Record().Load(enr.WithEntry(nfdEnrKey, &nfdValue))
|
|
require.ErrorContains(t, "missing ENR key", err, "nfd field should not be present when Fulu fork is disabled")
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
localNode, cleanup := setupTest(t, tt.fuluEnabled)
|
|
defer cleanup()
|
|
|
|
currentEntry := tt.currentEntry
|
|
nextEntry := tt.nextEntry
|
|
require.NoError(t, updateENR(localNode, currentEntry, nextEntry))
|
|
tt.validateNFD(t, localNode, nextEntry)
|
|
})
|
|
}
|
|
}
|