Light client consensus types #14512
Light client consensus types #14512
Conversation
| 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.
| 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
| 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.
| @@ -33,7 +33,9 @@ const ( | |||
| BlobSize = 131072 // defined to match blob.size in bazel ssz codegen | |||
| BlobSidecarSize = 131928 // defined to match blob sidecar size in bazel ssz codegen | |||
| KzgCommitmentInclusionProofDepth = 17 // Merkle proof depth for blob_kzg_commitments list item | |||
| NextSyncCommitteeBranchDepth = 5 // NextSyncCommitteeBranchDepth defines the depth of the next sync committee branch. | |||
| ExecutionBranchDepth = 4 // ExecutionBranchDepth defines the number of leaves in a merkle proof of the execution payload header. | |||
| SyncCommitteeBranchDepth = 5 // SyncCommitteeBranchDepth defines the number of leaves in a merkle proof of a sync committee. | |||
There was a problem hiding this comment.
The spec defines a CurrentSyncCommitteeBranch and NextSyncCommitteeBranch, but since the depth is the same, we might as well keep one variable. Even if we defined two separate types in the interfaces package, they would both alias [5][32]byte and thus would be assignable to each other, so compiler won't catch slip-ups.
|
Closing in favor of #14518 |
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