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 canonical flag to ListBlocks API response #8287

Merged
merged 2 commits into from Feb 1, 2021
+49 −9
Merged

Add canonical flag to ListBlocks API response #8287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2cf70d9
Add canonical flag to ListBlocks response
pinglamb Jan 19, 2021
d9e9589
Genesis is always canonical
pinglamb Jan 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 17 additions & 1 deletion beacon-chain/rpc/beacon/blocks.go
View file
Open in desktop
Expand Up @@ -63,9 +63,14 @@ func (bs *Server) ListBlocks(
if err != nil {
return nil, err
}
canonical, err := bs.CanonicalFetcher.IsCanonical(ctx, root)
if err != nil {
return nil, status.Errorf(codes.Internal, "Could not determine if block is canonical: %v", err)
}
containers[i] = &ethpb.BeaconBlockContainer{
Block: b,
BlockRoot: root[:],
Canonical: canonical,
}
}

Expand All @@ -90,11 +95,16 @@ func (bs *Server) ListBlocks(
if err != nil {
return nil, err
}
canonical, err := bs.CanonicalFetcher.IsCanonical(ctx, root)
if err != nil {
return nil, status.Errorf(codes.Internal, "Could not determine if block is canonical: %v", err)
}

return &ethpb.ListBlocksResponse{
BlockContainers: []*ethpb.BeaconBlockContainer{{
Block: blk,
BlockRoot: root[:]},
BlockRoot: root[:],
Canonical: canonical},
},
TotalSize: 1,
}, nil
Expand Down Expand Up @@ -126,9 +136,14 @@ func (bs *Server) ListBlocks(
if err != nil {
return nil, err
}
canonical, err := bs.CanonicalFetcher.IsCanonical(ctx, root)
if err != nil {
return nil, status.Errorf(codes.Internal, "Could not determine if block is canonical: %v", err)
}
containers[i] = &ethpb.BeaconBlockContainer{
Block: b,
BlockRoot: root[:],
Canonical: canonical,
}
}

Expand All @@ -153,6 +168,7 @@ func (bs *Server) ListBlocks(
{
Block: genBlk,
BlockRoot: root[:],
Canonical: true,
},
}

Expand Down
40 changes: 32 additions & 8 deletions beacon-chain/rpc/beacon/blocks_test.go
View file
Open in desktop
Expand Up @@ -98,6 +98,7 @@ func TestServer_ListBlocks_Genesis(t *testing.T) {
{
Block: blk,
BlockRoot: root[:],
Canonical: true,
},
},
NextPageToken: "0",
Expand Down Expand Up @@ -132,14 +133,11 @@ func TestServer_ListBlocks_Genesis_MultiBlocks(t *testing.T) {

count := uint64(100)
blks := make([]*ethpb.SignedBeaconBlock, count)
blkContainers := make([]*ethpb.BeaconBlockContainer, count)
for i := uint64(0); i < count; i++ {
b := testutil.NewBeaconBlock()
b.Block.Slot = i
root, err := b.Block.HashTreeRoot()
require.NoError(t, err)
blks[i] = b
blkContainers[i] = &ethpb.BeaconBlockContainer{Block: b, BlockRoot: root[:]}
}
require.NoError(t, db.SaveBlocks(ctx, blks))

Expand All @@ -154,6 +152,9 @@ func TestServer_ListBlocks_Genesis_MultiBlocks(t *testing.T) {

func TestServer_ListBlocks_Pagination(t *testing.T) {
db := dbTest.SetupDB(t)
chain := &chainMock.ChainService{
CanonicalRoots: map[[32]byte]bool{},
}
ctx := context.Background()

count := uint64(100)
Expand All @@ -164,13 +165,21 @@ func TestServer_ListBlocks_Pagination(t *testing.T) {
b.Block.Slot = i
root, err := b.Block.HashTreeRoot()
require.NoError(t, err)
chain.CanonicalRoots[root] = true
blks[i] = b
blkContainers[i] = &ethpb.BeaconBlockContainer{Block: b, BlockRoot: root[:]}
blkContainers[i] = &ethpb.BeaconBlockContainer{Block: b, BlockRoot: root[:], Canonical: true}
}
require.NoError(t, db.SaveBlocks(ctx, blks))

orphanedBlk := testutil.NewBeaconBlock()
orphanedBlk.Block.Slot = 300
orphanedBlkRoot, err := orphanedBlk.Block.HashTreeRoot()
require.NoError(t, err)
require.NoError(t, db.SaveBlock(ctx, orphanedBlk))

bs := &Server{
BeaconDB: db,
BeaconDB: db,
CanonicalFetcher: chain,
}

root6, err := blks[6].Block.HashTreeRoot()
Expand All @@ -188,7 +197,8 @@ func TestServer_ListBlocks_Pagination(t *testing.T) {
BlockContainers: []*ethpb.BeaconBlockContainer{{Block: testutil.HydrateSignedBeaconBlock(&ethpb.SignedBeaconBlock{
Block: &ethpb.BeaconBlock{
Slot: 5}}),
BlockRoot: blkContainers[5].BlockRoot}},
BlockRoot: blkContainers[5].BlockRoot,
Canonical: blkContainers[5].Canonical}},
NextPageToken: "",
TotalSize: 1}},
{req: &ethpb.ListBlocksRequest{
Expand All @@ -199,14 +209,16 @@ func TestServer_ListBlocks_Pagination(t *testing.T) {
BlockContainers: []*ethpb.BeaconBlockContainer{{Block: testutil.HydrateSignedBeaconBlock(&ethpb.SignedBeaconBlock{
Block: &ethpb.BeaconBlock{
Slot: 6}}),
BlockRoot: blkContainers[6].BlockRoot}},
BlockRoot: blkContainers[6].BlockRoot,
Canonical: blkContainers[6].Canonical}},
TotalSize: 1}},
{req: &ethpb.ListBlocksRequest{QueryFilter: &ethpb.ListBlocksRequest_Root{Root: root6[:]}},
res: &ethpb.ListBlocksResponse{
BlockContainers: []*ethpb.BeaconBlockContainer{{Block: testutil.HydrateSignedBeaconBlock(&ethpb.SignedBeaconBlock{
Block: &ethpb.BeaconBlock{
Slot: 6}}),
BlockRoot: blkContainers[6].BlockRoot}},
BlockRoot: blkContainers[6].BlockRoot,
Canonical: blkContainers[6].Canonical}},
TotalSize: 1}},
{req: &ethpb.ListBlocksRequest{
PageToken: strconv.Itoa(0),
Expand Down Expand Up @@ -240,6 +252,18 @@ func TestServer_ListBlocks_Pagination(t *testing.T) {
BlockContainers: blkContainers[96:100],
NextPageToken: "",
TotalSize: int32(params.BeaconConfig().SlotsPerEpoch / 2)}},
{req: &ethpb.ListBlocksRequest{
PageToken: strconv.Itoa(0),
QueryFilter: &ethpb.ListBlocksRequest_Slot{Slot: 300},
PageSize: 3},
res: &ethpb.ListBlocksResponse{
BlockContainers: []*ethpb.BeaconBlockContainer{{Block: testutil.HydrateSignedBeaconBlock(&ethpb.SignedBeaconBlock{
Block: &ethpb.BeaconBlock{
Slot: 300}}),
BlockRoot: orphanedBlkRoot[:],
Canonical: false}},
NextPageToken: "",
TotalSize: 1}},
}

for i, test := range tests {
Expand Down