Light client consensus types #14512
Open
Light client consensus types #14512
Conversation
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
rkapka
commented
Oct 7, 2024
Comment on lines
+33
to
+34
| header interfaces.LightClientHeader | ||
| currentSyncCommitteeBranch interfaces.LightClientSyncCommitteeBranch |
There was a problem hiding this comment.
I added fields for object that would have to be re-created every time the getter is called. That's one pointer to a wrapper with one pointer field for each header, and at most 6*32 bytes for branches.
rkapka
commented
Oct 7, 2024
Comment on lines
+47
to
+60
| if len(p.CurrentSyncCommitteeBranch) != interfaces.SyncCommitteeBranchNumOfLeaves { | ||
| return nil, fmt.Errorf( | ||
| "sync committee branch has %d leaves instead of expected %d", | ||
| len(p.CurrentSyncCommitteeBranch), | ||
| interfaces.SyncCommitteeBranchNumOfLeaves, | ||
| ) | ||
| } | ||
| branch := interfaces.LightClientSyncCommitteeBranch{} | ||
| for i, leaf := range p.CurrentSyncCommitteeBranch { | ||
| if len(leaf) != fieldparams.RootLength { | ||
| return nil, fmt.Errorf("sync committee branch leaf at index %d has length %d instead of expected %d", i, len(leaf), fieldparams.RootLength) | ||
| } | ||
| branch[i] = bytesutil.ToBytes32(leaf) | ||
| } |
There was a problem hiding this comment.
This pattern appears many times, I will de-duplicate it in a future commit
rkapka
commented
Oct 7, 2024
Comment on lines
+11
to
+13
| ExecutionBranchNumOfLeaves = 4 | ||
| SyncCommitteeBranchNumOfLeaves = 5 | ||
| FinalityBranchNumOfLeaves = 6 |
There was a problem hiding this comment.
I should probably move this to fieldparams, rename NumOfLeaves to Depth and rename SyncCommitteeBranch to NextSyncCommitteeBranch for clarity.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What type of PR is this?
Other
What does this PR do? Why is it needed?
This PR creates a foundation for changing how we interact with light client types in the codebase. Currently we use protobuf-generated objects everywhere, but this has some problems:
LightClientHeaderis defined using aoneof, which makes it impossible to generate SSZ for this type or any type referencing the header. Without this, we can't return SSZ-serialized objects from the Beacon API.This PR's design is largely influenced by https://github.com/prysmaticlabs/prysm/blob/develop/consensus-types/blocks/execution.go. Main components:
v1alpha1with one type per fork instead of using aoneof. The reason for having them inv1alpha1is that it is the default directory for protobuf definitions. Theeth/v1andeth/v2directories are an artifact of some previous work and should be removed ultimately.ssz.Marshalerinterface:LightClientHeaderLightClientBootstrapLightClientUpdateLightClientFinalityUpdateLightClientOptimisticUpdateWhich issues(s) does this PR fix?
Part of #12991
Acknowledgements