api

package
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 14, 2026 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Overview

Code generated by dynamic-ssz. DO NOT EDIT. Hash: 35bdb60b5b6157e70d9e19955ba6308bce83263d0556f59d1f0682ef8d8cd230 Version: v1.3.0 (https://github.com/pk910/dynamic-ssz)

Code generated by dynamic-ssz. DO NOT EDIT. Hash: 9cbc7789a4c2c2872a073a078549978372dcae68d91e0b29e34fc79a7182c5ac Version: v1.3.0 (https://github.com/pk910/dynamic-ssz)

Code generated by dynamic-ssz. DO NOT EDIT. Hash: a0e84fab429b04f0e4e3f0bf573b6129c1b9daa23a117b3d7517aaa65345deed Version: v1.3.0 (https://github.com/pk910/dynamic-ssz)

Index

Constants

This section is empty.

Variables

View Source
var ErrDataMissing = errors.New("data missing")

ErrDataMissing is returned when the data requested is missing from the versioned struct.

View Source
var ErrUnsupportedVersion = errors.New("unsupported version")

ErrUnsupportedVersion is returned when the data requested is not present for the version of the struct.

Functions

This section is empty.

Types

type AggregateAttestationOpts

type AggregateAttestationOpts struct {
	Common CommonOpts

	// Slot is the slot for which the data is obtained.
	Slot phase0.Slot
	// AttestationDataRoot is the root for which the data is obtained.
	AttestationDataRoot phase0.Root
	// CommitteeIndex is the committee index the attestation data belongs to.
	CommitteeIndex phase0.CommitteeIndex
}

AggregateAttestationOpts are the options for obtaining aggregate attestations.

type AttestationDataOpts

type AttestationDataOpts struct {
	Common CommonOpts

	// Slot is the slot for which the data is obtained.
	Slot phase0.Slot
	// CommitteeIndex is the committee index for which the data is obtained.
	CommitteeIndex phase0.CommitteeIndex
}

AttestationDataOpts are the options for obtaining attestation data.

type AttestationEventHandlerFunc

type AttestationEventHandlerFunc func(context.Context, *spec.VersionedAttestation)

AttestationEventHandlerFunc is the handler for attestation events.

type AttestationPoolOpts

type AttestationPoolOpts struct {
	Common CommonOpts

	// Slot is the slot for which the data is obtained.  If not present then
	// data for all slots will be obtained.
	Slot *phase0.Slot

	// CommitteeIndex is the committee index for which the data is obtained.
	// If not present then data for all committee indices will be obtained.
	CommitteeIndex *phase0.CommitteeIndex
}

AttestationPoolOpts are the options for obtaining the attestation pool.

type AttestationRewardsOpts

type AttestationRewardsOpts struct {
	Common CommonOpts

	// Epoch is the epoch for which the data is obtained.
	Epoch phase0.Epoch
	// Indices is a list of validator indices to restrict the returned values.
	// If no indices are supplied then no filter will be applied.
	Indices []phase0.ValidatorIndex
	// PubKeys is a list of validator public keys to restrict the returned values.
	// If no public keys are supplied then no filter will be applied.
	PubKeys []phase0.BLSPubKey
}

AttestationRewardsOpts are the options for obtaining attestation rewards.

type AttesterDutiesOpts

type AttesterDutiesOpts struct {
	Common CommonOpts

	// Epoch is the epoch for which the data is obtained.
	Epoch phase0.Epoch
	// Indices is a list of validators for which to obtain the duties.
	Indices []phase0.ValidatorIndex
}

AttesterDutiesOpts are the options for obtaining proposer duties.

type AttesterSlashingEventHandlerFunc

type AttesterSlashingEventHandlerFunc func(context.Context, *electra.AttesterSlashing)

AttesterSlashingEventHandlerFunc is the handler for attestation_slashing events.

type BLSToExecutionChangeEventHandlerFunc

type BLSToExecutionChangeEventHandlerFunc func(context.Context, *capella.SignedBLSToExecutionChange)

BLSToExecutionChangeEventHandlerFunc is the handler for bls_to_execution_change events.

type BeaconBlockHeaderOpts

type BeaconBlockHeaderOpts struct {
	Common CommonOpts

	// Block is the ID of the block which the data is obtained.
	Block string
}

BeaconBlockHeaderOpts are the options for obtaining beacon block headers.

type BeaconBlockRootOpts

type BeaconBlockRootOpts struct {
	Common CommonOpts

	// Block is the ID of the block which the data is obtained.
	Block string
}

BeaconBlockRootOpts are the options for obtaining the beacon block root.

type BeaconCommitteesOpts

type BeaconCommitteesOpts struct {
	Common CommonOpts

	// State is the state at which the data is obtained.
	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
	State string
	// Epoch is the epoch for which the data is obtained.
	// This is optional; if not supplied it will obtain the data at the epoch relating to the state.
	Epoch *phase0.Epoch
}

BeaconCommitteesOpts are the options for obtaining proposer duties.

type BeaconStateOpts

type BeaconStateOpts struct {
	Common CommonOpts

	// State is the state at which the data is obtained.
	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
	State string
}

BeaconStateOpts are the options for obtaining the beacon state.

type BeaconStateRandaoOpts

type BeaconStateRandaoOpts struct {
	Common CommonOpts

	// State is the state at which the data is obtained.
	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
	State string
}

BeaconStateRandaoOpts are the options for obtaining the beacon state RANDAO.

type BeaconStateRootOpts

type BeaconStateRootOpts struct {
	Common CommonOpts

	// State is the state at which the data is obtained.
	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
	State string
}

BeaconStateRootOpts are the options for obtaining the beacon state root.

type BlindedProposalOpts

type BlindedProposalOpts struct {
	Common CommonOpts

	// Slot is the slot for which the proposal should be fetched.
	Slot phase0.Slot
	// RandaoReveal is the RANDAO reveal for the proposal.
	RandaoReveal phase0.BLSSignature
	// Graffiti is the graffiti to be included in the beacon block body.
	Graffiti [32]byte
	// SkipRandaoVerification is true if we do not want the server to verify our RANDAO reveal.
	// If this is set then the RANDAO reveal should be passed as the point at infinity (0xc0…00)
	SkipRandaoVerification bool
}

BlindedProposalOpts are the options for obtaining blinded proposals.

type BlobSidecarEventHandlerFunc

type BlobSidecarEventHandlerFunc func(context.Context, *apiv1.BlobSidecarEvent)

BlobSidecarEventHandlerFunc is the handler for blob_sidecar events.

type BlobSidecars

type BlobSidecars struct {
	Sidecars []*deneb.BlobSidecar
}

BlobSidecars is an API construct to allow decoding an array of blob sidecars.

func (*BlobSidecars) HashTreeRoot

func (b *BlobSidecars) HashTreeRoot() ([32]byte, error)

HashTreeRoot ssz hashes the BlobSidecars object.

func (*BlobSidecars) MarshalSSZ

func (b *BlobSidecars) MarshalSSZ() ([]byte, error)

MarshalSSZ ssz marshals the BlobSidecars object.

func (*BlobSidecars) SizeSSZ

func (b *BlobSidecars) SizeSSZ() int

SizeSSZ returns the size of the BlobSidecars object.

func (*BlobSidecars) UnmarshalSSZ

func (b *BlobSidecars) UnmarshalSSZ(buf []byte) error

UnmarshalSSZ ssz unmarshals the BlobSidecars object.

type BlobSidecarsOpts

type BlobSidecarsOpts struct {
	Common CommonOpts

	// Block is the ID of the block for which the data is obtained.
	Block string
}

BlobSidecarsOpts are the options for obtaining blob sidecars.

type BlobsOpts

type BlobsOpts struct {
	Common CommonOpts

	// Block is the ID of the block for which the data is obtained.
	Block string
}

BlobsOpts are the options for obtaining blobs.

type BlockEventHandlerFunc

type BlockEventHandlerFunc func(context.Context, *apiv1.BlockEvent)

BlockEventHandlerFunc is the handler for block events.

type BlockGossipEventHandlerFunc

type BlockGossipEventHandlerFunc func(context.Context, *apiv1.BlockGossipEvent)

BlockGossipEventHandlerFunc is the handler for block_gossip events.

type BlockRewardsOpts

type BlockRewardsOpts struct {
	Common CommonOpts

	// Block is the ID of the block which the data is obtained.
	Block string
}

BlockRewardsOpts are the options for proposing a block.

type ChainReorgEventHandlerFunc

type ChainReorgEventHandlerFunc func(context.Context, *apiv1.ChainReorgEvent)

ChainReorgEventHandlerFunc is the handler for chain_reorg events.

type CommonOpts

type CommonOpts struct {
	// Timeout is a specific timeout for this call.
	// If 0 then the default timeout is used.
	Timeout time.Duration
}

CommonOpts are options common for all calls.

type ContributionAndProofEventHandlerFunc

type ContributionAndProofEventHandlerFunc func(context.Context, *altair.SignedContributionAndProof)

ContributionAndProofEventHandlerFunc is the handler for contribution_and_proof events.

type DataColumnSidecarEventHandlerFunc

type DataColumnSidecarEventHandlerFunc func(context.Context, *apiv1.DataColumnSidecarEvent)

DataColumnSidecarEventHandlerFunc is the handler for data_column_sidecar events.

type DepositContractOpts

type DepositContractOpts struct {
	Common CommonOpts
}

DepositContractOpts are the options for obtaining the deposit contract.

type Error

type Error struct {
	Method     string
	Endpoint   string
	StatusCode int
	Data       []byte
}

Error represents an API error.

func (Error) Error

func (e Error) Error() string

type EventHandlerFunc

type EventHandlerFunc func(*apiv1.Event)

EventHandlerFunc is the handler for generic events.

type EventsOpts

type EventsOpts struct {
	Common CommonOpts

	// Topics are the topics of events to which we want to listen.
	Topics []string

	// Handler is a generic handler function to which to send all events.
	// In general, it is better to use event-specific handlers as they avoid casting, and also provide a context.
	Handler EventHandlerFunc

	// AttestationHandler is a handler for the attestation event.
	AttestationHandler AttestationEventHandlerFunc
	// AttesterSlashingHandler is a handler for the attester_slashing event.
	AttesterSlashingHandler AttesterSlashingEventHandlerFunc
	// BlobSidecarHandler is a handler for the blob_sidecar event.
	BlobSidecarHandler BlobSidecarEventHandlerFunc
	// BlockHandler is a handler for the block event.
	BlockHandler BlockEventHandlerFunc
	// BlockGossipHandler is a handler for the block_gossip event.
	BlockGossipHandler BlockGossipEventHandlerFunc
	// BLSToExecutionChangeHandler is a handler for the bls_to_execution_change event.
	BLSToExecutionChangeHandler BLSToExecutionChangeEventHandlerFunc
	// ChainReorgHandler is a handler for the chain_reorg event.
	ChainReorgHandler ChainReorgEventHandlerFunc
	// ContributionAndProofHandler is a handler for the contribution_and_proof event.
	ContributionAndProofHandler ContributionAndProofEventHandlerFunc
	// DataColumnSidecarHandler is a handler for the data_column_sidecar event.
	DataColumnSidecarHandler DataColumnSidecarEventHandlerFunc
	// FinalizedCheckpointHandler is a handler for the finalized_checkpoint event.
	FinalizedCheckpointHandler FinalizedCheckpointEventHandlerFunc
	// HeadHandler is a handler for the head event.
	HeadHandler HeadEventHandlerFunc
	// PayloadAttributesHandler is a handler for the payload_attributes event.
	PayloadAttributesHandler PayloadAttributesEventHandlerFunc
	// ProposerSlashingHandler is a handler for the proposer_slashing event.
	ProposerSlashingHandler ProposerSlashingEventHandlerFunc
	// SingleAttestationHandler is a handler for the single_attestation event.
	SingleAttestationHandler SingleAttestationEventHandlerFunc
	// VoluntaryExitHandler is a handler for the voluntary_exit event.
	VoluntaryExitHandler VoluntaryExitEventHandlerFunc
}

EventsOpts are the options for obtaining events.

type FinalityOpts

type FinalityOpts struct {
	Common CommonOpts

	// State is the state at which the data is obtained.
	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
	State string
}

FinalityOpts are the options for obtaining finality checkpoints.

type FinalizedCheckpointEventHandlerFunc

type FinalizedCheckpointEventHandlerFunc func(context.Context, *apiv1.FinalizedCheckpointEvent)

FinalizedCheckpointEventHandlerFunc is the handler for finalized_checkpoint events.

type ForkChoiceOpts

type ForkChoiceOpts struct {
	Common CommonOpts
}

ForkChoiceOpts are the options for obtaining the fork choice.

type ForkOpts

type ForkOpts struct {
	Common CommonOpts

	// State is the state at which the data is obtained.
	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
	State string
}

ForkOpts are the options for obtaining the fork.

type ForkScheduleOpts

type ForkScheduleOpts struct {
	Common CommonOpts
}

ForkScheduleOpts are the options for obtaining the fork schedule.

type GenesisOpts

type GenesisOpts struct {
	Common CommonOpts
}

GenesisOpts are the options for obtaining genesis information.

type HeadEventHandlerFunc

type HeadEventHandlerFunc func(context.Context, *apiv1.HeadEvent)

HeadEventHandlerFunc is the handler for head events.

type NodePeersOpts

type NodePeersOpts struct {
	Common CommonOpts

	// State of the connection (disconnected, connecting, connected, disconnecting)
	State []string
	// Direction of the connection (inbound, outbound)
	Direction []string
}

NodePeersOpts are the options for client side peer filtering.

type NodeSyncingOpts

type NodeSyncingOpts struct {
	Common CommonOpts
}

NodeSyncingOpts are the options for obtaining node sync information.

type NodeVersionOpts

type NodeVersionOpts struct {
	Common CommonOpts
}

NodeVersionOpts are the options for obtaining the node version.

type PayloadAttributesEventHandlerFunc

type PayloadAttributesEventHandlerFunc func(context.Context, *apiv1.PayloadAttributesEvent)

PayloadAttributesEventHandlerFunc is the handler for payload_attributes events.

type PendingConsolidationsOpts

type PendingConsolidationsOpts struct {
	Common CommonOpts

	// State is the state at which the data is obtained.
	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
	State string
}

PendingConsolidationsOpts are the options for obtaining pending consolidations.

type PendingDepositsOpts

type PendingDepositsOpts struct {
	Common CommonOpts

	// State is the state at which the data is obtained.
	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
	State string
}

PendingDepositsOpts are the options for obtaining pending deposits.

type PendingPartialWithdrawalsOpts

type PendingPartialWithdrawalsOpts struct {
	Common CommonOpts

	// State is the state at which the data is obtained.
	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
	State string
}

PendingPartialWithdrawalsOpts are the options for obtaining pending partial withdrawals.

type ProposalOpts

type ProposalOpts struct {
	Common CommonOpts

	// Slot is the slot for which the proposal should be fetched.
	Slot phase0.Slot
	// RandaoReveal is the RANDAO reveal for the proposal.
	RandaoReveal phase0.BLSSignature
	// Graffiti is the graffiti to be included in the beacon block body.
	Graffiti [32]byte
	// SkipRandaoVerification is true if we do not want the server to verify our RANDAO reveal.
	// If this is set then the RANDAO reveal should be passed as the point at infinity (0xc0…00)
	SkipRandaoVerification bool
	// BuilderBoostFactor is the relative weight of the builder payload versus a locally-produced
	// payload, as per https://ethereum.github.io/beacon-APIs/#/Validator/produceBlockV3
	// This is optional; if not supplied it will use the default value of 100.
	BuilderBoostFactor *uint64
}

ProposalOpts are the options for obtaining proposals.

type ProposerDutiesOpts

type ProposerDutiesOpts struct {
	Common CommonOpts

	// Epoch is the epoch for which the data is obtained.
	Epoch phase0.Epoch
	// Indices is a list of validators to restrict the returned values.
	// If no indices are supplied then no filter will be applied.
	Indices []phase0.ValidatorIndex
}

ProposerDutiesOpts are the options for obtaining proposer duties.

type ProposerSlashingEventHandlerFunc

type ProposerSlashingEventHandlerFunc func(context.Context, *phase0.ProposerSlashing)

ProposerSlashingEventHandlerFunc is the handler for proposer_slashing events.

type Response

type Response[T any] struct {
	Data     T
	Metadata map[string]any
}

Response is a response from the beacon API which may contain metadata.

type SignedBeaconBlockOpts

type SignedBeaconBlockOpts struct {
	Common CommonOpts

	// Block is the ID of the block which the data is obtained.
	Block string
}

SignedBeaconBlockOpts are the options for obtaining signed beacon blocks.

type SignedExecutionPayloadEnvelopeOpts

type SignedExecutionPayloadEnvelopeOpts struct {
	Common CommonOpts

	// Block is the ID of the block which the data is obtained.
	Block string
}

SignedExecutionPayloadEnvelopeOpts are the options for obtaining signed execution payload envelopes.

type SingleAttestationEventHandlerFunc

type SingleAttestationEventHandlerFunc func(context.Context, *electra.SingleAttestation)

SingleAttestationEventHandlerFunc is the handler for single_attestation events.

type SpecOpts

type SpecOpts struct {
	Common CommonOpts
}

SpecOpts are the options for obtaining the chain specification.

type SubmitAggregateAttestationsOpts

type SubmitAggregateAttestationsOpts struct {
	Common CommonOpts

	// SignedAggregateAndProofs are the aggregate and proofs to submit.
	SignedAggregateAndProofs []*spec.VersionedSignedAggregateAndProof
}

SubmitAggregateAttestationsOpts are the options for submitting attestations.

type SubmitAttestationsOpts

type SubmitAttestationsOpts struct {
	Common CommonOpts

	// Attestations are the attestations to submit.
	Attestations []*spec.VersionedAttestation
}

SubmitAttestationsOpts are the options for submitting attestations.

type SubmitBlindedProposalOpts

type SubmitBlindedProposalOpts struct {
	Common CommonOpts

	// Proposal is the proposal to submit.
	Proposal *VersionedSignedBlindedProposal

	// BroadcastValidation is the validation required of the consensus node before broadcasting the proposal.
	BroadcastValidation *apiv2.BroadcastValidation
}

SubmitBlindedProposalOpts are the options for submitting proposals.

type SubmitProposalOpts

type SubmitProposalOpts struct {
	Common CommonOpts

	// Proposal is the proposal to submit.
	Proposal *VersionedSignedProposal

	// BroadcastValidation is the validation required of the consensus node before broadcasting the proposal.
	BroadcastValidation *apiv2.BroadcastValidation
}

SubmitProposalOpts are the options for submitting proposals.

type SyncCommitteeContributionOpts

type SyncCommitteeContributionOpts struct {
	Common CommonOpts

	// Slot is the slot for which the data is obtained.
	Slot phase0.Slot
	// SubcommitteeIndex is the index of the sync subcommittee for which the data is obtained.
	SubcommitteeIndex uint64
	// BeaconBlockRoot is the root of the beacon block for which the data is obtained.
	BeaconBlockRoot phase0.Root
}

SyncCommitteeContributionOpts are the options for obtaining sync committee contributions.

type SyncCommitteeDutiesOpts

type SyncCommitteeDutiesOpts struct {
	Common CommonOpts

	// Epoch is the epoch for which the data is obtained.
	Epoch phase0.Epoch
	// Indices is a list of validators for which to obtain the duties.
	Indices []phase0.ValidatorIndex
}

SyncCommitteeDutiesOpts are the options for obtaining sync committee duties.

type SyncCommitteeOpts

type SyncCommitteeOpts struct {
	Common CommonOpts

	// State is the state at which the data is obtained.
	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
	State string
	// Epoch is the epoch for which the data is obtained.
	// This is optional; if not supplied it will obtain the data at the epoch relating to the state.
	Epoch *phase0.Epoch
}

SyncCommitteeOpts are the options for obtaining sync committees.

type SyncCommitteeRewardsOpts

type SyncCommitteeRewardsOpts struct {
	Common CommonOpts

	// Block is the ID of the block which the data is obtained.
	Block string
	// Indices is a list of validator indices to restrict the returned values.
	// If no indices are supplied then no filter will be applied.
	Indices []phase0.ValidatorIndex
	// PubKeys is a list of validator public keys to restrict the returned values.
	// If no public keys are supplied then no filter will be applied.
	PubKeys []phase0.BLSPubKey
}

SyncCommitteeRewardsOpts are the options for obtaining sync committee rewards.

type ValidatorBalancesOpts

type ValidatorBalancesOpts struct {
	Common CommonOpts

	// State is the state at which the data is obtained.
	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
	State string
	// Indices is a list of validator indices to restrict the returned values.
	// If no indices are supplied then no filter will be applied.
	Indices []phase0.ValidatorIndex
	// PubKeys is a list of validator public keys to restrict the returned values.
	// If no public keys are supplied then no filter will be applied.
	PubKeys []phase0.BLSPubKey
}

ValidatorBalancesOpts are the options for obtaining validator balances.

type ValidatorLivenessOpts

type ValidatorLivenessOpts struct {
	Common CommonOpts

	// Epoch is the epoch for which the data is obtained.
	Epoch phase0.Epoch
	// Indices is a list of validators for which to obtain the duties.
	Indices []phase0.ValidatorIndex
}

ValidatorLivenessOpts are the options for obtaining validator liveness information.

type ValidatorsOpts

type ValidatorsOpts struct {
	Common CommonOpts

	// State is the state at which the data is obtained.
	// It can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized".
	State string
	// Indices is a list of validator indices to restrict the returned values.
	// If no indices are supplied then no filter will be applied.
	Indices []phase0.ValidatorIndex
	// PubKeys is a list of validator public keys to restrict the returned values.
	// If no public keys are supplied then no filter will be applied.
	PubKeys []phase0.BLSPubKey
	// ValidatorStates is a list of validator states to restrict the returned values.
	// If no validator states are supplied then no filter will be applied.
	ValidatorStates []apiv1.ValidatorState
}

ValidatorsOpts are the options for obtaining validators.

type VersionedBlindedBeaconBlock

VersionedBlindedBeaconBlock contains a versioned blinded beacon block.

func (*VersionedBlindedBeaconBlock) Attestations

Attestations returns the attestations of the blinded beacon block.

func (*VersionedBlindedBeaconBlock) BodyRoot

func (v *VersionedBlindedBeaconBlock) BodyRoot() (phase0.Root, error)

BodyRoot returns the body root of the blinded beacon block.

func (*VersionedBlindedBeaconBlock) FeeRecipient

FeeRecipient returns the fee recipient of the blinded beacon block.

func (*VersionedBlindedBeaconBlock) Graffiti

func (v *VersionedBlindedBeaconBlock) Graffiti() ([32]byte, error)

Graffiti returns the graffiti of the blinded beacon block.

func (*VersionedBlindedBeaconBlock) HashTreeRoot

func (t *VersionedBlindedBeaconBlock) HashTreeRoot() (root [32]byte, err error)

HashTreeRoot computes the SSZ hash tree root of the *VersionedBlindedBeaconBlock.

func (*VersionedBlindedBeaconBlock) HashTreeRootWith

func (t *VersionedBlindedBeaconBlock) HashTreeRootWith(hh sszutils.HashWalker) error

HashTreeRootWith computes the SSZ hash tree root of the *VersionedBlindedBeaconBlock using the given hash walker.

func (*VersionedBlindedBeaconBlock) IsEmpty

func (v *VersionedBlindedBeaconBlock) IsEmpty() bool

IsEmpty returns true if there is no block.

func (*VersionedBlindedBeaconBlock) MarshalSSZ

func (t *VersionedBlindedBeaconBlock) MarshalSSZ() ([]byte, error)

MarshalSSZ marshals the *VersionedBlindedBeaconBlock to SSZ-encoded bytes.

func (*VersionedBlindedBeaconBlock) MarshalSSZTo

func (t *VersionedBlindedBeaconBlock) MarshalSSZTo(buf []byte) (dst []byte, err error)

MarshalSSZTo marshals the *VersionedBlindedBeaconBlock to SSZ-encoded bytes, appending to the provided buffer.

func (*VersionedBlindedBeaconBlock) ParentRoot

func (v *VersionedBlindedBeaconBlock) ParentRoot() (phase0.Root, error)

ParentRoot returns the parent root of the blinded beacon block.

func (*VersionedBlindedBeaconBlock) ProposerIndex

ProposerIndex returns the proposer index of the beacon block.

func (*VersionedBlindedBeaconBlock) RandaoReveal

RandaoReveal returns the RANDAO reveal of the blinded beacon block.

func (*VersionedBlindedBeaconBlock) Root

Root returns the root of the blinded beacon block.

func (*VersionedBlindedBeaconBlock) SizeSSZ

func (t *VersionedBlindedBeaconBlock) SizeSSZ() (size int)

SizeSSZ returns the SSZ encoded size of the *VersionedBlindedBeaconBlock.

func (*VersionedBlindedBeaconBlock) Slot

Slot returns the slot of the blinded beacon block.

func (*VersionedBlindedBeaconBlock) StateRoot

func (v *VersionedBlindedBeaconBlock) StateRoot() (phase0.Root, error)

StateRoot returns the state root of the blinded beacon block.

func (*VersionedBlindedBeaconBlock) String

func (v *VersionedBlindedBeaconBlock) String() string

String returns a string version of the structure.

func (*VersionedBlindedBeaconBlock) Timestamp

func (v *VersionedBlindedBeaconBlock) Timestamp() (uint64, error)

Timestamp returns the timestamp of the blinded beacon block.

func (*VersionedBlindedBeaconBlock) TransactionsRoot

func (v *VersionedBlindedBeaconBlock) TransactionsRoot() (phase0.Root, error)

TransactionsRoot returns the transactions root of the blinded beacon block.

func (*VersionedBlindedBeaconBlock) UnmarshalSSZ

func (t *VersionedBlindedBeaconBlock) UnmarshalSSZ(buf []byte) (err error)

UnmarshalSSZ unmarshals the *VersionedBlindedBeaconBlock from SSZ-encoded bytes.

type VersionedBlindedProposal

VersionedBlindedProposal contains a versioned blinded proposal.

Gloas and later hard forks do not have blinded proposals: EIP-7732 delivers the execution payload as a standalone ExecutionPayloadEnvelope, so the beacon block itself never carries a payload header that could be blinded.

func (*VersionedBlindedProposal) Attestations

Attestations returns the attestations of the blinded proposal.

func (*VersionedBlindedProposal) BodyRoot

func (v *VersionedBlindedProposal) BodyRoot() (phase0.Root, error)

BodyRoot returns the body root of the blinded proposal.

func (*VersionedBlindedProposal) FeeRecipient

FeeRecipient returns the fee recipient of the blinded proposal.

func (*VersionedBlindedProposal) Graffiti

func (v *VersionedBlindedProposal) Graffiti() ([32]byte, error)

Graffiti returns the graffiti of the blinded proposal.

func (*VersionedBlindedProposal) IsEmpty

func (v *VersionedBlindedProposal) IsEmpty() bool

IsEmpty returns true if there is no proposal.

func (*VersionedBlindedProposal) ParentRoot

func (v *VersionedBlindedProposal) ParentRoot() (phase0.Root, error)

ParentRoot returns the parent root of the blinded proposal.

func (*VersionedBlindedProposal) ProposerIndex

func (v *VersionedBlindedProposal) ProposerIndex() (phase0.ValidatorIndex, error)

ProposerIndex returns the proposer index of the blinded proposal.

func (*VersionedBlindedProposal) RandaoReveal

func (v *VersionedBlindedProposal) RandaoReveal() (phase0.BLSSignature, error)

RandaoReveal returns the RANDAO reveal of the blinded proposal.

func (*VersionedBlindedProposal) Root

Root returns the root of the blinded proposal.

func (*VersionedBlindedProposal) Slot

Slot returns the slot of the blinded proposal.

func (*VersionedBlindedProposal) StateRoot

func (v *VersionedBlindedProposal) StateRoot() (phase0.Root, error)

StateRoot returns the state root of the blinded proposal.

func (*VersionedBlindedProposal) String

func (v *VersionedBlindedProposal) String() string

String returns a string version of the structure.

func (*VersionedBlindedProposal) Timestamp

func (v *VersionedBlindedProposal) Timestamp() (uint64, error)

Timestamp returns the timestamp of the blinded proposal.

func (*VersionedBlindedProposal) TransactionsRoot

func (v *VersionedBlindedProposal) TransactionsRoot() (phase0.Root, error)

TransactionsRoot returns the transactions root of the blinded proposal.

type VersionedBlockRequest

type VersionedBlockRequest struct {
	Version   spec.DataVersion
	Bellatrix *bellatrix.SignedBeaconBlock
	Capella   *capella.SignedBeaconBlock
	Deneb     *deneb.SignedBeaconBlock
	Electra   *electra.SignedBeaconBlock
	Fulu      *electra.SignedBeaconBlock
}

VersionedBlockRequest contains a versioned signed beacon block request.

func (*VersionedBlockRequest) Attestations

func (v *VersionedBlockRequest) Attestations() ([]spec.VersionedAttestation, error)

Attestations returns the attestations of the beacon block.

func (*VersionedBlockRequest) AttesterSlashings

func (v *VersionedBlockRequest) AttesterSlashings() ([]spec.VersionedAttesterSlashing, error)

AttesterSlashings returns the attester slashings of the beacon block.

func (*VersionedBlockRequest) BodyRoot

func (v *VersionedBlockRequest) BodyRoot() (phase0.Root, error)

BodyRoot returns the body root of the beacon block.

func (*VersionedBlockRequest) ExecutionBlockHash

func (v *VersionedBlockRequest) ExecutionBlockHash() (phase0.Hash32, error)

ExecutionBlockHash returns the block hash of the beacon block.

func (*VersionedBlockRequest) ParentRoot

func (v *VersionedBlockRequest) ParentRoot() (phase0.Root, error)

ParentRoot returns the parent root of the beacon block.

func (*VersionedBlockRequest) ProposerSlashings

func (v *VersionedBlockRequest) ProposerSlashings() ([]*phase0.ProposerSlashing, error)

ProposerSlashings returns the proposer slashings of the beacon block.

func (*VersionedBlockRequest) Root

func (v *VersionedBlockRequest) Root() (phase0.Root, error)

Root returns the root of the beacon block.

func (*VersionedBlockRequest) Slot

func (v *VersionedBlockRequest) Slot() (phase0.Slot, error)

Slot returns the slot of the signed beacon block.

func (*VersionedBlockRequest) StateRoot

func (v *VersionedBlockRequest) StateRoot() (phase0.Root, error)

StateRoot returns the state root of the beacon block.

func (*VersionedBlockRequest) String

func (v *VersionedBlockRequest) String() string

String returns a string version of the structure.

func (*VersionedBlockRequest) SyncAggregate

func (v *VersionedBlockRequest) SyncAggregate() (*altair.SyncAggregate, error)

SyncAggregate returns the sync aggregate of the beacon block.

type VersionedProposal

type VersionedProposal struct {
	Version          spec.DataVersion
	Blinded          bool
	ConsensusValue   *big.Int
	ExecutionValue   *big.Int
	Phase0           *phase0.BeaconBlock
	Altair           *altair.BeaconBlock
	Bellatrix        *bellatrix.BeaconBlock
	BellatrixBlinded *apiv1bellatrix.BlindedBeaconBlock
	Capella          *capella.BeaconBlock
	CapellaBlinded   *apiv1capella.BlindedBeaconBlock
	Deneb            *apiv1deneb.BlockContents
	DenebBlinded     *apiv1deneb.BlindedBeaconBlock
	Electra          *apiv1electra.BlockContents
	ElectraBlinded   *apiv1electra.BlindedBeaconBlock
	Fulu             *apiv1fulu.BlockContents
	FuluBlinded      *apiv1electra.BlindedBeaconBlock
	Gloas            *gloas.BeaconBlock
	Heze             *heze.BeaconBlock
}

VersionedProposal contains a versioned proposal.

Gloas and Heze proposals do not have blinded variants: EIP-7732 separates the execution payload into a standalone ExecutionPayloadEnvelope delivered by the builder, so the beacon block itself carries only a SignedExecutionPayloadBid. The Blinded flag is therefore ignored for those versions.

func (*VersionedProposal) Attestations

func (v *VersionedProposal) Attestations() ([]spec.VersionedAttestation, error)

Attestations returns the attestations of the proposal.

func (*VersionedProposal) Blobs

func (v *VersionedProposal) Blobs() ([]deneb.Blob, error)

Blobs returns the blobs of the proposal.

func (*VersionedProposal) BodyRoot

func (v *VersionedProposal) BodyRoot() (phase0.Root, error)

BodyRoot returns the body root of the proposal.

func (*VersionedProposal) FeeRecipient

func (v *VersionedProposal) FeeRecipient() (bellatrix.ExecutionAddress, error)

FeeRecipient returns the fee recipient of the proposal.

func (*VersionedProposal) GasLimit

func (v *VersionedProposal) GasLimit() (uint64, error)

GasLimit returns the gas limit of the proposal.

func (*VersionedProposal) Graffiti

func (v *VersionedProposal) Graffiti() ([32]byte, error)

Graffiti returns the graffiti of the proposal.

func (*VersionedProposal) IsEmpty

func (v *VersionedProposal) IsEmpty() bool

IsEmpty returns true if there is no proposal.

func (*VersionedProposal) KZGProofs

func (v *VersionedProposal) KZGProofs() ([]deneb.KZGProof, error)

KZGProofs returns the KZG proofs of the proposal.

func (*VersionedProposal) ParentRoot

func (v *VersionedProposal) ParentRoot() (phase0.Root, error)

ParentRoot returns the parent root of the proposal.

func (*VersionedProposal) ProposerIndex

func (v *VersionedProposal) ProposerIndex() (phase0.ValidatorIndex, error)

ProposerIndex returns the proposer index of the proposal.

func (*VersionedProposal) RandaoReveal

func (v *VersionedProposal) RandaoReveal() (phase0.BLSSignature, error)

RandaoReveal returns the RANDAO reveal of the proposal.

func (*VersionedProposal) Root

func (v *VersionedProposal) Root() (phase0.Root, error)

Root returns the root of the proposal.

func (*VersionedProposal) Slot

func (v *VersionedProposal) Slot() (phase0.Slot, error)

Slot returns the slot of the proposal.

func (*VersionedProposal) StateRoot

func (v *VersionedProposal) StateRoot() (phase0.Root, error)

StateRoot returns the state root of the proposal.

func (*VersionedProposal) String

func (v *VersionedProposal) String() string

String returns a string version of the structure.

func (*VersionedProposal) Timestamp

func (v *VersionedProposal) Timestamp() (uint64, error)

Timestamp returns the timestamp of the proposal.

func (*VersionedProposal) Transactions

func (v *VersionedProposal) Transactions() ([]bellatrix.Transaction, error)

Transactions returns the transactions of the proposal.

func (*VersionedProposal) Value

func (v *VersionedProposal) Value() *big.Int

Value returns the value of the proposal, in Wei.

type VersionedSignedBlindedBeaconBlock

VersionedSignedBlindedBeaconBlock contains a versioned signed blinded beacon block.

Gloas and later hard forks do not have blinded beacon blocks: EIP-7732 delivers the execution payload as a standalone ExecutionPayloadEnvelope, so the block itself never carries a payload header that could be blinded.

func (*VersionedSignedBlindedBeaconBlock) Attestations

Attestations returns the attestations of the signed blinded beacon block.

func (*VersionedSignedBlindedBeaconBlock) AttesterSlashings

AttesterSlashings returns the attester slashings of the beacon block.

func (*VersionedSignedBlindedBeaconBlock) BlobKZGCommitments

func (v *VersionedSignedBlindedBeaconBlock) BlobKZGCommitments() ([]deneb.KZGCommitment, error)

BlobKZGCommitments returns the blob KZG commitments of the beacon block.

func (*VersionedSignedBlindedBeaconBlock) BodyRoot

BodyRoot returns the body root of the beacon block.

func (*VersionedSignedBlindedBeaconBlock) ExecutionBlockHash

func (v *VersionedSignedBlindedBeaconBlock) ExecutionBlockHash() (phase0.Hash32, error)

ExecutionBlockHash returns the hash of the beacon block.

func (*VersionedSignedBlindedBeaconBlock) ExecutionBlockNumber

func (v *VersionedSignedBlindedBeaconBlock) ExecutionBlockNumber() (uint64, error)

ExecutionBlockNumber returns the block number of the beacon block.

func (*VersionedSignedBlindedBeaconBlock) ExecutionParentHash

func (v *VersionedSignedBlindedBeaconBlock) ExecutionParentHash() (phase0.Hash32, error)

ExecutionParentHash returns the parent hash of the beacon block.

func (*VersionedSignedBlindedBeaconBlock) HashTreeRoot

func (t *VersionedSignedBlindedBeaconBlock) HashTreeRoot() (root [32]byte, err error)

HashTreeRoot computes the SSZ hash tree root of the *VersionedSignedBlindedBeaconBlock.

func (*VersionedSignedBlindedBeaconBlock) HashTreeRootWith

HashTreeRootWith computes the SSZ hash tree root of the *VersionedSignedBlindedBeaconBlock using the given hash walker.

func (*VersionedSignedBlindedBeaconBlock) MarshalSSZ

func (t *VersionedSignedBlindedBeaconBlock) MarshalSSZ() ([]byte, error)

MarshalSSZ marshals the *VersionedSignedBlindedBeaconBlock to SSZ-encoded bytes.

func (*VersionedSignedBlindedBeaconBlock) MarshalSSZTo

func (t *VersionedSignedBlindedBeaconBlock) MarshalSSZTo(buf []byte) (dst []byte, err error)

MarshalSSZTo marshals the *VersionedSignedBlindedBeaconBlock to SSZ-encoded bytes, appending to the provided buffer.

func (*VersionedSignedBlindedBeaconBlock) ParentRoot

ParentRoot returns the parent root of the beacon block.

func (*VersionedSignedBlindedBeaconBlock) ProposerIndex

ProposerIndex returns the proposer index of the beacon block.

func (*VersionedSignedBlindedBeaconBlock) ProposerSlashings

func (v *VersionedSignedBlindedBeaconBlock) ProposerSlashings() ([]*phase0.ProposerSlashing, error)

ProposerSlashings returns the proposer slashings of the beacon block.

func (*VersionedSignedBlindedBeaconBlock) Root

Root returns the root of the beacon block.

func (*VersionedSignedBlindedBeaconBlock) Signature

Signature returns the signature of the beacon block.

func (*VersionedSignedBlindedBeaconBlock) SizeSSZ

func (t *VersionedSignedBlindedBeaconBlock) SizeSSZ() (size int)

SizeSSZ returns the SSZ encoded size of the *VersionedSignedBlindedBeaconBlock.

func (*VersionedSignedBlindedBeaconBlock) Slot

Slot returns the slot of the signed beacon block.

func (*VersionedSignedBlindedBeaconBlock) StateRoot

StateRoot returns the state root of the beacon block.

func (*VersionedSignedBlindedBeaconBlock) UnmarshalSSZ

func (t *VersionedSignedBlindedBeaconBlock) UnmarshalSSZ(buf []byte) (err error)

UnmarshalSSZ unmarshals the *VersionedSignedBlindedBeaconBlock from SSZ-encoded bytes.

type VersionedSignedBlindedProposal

VersionedSignedBlindedProposal contains a versioned signed blinded proposal.

Gloas and later hard forks do not have blinded proposals: EIP-7732 delivers the execution payload as a standalone ExecutionPayloadEnvelope, so the beacon block itself never carries a payload header that could be blinded.

func (*VersionedSignedBlindedProposal) Attestations

Attestations returns the attestations of the signed blinded proposal.

func (*VersionedSignedBlindedProposal) AttesterSlashings

AttesterSlashings returns the attester slashings of the blinded proposal.

func (*VersionedSignedBlindedProposal) BodyRoot

BodyRoot returns the body root of the blinded proposal.

func (*VersionedSignedBlindedProposal) ExecutionBlockHash

func (v *VersionedSignedBlindedProposal) ExecutionBlockHash() (phase0.Hash32, error)

ExecutionBlockHash returns the hash of the blinded proposal.

func (*VersionedSignedBlindedProposal) ExecutionBlockNumber

func (v *VersionedSignedBlindedProposal) ExecutionBlockNumber() (uint64, error)

ExecutionBlockNumber returns the block number of the blinded proposal.

func (*VersionedSignedBlindedProposal) ParentRoot

func (v *VersionedSignedBlindedProposal) ParentRoot() (phase0.Root, error)

ParentRoot returns the parent root of the blinded proposal.

func (*VersionedSignedBlindedProposal) ProposerIndex

ProposerIndex returns the proposer index of the blinded proposal.

func (*VersionedSignedBlindedProposal) ProposerSlashings

func (v *VersionedSignedBlindedProposal) ProposerSlashings() ([]*phase0.ProposerSlashing, error)

ProposerSlashings returns the proposer slashings of the blinded proposal.

func (*VersionedSignedBlindedProposal) Root

Root returns the root of the blinded proposal.

func (*VersionedSignedBlindedProposal) Signature

Signature returns the signature of the blinded proposal.

func (*VersionedSignedBlindedProposal) Slot

Slot returns the slot of the signed blinded proposal.

func (*VersionedSignedBlindedProposal) StateRoot

func (v *VersionedSignedBlindedProposal) StateRoot() (phase0.Root, error)

StateRoot returns the state root of the blinded proposal.

type VersionedSignedProposal

VersionedSignedProposal contains a versioned signed beacon node proposal.

Gloas and Heze proposals do not have blinded variants: EIP-7732 separates the execution payload into a standalone ExecutionPayloadEnvelope delivered by the builder, so the beacon block itself carries only a SignedExecutionPayloadBid. The Blinded flag is therefore ignored for those versions.

func (*VersionedSignedProposal) AssertPresent

func (v *VersionedSignedProposal) AssertPresent() error

AssertPresent throws an error if the expected proposal given the version and blinded fields is not present.

func (*VersionedSignedProposal) ExecutionBlockHash

func (v *VersionedSignedProposal) ExecutionBlockHash() (phase0.Hash32, error)

ExecutionBlockHash returns the hash of the execution payload.

func (*VersionedSignedProposal) ProposerIndex

func (v *VersionedSignedProposal) ProposerIndex() (phase0.ValidatorIndex, error)

ProposerIndex returns the proposer index of the signed proposal.

func (*VersionedSignedProposal) Slot

Slot returns the slot of the signed proposal.

func (*VersionedSignedProposal) String

func (v *VersionedSignedProposal) String() string

String returns a string version of the structure.

type VersionedSignedValidatorRegistration

type VersionedSignedValidatorRegistration struct {
	Version spec.BuilderVersion                `json:"version"`
	V1      *apiv1.SignedValidatorRegistration `json:"v1"`
}

VersionedSignedValidatorRegistration contains a versioned SignedValidatorRegistrationV1.

func (*VersionedSignedValidatorRegistration) FeeRecipient

FeeRecipient returns the fee recipient of the signed validator registration.

func (*VersionedSignedValidatorRegistration) GasLimit

GasLimit returns the gas limit of the signed validator registration.

func (*VersionedSignedValidatorRegistration) HashTreeRoot

func (t *VersionedSignedValidatorRegistration) HashTreeRoot() (root [32]byte, err error)

HashTreeRoot computes the SSZ hash tree root of the *VersionedSignedValidatorRegistration.

func (*VersionedSignedValidatorRegistration) HashTreeRootWith

HashTreeRootWith computes the SSZ hash tree root of the *VersionedSignedValidatorRegistration using the given hash walker.

func (*VersionedSignedValidatorRegistration) MarshalSSZ

func (t *VersionedSignedValidatorRegistration) MarshalSSZ() ([]byte, error)

MarshalSSZ marshals the *VersionedSignedValidatorRegistration to SSZ-encoded bytes.

func (*VersionedSignedValidatorRegistration) MarshalSSZTo

func (t *VersionedSignedValidatorRegistration) MarshalSSZTo(buf []byte) (dst []byte, err error)

MarshalSSZTo marshals the *VersionedSignedValidatorRegistration to SSZ-encoded bytes, appending to the provided buffer.

func (*VersionedSignedValidatorRegistration) PubKey

PubKey returns the public key of the signed validator registration.

func (*VersionedSignedValidatorRegistration) Root

Root returns the root of the validator registration.

func (*VersionedSignedValidatorRegistration) SizeSSZ

func (t *VersionedSignedValidatorRegistration) SizeSSZ() (size int)

SizeSSZ returns the SSZ encoded size of the *VersionedSignedValidatorRegistration.

func (*VersionedSignedValidatorRegistration) Timestamp

Timestamp returns the timestamp of the signed validator registration.

func (*VersionedSignedValidatorRegistration) UnmarshalSSZ

func (t *VersionedSignedValidatorRegistration) UnmarshalSSZ(buf []byte) (err error)

UnmarshalSSZ unmarshals the *VersionedSignedValidatorRegistration from SSZ-encoded bytes.

type VersionedValidatorRegistration

type VersionedValidatorRegistration struct {
	Version spec.BuilderVersion
	V1      *apiv1.ValidatorRegistration
}

VersionedValidatorRegistration contains a versioned ValidatorRegistrationV1.

func (*VersionedValidatorRegistration) FeeRecipient

FeeRecipient returns the fee recipient of the validator registration.

func (*VersionedValidatorRegistration) GasLimit

func (v *VersionedValidatorRegistration) GasLimit() (uint64, error)

GasLimit returns the gas limit of the validator registration.

func (*VersionedValidatorRegistration) IsEmpty

func (v *VersionedValidatorRegistration) IsEmpty() bool

IsEmpty returns true if there is no block.

func (*VersionedValidatorRegistration) PubKey

PubKey returns the public key of the validator registration.

func (*VersionedValidatorRegistration) Root

Root returns the root of the validator registration.

func (*VersionedValidatorRegistration) Timestamp

func (v *VersionedValidatorRegistration) Timestamp() (time.Time, error)

Timestamp returns the timestamp of the validator registration.

type VoluntaryExitEventHandlerFunc

type VoluntaryExitEventHandlerFunc func(context.Context, *phase0.SignedVoluntaryExit)

VoluntaryExitEventHandlerFunc is the handler for voluntary_exit events.

type VoluntaryExitPoolOpts

type VoluntaryExitPoolOpts struct {
	Common CommonOpts
}

VoluntaryExitPoolOpts are the options for obtaining the voluntary exit pool.

Directories

Path Synopsis
Package metadata contains keys for well-known metadata fields provided in an API response.
Package metadata contains keys for well-known metadata fields provided in an API response.
v1
Code generated by dynamic-ssz.
Code generated by dynamic-ssz.
bellatrix
Code generated by dynamic-ssz.
Code generated by dynamic-ssz.
capella
Code generated by dynamic-ssz.
Code generated by dynamic-ssz.
deneb
Code generated by dynamic-ssz.
Code generated by dynamic-ssz.
electra
Code generated by dynamic-ssz.
Code generated by dynamic-ssz.
fulu
Code generated by dynamic-ssz.
Code generated by dynamic-ssz.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL