lighthouse

Documentation

Index

• Constants
• type Client
  • func NewClient(providerAddress string) *Client
  • func (c *Client) Close() error
  • func (c *Client) ExitValidator(validatorIndex, epoch uint64, signature types.ValidatorSignature) error
  • func (c *Client) GetBeaconHead() (beacon.BeaconHead, error)
  • func (c *Client) GetClientType() beacon.BeaconClientType
  • func (c *Client) GetDomainData(domainType []byte, epoch uint64) ([]byte, error)
  • func (c *Client) GetEth2Config() (beacon.Eth2Config, error)
  • func (c *Client) GetSyncStatus() (beacon.SyncStatus, error)
  • func (c *Client) GetValidatorIndex(pubkey types.ValidatorPubkey) (uint64, error)
  • func (c *Client) GetValidatorStatus(pubkey types.ValidatorPubkey, opts *beacon.ValidatorStatusOptions) (beacon.ValidatorStatus, error)
  • func (c *Client) GetValidatorStatuses(pubkeys []types.ValidatorPubkey, opts *beacon.ValidatorStatusOptions) (map[types.ValidatorPubkey]beacon.ValidatorStatus, error)
• type Eth2ConfigResponse
• type FinalityCheckpointsResponse
• type ForkResponse
• type GenesisResponse
• type SyncStatusResponse
• type Validator
• type ValidatorsResponse
• type VoluntaryExitMessage
• type VoluntaryExitRequest

Constants

const (
	RequestUrlFormat   = "%s://%s%s"
	RequestProtocol    = "http"
	RequestContentType = "application/json"

	RequestSyncStatusPath          = "/eth/v1/node/syncing"
	RequestEth2ConfigPath          = "/eth/v1/config/spec"
	RequestGenesisPath             = "/eth/v1/beacon/genesis"
	RequestFinalityCheckpointsPath = "/eth/v1/beacon/states/%s/finality_checkpoints"
	RequestForkPath                = "/eth/v1/beacon/states/%s/fork"
	RequestValidatorsPath          = "/eth/v1/beacon/states/%s/validators"
	RequestVoluntaryExitPath       = "/eth/v1/beacon/pool/voluntary_exits"

	MaxRequestValidatorsCount = 600
)

Config

Types

type Client

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

Lighthouse client

func NewClient

func NewClient(providerAddress string) *Client

Create new lighthouse client

func (*Client) Close

func (c *Client) Close() error

Close the client connection

func (*Client) ExitValidator

func (c *Client) ExitValidator(validatorIndex, epoch uint64, signature types.ValidatorSignature) error

Perform a voluntary exit on a validator

func (*Client) GetBeaconHead

func (c *Client) GetBeaconHead() (beacon.BeaconHead, error)

Get the beacon head

func (*Client) GetClientType

func (c *Client) GetClientType() beacon.BeaconClientType

Get the beacon client type

func (*Client) GetDomainData

func (c *Client) GetDomainData(domainType []byte, epoch uint64) ([]byte, error)

Get domain data for a domain type at a given epoch

func (*Client) GetEth2Config

func (c *Client) GetEth2Config() (beacon.Eth2Config, error)

Get the eth2 config

func (*Client) GetSyncStatus

func (c *Client) GetSyncStatus() (beacon.SyncStatus, error)

Get the node's sync status

func (*Client) GetValidatorIndex

func (c *Client) GetValidatorIndex(pubkey types.ValidatorPubkey) (uint64, error)

Get a validator's index

func (*Client) GetValidatorStatus

func (c *Client) GetValidatorStatus(pubkey types.ValidatorPubkey, opts *beacon.ValidatorStatusOptions) (beacon.ValidatorStatus, error)

Get a validator's status

func (*Client) GetValidatorStatuses

func (c *Client) GetValidatorStatuses(pubkeys []types.ValidatorPubkey, opts *beacon.ValidatorStatusOptions) (map[types.ValidatorPubkey]beacon.ValidatorStatus, error)

Get multiple validators' statuses

type Eth2ConfigResponse

type Eth2ConfigResponse struct {
	Data struct {
		SecondsPerSlot uinteger `json:"SECONDS_PER_SLOT"`
		SlotsPerEpoch  uinteger `json:"SLOTS_PER_EPOCH"`
	} `json:"data"`
}

type FinalityCheckpointsResponse

type FinalityCheckpointsResponse struct {
	Data struct {
		PreviousJustified struct {
			Epoch uinteger `json:"epoch"`
		} `json:"previous_justified"`
		CurrentJustified struct {
			Epoch uinteger `json:"epoch"`
		} `json:"current_justified"`
		Finalized struct {
			Epoch uinteger `json:"epoch"`
		} `json:"finalized"`
	} `json:"data"`
}

type ForkResponse

type ForkResponse struct {
	Data struct {
		PreviousVersion byteArray `json:"previous_version"`
		CurrentVersion  byteArray `json:"current_version"`
		Epoch           uinteger  `json:"epoch"`
	} `json:"data"`
}

type GenesisResponse

type GenesisResponse struct {
	Data struct {
		GenesisTime           uinteger  `json:"genesis_time"`
		GenesisForkVersion    byteArray `json:"genesis_fork_version"`
		GenesisValidatorsRoot byteArray `json:"genesis_validators_root"`
	} `json:"data"`
}

type SyncStatusResponse

type SyncStatusResponse struct {
	Data struct {
		IsSyncing    bool     `json:"is_syncing"`
		HeadSlot     uinteger `json:"head_slot"`
		SyncDistance uinteger `json:"sync_distance"`
	} `json:"data"`
}

Response types

type Validator

type Validator struct {
	Index   uinteger `json:"index"`
	Balance uinteger `json:"balance"`
	//Status string                       `json:"status"`
	Validator struct {
		Pubkey                     byteArray `json:"pubkey"`
		WithdrawalCredentials      byteArray `json:"withdrawal_credentials"`
		EffectiveBalance           uinteger  `json:"effective_balance"`
		Slashed                    bool      `json:"slashed"`
		ActivationEligibilityEpoch uinteger  `json:"activation_eligibility_epoch"`
		ActivationEpoch            uinteger  `json:"activation_epoch"`
		ExitEpoch                  uinteger  `json:"exit_epoch"`
		WithdrawableEpoch          uinteger  `json:"withdrawable_epoch"`
	} `json:"validator"`
}

type ValidatorsResponse

type ValidatorsResponse struct {
	Data []Validator `json:"data"`
}

type VoluntaryExitMessage

type VoluntaryExitMessage struct {
	Epoch          uinteger `json:"epoch"`
	ValidatorIndex uinteger `json:"validator_index"`
}

type VoluntaryExitRequest

type VoluntaryExitRequest struct {
	Message   VoluntaryExitMessage `json:"message"`
	Signature byteArray            `json:"signature"`
}

Request types