api

Documentation

Overview

Package api provides the functionality of the Bee client-facing HTTP API.

Index

• Constants
• Variables
• type BeeNodeMode
  • func (b BeeNodeMode) String() string
• type ExtraOptions
• type FileInfo
• type Options
• type Peer
• type Probe
  • func NewProbe() *Probe
  • func (p *Probe) Healthy() ProbeStatus
  • func (p *Probe) Ready() ProbeStatus
  • func (p *Probe) SetHealthy(ps ProbeStatus)
  • func (p *Probe) SetReady(ps ProbeStatus)
• type ProbeStatus
  • func (ps ProbeStatus) String() string
• type Service
  • func New(publicKey, pssPublicKey ecdsa.PublicKey, ethereumAddress common.Address, ...) *Service
  • func (s *Service) Close() error
  • func (s *Service) Configure(signer crypto.Signer, auth auth.Authenticator, tracer *tracing.Tracer, ...) <-chan *pusher.Op
  • func (s *Service) Metrics() []prometheus.Collector
  • func (s *Service) MountAPI()
  • func (s *Service) MountDebug(restricted bool)
  • func (s *Service) MountTechnicalDebug()
  • func (s *Service) MustRegisterMetrics(cs ...prometheus.Collector)
  • func (s *Service) SetP2P(p2p p2p.DebugService)
  • func (s *Service) SetProbe(probe *Probe)
  • func (s *Service) SetSwarmAddress(addr *swarm.Address)
• type StorageIndexDebugger
• type UpgradedResponseWriter

Constants

const (
	SwarmPinHeader            = "Swarm-Pin"
	SwarmTagHeader            = "Swarm-Tag"
	SwarmEncryptHeader        = "Swarm-Encrypt"
	SwarmIndexDocumentHeader  = "Swarm-Index-Document"
	SwarmErrorDocumentHeader  = "Swarm-Error-Document"
	SwarmFeedIndexHeader      = "Swarm-Feed-Index"
	SwarmFeedIndexNextHeader  = "Swarm-Feed-Index-Next"
	SwarmCollectionHeader     = "Swarm-Collection"
	SwarmPostageBatchIdHeader = "Swarm-Postage-Batch-Id"
	SwarmDeferredUploadHeader = "Swarm-Deferred-Upload"
)

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 ExtraOptions

type ExtraOptions struct {
	Pingpong         pingpong.Interface
	TopologyDriver   topology.Driver
	LightNodes       *lightnode.Container
	Accounting       accounting.Interface
	Pseudosettle     settlement.Interface
	Swap             swap.Interface
	Chequebook       chequebook.Service
	BlockTime        time.Duration
	Tags             *tags.Tags
	Storer           storage.Storer
	Resolver         resolver.Interface
	Pss              pss.Interface
	TraversalService traversal.Traverser
	Pinning          pinning.Interface
	FeedFactory      feeds.Factory
	Post             postage.Service
	PostageContract  postagecontract.Interface
	Staking          staking.Contract
	Steward          steward.Interface
	SyncStatus       func() (bool, error)
	IndexDebugger    StorageIndexDebugger
}

type FileInfo

type FileInfo struct {
	Path        string
	Name        string
	ContentType string
	Size        int64
	Reader      io.Reader
}

type Options

type Options struct {
	CORSAllowedOrigins []string
	WsPingPeriod       time.Duration
	Restricted         bool
}

type Peer

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

Peer holds information about a Peer.

type Probe

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

Probe structure holds flags which indicate node healthiness (sometimes refert also as liveness) and readiness.

func NewProbe

func NewProbe() *Probe

NewProbe returns new Probe.

func (*Probe) Healthy

func (p *Probe) Healthy() ProbeStatus

Healthy returns the value of the healthy status.

func (*Probe) Ready

func (p *Probe) Ready() ProbeStatus

Ready returns the value of the ready status.

func (*Probe) SetHealthy

func (p *Probe) SetHealthy(ps ProbeStatus)

SetHealthy updates the value of the healthy status.

func (*Probe) SetReady

func (p *Probe) SetReady(ps ProbeStatus)

SetReady updates the value of the ready status.

type ProbeStatus

type ProbeStatus int32

ProbeStatus is the status of a probe. ProbeStatus is treated as a sync/atomic int32.

const (
	// ProbeStatusOK indicates positive ProbeStatus status.
	ProbeStatusOK ProbeStatus = 1

	// ProbeStatusNOK indicates negative ProbeStatus status.
	ProbeStatusNOK ProbeStatus = 0
)

func (ProbeStatus) String

func (ps ProbeStatus) String() string

String implements the fmt.Stringer interface.

type Service

type Service struct {
	Options

	http.Handler
	// contains filtered or unexported fields
}

func New

func New(publicKey, pssPublicKey ecdsa.PublicKey, ethereumAddress common.Address, logger log.Logger, transaction transaction.Service, batchStore postage.Storer, beeMode BeeNodeMode, chequebookEnabled bool, swapEnabled bool, chainBackend transaction.Backend, cors []string) *Service

func (*Service) Close

func (s *Service) Close() error

Close hangs up running websockets on shutdown.

func (*Service) Configure

func (s *Service) Configure(signer crypto.Signer, auth auth.Authenticator, tracer *tracing.Tracer, o Options, e ExtraOptions, chainID int64, erc20 erc20.Service) <-chan *pusher.Op

Configure will create a and initialize a new API service.

func (*Service) Metrics

func (s *Service) Metrics() []prometheus.Collector

func (*Service) MountAPI

func (s *Service) MountAPI()

func (*Service) MountDebug

func (s *Service) MountDebug(restricted bool)

func (*Service) MountTechnicalDebug

func (s *Service) MountTechnicalDebug()

func (*Service) MustRegisterMetrics

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

func (*Service) SetP2P

func (s *Service) SetP2P(p2p p2p.DebugService)

func (*Service) SetProbe

func (s *Service) SetProbe(probe *Probe)

func (*Service) SetSwarmAddress

func (s *Service) SetSwarmAddress(addr *swarm.Address)

type StorageIndexDebugger

type StorageIndexDebugger interface {
	DebugIndices() (map[string]int, error)
}

type UpgradedResponseWriter

type UpgradedResponseWriter interface {
	http.ResponseWriter
	http.Pusher
	http.Hijacker
	http.Flusher
	// staticcheck SA1019 CloseNotifier interface is required by gorilla compress handler
	// nolint:staticcheck
	http.CloseNotifier
}

UpgradedResponseWriter adds more functionality on top of ResponseWriter