Implement ListBeaconCommittees RPC Method #3977
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| package beacon | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/prysmaticlabs/prysm/beacon-chain/core/helpers" | ||
| ethpb "github.com/prysmaticlabs/prysm/proto/eth/v1alpha1" | ||
| "github.com/prysmaticlabs/prysm/shared/bytesutil" | ||
| "github.com/prysmaticlabs/prysm/shared/pagination" | ||
| "github.com/prysmaticlabs/prysm/shared/params" | ||
| "google.golang.org/grpc/codes" | ||
| "google.golang.org/grpc/status" | ||
| ) | ||
|
|
||
| // ListBeaconCommittees for a given epoch. | ||
| // | ||
| // If no filter criteria is specified, the response returns | ||
| // all beacon committees for the current epoch. The results are paginated by default. | ||
| func (bs *Server) ListBeaconCommittees( | ||
|
There was a problem hiding this comment. For this we might need more options for the In the event of a fork in the network, you could have two chains with different committees at the same epoch. To differentiate on the two sets of committees we would need to be able to identify committees from forked chains, so the state root is a good way to identify them. @shayzluf and I discussed this offline, in the event of a fork in the network , we need to be able to get the appropriate committees from each forked chain. There was a problem hiding this comment. Great point, that's a neat suggestion. So what happens if you provide a state root that doesnt match head state? There was a problem hiding this comment. Maybe we can do this in a follow-up PR as that will increase the diff quite a lot. There was a problem hiding this comment. I guess it would mean we are asking for the committees from a forked chain :) This would be important for the slasher, as it needs to be able to detect malicious attestations in the event of a fork. Sounds good, we can do it in a follow up PR |
||
| ctx context.Context, | ||
| req *ethpb.ListCommitteesRequest, | ||
| ) (*ethpb.BeaconCommittees, error) { | ||
| if int(req.PageSize) > params.BeaconConfig().MaxPageSize { | ||
| return nil, status.Errorf( | ||
| codes.InvalidArgument, | ||
| "requested page size %d can not be greater than max size %d", | ||
| req.PageSize, | ||
| params.BeaconConfig().MaxPageSize, | ||
| ) | ||
| } | ||
|
|
||
| headState := bs.HeadFetcher.HeadState() | ||
| var requestingGenesis bool | ||
| var startSlot uint64 | ||
| switch q := req.QueryFilter.(type) { | ||
| case *ethpb.ListCommitteesRequest_Epoch: | ||
| startSlot = helpers.StartSlot(q.Epoch) | ||
| case *ethpb.ListCommitteesRequest_Genesis: | ||
| requestingGenesis = q.Genesis | ||
| default: | ||
| startSlot = headState.Slot | ||
| } | ||
|
|
||
| var attesterSeed [32]byte | ||
| var activeIndices []uint64 | ||
| var err error | ||
| // This is the archival condition, if the requested epoch is < current epoch or if we are | ||
| // requesting data from the genesis epoch. | ||
| if requestingGenesis || helpers.SlotToEpoch(startSlot) < helpers.SlotToEpoch(headState.Slot) { | ||
|
There was a problem hiding this comment. This is the archival condition |
||
| activeIndices, err = helpers.ActiveValidatorIndices(headState, helpers.SlotToEpoch(startSlot)) | ||
| if err != nil { | ||
| return nil, status.Errorf( | ||
| codes.Internal, | ||
| "could not retrieve active indices for epoch %d: %v", | ||
| helpers.SlotToEpoch(startSlot), | ||
| err, | ||
| ) | ||
| } | ||
| archivedCommitteeInfo, err := bs.BeaconDB.ArchivedCommitteeInfo(ctx, helpers.SlotToEpoch(startSlot)) | ||
| if err != nil { | ||
| return nil, status.Errorf( | ||
| codes.Internal, | ||
| "could not request archival data for epoch %d: %v", | ||
| helpers.SlotToEpoch(startSlot), | ||
| err, | ||
| ) | ||
| } | ||
| if archivedCommitteeInfo == nil { | ||
| return nil, status.Errorf( | ||
| codes.NotFound, | ||
| "could not request data for epoch %d, perhaps --archive in the running beacon node is disabled", | ||
| helpers.SlotToEpoch(startSlot), | ||
| ) | ||
| } | ||
| attesterSeed = bytesutil.ToBytes32(archivedCommitteeInfo.AttesterSeed) | ||
| } else if !requestingGenesis && helpers.SlotToEpoch(startSlot) == helpers.SlotToEpoch(headState.Slot) { | ||
|
There was a problem hiding this comment. Otherwise if requesting current epoch, return current results There was a problem hiding this comment. Can you add these as comments? it seems helpful |
||
| // Otherwise, we use data from the current epoch. | ||
| currentEpoch := helpers.SlotToEpoch(headState.Slot) | ||
| activeIndices, err = helpers.ActiveValidatorIndices(headState, currentEpoch) | ||
| if err != nil { | ||
| return nil, status.Errorf( | ||
| codes.Internal, | ||
| "could not retrieve active indices for current epoch %d: %v", | ||
| currentEpoch, | ||
| err, | ||
| ) | ||
| } | ||
| attesterSeed, err = helpers.Seed(headState, currentEpoch, params.BeaconConfig().DomainBeaconAttester) | ||
| if err != nil { | ||
| return nil, status.Errorf( | ||
| codes.Internal, | ||
| "could not retrieve attester seed for current epoch %d: %v", | ||
| currentEpoch, | ||
| err, | ||
| ) | ||
| } | ||
| } else { | ||
| // Otherwise, we are requesting data from the future and we return an error. | ||
| return nil, status.Errorf( | ||
| codes.FailedPrecondition, | ||
| "cannot retrieve information about an epoch in the future, current epoch %d, requesting %d", | ||
| helpers.SlotToEpoch(headState.Slot), | ||
| helpers.StartSlot(startSlot), | ||
| ) | ||
| } | ||
|
|
||
| committees := make([]*ethpb.BeaconCommittees_CommitteeItem, 0) | ||
| for slot := startSlot; slot < startSlot+params.BeaconConfig().SlotsPerEpoch; slot++ { | ||
| var countAtSlot = uint64(len(activeIndices)) / params.BeaconConfig().SlotsPerEpoch / params.BeaconConfig().TargetCommitteeSize | ||
| if countAtSlot > params.BeaconConfig().MaxCommitteesPerSlot { | ||
| countAtSlot = params.BeaconConfig().MaxCommitteesPerSlot | ||
| } | ||
| if countAtSlot == 0 { | ||
| countAtSlot = 1 | ||
| } | ||
| for i := uint64(0); i < countAtSlot; i++ { | ||
| epochOffset := i + (slot%params.BeaconConfig().SlotsPerEpoch)*countAtSlot | ||
| totalCount := countAtSlot * params.BeaconConfig().SlotsPerEpoch | ||
| committee, err := helpers.ComputeCommittee(activeIndices, attesterSeed, epochOffset, totalCount) | ||
| if err != nil { | ||
| return nil, status.Errorf( | ||
| codes.Internal, | ||
| "could not compute committee for slot %d: %v", | ||
| slot, | ||
| err, | ||
| ) | ||
| } | ||
| committees = append(committees, ðpb.BeaconCommittees_CommitteeItem{ | ||
| Committee: committee, | ||
| Slot: slot, | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| numCommittees := len(committees) | ||
| start, end, nextPageToken, err := pagination.StartAndEndPage(req.PageToken, int(req.PageSize), numCommittees) | ||
| if err != nil { | ||
| return nil, status.Errorf( | ||
| codes.FailedPrecondition, | ||
| "could not paginate results: %v", | ||
| err, | ||
| ) | ||
| } | ||
| return ðpb.BeaconCommittees{ | ||
| Epoch: helpers.SlotToEpoch(startSlot), | ||
| ActiveValidatorCount: uint64(len(activeIndices)), | ||
| Committees: committees[start:end], | ||
| TotalSize: int32(numCommittees), | ||
| NextPageToken: nextPageToken, | ||
| }, nil | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is wrong, we shouldn't store this because it can change on a slot by slot basis