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 /addressesplus health give the full picture.Versionsis the structured triple bee-js exposes from/health.- BinInfo
- Per-bin population summary. Mirrors bee-go
BinInfo. - Cashout
Result - On-chain outcome of a previous cashout.
- Chain
State GET /chainstateresponse. Mirrors bee-go’sChainStateResponse, including the bigint-as-string custom decode forcurrentPrice/totalAmount(one of the three live-Bee bug fixes bee-go hit).- Cheque
- One sent or received cheque.
- Chequebook
Balance GET /chequebook/balanceresponse.- Chunk
Inclusion Proof - Inclusion proof for one chunk in the reserve sample.
- Chunk
Inclusion Proofs - Trio of chunk-inclusion proofs that backs the reserve commitment.
- Debug
Api - Handle exposing the debug endpoints. Cheap to clone.
- Health
GET /healthresponse. Mirrors bee-jsHealth.- Last
Cashout Action GET /chequebook/cashout/{peer}snapshot.- Last
Cheque - One row of
GET /chequebook/cheque.last_receivedmay beNone. - Logger
- One logger row in
LoggerListing. - Logger
Listing GET /loggersandGET /loggers/{expr}response. Thetreepayload is recursive and rarely needed — it is preserved as a raw JSON value.- Metric
Snapshot View - Per-peer connection metrics. Mirrors bee-go
MetricSnapshotView. - Neighborhood
GET /status/neighborhoodsrow — per-neighbourhood reserve stats.- Node
Info GET /noderesponse — operator-mode flags. Mirrors bee-goNodeInfo.- Peer
- One connected peer entry. Mirrors bee-go
Peer. - Peer
Accounting - Full per-peer accounting state (richer than
Balance). All monetary fields are PLUR. - Peer
Cheques - Sent + received cheques for one peer (
GET /chequebook/cheque/{peer}). - Peer
Info - One peer entry inside a
BinInfo. Mirrors bee-goPeerInfo. - Peer
Status GET /status/peersrow — likeStatusbut per-peer, with arequest_failedflag set when the snapshot couldn’t be gathered.- Postage
Proof - Postage stamp proof embedded in a
ChunkInclusionProof. - RCHash
Response - Reserve-commitment hash + sample inclusion proofs returned by
GET /rchash/{depth}/{anchor1}/{anchor2}. Mirrors bee-goApiRCHashResponse. - Redistribution
State - Redistribution-state snapshot. Mirrors bee-go
RedistributionStateResponse. - Reserve
State - Reserve state snapshot —
GET /reservestate. - Settlement
- One peer settlement entry.
- Settlements
GET /settlementsresponse.- SocProof
- Single-owner-chunk proof embedded in a
ChunkInclusionProof. - Status
GET /statusresponse — operational status snapshot. Mirrors bee-goStatusResponse.- Topology
- Topology snapshot —
GET /topology. - Transaction
Info - One pending transaction Bee knows about. Mirrors bee-go
TransactionInfo. The bigint fields arrive as decimal strings on the wire; missing/empty values becomeNone. - Wallet
GET /walletresponse. Mirrors bee-goWalletResponse.
Constants§
- SUPPORTED_
API_ VERSION - Supported API version this client claims compatibility with.
- SUPPORTED_
BEE_ VERSION_ EXACT - Supported exact Bee version this client targets.