eth2wrap

Documentation

Overview

Package eth2wrap provides a wrapper for eth2http.Service adding prometheus metrics and error wrapping.

Index

• func NewHTTPAdapterForT(_ *testing.T, address string, timeout time.Duration) *httpAdapter
• type BlockAttestationsProvider
• type Client
  • func AdaptEth2HTTP(eth2Svc *eth2http.Service, timeout time.Duration) Client
  • func Instrument(clients ...Client) (Client, error)
  • func NewMultiHTTP(ctx context.Context, timeout time.Duration, addresses ...string) (Client, error)

Functions

func NewHTTPAdapterForT

func NewHTTPAdapterForT(_ *testing.T, address string, timeout time.Duration) *httpAdapter

NewHTTPAdapterForT returns a http adaptor for testing non-eth2service methods as it is nil.

Types

type BlockAttestationsProvider

type BlockAttestationsProvider interface {
	BlockAttestations(ctx context.Context, stateID string) ([]*eth2p0.Attestation, error)
}

BlockAttestationsProvider is the interface for providing attestations included in blocks. It is a standard beacon API endpoint not implemented by eth2client. See https://ethereum.github.io/beacon-APIs/#/Beacon/getBlockAttestations.

type Client

type Client interface {
	eth2client.Service
	eth2exp.BeaconCommitteeSelectionAggregator
	eth2exp.SyncCommitteeSelectionAggregator
	BlockAttestationsProvider

	eth2client.AggregateAttestationProvider
	eth2client.AggregateAttestationsSubmitter
	eth2client.AttestationDataProvider
	eth2client.AttestationsSubmitter
	eth2client.AttesterDutiesProvider
	eth2client.BeaconBlockProposalProvider
	eth2client.BeaconBlockRootProvider
	eth2client.BeaconBlockSubmitter
	eth2client.BeaconCommitteeSubscriptionsSubmitter
	eth2client.BlindedBeaconBlockProposalProvider
	eth2client.BlindedBeaconBlockSubmitter
	eth2client.DepositContractProvider
	eth2client.DomainProvider
	eth2client.EventsProvider
	eth2client.ForkProvider
	eth2client.ForkScheduleProvider
	eth2client.GenesisProvider
	eth2client.GenesisTimeProvider
	eth2client.NodeSyncingProvider
	eth2client.NodeVersionProvider
	eth2client.ProposalPreparationsSubmitter
	eth2client.ProposerDutiesProvider
	eth2client.SlotDurationProvider
	eth2client.SlotsPerEpochProvider
	eth2client.SpecProvider
	eth2client.SyncCommitteeContributionProvider
	eth2client.SyncCommitteeContributionsSubmitter
	eth2client.SyncCommitteeDutiesProvider
	eth2client.SyncCommitteeMessagesSubmitter
	eth2client.SyncCommitteeSubscriptionsSubmitter
	eth2client.ValidatorRegistrationsSubmitter
	eth2client.ValidatorsProvider
	eth2client.VoluntaryExitSubmitter
}

Client defines all go-eth2-client interfaces used in charon.

func AdaptEth2HTTP

func AdaptEth2HTTP(eth2Svc *eth2http.Service, timeout time.Duration) Client

AdaptEth2HTTP returns a Client wrapping an eth2http service by adding experimental endpoints. Note that the returned client doesn't wrap errors, so they are unstructured without stacktraces.

func Instrument

func Instrument(clients ...Client) (Client, error)

Instrument returns a new multi instrumented client using the provided clients as backends.

func NewMultiHTTP

func NewMultiHTTP(ctx context.Context, timeout time.Duration, addresses ...string) (Client, error)

NewMultiHTTP returns a new instrumented multi eth2 http client.