beacon_api

Documentation

Index

• func JsonifySignedVoluntaryExits(voluntaryExits []*ethpb.SignedVoluntaryExit) []*shared.SignedVoluntaryExit
• func NewBeaconApiBeaconChainClientWithFallback(jsonRestHandler JsonRestHandler, fallbackClient iface.BeaconChainClient) iface.BeaconChainClient
• func NewBeaconApiValidatorClient(jsonRestHandler JsonRestHandler, opts ...ValidatorClientOpt) iface.ValidatorClient
• func NewNodeClientWithFallback(jsonRestHandler JsonRestHandler, fallbackClient iface.NodeClient) iface.NodeClient
• func NewPrysmBeaconChainClient(jsonRestHandler JsonRestHandler, nodeClient iface.NodeClient) iface.PrysmBeaconChainClient
• type BeaconApiJsonRestHandler
  • func (c BeaconApiJsonRestHandler) Get(ctx context.Context, endpoint string, resp interface{}) error
  • func (c BeaconApiJsonRestHandler) Post(ctx context.Context, apiEndpoint string, headers map[string]string, ...) error
• type BeaconBlockConverter
• type DoppelGangerInfo
• type EventHandler
  • func NewEventHandler(httpClient *http.Client, host string) *EventHandler
• type GenesisProvider
• type IndexNotFoundError
  • func NewIndexNotFoundError(pubkey string) IndexNotFoundError
  • func (e *IndexNotFoundError) Error() string
• type JsonRestHandler
• type StateValidatorsProvider
• type ValidatorClientOpt
  • func WithEventHandler(h *EventHandler) ValidatorClientOpt

Functions

func JsonifySignedVoluntaryExits

func JsonifySignedVoluntaryExits(voluntaryExits []*ethpb.SignedVoluntaryExit) []*shared.SignedVoluntaryExit

JsonifySignedVoluntaryExits converts an array of voluntary exit structs to a JSON hex string compatible format.

func NewBeaconApiBeaconChainClientWithFallback

func NewBeaconApiBeaconChainClientWithFallback(jsonRestHandler JsonRestHandler, fallbackClient iface.BeaconChainClient) iface.BeaconChainClient

func NewBeaconApiValidatorClient

func NewBeaconApiValidatorClient(jsonRestHandler JsonRestHandler, opts ...ValidatorClientOpt) iface.ValidatorClient

func NewNodeClientWithFallback

func NewNodeClientWithFallback(jsonRestHandler JsonRestHandler, fallbackClient iface.NodeClient) iface.NodeClient

func NewPrysmBeaconChainClient

func NewPrysmBeaconChainClient(jsonRestHandler JsonRestHandler, nodeClient iface.NodeClient) iface.PrysmBeaconChainClient

NewPrysmBeaconChainClient returns implementation of iface.PrysmBeaconChainClient.

Types

type BeaconApiJsonRestHandler

type BeaconApiJsonRestHandler struct {
	HttpClient http.Client
	Host       string
}

func (BeaconApiJsonRestHandler) Get

func (c BeaconApiJsonRestHandler) Get(ctx context.Context, endpoint string, resp interface{}) error

Get sends a GET request and decodes the response body as a JSON object into the passed in object. If an HTTP error is returned, the body is decoded as a DefaultJsonError JSON object and returned as the first return value.

func (BeaconApiJsonRestHandler) Post

func (c BeaconApiJsonRestHandler) Post(
	ctx context.Context,
	apiEndpoint string,
	headers map[string]string,
	data *bytes.Buffer,
	resp interface{},
) error

Post sends a POST request and decodes the response body as a JSON object into the passed in object. If an HTTP error is returned, the body is decoded as a DefaultJsonError JSON object and returned as the first return value.

type BeaconBlockConverter

type BeaconBlockConverter interface {
	ConvertRESTPhase0BlockToProto(block *shared.BeaconBlock) (*ethpb.BeaconBlock, error)
	ConvertRESTAltairBlockToProto(block *shared.BeaconBlockAltair) (*ethpb.BeaconBlockAltair, error)
	ConvertRESTBellatrixBlockToProto(block *shared.BeaconBlockBellatrix) (*ethpb.BeaconBlockBellatrix, error)
	ConvertRESTCapellaBlockToProto(block *shared.BeaconBlockCapella) (*ethpb.BeaconBlockCapella, error)
}

type DoppelGangerInfo

type DoppelGangerInfo struct {
	// contains filtered or unexported fields
}

type EventHandler

type EventHandler struct {
	sync.Mutex
	// contains filtered or unexported fields
}

EventHandler is responsible for subscribing to the Beacon API events endpoint and dispatching received events to subscribers.

func NewEventHandler

func NewEventHandler(httpClient *http.Client, host string) *EventHandler

NewEventHandler returns a new handler.

type GenesisProvider

type GenesisProvider interface {
	GetGenesis(ctx context.Context) (*beacon.Genesis, error)
}

type IndexNotFoundError

type IndexNotFoundError struct {
	// contains filtered or unexported fields
}

IndexNotFoundError represents an error scenario where no validator index matches a pubkey.

func NewIndexNotFoundError

func NewIndexNotFoundError(pubkey string) IndexNotFoundError

NewIndexNotFoundError creates a new error instance.

func (*IndexNotFoundError) Error

func (e *IndexNotFoundError) Error() string

Error returns the underlying error message.

type JsonRestHandler

type JsonRestHandler interface {
	Get(ctx context.Context, endpoint string, resp interface{}) error
	Post(ctx context.Context, endpoint string, headers map[string]string, data *bytes.Buffer, resp interface{}) error
}

type StateValidatorsProvider

type StateValidatorsProvider interface {
	GetStateValidators(context.Context, []string, []primitives.ValidatorIndex, []string) (*beacon.GetValidatorsResponse, error)
	GetStateValidatorsForSlot(context.Context, primitives.Slot, []string, []primitives.ValidatorIndex, []string) (*beacon.GetValidatorsResponse, error)
	GetStateValidatorsForHead(context.Context, []string, []primitives.ValidatorIndex, []string) (*beacon.GetValidatorsResponse, error)
}

type ValidatorClientOpt

type ValidatorClientOpt func(*beaconApiValidatorClient)

func WithEventHandler

func WithEventHandler(h *EventHandler) ValidatorClientOpt