api

package
v0.7.2 Latest Latest
Warning

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

 Go to latest Published: Sep 29, 2025 License: Apache-2.0 Imports: 15 Imported by: 25

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BuilderBidOpts added in v0.5.0 

type BuilderBidOpts struct {
	Common CommonOpts

	// Slot is the slot for which to obtain a builder bid.
	Slot phase0.Slot
	// ParentHash is the hash of the parent execution payload.
	ParentHash phase0.Hash32
	// PubKey is the public key of the ?
	PubKey phase0.BLSPubKey
}

BuilderBidOpts are the options for obtaining builder bids.

type CommonOpts added in v0.5.0 

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 Error added in v0.5.0 

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

Error represents an API error.

func (Error) Error added in v0.5.0 

func (e Error) Error() string

type Response added in v0.5.0 

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

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

type SubmitValidatorRegistrationsOpts added in v0.5.0 

type SubmitValidatorRegistrationsOpts struct {
	Common CommonOpts

	// Registrations are the validator registrations.
	Registrations []*VersionedSignedValidatorRegistration
}

SubmitValidatorRegistrationsOpts are the options for submitting validator registrations.

type UnblindProposalOpts added in v0.5.0 

type UnblindProposalOpts struct {
	Common CommonOpts

	// Proposal is the porposal to unblind.
	Proposal *consensusapi.VersionedSignedBlindedProposal
}

UnblindProposalOpts are the options for unblinding proposals.

type VersionedBlobsBundle added in v0.7.0 

type VersionedBlobsBundle struct {
	Version consensusspec.DataVersion
	Deneb   *deneb.BlobsBundle
	Electra *deneb.BlobsBundle
	Fulu    *fulu.BlobsBundle
}

VersionedBlobsBundle contains a versioned BlobsBundle.

func (*VersionedBlobsBundle) Blobs added in v0.7.0 

func (v *VersionedBlobsBundle) Blobs() ([]consensusdeneb.Blob, error)

func (*VersionedBlobsBundle) Commitments added in v0.7.0 

func (v *VersionedBlobsBundle) Commitments() ([]consensusdeneb.KZGCommitment, error)

func (*VersionedBlobsBundle) Proofs added in v0.7.0 

func (v *VersionedBlobsBundle) Proofs() ([]consensusdeneb.KZGProof, error)

type VersionedExecutionPayload 

type VersionedExecutionPayload struct {
	Version   consensusspec.DataVersion
	Bellatrix *bellatrix.ExecutionPayload
	Capella   *capella.ExecutionPayload
	Deneb     *deneb.ExecutionPayload
	Electra   *deneb.ExecutionPayload
	Fulu      *deneb.ExecutionPayload
}

VersionedExecutionPayload contains a versioned ExecutionPayloadV1.

func (*VersionedExecutionPayload) BlockHash added in v0.3.1 

func (v *VersionedExecutionPayload) BlockHash() (phase0.Hash32, error)

func (*VersionedExecutionPayload) IsEmpty 

func (v *VersionedExecutionPayload) IsEmpty() bool

IsEmpty returns true if there is no payload.

func (*VersionedExecutionPayload) MarshalJSON added in v0.2.6 

func (v *VersionedExecutionPayload) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (*VersionedExecutionPayload) Transactions added in v0.4.0 

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

Transactions returns the transactions in the execution payload.

func (*VersionedExecutionPayload) UnmarshalJSON added in v0.2.2 

func (v *VersionedExecutionPayload) UnmarshalJSON(input []byte) error

UnmarshalJSON implements json.Unmarshaler.

type VersionedExecutionPayloadHeader 

type VersionedExecutionPayloadHeader struct {
	Version   consensusspec.DataVersion         `json:"version"`
	Bellatrix *bellatrix.ExecutionPayloadHeader `json:"bellatrix,omitempty"`
	Capella   *capella.ExecutionPayloadHeader   `json:"capella,omitempty"`
	Deneb     *deneb.ExecutionPayloadHeader     `json:"deneb,omitempty"`
	Electra   *deneb.ExecutionPayloadHeader     `json:"electra,omitempty"`
	Fulu      *deneb.ExecutionPayloadHeader     `json:"fulu,omitempty"`
}

VersionedExecutionPayloadHeader contains a versioned ExecutionPayloadHeaderV1.

func (*VersionedExecutionPayloadHeader) IsEmpty 

func (v *VersionedExecutionPayloadHeader) IsEmpty() bool

