Skip to main content

Module debug

Module debug 

Source
Expand description

Debug / operator endpoints. Mirrors pkg/debug in bee-go.

Structs§

Addresses
Node addresses payload — GET /addresses.
Balance
Settlement balance with one peer. Mirrors bee-go Balance.
BeeVersions
GET /node / GET /addresses plus health give the full picture. Versions is the structured triple bee-js exposes from /health.
BinInfo
Per-bin population summary. Mirrors bee-go BinInfo.
CashoutResult
On-chain outcome of a previous cashout.
ChainState
GET /chainstate response. Mirrors bee-go’s ChainStateResponse, including the bigint-as-string custom decode for currentPrice / totalAmount (one of the three live-Bee bug fixes bee-go hit).
Cheque
One sent or received cheque.
ChequebookBalance
GET /chequebook/balance response.
ChunkInclusionProof
Inclusion proof for one chunk in the reserve sample.
ChunkInclusionProofs
Trio of chunk-inclusion proofs that backs the reserve commitment.
DebugApi
Handle exposing the debug endpoints. Cheap to clone.
Health
GET /health response. Mirrors bee-js Health.
LastCashoutAction
GET /chequebook/cashout/{peer} snapshot.
LastCheque
One row of GET /chequebook/cheque. last_received may be None.
Logger
One logger row in LoggerListing.
LoggerListing
GET /loggers and GET /loggers/{expr} response. The tree payload is recursive and rarely needed — it is preserved as a raw JSON value.
MetricSnapshotView
Per-peer connection metrics. Mirrors bee-go MetricSnapshotView.
Neighborhood
GET /status/neighborhoods row — per-neighbourhood reserve stats.
NodeInfo
GET /node response — operator-mode flags. Mirrors bee-go NodeInfo.
Peer
One connected peer entry. Mirrors bee-go Peer.
PeerAccounting
Full per-peer accounting state (richer than Balance). All monetary fields are PLUR.
PeerCheques
Sent + received cheques for one peer (GET /chequebook/cheque/{peer}).
PeerInfo
One peer entry inside a BinInfo. Mirrors bee-go PeerInfo.
PeerStatus
GET /status/peers row — like Status but per-peer, with a request_failed flag set when the snapshot couldn’t be gathered.
PostageProof
Postage stamp proof embedded in a ChunkInclusionProof.
RCHashResponse
Reserve-commitment hash + sample inclusion proofs returned by GET /rchash/{depth}/{anchor1}/{anchor2}. Mirrors bee-go ApiRCHashResponse.
RedistributionState
Redistribution-state snapshot. Mirrors bee-go RedistributionStateResponse.
ReserveState
Reserve state snapshot — GET /reservestate.
Settlement
One peer settlement entry.
Settlements
GET /settlements response.
SocProof
Single-owner-chunk proof embedded in a ChunkInclusionProof.
Status
GET /status response — operational status snapshot. Mirrors bee-go StatusResponse.
Topology
Topology snapshot — GET /topology.
TransactionInfo
One pending transaction Bee knows about. Mirrors bee-go TransactionInfo. The bigint fields arrive as decimal strings on the wire; missing/empty values become None.
Wallet
GET /wallet response. Mirrors bee-go WalletResponse.

Constants§

SUPPORTED_API_VERSION
Supported API version this client claims compatibility with.
SUPPORTED_BEE_VERSION_EXACT
Supported exact Bee version this client targets.