-
Notifications
You must be signed in to change notification settings - Fork 1k
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.
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
Call FCU with attribute on non head block #11919
Merged
Merged
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
3f2bd1d
Call FCU with attribute on non head block
terencechain 18a6b46
Merge branch 'develop' into fcu-with-attribute
terencechain dcd0e22
Fix condition
terencechain 35bb6fc
Filer save head
terencechain 71ac2be
Refactor
terencechain b0f3c8c
Rm
terencechain 8f3e9db
Add tests
terencechain 45601cf
Merge branch 'develop' into fcu-with-attribute
terencechain 455c951
Fix race test
terencechain 7db992a
Merge branch 'fcu-with-attribute' of github.com:prysmaticlabs/prysm i…
terencechain 4b0dca7
Potuz feedback
terencechain 0259c60
Merge branch 'develop' into fcu-with-attribute
rkapka 3fa81dc
Merge refs/heads/develop into fcu-with-attribute
prylabs-bulldozer[bot] 45856b7
Reorder r != currentHeadRoot
terencechain ae1b867
Merge branch 'fcu-with-attribute' of github.com:prysmaticlabs/prysm i…
terencechain 24d5fa6
Merge branch 'develop' into fcu-with-attribute
terencechain 5a7f9bb
Merge refs/heads/develop into fcu-with-attribute
prylabs-bulldozer[bot] ae7f695
Merge refs/heads/develop into fcu-with-attribute
prylabs-bulldozer[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
package blockchain | ||
|
||
import ( | ||
"context" | ||
|
||
"github.com/pkg/errors" | ||
"github.com/prysmaticlabs/prysm/v3/beacon-chain/state" | ||
"github.com/prysmaticlabs/prysm/v3/consensus-types/interfaces" | ||
) | ||
|
||
func (s *Service) isNewProposer() bool { | ||
_, _, ok := s.cfg.ProposerSlotIndexCache.GetProposerPayloadIDs(s.CurrentSlot()+1, [32]byte{} /* root */) | ||
return ok | ||
} | ||
|
||
func (s *Service) isNewHead(r [32]byte) bool { | ||
s.headLock.RLock() | ||
defer s.headLock.RUnlock() | ||
|
||
currentHeadRoot := s.originBlockRoot | ||
if s.head != nil { | ||
currentHeadRoot = s.headRoot() | ||
} | ||
|
||
return r != currentHeadRoot || r == [32]byte{} | ||
} | ||
|
||
func (s *Service) getStateAndBlock(ctx context.Context, r [32]byte) (state.BeaconState, interfaces.SignedBeaconBlock, error) { | ||
if !s.hasBlockInInitSyncOrDB(ctx, r) { | ||
return nil, nil, errors.New("block does not exist") | ||
} | ||
newHeadBlock, err := s.getBlock(ctx, r) | ||
if err != nil { | ||
return nil, nil, err | ||
} | ||
headState, err := s.cfg.StateGen.StateByRoot(ctx, r) | ||
if err != nil { | ||
return nil, nil, err | ||
} | ||
return headState, newHeadBlock, nil | ||
} | ||
|
||
func (s *Service) forkchoiceUpdateWithExecution(ctx context.Context, newHeadRoot [32]byte) error { | ||
isNewHead := s.isNewHead(newHeadRoot) | ||
if !isNewHead && !s.isNewProposer() { | ||
return nil | ||
} | ||
|
||
headState, headBlock, err := s.getStateAndBlock(ctx, newHeadRoot) | ||
if err != nil { | ||
log.WithError(err).Error("Could not get forkchoice update argument") | ||
return nil | ||
} | ||
|
||
_, err = s.notifyForkchoiceUpdate(ctx, ¬ifyForkchoiceUpdateArg{ | ||
headState: headState, | ||
headRoot: newHeadRoot, | ||
headBlock: headBlock.Block(), | ||
}) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
if isNewHead { | ||
if err := s.saveHead(ctx, newHeadRoot, headBlock, headState); err != nil { | ||
log.WithError(err).Error("could not save head") | ||
} | ||
} | ||
|
||
return nil | ||
} |
190 changes: 190 additions & 0 deletions
190
beacon-chain/blockchain/forkchoice_update_execution_test.go
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,190 @@ | ||
package blockchain | ||
|
||
import ( | ||
"context" | ||
"testing" | ||
|
||
"github.com/prysmaticlabs/prysm/v3/beacon-chain/cache" | ||
testDB "github.com/prysmaticlabs/prysm/v3/beacon-chain/db/testing" | ||
mockExecution "github.com/prysmaticlabs/prysm/v3/beacon-chain/execution/testing" | ||
doublylinkedtree "github.com/prysmaticlabs/prysm/v3/beacon-chain/forkchoice/doubly-linked-tree" | ||
"github.com/prysmaticlabs/prysm/v3/beacon-chain/state/stategen" | ||
"github.com/prysmaticlabs/prysm/v3/config/params" | ||
"github.com/prysmaticlabs/prysm/v3/consensus-types/blocks" | ||
"github.com/prysmaticlabs/prysm/v3/consensus-types/primitives" | ||
ethpb "github.com/prysmaticlabs/prysm/v3/proto/prysm/v1alpha1" | ||
"github.com/prysmaticlabs/prysm/v3/testing/require" | ||
"github.com/prysmaticlabs/prysm/v3/testing/util" | ||
logTest "github.com/sirupsen/logrus/hooks/test" | ||
) | ||
|
||
func TestService_isNewProposer(t *testing.T) { | ||
beaconDB := testDB.SetupDB(t) | ||
service := setupBeaconChain(t, beaconDB) | ||
require.Equal(t, false, service.isNewProposer()) | ||
|
||
service.cfg.ProposerSlotIndexCache.SetProposerAndPayloadIDs(service.CurrentSlot()+1, 0, [8]byte{}, [32]byte{} /* root */) | ||
require.Equal(t, true, service.isNewProposer()) | ||
} | ||
|
||
func TestService_isNewHead(t *testing.T) { | ||
beaconDB := testDB.SetupDB(t) | ||
service := setupBeaconChain(t, beaconDB) | ||
require.Equal(t, true, service.isNewHead([32]byte{})) | ||
|
||
service.head = &head{root: [32]byte{1}} | ||
require.Equal(t, true, service.isNewHead([32]byte{2})) | ||
require.Equal(t, false, service.isNewHead([32]byte{1})) | ||
|
||
// Nil head should use origin root | ||
service.head = nil | ||
service.originBlockRoot = [32]byte{3} | ||
require.Equal(t, true, service.isNewHead([32]byte{2})) | ||
require.Equal(t, false, service.isNewHead([32]byte{3})) | ||
} | ||
|
||
func TestService_getHeadStateAndBlock(t *testing.T) { | ||
beaconDB := testDB.SetupDB(t) | ||
service := setupBeaconChain(t, beaconDB) | ||
_, _, err := service.getStateAndBlock(context.Background(), [32]byte{}) | ||
require.ErrorContains(t, "block does not exist", err) | ||
|
||
blk, err := blocks.NewSignedBeaconBlock(util.HydrateSignedBeaconBlock(ðpb.SignedBeaconBlock{Signature: []byte{1}})) | ||
require.NoError(t, err) | ||
require.NoError(t, service.cfg.BeaconDB.SaveBlock(context.Background(), blk)) | ||
|
||
st, _ := util.DeterministicGenesisState(t, 1) | ||
r, err := blk.Block().HashTreeRoot() | ||
require.NoError(t, err) | ||
require.NoError(t, service.cfg.BeaconDB.SaveState(context.Background(), st, r)) | ||
|
||
gotState, err := service.cfg.BeaconDB.State(context.Background(), r) | ||
require.NoError(t, err) | ||
require.DeepEqual(t, st.ToProto(), gotState.ToProto()) | ||
|
||
gotBlk, err := service.cfg.BeaconDB.Block(context.Background(), r) | ||
require.NoError(t, err) | ||
require.DeepEqual(t, blk, gotBlk) | ||
} | ||
|
||
func TestService_forkchoiceUpdateWithExecution_exceptionalCases(t *testing.T) { | ||
hook := logTest.NewGlobal() | ||
ctx := context.Background() | ||
opts := testServiceOptsWithDB(t) | ||
|
||
service, err := NewService(ctx, opts...) | ||
require.NoError(t, err) | ||
service.cfg.ProposerSlotIndexCache = cache.NewProposerPayloadIDsCache() | ||
require.NoError(t, service.forkchoiceUpdateWithExecution(ctx, service.headRoot())) | ||
hookErr := "could not notify forkchoice update" | ||
invalidStateErr := "could not get state summary: could not find block in DB" | ||
require.LogsDoNotContain(t, hook, invalidStateErr) | ||
require.LogsDoNotContain(t, hook, hookErr) | ||
gb, err := blocks.NewSignedBeaconBlock(util.NewBeaconBlock()) | ||
require.NoError(t, err) | ||
require.NoError(t, service.saveInitSyncBlock(ctx, [32]byte{'a'}, gb)) | ||
require.NoError(t, service.forkchoiceUpdateWithExecution(ctx, [32]byte{'a'})) | ||
require.LogsContain(t, hook, invalidStateErr) | ||
|
||
hook.Reset() | ||
service.head = &head{ | ||
root: [32]byte{'a'}, | ||
block: nil, /* should not panic if notify head uses correct head */ | ||
} | ||
|
||
// Block in Cache | ||
b := util.NewBeaconBlock() | ||
b.Block.Slot = 2 | ||
wsb, err := blocks.NewSignedBeaconBlock(b) | ||
require.NoError(t, err) | ||
r1, err := b.Block.HashTreeRoot() | ||
require.NoError(t, err) | ||
require.NoError(t, service.saveInitSyncBlock(ctx, r1, wsb)) | ||
st, _ := util.DeterministicGenesisState(t, 1) | ||
service.head = &head{ | ||
root: r1, | ||
block: wsb, | ||
state: st, | ||
} | ||
service.cfg.ProposerSlotIndexCache.SetProposerAndPayloadIDs(2, 1, [8]byte{1}, [32]byte{2}) | ||
require.NoError(t, service.forkchoiceUpdateWithExecution(ctx, r1)) | ||
require.LogsDoNotContain(t, hook, invalidStateErr) | ||
require.LogsDoNotContain(t, hook, hookErr) | ||
|
||
// Block in DB | ||
b = util.NewBeaconBlock() | ||
b.Block.Slot = 3 | ||
util.SaveBlock(t, ctx, service.cfg.BeaconDB, b) | ||
r1, err = b.Block.HashTreeRoot() | ||
require.NoError(t, err) | ||
st, _ = util.DeterministicGenesisState(t, 1) | ||
service.head = &head{ | ||
root: r1, | ||
block: wsb, | ||
state: st, | ||
} | ||
service.cfg.ProposerSlotIndexCache.SetProposerAndPayloadIDs(2, 1, [8]byte{1}, [32]byte{2}) | ||
require.NoError(t, service.forkchoiceUpdateWithExecution(ctx, r1)) | ||
require.LogsDoNotContain(t, hook, invalidStateErr) | ||
require.LogsDoNotContain(t, hook, hookErr) | ||
vId, payloadID, has := service.cfg.ProposerSlotIndexCache.GetProposerPayloadIDs(2, [32]byte{2}) | ||
require.Equal(t, true, has) | ||
require.Equal(t, primitives.ValidatorIndex(1), vId) | ||
require.Equal(t, [8]byte{1}, payloadID) | ||
|
||
// Test zero headRoot returns immediately. | ||
headRoot := service.headRoot() | ||
require.NoError(t, service.forkchoiceUpdateWithExecution(ctx, [32]byte{})) | ||
require.Equal(t, service.headRoot(), headRoot) | ||
} | ||
|
||
func TestService_forkchoiceUpdateWithExecution_SameHeadRootNewProposer(t *testing.T) { | ||
ctx := context.Background() | ||
beaconDB := testDB.SetupDB(t) | ||
altairBlk := util.SaveBlock(t, ctx, beaconDB, util.NewBeaconBlockAltair()) | ||
altairBlkRoot, err := altairBlk.Block().HashTreeRoot() | ||
require.NoError(t, err) | ||
bellatrixBlk := util.SaveBlock(t, ctx, beaconDB, util.NewBeaconBlockBellatrix()) | ||
bellatrixBlkRoot, err := bellatrixBlk.Block().HashTreeRoot() | ||
require.NoError(t, err) | ||
fcs := doublylinkedtree.New() | ||
opts := []Option{ | ||
WithDatabase(beaconDB), | ||
WithStateGen(stategen.New(beaconDB, fcs)), | ||
WithForkChoiceStore(fcs), | ||
WithProposerIdsCache(cache.NewProposerPayloadIDsCache()), | ||
} | ||
service, err := NewService(ctx, opts...) | ||
require.NoError(t, err) | ||
st, _ := util.DeterministicGenesisState(t, 10) | ||
service.head = &head{ | ||
state: st, | ||
} | ||
|
||
ojc := ðpb.Checkpoint{Root: params.BeaconConfig().ZeroHash[:]} | ||
ofc := ðpb.Checkpoint{Root: params.BeaconConfig().ZeroHash[:]} | ||
state, blkRoot, err := prepareForkchoiceState(ctx, 0, [32]byte{}, [32]byte{}, params.BeaconConfig().ZeroHash, ojc, ofc) | ||
require.NoError(t, err) | ||
require.NoError(t, fcs.InsertNode(ctx, state, blkRoot)) | ||
state, blkRoot, err = prepareForkchoiceState(ctx, 1, altairBlkRoot, [32]byte{}, params.BeaconConfig().ZeroHash, ojc, ofc) | ||
require.NoError(t, err) | ||
require.NoError(t, fcs.InsertNode(ctx, state, blkRoot)) | ||
state, blkRoot, err = prepareForkchoiceState(ctx, 2, bellatrixBlkRoot, altairBlkRoot, params.BeaconConfig().ZeroHash, ojc, ofc) | ||
require.NoError(t, err) | ||
require.NoError(t, fcs.InsertNode(ctx, state, blkRoot)) | ||
|
||
service.cfg.ExecutionEngineCaller = &mockExecution.EngineClient{} | ||
require.NoError(t, beaconDB.SaveState(ctx, st, bellatrixBlkRoot)) | ||
require.NoError(t, beaconDB.SaveGenesisBlockRoot(ctx, bellatrixBlkRoot)) | ||
sb, err := blocks.NewSignedBeaconBlock(util.HydrateSignedBeaconBlockBellatrix(ðpb.SignedBeaconBlockBellatrix{})) | ||
require.NoError(t, err) | ||
require.NoError(t, beaconDB.SaveBlock(ctx, sb)) | ||
r, err := sb.Block().HashTreeRoot() | ||
require.NoError(t, err) | ||
|
||
// Set head to be the same but proposing next slot | ||
service.head.root = r | ||
service.cfg.ProposerSlotIndexCache.SetProposerAndPayloadIDs(service.CurrentSlot()+1, 0, [8]byte{}, [32]byte{} /* root */) | ||
require.NoError(t, service.forkchoiceUpdateWithExecution(ctx, r)) | ||
|
||
} |
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
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 adds duplicated logic in a few places. At the very least I remember
saveHead
where the same check its used. If we are going to have a dedicated method to check if a given block root differs from the stored head, we should move these checks to use this method.Also, the logic in
saveHead
is a little safer with respect to the origin Root, so I'll extend slightly this comment. This is whatsaveHead
currently has:We should move the last check to
But also, we should probably add the checks for head being nil and dealing with the
originBlockRoot
in this method as well.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.
Done. One annoying part is we still need to retrieve
oldHeadRoot
for logs