debug

Documentation

Overview

Package debug defines a gRPC server implementation of a debugging service which allows for helpful endpoints to debug a beacon node at runtime, this server is gated behind the feature flag --enable-debug-rpc-endpoints.

Index

• type Server
  • func (ds *Server) GetBeaconState(ctx context.Context, req *pbrpc.BeaconStateRequest) (*pbrpc.SSZResponse, error)
  • func (ds *Server) GetBlock(ctx context.Context, req *pbrpc.BlockRequest) (*pbrpc.SSZResponse, error)
  • func (ds *Server) GetInclusionSlot(ctx context.Context, req *pbrpc.InclusionSlotRequest) (*pbrpc.InclusionSlotResponse, error)
  • func (ds *Server) GetPeer(_ context.Context, peerReq *ethpb.PeerRequest) (*pbrpc.DebugPeerResponse, error)
  • func (ds *Server) GetProtoArrayForkChoice(_ context.Context, _ *empty.Empty) (*pbrpc.ProtoArrayForkChoiceResponse, error)
  • func (ds *Server) ListPeers(_ context.Context, _ *empty.Empty) (*pbrpc.DebugPeerResponses, error)
  • func (ds *Server) SetLoggingLevel(_ context.Context, req *pbrpc.LoggingLevelRequest) (*empty.Empty, error)

Types

type Server

type Server struct {
	BeaconDB           db.NoHeadAccessDatabase
	GenesisTimeFetcher blockchain.TimeFetcher
	StateGen           *stategen.State
	HeadFetcher        blockchain.HeadFetcher
	PeerManager        p2p.PeerManager
	PeersFetcher       p2p.PeersProvider
}

Server defines a server implementation of the gRPC Debug service, providing RPC endpoints for runtime debugging of a node, this server is gated behind the feature flag --enable-debug-rpc-endpoints.

func (*Server) GetBeaconState

func (ds *Server) GetBeaconState(
	ctx context.Context,
	req *pbrpc.BeaconStateRequest,
) (*pbrpc.SSZResponse, error)

GetBeaconState retrieves an ssz-encoded beacon state from the beacon node by either a slot or block root.

func (*Server) GetBlock

func (ds *Server) GetBlock(
	ctx context.Context,
	req *pbrpc.BlockRequest,
) (*pbrpc.SSZResponse, error)

GetBlock in an ssz-encoded format by block root.

func (*Server) GetInclusionSlot

func (ds *Server) GetInclusionSlot(ctx context.Context, req *pbrpc.InclusionSlotRequest) (*pbrpc.InclusionSlotResponse, error)

GetInclusionSlot of an attestation in block.

func (*Server) GetPeer

func (ds *Server) GetPeer(_ context.Context, peerReq *ethpb.PeerRequest) (*pbrpc.DebugPeerResponse, error)

GetPeer returns the data known about the peer defined by the provided peer id.

func (*Server) GetProtoArrayForkChoice

func (ds *Server) GetProtoArrayForkChoice(_ context.Context, _ *empty.Empty) (*pbrpc.ProtoArrayForkChoiceResponse, error)

GetProtoArrayForkChoice returns proto array fork choice store.

func (*Server) ListPeers

func (ds *Server) ListPeers(_ context.Context, _ *empty.Empty) (*pbrpc.DebugPeerResponses, error)

ListPeers returns all peers known to the host node, irregardless of if they are connected/ disconnected.

func (*Server) SetLoggingLevel

func (ds *Server) SetLoggingLevel(_ context.Context, req *pbrpc.LoggingLevelRequest) (*empty.Empty, error)

SetLoggingLevel of a beacon node according to a request type, either INFO, DEBUG, or TRACE.