Skip to content

fix(api): return block root in getBlockHeader response #3134

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

Open
NikhilSharmaWe wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −17
Open

fix(api): return block root in getBlockHeader response #3134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion node-api/handlers/beacon/header.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ func (h *Handler) makeBlockHeaderResponse(height int64, resultsInList bool) (any
// access finalized blocks in this APIs. Still we may return a list of responses
// to be compliant with API specs https://ethereum.github.io/beacon-APIs/?urls.primaryName=v3.1.0#/Beacon/getBlockHeader
headerResp := beacontypes.BlockHeaderResponse{
Root: header.GetBodyRoot(),
Root: header.HashTreeRoot(),
Canonical: true,
Header: &beacontypes.SignedBeaconBlockHeader{
Message: beacontypes.BeaconBlockHeaderFromConsensus(header),
Expand Down
43 changes: 27 additions & 16 deletions node-api/handlers/beacon/header_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,11 @@ func TestGetBlockHeaders(t *testing.T) {
StateRoot: common.Root{'p', 'a', 'r', 'e', 'n', 't', 's', 't', 'a', 't', 'e', 'r', 'o', 'o', 't'},
BodyRoot: common.Root{'p', 'a', 'r', 'e', 'n', 't', 'r', 'o', 'o', 't'},
}
parentBlockRoot := testParentHeader.HashTreeRoot()
testHeader := &ctypes.BeaconBlockHeader{
Slot: testParentHeader.Slot + 1,
ProposerIndex: math.ValidatorIndex(5678),
ParentBlockRoot: testParentHeader.BodyRoot,
ParentBlockRoot: parentBlockRoot,
StateRoot: common.Root{}, // set in test cases
BodyRoot: common.Root{'d', 'u', 'm', 'm', 'y', 'r', 'o', 'o', 't'},
}
Expand Down Expand Up @@ -105,7 +106,7 @@ func TestGetBlockHeaders(t *testing.T) {
data, _ := gr.Data.([]beacontypes.BlockHeaderResponse)
require.Len(t, data, 1)

require.Equal(t, testHeader.BodyRoot, data[0].Root)
require.Equal(t, expectedHeaderBlockRoot(testHeader, expectedStateRoot), data[0].Root)
expectedHeader := &beacontypes.BeaconBlockHeader{
Slot: testHeader.Slot.Base10(),
ProposerIndex: testHeader.ProposerIndex.Base10(),
Expand Down Expand Up @@ -145,7 +146,7 @@ func TestGetBlockHeaders(t *testing.T) {
data, _ := gr.Data.([]beacontypes.BlockHeaderResponse)
require.Len(t, data, 1)

require.Equal(t, testHeader.BodyRoot, data[0].Root)
require.Equal(t, expectedHeaderBlockRoot(testHeader, expectedStateRoot), data[0].Root)
expectedHeader := &beacontypes.BeaconBlockHeader{
Slot: testHeader.Slot.Base10(),
ProposerIndex: testHeader.ProposerIndex.Base10(),
Expand Down Expand Up @@ -211,7 +212,7 @@ func TestGetBlockHeaders(t *testing.T) {
st := makeTestState(t, cs)
stateRoot := testDummyState(t, cs, st, testHeader)
b.EXPECT().StateAndSlotFromHeight(mock.Anything).Return(st, math.Slot(0), nil)
b.EXPECT().GetSlotByBlockRoot(testParentHeader.BodyRoot).Return(testParentHeader.Slot, nil)
b.EXPECT().GetSlotByBlockRoot(parentBlockRoot).Return(testParentHeader.Slot, nil)
return stateRoot
},
check: func(t *testing.T, expectedStateRoot common.Root, res any, err error) {
Expand All @@ -225,7 +226,7 @@ func TestGetBlockHeaders(t *testing.T) {
data, _ := gr.Data.([]beacontypes.BlockHeaderResponse)
require.Len(t, data, 1)

require.Equal(t, testHeader.BodyRoot, data[0].Root)
require.Equal(t, expectedHeaderBlockRoot(testHeader, expectedStateRoot), data[0].Root)
expectedHeader := &beacontypes.BeaconBlockHeader{
Slot: testHeader.Slot.Base10(),
ProposerIndex: testHeader.ProposerIndex.Base10(),
Expand Down Expand Up @@ -263,7 +264,7 @@ func TestGetBlockHeaders(t *testing.T) {
},
setMockExpectations: func(_ *testing.T, b *mocks.Backend) common.Root {
// Assume parent header is not known
b.EXPECT().GetSlotByBlockRoot(testParentHeader.BodyRoot).Return(0, errTestHeaderNotFound)
b.EXPECT().GetSlotByBlockRoot(parentBlockRoot).Return(0, errTestHeaderNotFound)
return common.Root{}
},
check: func(t *testing.T, _ common.Root, _ any, err error) {
Expand All @@ -289,7 +290,7 @@ func TestGetBlockHeaders(t *testing.T) {
st := makeTestState(t, cs)
stateRoot := testDummyState(t, cs, st, testHeader)
b.EXPECT().StateAndSlotFromHeight(mock.Anything).Return(st, math.Slot(0), nil)
b.EXPECT().GetSlotByBlockRoot(testParentHeader.BodyRoot).Return(testParentHeader.Slot, nil)
b.EXPECT().GetSlotByBlockRoot(parentBlockRoot).Return(testParentHeader.Slot, nil)
return stateRoot
},
check: func(t *testing.T, expectedStateRoot common.Root, res any, err error) {
Expand All @@ -303,7 +304,7 @@ func TestGetBlockHeaders(t *testing.T) {
data, _ := gr.Data.([]beacontypes.BlockHeaderResponse)
require.Len(t, data, 1)

require.Equal(t, testHeader.BodyRoot, data[0].Root)
require.Equal(t, expectedHeaderBlockRoot(testHeader, expectedStateRoot), data[0].Root)
expectedHeader := &beacontypes.BeaconBlockHeader{
Slot: testHeader.Slot.Base10(),
ProposerIndex: testHeader.ProposerIndex.Base10(),
Expand All @@ -325,7 +326,7 @@ func TestGetBlockHeaders(t *testing.T) {
}
},
setMockExpectations: func(_ *testing.T, b *mocks.Backend) common.Root {
b.EXPECT().GetSlotByBlockRoot(testParentHeader.BodyRoot).Return(testParentHeader.Slot, nil)
b.EXPECT().GetSlotByBlockRoot(parentBlockRoot).Return(testParentHeader.Slot, nil)
return common.Root{}
},
check: func(t *testing.T, _ common.Root, _ any, err error) {
Expand Down Expand Up @@ -382,6 +383,11 @@ func TestGetBlockHeaderByID(t *testing.T) {
StateRoot: common.Root{}, // set in test cases
BodyRoot: common.Root{'d', 'u', 'm', 'm', 'y', 'r', 'o', 'o', 't'},
}
stForBlockRoot := makeTestState(t, cs)
testBlockRoot := expectedHeaderBlockRoot(
testHeader,
testDummyState(t, cs, stForBlockRoot, testHeader),
)
errTestHeaderNotFound := errors.New("test header not found error")

testCases := []struct {
Expand Down Expand Up @@ -417,7 +423,7 @@ func TestGetBlockHeaderByID(t *testing.T) {
require.IsType(t, &beacontypes.BlockHeaderResponse{}, gr.Data)
data, _ := gr.Data.(*beacontypes.BlockHeaderResponse)

require.Equal(t, testHeader.BodyRoot, data.Root)
require.Equal(t, expectedHeaderBlockRoot(testHeader, expectedStateRoot), data.Root)
expectedHeader := &beacontypes.BeaconBlockHeader{
Slot: testHeader.Slot.Base10(),
ProposerIndex: testHeader.ProposerIndex.Base10(),
Expand Down Expand Up @@ -473,7 +479,7 @@ func TestGetBlockHeaderByID(t *testing.T) {
inputs: func() beacontypes.GetBlockHeaderRequest {
return beacontypes.GetBlockHeaderRequest{
BlockIDRequest: handlertypes.BlockIDRequest{
BlockID: testHeader.BodyRoot.Hex(),
BlockID: testBlockRoot.Hex(),
},
}
},
Expand All @@ -483,7 +489,7 @@ func TestGetBlockHeaderByID(t *testing.T) {
st := makeTestState(t, cs)
stateRoot := testDummyState(t, cs, st, testHeader)
b.EXPECT().StateAndSlotFromHeight(mock.Anything).Return(st, math.Slot(0), nil)
b.EXPECT().GetSlotByBlockRoot(testHeader.BodyRoot).Return(testHeader.Slot, nil)
b.EXPECT().GetSlotByBlockRoot(testBlockRoot).Return(testHeader.Slot, nil)
return stateRoot
},
check: func(t *testing.T, expectedStateRoot common.Root, res any, err error) {
Expand All @@ -496,7 +502,7 @@ func TestGetBlockHeaderByID(t *testing.T) {
require.IsType(t, &beacontypes.BlockHeaderResponse{}, gr.Data)
data, _ := gr.Data.(*beacontypes.BlockHeaderResponse)

require.Equal(t, testHeader.BodyRoot, data.Root)
require.Equal(t, expectedHeaderBlockRoot(testHeader, expectedStateRoot), data.Root)
expectedHeader := &beacontypes.BeaconBlockHeader{
Slot: testHeader.Slot.Base10(),
ProposerIndex: testHeader.ProposerIndex.Base10(),
Expand Down Expand Up @@ -530,13 +536,12 @@ func TestGetBlockHeaderByID(t *testing.T) {
inputs: func() beacontypes.GetBlockHeaderRequest {
return beacontypes.GetBlockHeaderRequest{
BlockIDRequest: handlertypes.BlockIDRequest{
BlockID: testHeader.BodyRoot.Hex(),
BlockID: testBlockRoot.Hex(),
},
}
},
setMockExpectations: func(_ *testing.T, b *mocks.Backend) common.Root {
// Assume parent header is not known
b.EXPECT().GetSlotByBlockRoot(testHeader.BodyRoot).Return(0, errTestHeaderNotFound)
b.EXPECT().GetSlotByBlockRoot(testBlockRoot).Return(0, errTestHeaderNotFound)
return common.Root{}
},
check: func(t *testing.T, _ common.Root, _ any, err error) {
Expand Down Expand Up @@ -618,3 +623,9 @@ func testDummyState(

return st.HashTreeRoot()
}

func expectedHeaderBlockRoot(hdr *ctypes.BeaconBlockHeader, stateRoot common.Root) common.Root {
h := *hdr
h.SetStateRoot(stateRoot)
return h.HashTreeRoot()
}