rewards

Documentation

Index

• type AttestationRewards
• type AttestationRewardsResponse
• type BlockRewardService
  • func (rs *BlockRewardService) GetBlockRewardsData(ctx context.Context, blk interfaces.ReadOnlySignedBeaconBlock) (*BlockRewards, *http2.DefaultErrorJson)
  • func (rs *BlockRewardService) GetStateForRewards(ctx context.Context, blk interfaces.ReadOnlySignedBeaconBlock) (state.BeaconState, *http2.DefaultErrorJson)
• type BlockRewards
• type BlockRewardsFetcher
• type BlockRewardsResponse
• type IdealAttestationReward
• type Server
  • func (s *Server) AttestationRewards(w http.ResponseWriter, r *http.Request)
  • func (s *Server) BlockRewards(w http.ResponseWriter, r *http.Request)
  • func (s *Server) SyncCommitteeRewards(w http.ResponseWriter, r *http.Request)
• type SyncCommitteeReward
• type SyncCommitteeRewardsResponse
• type TotalAttestationReward

Types

type AttestationRewards

type AttestationRewards struct {
	IdealRewards []IdealAttestationReward `json:"ideal_rewards"`
	TotalRewards []TotalAttestationReward `json:"total_rewards"`
}

type AttestationRewardsResponse

type AttestationRewardsResponse struct {
	Data                AttestationRewards `json:"data"`
	ExecutionOptimistic bool               `json:"execution_optimistic"`
	Finalized           bool               `json:"finalized"`
}

type BlockRewardService

type BlockRewardService struct {
	Replayer stategen.ReplayerBuilder
}

BlockRewardService implements BlockRewardsFetcher and can be declared to access the underlying functions

func (*BlockRewardService) GetBlockRewardsData

func (rs *BlockRewardService) GetBlockRewardsData(ctx context.Context, blk interfaces.ReadOnlySignedBeaconBlock) (*BlockRewards, *http2.DefaultErrorJson)

GetBlockRewardsData returns the BlockRewards Object which is used for the BlockRewardsResponse and ProduceBlockV3

func (*BlockRewardService) GetStateForRewards

func (rs *BlockRewardService) GetStateForRewards(ctx context.Context, blk interfaces.ReadOnlySignedBeaconBlock) (state.BeaconState, *http2.DefaultErrorJson)

GetStateForRewards returns the state replayed up to the block's slot

type BlockRewards

type BlockRewards struct {
	ProposerIndex     string `json:"proposer_index"`
	Total             string `json:"total"`
	Attestations      string `json:"attestations"`
	SyncAggregate     string `json:"sync_aggregate"`
	ProposerSlashings string `json:"proposer_slashings"`
	AttesterSlashings string `json:"attester_slashings"`
}

type BlockRewardsFetcher

type BlockRewardsFetcher interface {
	GetBlockRewardsData(context.Context, interfaces.ReadOnlySignedBeaconBlock) (*BlockRewards, *http2.DefaultErrorJson)
	GetStateForRewards(context.Context, interfaces.ReadOnlySignedBeaconBlock) (state.BeaconState, *http2.DefaultErrorJson)
}

BlockRewardsFetcher is a interface that provides access to reward related responses

type BlockRewardsResponse

type BlockRewardsResponse struct {
	Data                *BlockRewards `json:"data"`
	ExecutionOptimistic bool          `json:"execution_optimistic"`
	Finalized           bool          `json:"finalized"`
}

type IdealAttestationReward

type IdealAttestationReward struct {
	EffectiveBalance string `json:"effective_balance"`
	Head             string `json:"head"`
	Target           string `json:"target"`
	Source           string `json:"source"`
}

type Server

type Server struct {
	Blocker               lookup.Blocker
	OptimisticModeFetcher blockchain.OptimisticModeFetcher
	FinalizationFetcher   blockchain.FinalizationFetcher
	TimeFetcher           blockchain.TimeFetcher
	Stater                lookup.Stater
	HeadFetcher           blockchain.HeadFetcher
	BlockRewardFetcher    BlockRewardsFetcher
}

func (*Server) AttestationRewards

func (s *Server) AttestationRewards(w http.ResponseWriter, r *http.Request)

AttestationRewards retrieves attestation reward info for validators specified by array of public keys or validator index. If no array is provided, return reward info for every validator. TODO: Inclusion delay

func (*Server) BlockRewards

func (s *Server) BlockRewards(w http.ResponseWriter, r *http.Request)

BlockRewards is an HTTP handler for Beacon API getBlockRewards.

func (*Server) SyncCommitteeRewards

func (s *Server) SyncCommitteeRewards(w http.ResponseWriter, r *http.Request)

SyncCommitteeRewards retrieves rewards info for sync committee members specified by array of public keys or validator index. If no array is provided, return reward info for every committee member.

type SyncCommitteeReward

type SyncCommitteeReward struct {
	ValidatorIndex string `json:"validator_index"`
	Reward         string `json:"reward"`
}

type SyncCommitteeRewardsResponse

type SyncCommitteeRewardsResponse struct {
	Data                []SyncCommitteeReward `json:"data"`
	ExecutionOptimistic bool                  `json:"execution_optimistic"`
	Finalized           bool                  `json:"finalized"`
}

type TotalAttestationReward

type TotalAttestationReward struct {
	ValidatorIndex string `json:"validator_index"`
	Head           string `json:"head"`
	Target         string `json:"target"`
	Source         string `json:"source"`
	InclusionDelay string `json:"inclusion_delay"`
}