debugapi

Documentation

Overview

Package debugapi exposes the debug API used to control and analyze low-level and runtime features and functionalities of hop.

Index

• Variables
• type BeeNodeMode
  • func (b BeeNodeMode) String() string
• type Peer
• type Service
  • func New(publicKey, pssPublicKey ecdsa.PublicKey, ethereumAddress common.Address, ...) *Service
  • func (s *Service) Configure(overlay swarm.Address, p2p p2p.DebugService, pingpong pingpong.Interface, ...)
  • func (s *Service) MustRegisterMetrics(cs ...prometheus.Collector)
  • func (s *Service) ServeHTTP(w http.ResponseWriter, r *http.Request)

Variables

var Version = "0.0.0"

Version is set in the build process.

Types

type BeeNodeMode

type BeeNodeMode uint

const (
	LightMode BeeNodeMode = iota
	FullMode
	DevMode
	UltraLightMode
)

func (BeeNodeMode) String

func (b BeeNodeMode) String() string

type Peer

type Peer struct {
	Address  swarm.Address `json:"address"`
	FullNode bool          `json:"fullNode"`
}

Peer holds information about a Peer.

type Service

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

Service implements http.Handler interface to be used in HTTP server.

func New

func New(publicKey, pssPublicKey ecdsa.PublicKey, ethereumAddress common.Address, logger logging.Logger, tracer *tracing.Tracer, corsAllowedOrigins []string, blockTime *big.Int, backend transaction.Backend, transaction transaction.Service, restrict bool, auth authenticator) *Service

New creates a new Debug API Service with only basic routers enabled in order to expose /addresses, /health endpoints, Go metrics and pprof. It is useful to expose these endpoints before all dependencies are configured and injected to have access to basic debugging tools and /health endpoint.

func (*Service) Configure

func (s *Service) Configure(overlay swarm.Address, p2p p2p.DebugService, pingpong pingpong.Interface, topologyDriver topology.Driver, lightNodes *lightnode.Container, storer storage.Storer, tags *tags.Tags, accounting accounting.Interface, pseudosettle settlement.Interface, chequebookEnabled bool, swap swap.Interface, chequebook chequebook.Service, batchStore postage.Storer, post postage.Service, postageContract postagecontract.Interface, pledgeContract pledge.Service, rewardContract reward.Service, traverser traversal.Traverser)

Configure injects required dependencies and configuration parameters and constructs HTTP routes that depend on them. It is intended and safe to call this method only once.

func (*Service) MustRegisterMetrics

func (s *Service) MustRegisterMetrics(cs ...prometheus.Collector)

func (*Service) ServeHTTP

func (s *Service) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.Handler interface.