Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add validatorStates filter to Validators #78

Closed
wants to merge 3 commits into from
Closed

Add validatorStates filter to Validators #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6aa422c
Add validatorStates filter to Validators
cihati Sep 30, 2023
7f6575e
Fix imports
cihati Oct 2, 2023
0231f94
gosimple fix
cihati Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions http/validators.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ func (s *Service) indexChunkSize(ctx context.Context) int {
// Validators provides the validators, with their balance and status, for a given state.
// stateID can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
// validatorIndices is a list of validators to restrict the returned values. If no validators are supplied no filter will be applied.
func (s *Service) Validators(ctx context.Context, stateID string, validatorIndices []phase0.ValidatorIndex) (map[phase0.ValidatorIndex]*api.Validator, error) {
// validatorStates is a list of validator states to restrict the returned values. If no states are supplied no filter will be applied.
func (s *Service) Validators(ctx context.Context, stateID string, validatorIndices []phase0.ValidatorIndex, validatorStates []api.ValidatorState) (map[phase0.ValidatorIndex]*api.Validator, error) {
if stateID == "" {
return nil, errors.New("no state ID specified")
}
Expand All @@ -80,7 +81,7 @@ func (s *Service) Validators(ctx context.Context, stateID string, validatorIndic
}

if len(validatorIndices) > s.indexChunkSize(ctx) {
return s.chunkedValidators(ctx, stateID, validatorIndices)
return s.chunkedValidators(ctx, stateID, validatorIndices, validatorStates)
}

url := fmt.Sprintf("/eth/v1/beacon/states/%s/validators", stateID)
Expand All @@ -91,6 +92,17 @@ func (s *Service) Validators(ctx context.Context, stateID string, validatorIndic
}
url = fmt.Sprintf("%s?id=%s", url, strings.Join(ids, ","))
}
if len(validatorStates) != 0 {
states := make([]string, len(validatorStates))
for i := range validatorStates {
states[i] = validatorStates[i].String()
}
if len(validatorIndices) != 0 {
url = fmt.Sprintf("%s&status=%s", url, strings.Join(states, ","))
} else {
url = fmt.Sprintf("%s?status=%s", url, strings.Join(states, ","))
}
}

respBodyReader, err := s.get(ctx, url)
if err != nil {
Expand Down Expand Up @@ -168,7 +180,7 @@ func (s *Service) validatorsFromState(ctx context.Context, stateID string) (map[
}

// chunkedValidators obtains the validators a chunk at a time.
func (s *Service) chunkedValidators(ctx context.Context, stateID string, validatorIndices []phase0.ValidatorIndex) (map[phase0.ValidatorIndex]*api.Validator, error) {
func (s *Service) chunkedValidators(ctx context.Context, stateID string, validatorIndices []phase0.ValidatorIndex, validatorStates []api.ValidatorState) (map[phase0.ValidatorIndex]*api.Validator, error) {
res := make(map[phase0.ValidatorIndex]*api.Validator)
indexChunkSize := s.indexChunkSize(ctx)
for i := 0; i < len(validatorIndices); i += indexChunkSize {
Expand All @@ -178,7 +190,7 @@ func (s *Service) chunkedValidators(ctx context.Context, stateID string, validat
chunkEnd = len(validatorIndices)
}
chunk := validatorIndices[chunkStart:chunkEnd]
chunkRes, err := s.Validators(ctx, stateID, chunk)
chunkRes, err := s.Validators(ctx, stateID, chunk, validatorStates)
if err != nil {
return nil, errors.Wrap(err, "failed to obtain chunk")
}
Expand Down
12 changes: 11 additions & 1 deletion http/validators_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"testing"

client "github.com/attestantio/go-eth2-client"
v1 "github.com/attestantio/go-eth2-client/api/v1"
"github.com/attestantio/go-eth2-client/http"
"github.com/attestantio/go-eth2-client/spec/phase0"
"github.com/stretchr/testify/require"
Expand All @@ -34,6 +35,7 @@ func TestValidators(t *testing.T) {
stateID string
expectedErrorCode int
validatorIndices []phase0.ValidatorIndex
validatorStates []v1.ValidatorState
}{
{
name: "Invalid",
Expand Down Expand Up @@ -61,6 +63,14 @@ func TestValidators(t *testing.T) {
name: "Justified",
stateID: "justified",
},
{
name: "SomeStates",
stateID: "head",
validatorStates: []v1.ValidatorState{
v1.ValidatorStateActiveOngoing,
v1.ValidatorStateExitedSlashed,
},
},
{
name: "ManyValidators",
stateID: "head",
Expand All @@ -78,7 +88,7 @@ func TestValidators(t *testing.T) {

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
validators, err := service.(client.ValidatorsProvider).Validators(ctx, test.stateID, test.validatorIndices)
validators, err := service.(client.ValidatorsProvider).Validators(ctx, test.stateID, test.validatorIndices, test.validatorStates)
if test.expectedErrorCode != 0 {
require.Contains(t, err.Error(), fmt.Sprintf("%d", test.expectedErrorCode))
} else {
Expand Down
2 changes: 1 addition & 1 deletion mock/validators.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ import (
// stateID can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
// validatorIndices is a list of validator indices to restrict the returned values. If no validators IDs are supplied no filter
// will be applied.
func (s *Service) Validators(_ context.Context, _ string, _ []phase0.ValidatorIndex) (map[phase0.ValidatorIndex]*api.Validator, error) {
func (s *Service) Validators(_ context.Context, _ string, _ []phase0.ValidatorIndex, _ []api.ValidatorState) (map[phase0.ValidatorIndex]*api.Validator, error) {
return map[phase0.ValidatorIndex]*api.Validator{}, nil
}
5 changes: 4 additions & 1 deletion multi/validators.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,18 @@ import (
// Validators provides the validators, with their balance and status, for a given state.
// stateID can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
// validatorIndices is a list of validators to restrict the returned values. If no validators are supplied no filter will be applied.
// validatorStates is a list of validator states to restrict the returned values. If no validators states are supplied no filter
// will be applied.
func (s *Service) Validators(ctx context.Context,
stateID string,
validatorIndices []phase0.ValidatorIndex,
validatorStates []api.ValidatorState,
) (
map[phase0.ValidatorIndex]*api.Validator,
error,
) {
res, err := s.doCall(ctx, func(ctx context.Context, client consensusclient.Service) (interface{}, error) {
block, err := client.(consensusclient.ValidatorsProvider).Validators(ctx, stateID, validatorIndices)
block, err := client.(consensusclient.ValidatorsProvider).Validators(ctx, stateID, validatorIndices, validatorStates)
if err != nil {
return nil, err
}
Expand Down
3 changes: 2 additions & 1 deletion multi/validators_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import (
"testing"

consensusclient "github.com/attestantio/go-eth2-client"
v1 "github.com/attestantio/go-eth2-client/api/v1"
"github.com/attestantio/go-eth2-client/mock"
"github.com/attestantio/go-eth2-client/multi"
"github.com/attestantio/go-eth2-client/spec/phase0"
Expand Down Expand Up @@ -51,7 +52,7 @@ func TestValidators(t *testing.T) {
require.NoError(t, err)

for i := 0; i < 128; i++ {
res, err := multiClient.(consensusclient.ValidatorsProvider).Validators(ctx, "1", []phase0.ValidatorIndex{})
res, err := multiClient.(consensusclient.ValidatorsProvider).Validators(ctx, "1", []phase0.ValidatorIndex{}, []v1.ValidatorState{})
require.NoError(t, err)
require.NotNil(t, res)
}
Expand Down
4 changes: 3 additions & 1 deletion service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,9 @@ type ValidatorsProvider interface {
// stateID can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
// validatorIndices is a list of validator indices to restrict the returned values. If no validators IDs are supplied no filter
// will be applied.
Validators(ctx context.Context, stateID string, validatorIndices []phase0.ValidatorIndex) (map[phase0.ValidatorIndex]*apiv1.Validator, error)
// validatorStates is a list of validator states to restrict the returned values. If no validators states are supplied no filter
// will be applied.
Validators(ctx context.Context, stateID string, validatorIndices []phase0.ValidatorIndex, validatorStates []apiv1.ValidatorState) (map[phase0.ValidatorIndex]*apiv1.Validator, error)

// ValidatorsByPubKey provides the validators, with their balance and status, for a given state.
// stateID can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
Expand Down
6 changes: 4 additions & 2 deletions testclients/erroring.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -580,15 +580,17 @@ func (s *Erroring) ValidatorBalances(ctx context.Context, stateID string, valida
// stateID can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
// validatorIndices is a list of validator indices to restrict the returned values. If no validators IDs are supplied no filter
// will be applied.
func (s *Erroring) Validators(ctx context.Context, stateID string, validatorIndices []phase0.ValidatorIndex) (map[phase0.ValidatorIndex]*apiv1.Validator, error) {
// validatorStates is a list of validator states to restrict the returned values. If no validators states are supplied no filter
// will be applied.
func (s *Erroring) Validators(ctx context.Context, stateID string, validatorIndices []phase0.ValidatorIndex, validatorStates []apiv1.ValidatorState) (map[phase0.ValidatorIndex]*apiv1.Validator, error) {
if err := s.maybeError(ctx); err != nil {
return nil, err
}
next, isNext := s.next.(consensusclient.ValidatorsProvider)
if !isNext {
return nil, fmt.Errorf("%s@%s does not support this call", s.next.Name(), s.next.Address())
}
return next.Validators(ctx, stateID, validatorIndices)
return next.Validators(ctx, stateID, validatorIndices, validatorStates)
}

// ValidatorsByPubKey provides the validators, with their balance and status, for a given state.
Expand Down
6 changes: 4 additions & 2 deletions testclients/sleepy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,13 +395,15 @@ func (s *Sleepy) ValidatorBalances(ctx context.Context, stateID string, validato
// stateID can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
// validatorIndices is a list of validator indices to restrict the returned values. If no validators IDs are supplied no filter
// will be applied.
func (s *Sleepy) Validators(ctx context.Context, stateID string, validatorIndices []phase0.ValidatorIndex) (map[phase0.ValidatorIndex]*apiv1.Validator, error) {
// validatorStates is a list of validator states to restrict the returned values. If no validators states are supplied no filter
// will be applied.
func (s *Sleepy) Validators(ctx context.Context, stateID string, validatorIndices []phase0.ValidatorIndex, validatorStates []apiv1.ValidatorState) (map[phase0.ValidatorIndex]*apiv1.Validator, error) {
s.sleep(ctx)
next, isNext := s.next.(consensusclient.ValidatorsProvider)
if !isNext {
return nil, errors.New("next does not support this call")
}
return next.Validators(ctx, stateID, validatorIndices)
return next.Validators(ctx, stateID, validatorIndices, validatorStates)
}

// ValidatorsByPubKey provides the validators, with their balance and status, for a given state.
Expand Down