IsEmpty returns true if there is no payload.

type VersionedSignedValidatorRegistration 

type VersionedSignedValidatorRegistration struct {
	Version spec.BuilderVersion
	V1      *apiv1.SignedValidatorRegistration
}

VersionedSignedValidatorRegistration contains a versioned SignedValidatorRegistrationV1.

func (*VersionedSignedValidatorRegistration) FeeRecipient 

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

FeeRecipient returns the fee recipient of the signed validator registration.

func (*VersionedSignedValidatorRegistration) GasLimit 

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

GasLimit returns the gas limit of the signed validator registration.

func (*VersionedSignedValidatorRegistration) PubKey 

func (v *VersionedSignedValidatorRegistration) PubKey() (phase0.BLSPubKey, error)

PubKey returns the public key of the signed validator registration.

func (*VersionedSignedValidatorRegistration) Timestamp 

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

Timestamp returns the timestamp of the signed validator registration.

type VersionedSubmitBlindedBlockResponse added in v0.4.0 

type VersionedSubmitBlindedBlockResponse struct {
	Version   consensusspec.DataVersion
	Bellatrix *bellatrix.ExecutionPayload
	Capella   *capella.ExecutionPayload
	Deneb     *deneb.ExecutionPayloadAndBlobsBundle
	Electra   *deneb.ExecutionPayloadAndBlobsBundle
	Fulu      *fulu.ExecutionPayloadAndBlobsBundle
}

VersionedSubmitBlindedBlockResponse contains a versioned SubmitBlindedBlockResponse.

func (*VersionedSubmitBlindedBlockResponse) BlobGasUsed added in v0.6.0 

func (v *VersionedSubmitBlindedBlockResponse) BlobGasUsed() (uint64, error)

BlobGasUsed returns the blob gas used of the payload.

func (*VersionedSubmitBlindedBlockResponse) Blobs added in v0.6.0 

func (v *VersionedSubmitBlindedBlockResponse) Blobs() ([]consensusdeneb.Blob, error)

Blobs returns the blobs of the blobs bundle.

func (*VersionedSubmitBlindedBlockResponse) BlobsBundle added in v0.6.1 

func (v *VersionedSubmitBlindedBlockResponse) BlobsBundle() (*VersionedBlobsBundle, error)

BlobsBundle returns the blobs bundle.

func (*VersionedSubmitBlindedBlockResponse) BlockHash added in v0.4.0 

func (v *VersionedSubmitBlindedBlockResponse) BlockHash() (phase0.Hash32, error)

func (*VersionedSubmitBlindedBlockResponse) ExcessBlobGas added in v0.6.0 

func (v *VersionedSubmitBlindedBlockResponse) ExcessBlobGas() (uint64, error)

ExcessBlobGas returns the excess blob gas of the payload.

func (*VersionedSubmitBlindedBlockResponse) IsEmpty added in v0.4.0 

func (v *VersionedSubmitBlindedBlockResponse) IsEmpty() bool

IsEmpty returns true if there is no payload.

func (*VersionedSubmitBlindedBlockResponse) MarshalJSON added in v0.4.0 

func (v *VersionedSubmitBlindedBlockResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (*VersionedSubmitBlindedBlockResponse) Transactions added in v0.4.0 

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

Transactions returns the transactions in the execution payload.

func (*VersionedSubmitBlindedBlockResponse) UnmarshalJSON added in v0.4.0 

func (v *VersionedSubmitBlindedBlockResponse) UnmarshalJSON(input []byte) error

UnmarshalJSON implements json.Unmarshaler.

type VersionedValidatorRegistration 

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

VersionedValidatorRegistration contains a versioned ValidatorRegistrationV1.

func (*VersionedValidatorRegistration) FeeRecipient 

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

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 

func (v *VersionedValidatorRegistration) PubKey() (phase0.BLSPubKey, error)

PubKey returns the public key of the validator registration.

func (*VersionedValidatorRegistration) Timestamp 

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

Timestamp returns the timestamp of the validator registration.

Source Files

View all Source files

Directories

Path Synopsis
Code generated by fastssz.
 Code generated by fastssz.
Code generated by fastssz.
 Code generated by fastssz.
Code generated by fastssz.
 Code generated by fastssz.
Code generated by fastssz.
 Code generated by fastssz.
Code generated by fastssz.
 Code generated by fastssz.
Code generated by fastssz.
 Code generated by fastssz.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.