node

Documentation

Overview

Package node defines a gRPC node service implementation, providing useful endpoints for checking a node's sync status, peer info, genesis data, and version information.

Index

• type Server
  • func (s *Server) GetHealth(w http.ResponseWriter, r *http.Request)
  • func (s *Server) GetIdentity(w http.ResponseWriter, r *http.Request)
  • func (s *Server) GetPeer(w http.ResponseWriter, r *http.Request)
  • func (s *Server) GetPeerCount(w http.ResponseWriter, r *http.Request)
  • func (s *Server) GetPeers(w http.ResponseWriter, r *http.Request)
  • func (s *Server) GetSyncStatus(w http.ResponseWriter, r *http.Request)
  • func (*Server) GetVersion(w http.ResponseWriter, r *http.Request)

Types

type Server

type Server struct {
	SyncChecker               sync.Checker
	OptimisticModeFetcher     blockchain.OptimisticModeFetcher
	Server                    *grpc.Server
	BeaconDB                  db.ReadOnlyDatabase
	PeersFetcher              p2p.PeersProvider
	PeerManager               p2p.PeerManager
	MetadataProvider          p2p.MetadataProvider
	GenesisTimeFetcher        blockchain.TimeFetcher
	HeadFetcher               blockchain.HeadFetcher
	ExecutionChainInfoFetcher execution.ChainInfoFetcher
}

Server defines a server implementation of the gRPC Node service, providing RPC endpoints for verifying a beacon node's sync status, genesis and version information.

func (*Server) GetHealth

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

GetHealth returns node health status in http status codes. Useful for load balancers.

func (*Server) GetIdentity

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

GetIdentity retrieves data about the node's network presence.

func (*Server) GetPeer

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

GetPeer retrieves data about the given peer.

func (*Server) GetPeerCount

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

GetPeerCount retrieves number of known peers.

func (*Server) GetPeers

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

GetPeers retrieves data about the node's network peers.

func (*Server) GetSyncStatus

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

GetSyncStatus requests the beacon node to describe if it's currently syncing or not, and if it is, what block it is up to.

func (*Server) GetVersion

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

GetVersion requests that the beacon node identify information about its implementation in a format similar to a HTTP User-Agent field.