Skip to content

Add light-client types #50

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
fearlessfe wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Add light-client types #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ce1810f
feat: add lightClientHeader type
fearlessfe Apr 1, 2024
fdfcb72
feat: add LightClientBootstrap type
Apr 2, 2024
188558b
Merge pull request #1 from optimism-java/light_client_header
GrapeBaBa Apr 2, 2024
d84c1ad
feat: add lightclient types
fearlessfe Apr 3, 2024
43436cd
Merge pull request #3 from optimism-java/types
fearlessfe Apr 3, 2024
235b70f
Revert "feat: add lightclient types"
fearlessfe Apr 3, 2024
f1c14ad
Merge pull request #4 from optimism-java/revert-3-types
fearlessfe Apr 3, 2024
04d1d44
feat: add lightclient types
fearlessfe Apr 3, 2024
89802fe
fix: FixedLength method err
Apr 8, 2024
d9dbf06
feat: add lightclient type for deneb
fearlessfe Apr 14, 2024
bca5f73
Merge remote-tracking branch 'upstream/master' into portal
fearlessfe May 26, 2025
bc543d0
faet: add light client types for electra
fearlessfe May 28, 2025
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
168 changes: 164 additions & 4 deletions eth2/beacon/altair/lightclient.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,10 @@ func (fb FinalizedRootProofBranch) HashTreeRoot(hFn tree.HashFn) common.Root {

func LightClientUpdateType(spec *common.Spec) *ContainerTypeDef {
return ContainerType("SyncCommittee", []FieldDef{
{"attested_header", common.BeaconBlockHeaderType},
{"attested_header", LightClientHeaderType},
{"next_sync_committee", common.SyncCommitteeType(spec)},
{"next_sync_committee_branch", SyncCommitteeProofBranchType},
{"finalized_header", common.BeaconBlockHeaderType},
{"finalized_header", LightClientHeaderType},
{"finality_branch", FinalizedRootProofBranchType},
{"sync_aggregate", SyncAggregateType(spec)},
{"signature_slot", common.SlotType},
Expand All @@ -148,12 +148,12 @@ func LightClientUpdateType(spec *common.Spec) *ContainerTypeDef {

type LightClientUpdate struct {
// Update beacon block header
AttestedHeader common.BeaconBlockHeader `yaml:"attested_header" json:"attested_header"`
AttestedHeader LightClientHeader `yaml:"attested_header" json:"attested_header"`
// Next sync committee corresponding to the header
NextSyncCommittee common.SyncCommittee `yaml:"next_sync_committee" json:"next_sync_committee"`
NextSyncCommitteeBranch SyncCommitteeProofBranch `yaml:"next_sync_committee_branch" json:"next_sync_committee_branch"`
// Finality proof for the update header
FinalizedHeader common.BeaconBlockHeader `yaml:"finalized_header" json:"finalized_header"`
FinalizedHeader LightClientHeader `yaml:"finalized_header" json:"finalized_header"`
FinalityBranch FinalizedRootProofBranch `yaml:"finality_branch" json:"finality_branch"`
// Sync committee aggregate signature
SyncAggregate SyncAggregate `yaml:"sync_aggregate" json:"sync_aggregate"`
Expand Down Expand Up @@ -220,3 +220,163 @@ func (lcu *LightClientUpdate) HashTreeRoot(spec *common.Spec, hFn tree.HashFn) c
&lcu.SignatureSlot,
)
}

var LightClientHeaderType = ContainerType("LightClientHeaderType", []FieldDef{
{Name: "beacon", Type: common.BeaconBlockHeaderType},
})

type LightClientHeader struct {
Beacon common.BeaconBlockHeader `yaml:"beacon" json:"beacon"`
}

func (lch *LightClientHeader) Deserialize(dr *codec.DecodingReader) error {
return dr.FixedLenContainer(
&lch.Beacon,
)
}

func (lch *LightClientHeader) Serialize(w *codec.EncodingWriter) error {
return w.FixedLenContainer(
&lch.Beacon,
)
}

func (lch *LightClientHeader) ByteLength() uint64 {
return codec.ContainerLength(
&lch.Beacon,
)
}

func (lch *LightClientHeader) FixedLength() uint64 {
return codec.ContainerLength(
&lch.Beacon,
)
}

func (lch *LightClientHeader) HashTreeRoot(hFn tree.HashFn) common.Root {
return hFn.HashTreeRoot(
&lch.Beacon,
)
}

type LightClientBootstrap struct {
Header LightClientHeader `yaml:"header" json:"header"`
CurrentSyncCommittee common.SyncCommittee `yaml:"current_sync_committee" json:"current_sync_committee"`
CurrentSyncCommitteeBranch SyncCommitteeProofBranch `yaml:"current_sync_committee_branch" json:"current_sync_committee_branch"`
}

func NewLightClientBootstrapType(spec *common.Spec) *ContainerTypeDef {
return ContainerType("LightClientHeader", []FieldDef{
{Name: "header", Type: LightClientHeaderType},
{Name: "current_sync_committee", Type: common.SyncCommitteeType(spec)},
{Name: "current_sync_committee_branch", Type: SyncCommitteeProofBranchType},
})
}

func (lcb *LightClientBootstrap) FixedLength(spec *common.Spec) uint64 {
return codec.ContainerLength(&lcb.Header, spec.Wrap(&lcb.CurrentSyncCommittee), &lcb.CurrentSyncCommitteeBranch)
}

func (lcb *LightClientBootstrap) Deserialize(spec *common.Spec, dr *codec.DecodingReader) error {
return dr.Container(&lcb.Header, spec.Wrap(&lcb.CurrentSyncCommittee), &lcb.CurrentSyncCommitteeBranch)
}

func (lcb *LightClientBootstrap) Serialize(spec *common.Spec, w *codec.EncodingWriter) error {
return w.Container(&lcb.Header, spec.Wrap(&lcb.CurrentSyncCommittee), &lcb.CurrentSyncCommitteeBranch)
}

func (lcb *LightClientBootstrap) ByteLength(spec *common.Spec) uint64 {
return codec.ContainerLength(&lcb.Header, spec.Wrap(&lcb.CurrentSyncCommittee), &lcb.CurrentSyncCommitteeBranch)
}

func (lcb *LightClientBootstrap) HashTreeRoot(spec *common.Spec, hFn tree.HashFn) common.Root {
return hFn.HashTreeRoot(
&lcb.Header,
spec.Wrap(&lcb.CurrentSyncCommittee),
&lcb.CurrentSyncCommitteeBranch,
)
}

type LightClientFinalityUpdate struct {
AttestedHeader LightClientHeader `yaml:"attested_header" json:"attested_header"`
FinalizedHeader common.BeaconBlockHeader `yaml:"finalized_header" json:"finalized_header"`
FinalityBranch FinalizedRootProofBranch `yaml:"finality_branch" json:"finality_branch"`
SyncAggregate SyncAggregate `yaml:"sync_aggregate" json:"sync_aggregate"`
SignatureSlot common.Slot `yaml:"signature_slot" json:"signature_slot"`
}

func LightClientFinalityUpdateType(spec *common.Spec) *ContainerTypeDef {
return ContainerType("SyncCommittee", []FieldDef{
{Name: "attested_header", Type: common.BeaconBlockHeaderType},
{Name: "finalized_header", Type: common.BeaconBlockHeaderType},
{Name: "finality_branch", Type: FinalizedRootProofBranchType},
{Name: "sync_aggregate", Type: SyncAggregateType(spec)},
{Name: "signature_slot", Type: common.SlotType},
})
}

func (lcfu *LightClientFinalityUpdate) FixedLength(spec *common.Spec) uint64 {
return codec.ContainerLength(&lcfu.AttestedHeader, &lcfu.FinalizedHeader, &lcfu.FinalityBranch, spec.Wrap(&lcfu.SyncAggregate), &lcfu.SignatureSlot)
}

func (lcfu *LightClientFinalityUpdate) Deserialize(spec *common.Spec, dr *codec.DecodingReader) error {
return dr.Container(&lcfu.AttestedHeader, &lcfu.FinalizedHeader, &lcfu.FinalityBranch, spec.Wrap(&lcfu.SyncAggregate), &lcfu.SignatureSlot)
}

func (lcfu *LightClientFinalityUpdate) Serialize(spec *common.Spec, w *codec.EncodingWriter) error {
return w.Container(&lcfu.AttestedHeader, &lcfu.FinalizedHeader, &lcfu.FinalityBranch, spec.Wrap(&lcfu.SyncAggregate), &lcfu.SignatureSlot)
}

func (lcfu *LightClientFinalityUpdate) ByteLength(spec *common.Spec) uint64 {
return codec.ContainerLength(&lcfu.AttestedHeader, &lcfu.FinalizedHeader, &lcfu.FinalityBranch, spec.Wrap(&lcfu.SyncAggregate), &lcfu.SignatureSlot)
}

func (lcfu *LightClientFinalityUpdate) HashTreeRoot(spec *common.Spec, hFn tree.HashFn) common.Root {
return hFn.HashTreeRoot(
&lcfu.AttestedHeader,
&lcfu.FinalizedHeader,
&lcfu.FinalityBranch,
spec.Wrap(&lcfu.SyncAggregate),
&lcfu.SignatureSlot,
)
}

type LightClientOptimisticUpdate struct {
AttestedHeader LightClientHeader `yaml:"attested_header" json:"attested_header"`
SyncAggregate SyncAggregate `yaml:"sync_aggregate" json:"sync_aggregate"`
SignatureSlot common.Slot `yaml:"signature_slot" json:"signature_slot"`
}

func LightClientOptimisticUpdateType(spec *common.Spec) *ContainerTypeDef {
return ContainerType("SyncCommittee", []FieldDef{
{Name: "attested_header", Type: common.BeaconBlockHeaderType},
{Name: "finalized_header", Type: common.BeaconBlockHeaderType},
{Name: "finality_branch", Type: FinalizedRootProofBranchType},
{Name: "sync_aggregate", Type: SyncAggregateType(spec)},
{Name: "signature_slot", Type: common.SlotType},
})
}

func (lcou *LightClientOptimisticUpdate) FixedLength(spec *common.Spec) uint64 {
return codec.ContainerLength(&lcou.AttestedHeader, spec.Wrap(&lcou.SyncAggregate), &lcou.SignatureSlot)
}

func (lcou *LightClientOptimisticUpdate) Deserialize(spec *common.Spec, dr *codec.DecodingReader) error {
return dr.Container(&lcou.AttestedHeader, spec.Wrap(&lcou.SyncAggregate), &lcou.SignatureSlot)
}

func (lcou *LightClientOptimisticUpdate) Serialize(spec *common.Spec, w *codec.EncodingWriter) error {
return w.Container(&lcou.AttestedHeader, spec.Wrap(&lcou.SyncAggregate), &lcou.SignatureSlot)
}

func (lcou *LightClientOptimisticUpdate) ByteLength(spec *common.Spec) uint64 {
return codec.ContainerLength(&lcou.AttestedHeader, spec.Wrap(&lcou.SyncAggregate), &lcou.SignatureSlot)
}

func (lcou *LightClientOptimisticUpdate) HashTreeRoot(spec *common.Spec, hFn tree.HashFn) common.Root {
return hFn.HashTreeRoot(
&lcou.AttestedHeader,
spec.Wrap(&lcou.SyncAggregate),
&lcou.SignatureSlot,
)
}
Loading