github/prysm
1
1
Fork 0
mirror of https://github.com/OffchainLabs/prysm.git synced 2026-01-09 15:37:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

HTTP Beacon API: /eth/v1/beacon/states/{state_id}/committees (#12879)

Browse Source 
* Initial setup

* Gaz

* Remove original implementation

* Fix protos

* Cleanup + tests

* Cleanup

* Radek' review + fixes

* Fix merge errors

* Fix imports

* Rename error handling

* Fix broken e2e

* Gaz

* Update comment
This commit is contained in:
Sammy Rosso
2023-09-13 10:29:32 -07:00
committed by GitHub
parent 0ccfc74e86
commit 8c39c55f05
19 changed files with 1038 additions and 1361 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
validator/client/beacon-api/duties.go
View File

@@ -9,7 +9,8 @@ import (
"strconv"
"github.com/pkg/errors"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/rpc/apimiddleware"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/rpc/eth/beacon"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/rpc/eth/shared"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/rpc/eth/validator"
"github.com/prysmaticlabs/prysm/v4/config/params"
"github.com/prysmaticlabs/prysm/v4/consensus-types/primitives"
@@ -20,7 +21,7 @@ type dutiesProvider interface {
GetAttesterDuties(ctx context.Context, epoch primitives.Epoch, validatorIndices []primitives.ValidatorIndex) ([]*validator.AttesterDuty, error)
GetProposerDuties(ctx context.Context, epoch primitives.Epoch) ([]*validator.ProposerDuty, error)
GetSyncDuties(ctx context.Context, epoch primitives.Epoch, validatorIndices []primitives.ValidatorIndex) ([]*validator.SyncCommitteeDuty, error)
GetCommittees(ctx context.Context, epoch primitives.Epoch) ([]*apimiddleware.CommitteeJson, error)
GetCommittees(ctx context.Context, epoch primitives.Epoch) ([]*shared.Committee, error)
}
type beaconApiDutiesProvider struct {
@@ -200,12 +201,12 @@ func (c beaconApiValidatorClient) getDutiesForEpoch(
}
// GetCommittees retrieves the committees for the given epoch
func (c beaconApiDutiesProvider) GetCommittees(ctx context.Context, epoch primitives.Epoch) ([]*apimiddleware.CommitteeJson, error) {
func (c beaconApiDutiesProvider) GetCommittees(ctx context.Context, epoch primitives.Epoch) ([]*shared.Committee, error) {
committeeParams := url.Values{}
committeeParams.Add("epoch", strconv.FormatUint(uint64(epoch), 10))
committeesRequest := buildURL("/eth/v1/beacon/states/head/committees", committeeParams)
var stateCommittees apimiddleware.StateCommitteesResponseJson
var stateCommittees beacon.GetCommitteesResponse
if _, err := c.jsonRestHandler.GetRestJsonResponse(ctx, committeesRequest, &stateCommittees); err != nil {
return nil, errors.Wrapf(err, "failed to query committees for epoch `%d`", epoch)
}

32
validator/client/beacon-api/duties_test.go
View File

@@ -12,6 +12,8 @@ import (
"github.com/ethereum/go-ethereum/common/hexutil"
"github.com/golang/mock/gomock"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/rpc/apimiddleware"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/rpc/eth/beacon"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/rpc/eth/shared"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/rpc/eth/validator"
"github.com/prysmaticlabs/prysm/v4/config/params"
"github.com/prysmaticlabs/prysm/v4/consensus-types/primitives"
@@ -405,8 +407,8 @@ func TestGetSyncDuties_NilSyncDuty(t *testing.T) {
func TestGetCommittees_Valid(t *testing.T) {
const epoch = primitives.Epoch(1)
expectedCommittees := apimiddleware.StateCommitteesResponseJson{
Data: []*apimiddleware.CommitteeJson{
expectedCommittees := beacon.GetCommitteesResponse{
Data: []*shared.Committee{
{
Index: "1",
Slot: "2",
@@ -435,7 +437,7 @@ func TestGetCommittees_Valid(t *testing.T) {
jsonRestHandler.EXPECT().GetRestJsonResponse(
ctx,
fmt.Sprintf("%s?epoch=%d", getCommitteesTestEndpoint, epoch),
&apimiddleware.StateCommitteesResponseJson{},
&beacon.GetCommitteesResponse{},
).Return(
nil,
nil,
@@ -492,7 +494,7 @@ func TestGetCommittees_NilData(t *testing.T) {
nil,
).SetArg(
2,
apimiddleware.StateCommitteesResponseJson{
beacon.GetCommitteesResponse{
Data: nil,
},
).Times(1)
@@ -520,8 +522,8 @@ func TestGetCommittees_NilCommittee(t *testing.T) {
nil,
).SetArg(
2,
apimiddleware.StateCommitteesResponseJson{
Data: []*apimiddleware.CommitteeJson{nil},
beacon.GetCommitteesResponse{
Data: []*shared.Committee{nil},
},
).Times(1)
@@ -547,7 +549,7 @@ func TestGetDutiesForEpoch_Error(t *testing.T) {
fetchProposerDutiesError error
generateSyncDuties func() []*validator.SyncCommitteeDuty
fetchSyncDutiesError error
generateCommittees func() []*apimiddleware.CommitteeJson
generateCommittees func() []*shared.Committee
fetchCommitteesError error
}{
{
@@ -628,7 +630,7 @@ func TestGetDutiesForEpoch_Error(t *testing.T) {
{
name: "bad committee index",
expectedError: "failed to parse committee index `foo`",
generateCommittees: func() []*apimiddleware.CommitteeJson {
generateCommittees: func() []*shared.Committee {
committees := generateValidCommittees(committeeIndices, committeeSlots, validatorIndices)
committees[0].Index = "foo"
return committees
@@ -637,7 +639,7 @@ func TestGetDutiesForEpoch_Error(t *testing.T) {
{
name: "bad committee slot",
expectedError: "failed to parse slot `foo`",
generateCommittees: func() []*apimiddleware.CommitteeJson {
generateCommittees: func() []*shared.Committee {
committees := generateValidCommittees(committeeIndices, committeeSlots, validatorIndices)
committees[0].Slot = "foo"
return committees
@@ -646,7 +648,7 @@ func TestGetDutiesForEpoch_Error(t *testing.T) {
{
name: "bad committee validator index",
expectedError: "failed to parse committee validator index `foo`",
generateCommittees: func() []*apimiddleware.CommitteeJson {
generateCommittees: func() []*shared.Committee {
committees := generateValidCommittees(committeeIndices, committeeSlots, validatorIndices)
committees[0].Validators[0] = "foo"
return committees
@@ -661,8 +663,8 @@ func TestGetDutiesForEpoch_Error(t *testing.T) {
attesterDuties[0].Slot = "2"
return attesterDuties
},
generateCommittees: func() []*apimiddleware.CommitteeJson {
return []*apimiddleware.CommitteeJson{}
generateCommittees: func() []*shared.Committee {
return []*shared.Committee{}
},
},
}
@@ -695,7 +697,7 @@ func TestGetDutiesForEpoch_Error(t *testing.T) {
syncDuties = testCase.generateSyncDuties()
}
var committees []*apimiddleware.CommitteeJson
var committees []*shared.Committee
if testCase.generateCommittees == nil {
committees = generateValidCommittees(committeeIndices, committeeSlots, validatorIndices)
} else {
@@ -1368,8 +1370,8 @@ func TestGetDuties_GetDutiesForEpochFailed(t *testing.T) {
assert.ErrorContains(t, "foo error", err)
}
func generateValidCommittees(committeeIndices []primitives.CommitteeIndex, slots []primitives.Slot, validatorIndices []primitives.ValidatorIndex) []*apimiddleware.CommitteeJson {
return []*apimiddleware.CommitteeJson{
func generateValidCommittees(committeeIndices []primitives.CommitteeIndex, slots []primitives.Slot, validatorIndices []primitives.ValidatorIndex) []*shared.Committee {
return []*shared.Committee{
{
Index: strconv.FormatUint(uint64(committeeIndices[0]), 10),
Slot: strconv.FormatUint(uint64(slots[0]), 10),

1
validator/client/beacon-api/mock/BUILD.bazel
View File

@@ -14,6 +14,7 @@ go_library(
deps = [
"//api/gateway/apimiddleware:go_default_library",
"//beacon-chain/rpc/apimiddleware:go_default_library",
"//beacon-chain/rpc/eth/shared:go_default_library",
"//beacon-chain/rpc/eth/validator:go_default_library",
"//consensus-types/primitives:go_default_library",
"//proto/prysm/v1alpha1:go_default_library",

6
validator/client/beacon-api/mock/duties_mock.go generated
View File

@@ -9,7 +9,7 @@ import (
reflect "reflect"
gomock "github.com/golang/mock/gomock"
apimiddleware "github.com/prysmaticlabs/prysm/v4/beacon-chain/rpc/apimiddleware"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/rpc/eth/shared"
"github.com/prysmaticlabs/prysm/v4/beacon-chain/rpc/eth/validator"
primitives "github.com/prysmaticlabs/prysm/v4/consensus-types/primitives"
)
@@ -53,10 +53,10 @@ func (mr *MockdutiesProviderMockRecorder) GetAttesterDuties(ctx, epoch, validato
}
// GetCommittees mocks base method.
func (m *MockdutiesProvider) GetCommittees(ctx context.Context, epoch primitives.Epoch) ([]*apimiddleware.CommitteeJson, error) {
func (m *MockdutiesProvider) GetCommittees(ctx context.Context, epoch primitives.Epoch) ([]*shared.Committee, error) {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "GetCommittees", ctx, epoch)
ret0, _ := ret[0].([]*apimiddleware.CommitteeJson)
ret0, _ := ret[0].([]*shared.Committee)
ret1, _ := ret[1].(error)
return ret0, ret1
}