Documentation
¶
Index ¶
- type Parameter
- type Service
- func (s *Service) Address() string
- func (s *Service) AggregateAndProofDomain(_ context.Context) (spec.DomainType, error)
- func (s *Service) AggregateAttestation(_ context.Context, _ spec.Slot, _ spec.Root) (*spec.Attestation, error)
- func (s *Service) AttestationData(_ context.Context, _ spec.Slot, _ spec.CommitteeIndex) (*spec.AttestationData, error)
- func (s *Service) AttestationPool(_ context.Context, _ spec.Slot) ([]*spec.Attestation, error)
- func (s *Service) AttesterDuties(_ context.Context, _ spec.Epoch, validatorIndices []spec.ValidatorIndex) ([]*api.AttesterDuty, error)
- func (s *Service) BeaconAttesterDomain(_ context.Context) (spec.DomainType, error)
- func (s *Service) BeaconBlockHeader(_ context.Context, _ string) (*api.BeaconBlockHeader, error)
- func (s *Service) BeaconBlockProposal(_ context.Context, slot phase0.Slot, randaoReveal phase0.BLSSignature, ...) (*spec.VersionedBeaconBlock, error)
- func (s *Service) BeaconBlockRoot(_ context.Context, _ string) (*phase0.Root, error)
- func (s *Service) BeaconCommittees(_ context.Context, _ string) ([]*api.BeaconCommittee, error)
- func (s *Service) BeaconCommitteesAtEpoch(_ context.Context, _ string, _ phase0.Epoch) ([]*api.BeaconCommittee, error)
- func (s *Service) BeaconProposerDomain(_ context.Context) (spec.DomainType, error)
- func (s *Service) BeaconState(_ context.Context, _ string) (*spec.VersionedBeaconState, error)
- func (s *Service) BeaconStateRoot(_ context.Context, _ string) (*spec.Root, error)
- func (s *Service) BlindedBeaconBlockProposal(_ context.Context, slot phase0.Slot, randaoReveal phase0.BLSSignature, ...) (*api.VersionedBlindedBeaconBlock, error)
- func (s *Service) DepositContract(_ context.Context) (*api.DepositContract, error)
- func (s *Service) DepositDomain(_ context.Context) (spec.DomainType, error)
- func (s *Service) Domain(ctx context.Context, domainType phase0.DomainType, epoch phase0.Epoch) (phase0.Domain, error)
- func (s *Service) Events(_ context.Context, _ []string, _ client.EventHandlerFunc) error
- func (s *Service) FarFutureEpoch(_ context.Context) (spec.Epoch, error)
- func (s *Service) Finality(_ context.Context, _ string) (*api.Finality, error)
- func (s *Service) Fork(ctx context.Context, _ string) (*spec.Fork, error)
- func (s *Service) ForkSchedule(_ context.Context) ([]*spec.Fork, error)
- func (s *Service) Genesis(_ context.Context) (*api.Genesis, error)
- func (s *Service) GenesisDomain(ctx context.Context, domainType phase0.DomainType) (phase0.Domain, error)
- func (s *Service) GenesisTime(ctx context.Context) (time.Time, error)
- func (s *Service) Name() string
- func (s *Service) NodeSyncing(_ context.Context) (*api.SyncState, error)
- func (s *Service) NodeVersion(_ context.Context) (string, error)
- func (s *Service) ProposerDuties(_ context.Context, _ spec.Epoch, validatorIndices []spec.ValidatorIndex) ([]*api.ProposerDuty, error)
- func (s *Service) RANDAODomain(_ context.Context) (spec.DomainType, error)
- func (s *Service) SelectionProofDomain(_ context.Context) (spec.DomainType, error)
- func (s *Service) SignedBeaconBlock(_ context.Context, _ string) (*spec.VersionedSignedBeaconBlock, error)
- func (s *Service) SlotDuration(_ context.Context) (time.Duration, error)
- func (s *Service) SlotsPerEpoch(_ context.Context) (uint64, error)
- func (s *Service) Spec(_ context.Context) (map[string]interface{}, error)
- func (s *Service) SubmitAggregateAttestations(_ context.Context, _ []*spec.SignedAggregateAndProof) error
- func (s *Service) SubmitAttestations(_ context.Context, _ []*spec.Attestation) error
- func (s *Service) SubmitBLSToExecutionChange(_ context.Context, _ *capella.SignedBLSToExecutionChange) error
- func (s *Service) SubmitBeaconBlock(_ context.Context, _ *spec.VersionedSignedBeaconBlock) error
- func (s *Service) SubmitBeaconCommitteeSubscriptions(_ context.Context, _ []*api.BeaconCommitteeSubscription) error
- func (s *Service) SubmitBlindedBeaconBlock(_ context.Context, _ *api.VersionedSignedBlindedBeaconBlock) error
- func (s *Service) SubmitProposalPreparations(_ context.Context, _ []*apiv1.ProposalPreparation) error
- func (s *Service) SubmitSyncCommitteeContributions(_ context.Context, _ []*altair.SignedContributionAndProof) error
- func (s *Service) SubmitSyncCommitteeMessages(_ context.Context, _ []*altair.SyncCommitteeMessage) error
- func (s *Service) SubmitSyncCommitteeSubscriptions(_ context.Context, _ []*api.SyncCommitteeSubscription) error
- func (s *Service) SubmitValidatorRegistrations(_ context.Context, _ []*api.VersionedSignedValidatorRegistration) error
- func (s *Service) SubmitVoluntaryExit(_ context.Context, _ *spec.SignedVoluntaryExit) error
- func (s *Service) SyncCommittee(_ context.Context, _ string) (*api.SyncCommittee, error)
- func (s *Service) SyncCommitteeAtEpoch(_ context.Context, _ string, _ phase0.Epoch) (*api.SyncCommittee, error)
- func (s *Service) SyncCommitteeContribution(_ context.Context, _ phase0.Slot, _ uint64, _ phase0.Root) (*altair.SyncCommitteeContribution, error)
- func (s *Service) SyncCommitteeDuties(_ context.Context, _ phase0.Epoch, validatorIndices []phase0.ValidatorIndex) ([]*api.SyncCommitteeDuty, error)
- func (s *Service) TargetAggregatorsPerCommittee(_ context.Context) (uint64, error)
- func (s *Service) ValidatorBalances(_ context.Context, _ string, _ []spec.ValidatorIndex) (map[spec.ValidatorIndex]spec.Gwei, error)
- func (s *Service) Validators(_ context.Context, _ string, _ []phase0.ValidatorIndex) (map[phase0.ValidatorIndex]*api.Validator, error)
- func (s *Service) ValidatorsByPubKey(_ context.Context, _ string, _ []phase0.BLSPubKey) (map[phase0.ValidatorIndex]*api.Validator, error)
- func (s *Service) VoluntaryExitDomain(_ context.Context) (spec.DomainType, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Parameter ¶
type Parameter interface {
// contains filtered or unexported methods
}
Parameter is the interface for service parameters.
func WithLogLevel ¶
WithLogLevel sets the log level for the module.
func WithTimeout ¶
WithTimeout sets the maximum duration for all requests to the endpoint.
type Service ¶
type Service struct { // Values that can be altered if required. HeadSlot phase0.Slot SyncDistance phase0.Slot // contains filtered or unexported fields }
Service is a mock Ethereum 2 client service, providing data locally.
func (*Service) AggregateAndProofDomain ¶
AggregateAndProofDomain provides the aggregate and proof domain.
func (*Service) AggregateAttestation ¶
func (s *Service) AggregateAttestation(_ context.Context, _ spec.Slot, _ spec.Root) (*spec.Attestation, error)
AggregateAttestation fetches the aggregate attestation given an attestation.
func (*Service) AttestationData ¶
func (s *Service) AttestationData(_ context.Context, _ spec.Slot, _ spec.CommitteeIndex) (*spec.AttestationData, error)
AttestationData fetches the attestation data for the given slot and committee index.
func (*Service) AttestationPool ¶
AttestationPool fetches the attestation pool for the given slot.
func (*Service) AttesterDuties ¶
func (s *Service) AttesterDuties(_ context.Context, _ spec.Epoch, validatorIndices []spec.ValidatorIndex) ([]*api.AttesterDuty, error)
AttesterDuties obtains attester duties. If validatorIndicess is nil it will return all duties for the given epoch.
func (*Service) BeaconAttesterDomain ¶
BeaconAttesterDomain provides the beacon attester domain.
func (*Service) BeaconBlockHeader ¶
BeaconBlockHeader provides the block header of a given block ID.
func (*Service) BeaconBlockProposal ¶
func (s *Service) BeaconBlockProposal(_ context.Context, slot phase0.Slot, randaoReveal phase0.BLSSignature, graffiti []byte) (*spec.VersionedBeaconBlock, error)
BeaconBlockProposal fetches a proposed beacon block for signing.
func (*Service) BeaconBlockRoot ¶
BeaconBlockRoot fetches a block's root given a block ID.
func (*Service) BeaconCommittees ¶
BeaconCommittees fetches all beacon committees for the epoch at the given state.
func (*Service) BeaconCommitteesAtEpoch ¶
func (s *Service) BeaconCommitteesAtEpoch(_ context.Context, _ string, _ phase0.Epoch) ([]*api.BeaconCommittee, error)
BeaconCommitteesAtEpoch fetches all beacon committees for the given epoch at the given state.
func (*Service) BeaconProposerDomain ¶
BeaconProposerDomain provides the beacon proposer domain.
func (*Service) BeaconState ¶
BeaconState fetches a beacon state given a state ID.
func (*Service) BeaconStateRoot ¶
BeaconStateRoot fetches a beacon state root given a state ID.
func (*Service) BlindedBeaconBlockProposal ¶
func (s *Service) BlindedBeaconBlockProposal(_ context.Context, slot phase0.Slot, randaoReveal phase0.BLSSignature, graffiti []byte) (*api.VersionedBlindedBeaconBlock, error)
BlindedBeaconBlockProposal fetches a blinded proposed beacon block for signing.
func (*Service) DepositContract ¶
DepositContract provides details of the Ethereum 1 deposit contract for the chain.
func (*Service) DepositDomain ¶
DepositDomain provides the deposit domain.
func (*Service) Domain ¶
func (s *Service) Domain(ctx context.Context, domainType phase0.DomainType, epoch phase0.Epoch) (phase0.Domain, error)
Domain provides a domain for a given domain type at a given epoch.
func (*Service) Events ¶
Events feeds requested events with the given topics to the supplied handler.
func (*Service) FarFutureEpoch ¶
FarFutureEpoch provides the values for FAR_FUTURE_EOPCH of the chain.
func (*Service) ForkSchedule ¶
ForkSchedule provides details of past and future changes in the chain's fork version.
func (*Service) GenesisDomain ¶
func (s *Service) GenesisDomain(ctx context.Context, domainType phase0.DomainType) (phase0.Domain, error)
GenesisDomain returns the domain for the given domain type at genesis. N.B. this is not always the same as the the domain at epoch 0. It is possible for a chain's fork schedule to have multiple forks at genesis. In this situation, GenesisDomain() will return the first, and Domain() will return the last.
func (*Service) GenesisTime ¶
GenesisTime provides the genesis time of the chain.
func (*Service) NodeSyncing ¶
NodeSyncing provides the state of the node's synchronization with the chain.
func (*Service) NodeVersion ¶
NodeVersion returns a free-text string with the node version.
func (*Service) ProposerDuties ¶
func (s *Service) ProposerDuties(_ context.Context, _ spec.Epoch, validatorIndices []spec.ValidatorIndex) ([]*api.ProposerDuty, error)
ProposerDuties obtains proposer duties for the given epoch. If validatorIndices is empty all duties are returned, otherwise only matching duties are returned.
func (*Service) RANDAODomain ¶
RANDAODomain provides the RANDAO domain.
func (*Service) SelectionProofDomain ¶
SelectionProofDomain provides the selection proof domain.
func (*Service) SignedBeaconBlock ¶
func (s *Service) SignedBeaconBlock(_ context.Context, _ string) (*spec.VersionedSignedBeaconBlock, error)
SignedBeaconBlock fetches a signed beacon block given a block ID.
func (*Service) SlotDuration ¶
SlotDuration provides the duration of a slot of the chain.
func (*Service) SlotsPerEpoch ¶
SlotsPerEpoch provides the slots per epoch of the chain.
func (*Service) Spec ¶
Spec provides the spec information of the chain. This returns various useful values.
func (*Service) SubmitAggregateAttestations ¶
func (s *Service) SubmitAggregateAttestations(_ context.Context, _ []*spec.SignedAggregateAndProof) error
SubmitAggregateAttestations submits aggregate attestations.
func (*Service) SubmitAttestations ¶
SubmitAttestations submits attestations.
func (*Service) SubmitBLSToExecutionChange ¶
func (s *Service) SubmitBLSToExecutionChange(_ context.Context, _ *capella.SignedBLSToExecutionChange) error
SubmitBLSToExecutionChange submits a BLS to execution address change operation.
func (*Service) SubmitBeaconBlock ¶
SubmitBeaconBlock submits a beacon block.
func (*Service) SubmitBeaconCommitteeSubscriptions ¶
func (s *Service) SubmitBeaconCommitteeSubscriptions(_ context.Context, _ []*api.BeaconCommitteeSubscription) error
SubmitBeaconCommitteeSubscriptions subscribes to beacon committees.
func (*Service) SubmitBlindedBeaconBlock ¶
func (s *Service) SubmitBlindedBeaconBlock(_ context.Context, _ *api.VersionedSignedBlindedBeaconBlock) error
SubmitBlindedBeaconBlock submits a blinded beacon block.
func (*Service) SubmitProposalPreparations ¶
func (s *Service) SubmitProposalPreparations(_ context.Context, _ []*apiv1.ProposalPreparation) error
SubmitProposalPreparations provides the beacon node with information required if a proposal for the given validators shows up in the next epoch.
func (*Service) SubmitSyncCommitteeContributions ¶
func (s *Service) SubmitSyncCommitteeContributions(_ context.Context, _ []*altair.SignedContributionAndProof) error
SubmitSyncCommitteeContributions submits sync committee contributions.
func (*Service) SubmitSyncCommitteeMessages ¶
func (s *Service) SubmitSyncCommitteeMessages(_ context.Context, _ []*altair.SyncCommitteeMessage) error
SubmitSyncCommitteeMessages submits sync committee messages.
func (*Service) SubmitSyncCommitteeSubscriptions ¶
func (s *Service) SubmitSyncCommitteeSubscriptions(_ context.Context, _ []*api.SyncCommitteeSubscription) error
SubmitSyncCommitteeSubscriptions subscribes to sync committees.
func (*Service) SubmitValidatorRegistrations ¶
func (s *Service) SubmitValidatorRegistrations(_ context.Context, _ []*api.VersionedSignedValidatorRegistration) error
SubmitValidatorRegistrations submits a validator registration.
func (*Service) SubmitVoluntaryExit ¶
SubmitVoluntaryExit submits a voluntary exit.
func (*Service) SyncCommittee ¶
SyncCommittee fetches the sync committee for the given state.
func (*Service) SyncCommitteeAtEpoch ¶
func (s *Service) SyncCommitteeAtEpoch(_ context.Context, _ string, _ phase0.Epoch) (*api.SyncCommittee, error)
SyncCommitteeAtEpoch fetches the sync committee for the given epoch at the given state.
func (*Service) SyncCommitteeContribution ¶
func (s *Service) SyncCommitteeContribution(_ context.Context, _ phase0.Slot, _ uint64, _ phase0.Root) (*altair.SyncCommitteeContribution, error)
SyncCommitteeContribution provides a sync committee contribution.
func (*Service) SyncCommitteeDuties ¶
func (s *Service) SyncCommitteeDuties(_ context.Context, _ phase0.Epoch, validatorIndices []phase0.ValidatorIndex) ([]*api.SyncCommitteeDuty, error)
SyncCommitteeDuties obtains sync committee duties. If validatorIndicess is nil it will return all duties for the given epoch.
func (*Service) TargetAggregatorsPerCommittee ¶
TargetAggregatorsPerCommittee provides the target number of aggregators for each attestation committee.
func (*Service) ValidatorBalances ¶
func (s *Service) ValidatorBalances(_ context.Context, _ string, _ []spec.ValidatorIndex) (map[spec.ValidatorIndex]spec.Gwei, error)
ValidatorBalances provides the validator balances for a given state. stateID can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized". validatorIndices is a list of validator indices to restrict the returned values. If no validators are supplied no filter will be applied.
func (*Service) Validators ¶
func (s *Service) Validators(_ context.Context, _ string, _ []phase0.ValidatorIndex) (map[phase0.ValidatorIndex]*api.Validator, error)
Validators provides the validators, with their balance and status, for a given state. stateID can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized". validatorIndices is a list of validator indices to restrict the returned values. If no validators IDs are supplied no filter will be applied.
func (*Service) ValidatorsByPubKey ¶
func (s *Service) ValidatorsByPubKey(_ context.Context, _ string, _ []phase0.BLSPubKey) (map[phase0.ValidatorIndex]*api.Validator, error)
ValidatorsByPubKey provides the validators, with their balance and status, for a given state. stateID can be a slot number or state root, or one of the special values "genesis", "head", "justified" or "finalized". validatorPubKeys is a list of validator public keys to restrict the returned values. If no validators public keys are supplied no filter will be applied.
func (*Service) VoluntaryExitDomain ¶
VoluntaryExitDomain provides the voluntary exit domain.
Source Files
¶
- aggregateandproofdomain.go
- aggregateattestation.go
- attestationdata.go
- attestationpool.go
- attesterduties.go
- beaconattesterdomain.go
- beaconblockheader.go
- beaconblockproposal.go
- beaconblockroot.go
- beaconcommittees.go
- beaconcommitteesatepoch.go
- beaconproposerdomain.go
- beaconstate.go
- blindedbeaconblockproposal.go
- depositcontract.go
- depositdomain.go
- domain.go
- events.go
- farfutureepoch.go
- finality.go
- fork.go
- forkschedule.go
- genesis.go
- genesistime.go
- nodesyncing.go
- nodeversion.go
- parameters.go
- proposerduties.go
- randaodomain.go
- selectionproofdomain.go
- service.go
- signedbeaconblock.go
- slotduration.go
- slotsperepoch.go
- spec.go
- stateroot.go
- submitaggregateattestations.go
- submitattestations.go
- submitbeaconblock.go
- submitbeaconcommitteesubscriptions.go
- submitblindedbeaconblock.go
- submitblstoexecutionchange.go
- submitproposalpreparations.go
- submitsynccommitteecontributions.go
- submitsynccommitteemessages.go
- submitsynccommitteesubscriptions.go
- submitvalidatorregistration.go
- submitvoluntaryexit.go
- synccommittee.go
- synccommitteecontributionprovider.go
- synccommitteeduties.go
- targetaggregatorspercommittee.go
- validatorbalances.go
- validators.go
- validatorsbypubkey.go
- voluntaryexitdomain.go