Files
ethdo/services/chaintime/standard/service_test.go
2025-02-08 11:46:49 +00:00

281 lines
7.5 KiB
Go

// Copyright © 2021 Weald Technology Trading.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package standard_test
import (
"context"
"testing"
"time"
"github.com/attestantio/go-eth2-client/api"
apiv1 "github.com/attestantio/go-eth2-client/api/v1"
"github.com/attestantio/go-eth2-client/mock"
"github.com/attestantio/go-eth2-client/spec/phase0"
"github.com/rs/zerolog"
"github.com/stretchr/testify/require"
"github.com/wealdtech/ethdo/services/chaintime"
"github.com/wealdtech/ethdo/services/chaintime/standard"
)
func TestService(t *testing.T) {
ctx := context.Background()
mockClient, err := mock.New(ctx)
require.NoError(t, err)
// genesis is 1 day ago.
genesisTime := time.Now().AddDate(0, 0, -1)
mockClient.GenesisFunc = func(context.Context, *api.GenesisOpts) (*api.Response[*apiv1.Genesis], error) {
return &api.Response[*apiv1.Genesis]{
Data: &apiv1.Genesis{
GenesisTime: genesisTime,
},
Metadata: make(map[string]any),
}, nil
}
mockClient.SpecFunc = func(context.Context, *api.SpecOpts) (*api.Response[map[string]any], error) {
return &api.Response[map[string]any]{
Data: map[string]any{
"SECONDS_PER_SLOT": time.Second * 12,
"SLOTS_PER_EPOCH": uint64(32),
"EPOCHS_PER_SYNC_COMMITTEE_PERIOD": uint64(256),
},
Metadata: make(map[string]any),
}, nil
}
tests := []struct {
name string
params []standard.Parameter
err string
}{
{
name: "GenesisProviderMissing",
params: []standard.Parameter{
standard.WithLogLevel(zerolog.Disabled),
standard.WithSpecProvider(mockClient),
},
err: "problem with parameters: no genesis provider specified",
},
{
name: "SpecProviderMissing",
params: []standard.Parameter{
standard.WithLogLevel(zerolog.Disabled),
standard.WithGenesisProvider(mockClient),
},
err: "problem with parameters: no spec provider specified",
},
{
name: "Good",
params: []standard.Parameter{
standard.WithLogLevel(zerolog.Disabled),
standard.WithGenesisProvider(mockClient),
standard.WithSpecProvider(mockClient),
},
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
_, err := standard.New(context.Background(), test.params...)
if test.err != "" {
require.EqualError(t, err, test.err)
} else {
require.NoError(t, err)
}
})
}
}
// createService is a helper that creates a mock chaintime service.
func createService(genesisTime time.Time) (chaintime.Service, time.Duration, uint64, uint64, []*phase0.Fork, error) {
ctx := context.Background()
mockClient, err := mock.New(ctx)
if err != nil {
return nil, 0, 0, 0, nil, err
}
secondsPerSlot := time.Second * 12
slotsPerEpoch := uint64(32)
epochsPerSyncCommitteePeriod := uint64(256)
forkSchedule := []*phase0.Fork{
{
PreviousVersion: phase0.Version{0x01, 0x02, 0x03, 0x04},
CurrentVersion: phase0.Version{0x01, 0x02, 0x03, 0x04},
Epoch: 0,
},
{
PreviousVersion: phase0.Version{0x01, 0x02, 0x03, 0x04},
CurrentVersion: phase0.Version{0x05, 0x06, 0x07, 0x08},
Epoch: 10,
},
}
mockClient.GenesisFunc = func(context.Context, *api.GenesisOpts) (*api.Response[*apiv1.Genesis], error) {
return &api.Response[*apiv1.Genesis]{
Data: &apiv1.Genesis{
GenesisTime: genesisTime,
},
Metadata: make(map[string]any),
}, nil
}
mockClient.SpecFunc = func(context.Context, *api.SpecOpts) (*api.Response[map[string]any], error) {
return &api.Response[map[string]any]{
Data: map[string]any{
"SECONDS_PER_SLOT": secondsPerSlot,
"SLOTS_PER_EPOCH": slotsPerEpoch,
"EPOCHS_PER_SYNC_COMMITTEE_PERIOD": epochsPerSyncCommitteePeriod,
},
Metadata: make(map[string]any),
}, nil
}
mockClient.ForkScheduleFunc = func(context.Context, *api.ForkScheduleOpts) (*api.Response[[]*phase0.Fork], error) {
return &api.Response[[]*phase0.Fork]{
Data: forkSchedule,
Metadata: make(map[string]any),
}, nil
}
s, err := standard.New(ctx,
standard.WithGenesisProvider(mockClient),
standard.WithSpecProvider(mockClient),
)
return s, secondsPerSlot, slotsPerEpoch, epochsPerSyncCommitteePeriod, forkSchedule, err
}
func TestGenesisTime(t *testing.T) {
genesisTime := time.Now()
s, _, _, _, _, err := createService(genesisTime)
require.NoError(t, err)
require.Equal(t, genesisTime, s.GenesisTime())
}
func TestStartOfSlot(t *testing.T) {
genesisTime := time.Now()
s, slotDuration, _, _, _, err := createService(genesisTime)
require.NoError(t, err)
require.Equal(t, genesisTime, s.StartOfSlot(0))
require.Equal(t, genesisTime.Add(1000*slotDuration), s.StartOfSlot(1000))
}
func TestStartOfEpoch(t *testing.T) {
genesisTime := time.Now()
s, slotDuration, slotsPerEpoch, _, _, err := createService(genesisTime)
require.NoError(t, err)
require.Equal(t, genesisTime, s.StartOfEpoch(0))
require.Equal(t, genesisTime.Add(time.Duration(1000*slotsPerEpoch)*slotDuration), s.StartOfEpoch(1000))
}
func TestCurrentSlot(t *testing.T) {
genesisTime := time.Now().Add(-60 * time.Second)
s, _, _, _, _, err := createService(genesisTime)
require.NoError(t, err)
require.Equal(t, phase0.Slot(5), s.CurrentSlot())
}
func TestCurrentEpoch(t *testing.T) {
genesisTime := time.Now().Add(-1000 * time.Second)
s, _, _, _, _, err := createService(genesisTime)
require.NoError(t, err)
require.Equal(t, phase0.Epoch(2), s.CurrentEpoch())
}
func TestTimestampToSlot(t *testing.T) {
genesisTime := time.Now()
s, _, _, _, _, err := createService(genesisTime)
require.NoError(t, err)
tests := []struct {
name string
timestamp time.Time
slot phase0.Slot
}{
{
name: "PreGenesis",
timestamp: genesisTime.AddDate(0, 0, -1),
slot: 0,
},
{
name: "Genesis",
timestamp: genesisTime,
slot: 0,
},
{
name: "Slot1",
timestamp: genesisTime.Add(12 * time.Second),
slot: 1,
},
{
name: "Slot999",
timestamp: genesisTime.Add(999 * 12 * time.Second),
slot: 999,
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
require.Equal(t, test.slot, s.TimestampToSlot(test.timestamp))
})
}
}
func TestTimestampToEpoch(t *testing.T) {
genesisTime := time.Now()
s, _, _, _, _, err := createService(genesisTime)
require.NoError(t, err)
tests := []struct {
name string
timestamp time.Time
epoch phase0.Epoch
}{
{
name: "PreGenesis",
timestamp: genesisTime.AddDate(0, 0, -1),
epoch: 0,
},
{
name: "Genesis",
timestamp: genesisTime,
epoch: 0,
},
{
name: "Epoch1",
timestamp: genesisTime.Add(32 * 12 * time.Second),
epoch: 1,
},
{
name: "Epoch1Boundary",
timestamp: genesisTime.Add(64 * 12 * time.Second).Add(-1 * time.Millisecond),
epoch: 1,
},
{
name: "Epoch999",
timestamp: genesisTime.Add(999 * 32 * 12 * time.Second),
epoch: 999,
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
require.Equal(t, test.epoch, s.TimestampToEpoch(test.timestamp))
})
}
}