beacon_api

Documentation

Index

• func JsonifySignedVoluntaryExits(voluntaryExits []*ethpb.SignedVoluntaryExit) []*structs.SignedVoluntaryExit
• func NewBeaconApiChainClientWithFallback(jsonRestHandler JsonRestHandler, fallbackClient iface.ChainClient) iface.ChainClient
• func NewBeaconApiValidatorClient(jsonRestHandler JsonRestHandler, opts ...ValidatorClientOpt) iface.ValidatorClient
• func NewNodeClientWithFallback(jsonRestHandler JsonRestHandler, fallbackClient iface.NodeClient) iface.NodeClient
• func NewPrysmChainClient(jsonRestHandler JsonRestHandler, nodeClient iface.NodeClient) iface.PrysmChainClient
• type BeaconApiJsonRestHandler
  • func (c *BeaconApiJsonRestHandler) Get(ctx context.Context, endpoint string, resp interface{}) error
  • func (c *BeaconApiJsonRestHandler) Host() string
  • func (c *BeaconApiJsonRestHandler) HttpClient() *http.Client
  • func (c *BeaconApiJsonRestHandler) Post(ctx context.Context, apiEndpoint string, headers map[string]string, ...) error
  • func (c *BeaconApiJsonRestHandler) SetHost(host string)
• type BeaconBlockConverter
• type DoppelGangerInfo
• type GenesisProvider
• type IndexNotFoundError
  • func NewIndexNotFoundError(pubkey string) IndexNotFoundError
  • func (e *IndexNotFoundError) Error() string
• type JsonRestHandler
  • func NewBeaconApiJsonRestHandler(client http.Client, host string) JsonRestHandler
• type StateValidatorsProvider
• type ValidatorClientOpt

Functions

func JsonifySignedVoluntaryExits

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

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

func NewBeaconApiChainClientWithFallback

func NewBeaconApiChainClientWithFallback(jsonRestHandler JsonRestHandler, fallbackClient iface.ChainClient) iface.ChainClient

func NewBeaconApiValidatorClient

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

func NewNodeClientWithFallback

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

func NewPrysmChainClient

func NewPrysmChainClient(jsonRestHandler JsonRestHandler, nodeClient iface.NodeClient) iface.PrysmChainClient

NewPrysmChainClient returns implementation of iface.PrysmChainClient.

Types

type BeaconApiJsonRestHandler

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

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) Host

func (c *BeaconApiJsonRestHandler) Host() string

Host returns the underlying HTTP host

func (*BeaconApiJsonRestHandler) HttpClient

func (c *BeaconApiJsonRestHandler) HttpClient() *http.Client

HttpClient returns the underlying HTTP client of the handler

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.

func (*BeaconApiJsonRestHandler) SetHost

func (c *BeaconApiJsonRestHandler) SetHost(host string)

type BeaconBlockConverter

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

type DoppelGangerInfo

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

type GenesisProvider

type GenesisProvider interface {
	Genesis(ctx context.Context) (*structs.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
	HttpClient() *http.Client
	Host() string
	SetHost(host string)
}

func NewBeaconApiJsonRestHandler

func NewBeaconApiJsonRestHandler(client http.Client, host string) JsonRestHandler

NewBeaconApiJsonRestHandler returns a JsonRestHandler

type StateValidatorsProvider

type StateValidatorsProvider interface {
	StateValidators(context.Context, []string, []primitives.ValidatorIndex, []string) (*structs.GetValidatorsResponse, error)
	StateValidatorsForSlot(context.Context, primitives.Slot, []string, []primitives.ValidatorIndex, []string) (*structs.GetValidatorsResponse, error)
	StateValidatorsForHead(context.Context, []string, []primitives.ValidatorIndex, []string) (*structs.GetValidatorsResponse, error)
}

type ValidatorClientOpt

type ValidatorClientOpt func(*beaconApiValidatorClient)