@ethersphere/bee-js 8.3.1 → 9.0.1

package/README.md

@@ -7,13 +7,13 @@
 ![](https://img.shields.io/badge/Node.js-%3E%3D18.0.0-orange.svg?style=flat-square)
 ![](https://img.shields.io/badge/runs%20in-browser%20%7C%20node%20%7C%20webworker%20%7C%20electron-orange)
 
-> JavaScript SDK for connecting to a Bee node in the Swarm decentralised storage.
+> JavaScript SDK for the Swarm decentralised storage.
 
 > Supports Node.js 18+, Vite and Webpack.
 
 > Write your code in CJS, MJS or TypeScript.
 
-> Intended to be used with Bee version 2.2.0.
+> Intended to be used with Bee version 2.5.0.
 
 ## Quick start
 
@@ -37,12 +37,6 @@ Supported types are `node`, `node-esm`, `node-ts` and `vite-tsx`. Replace `my-da
 npm install @ethersphere/bee-js
 ```
 
-or
-
-```sh
-yarn add @ethersphere/bee-js
-```
-
 ## Import
 
 ### CJS
@@ -65,6 +59,185 @@ Loading this module through a script tag will make the `BeeJs` object available
 <script src="https://unpkg.com/@ethersphere/bee-js/dist/index.browser.min.js"></script>
 ```
 
+## Overview
+
+### Type interfaces
+
+`NumberString` is a branded type for marking strings that represent numbers. It interops with `string` and `bigint`
+types. Where `NumberString` is present, `number` is disallowed in order to avoid pitfalls with unsafe large values.
+
+### Byte primitives
+
+All the classes below extend `Bytes`, therefor the following methods are available on all of them: `toUint8Array`,
+`toHex`, `toBase64`, `toBase32`, `toUtf8`, `toJSON`, `static keccak256`, `static fromUtf8`.
+
+The `toString` method uses `toHex`.
+
+`Bytes` and its subclasses may be constructed with `new` from `Uint8Array` or hex `string`.
+
+#### Elliptic
+
+| Name       | Description               | Methods                                                |
+| ---------- | ------------------------- | ------------------------------------------------------ |
+| PrivateKey | 32 bytes private key      | `publicKey`, `sign`                                    |
+| PublicKey  | 64 bytes public key       | `address`, `toCompressedUint8Array`, `toCompressedHex` |
+| EthAddress | 20 bytes Ethereum address | `toChecksum`                                           |
+| Signature  | 65 bytes signature        | `recoverPublicKey`                                     |
+
+#### Swarm
+
+| Name          | Description                         | Methods                         |
+| ------------- | ----------------------------------- | ------------------------------- |
+| Reference     | 32/64 bytes reference (chunk, feed) | `toCid`                         |
+| Identifier    | 32 bytes identifier (SOC, Feed)     | -                               |
+| TransactionId | 32 bytes transaction ID             | -                               |
+| FeedIndex     | 8 bytes feed index (BE)             | `static fromBigInt`, `toBigInt` |
+| Topic         | 32 bytes topic                      | `static fromString`             |
+| PeerAddress   | 32 bytes peer address               | -                               |
+| BatchId       | 32 bytes batch ID                   | -                               |
+| Span          | 8 bytes span (LE)                   | `static fromBigInt`, `toBigInt` |
+
+### Tokens
+
+| Name | Description                 | Methods                                                                                          |
+| ---- | --------------------------- | ------------------------------------------------------------------------------------------------ |
+| DAI  | ERC20 DAI token (18 digits) | `static fromDecimalString`, `static fromWei`, `toWeiString`, `toWeiBigInt`, `toDecimalString`    |
+| BZZ  | ERC20 BZZ token (16 digits) | `static fromDecimalString`, `static fromPLUR`, `toPLURString`, `toPLURBigInt`, `toDecimalString` |
+
+### Swarm chunks
+
+| Name             | Description                                                                                     | Creation                    |
+| ---------------- | ----------------------------------------------------------------------------------------------- | --------------------------- |
+| Chunk            | Span, max. 4096 bytes payload; address dervied from content                                     | `makeContentAddressedChunk` |
+| SingleOwnerChunk | Identifier, signature, span, max. 4096 bytes payload; address derived from identifier and owner | `makeSingleOwnerChunk`      |
+
+### Swarm primitives
+
+| Name         | Description                                          | Methods                                                                                                                                         |
+| ------------ | ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| MantarayNode | Compact trie with reference values and JSON metadata | `addFork`, `removeFork`, `calculateSelfAddress`, `find`, `findClosest`, `collect`, `marshal`, `unmarshal`, `saveRecursively`, `loadRecursively` |
+| MerkleTree   | Streaming BMT of chunks                              | `append`, `finalize`, `static root`                                                                                                             |
+
+### Swarm objects
+
+| Name       | Description             | Creation             |
+| ---------- | ----------------------- | -------------------- |
+| SOCWriter  | SingleOwnerChunk writer | `bee.makeSOCWriter`  |
+| SOCReader  | SingleOwnerChunk reader | `bee.makeSOCReader`  |
+| FeedWriter | Feed writer             | `bee.makeFeedWriter` |
+| FeedReader | Feed reader             | `bee.makeFeedReader` |
+
+### Bee API
+
+- ❌❌✅ - Full node only
+- ❌✅✅ - Light node and full node
+- ✅✅✅ - Ultra-light node, light node and full node
+
+| JS Call                              | Bee Endpoint                                                                                                                                             | Bee Mode |
+| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
+| `uploadFile`                         | `POST /bzz` [🔗](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)                                                                                | ❌✅✅   |
+| `uploadFilesFromDirectory` _Node.js_ | `POST /bzz` [🔗](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)                                                                                | ❌✅✅   |
+| `uploadFiles`                        | `POST /bzz` [🔗](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)                                                                                | ❌✅✅   |
+| `uploadCollection`                   | `POST /bzz` [🔗](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)                                                                                | ❌✅✅   |
+| `uploadData`                         | `POST /bytes` [🔗](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes/post)                                                                          | ❌✅✅   |
+| `uploadChunk`                        | `POST /chunks` [🔗](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks/post)                                                                        | ❌✅✅   |
+| `streamDirectory` _Node.js_          | `POST /chunks` [🔗](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks/post)                                                                        | ❌✅✅   |
+| `streamFiles` _Browser_              | `POST /chunks` [🔗](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks/post)                                                                        | ❌✅✅   |
+| `SOCWriter.upload`                   | `POST /soc/:owner/:identifier` [🔗](https://docs.ethswarm.org/api/#tag/Single-owner-chunk/paths/~1soc~1%7Bowner%7D~1%7Bid%7D/post)                       | ❌✅✅   |
+| `FeedReader.download`                | `GET /feeds/:owner/:topic` [🔗](https://docs.ethswarm.org/api/#tag/Feed/paths/~1feeds~1%7Bowner%7D~1%7Btopic%7D/get)                                     | ✅✅✅   |
+| `FeedWriter.updateFeed`              | `POST /soc/:owner/:identifier` [🔗](https://docs.ethswarm.org/api/#tag/Single-owner-chunk/paths/~1soc~1%7Bowner%7D~1%7Bid%7D/post)                       | ❌✅✅   |
+| `downloadFile`                       | `GET /bzz/:reference` [🔗](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz~1%7Breference%7D/get)                                                      | ✅✅✅   |
+| `downloadFile`                       | `GET /bzz/:reference/:path` [🔗](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz~1%7Breference%7D~1%7Bpath%7D/get)                                    | ✅✅✅   |
+| `downloadReadableFile`               | `GET /bzz/:reference` [🔗](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz~1%7Breference%7D/get)                                                      | ✅✅✅   |
+| `downloadData`                       | `GET /bytes/:reference` [🔗](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1%7Breference%7D/get)                                                | ✅✅✅   |
+| `downloadReadableData`               | `GET /bytes/:reference` [🔗](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1%7Breference%7D/get)                                                | ✅✅✅   |
+| `downloadChunk`                      | `GET /chunks/:reference` [🔗](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks~1%7Baddress%7D/get)                                                | ✅✅✅   |
+| `createFeedManifest`                 | `POST /feeds/:owner/:topic` [🔗](https://docs.ethswarm.org/api/#tag/Feed/paths/~1feeds~1%7Bowner%7D~1%7Btopic%7D/post)                                   | ❌✅✅   |
+| `isConnected`                        | `GET /`                                                                                                                                                  | ✅✅✅   |
+| `getHealth`                          | `GET /health` [🔗](https://docs.ethswarm.org/api/#tag/Status/paths/~1health/get)                                                                         | ✅✅✅   |
+| `getReadiness`                       | `GET /readiness` [🔗](https://docs.ethswarm.org/api/#tag/Status/paths/~1readiness/get)                                                                   | ✅✅✅   |
+| `getNodeInfo`                        | `GET /node` [🔗](https://docs.ethswarm.org/api/#tag/Status/paths/~1node/get)                                                                             | ✅✅✅   |
+| `getChainState`                      | `GET /chainstate` [🔗](https://docs.ethswarm.org/api/#tag/Status/paths/~1chainstate/get)                                                                 | ❌✅✅   |
+| `getRedistributionState`             | `GET /redistributionstate` [🔗](https://docs.ethswarm.org/api/#tag/RedistributionState/paths/~1redistributionstate/get)                                  | ❌❌✅   |
+| `getReserveState`                    | `GET /reservestate` [🔗](https://docs.ethswarm.org/api/#tag/Status/paths/~1reservestate/get)                                                             | ❌❌✅   |
+| `getStatus`                          | `GET /status` [🔗](https://docs.ethswarm.org/api/#tag/Node-Status/paths/~1status/get)                                                                    | ✅✅✅   |
+| `getWallet`                          | `GET /wallet` [🔗](https://docs.ethswarm.org/api/#tag/Wallet/paths/~1wallet/get)                                                                         | ❌✅✅   |
+| `getTopology`                        | `GET /topology` [🔗](https://docs.ethswarm.org/api/#tag/Connectivity/paths/~1topology/get)                                                               | ✅✅✅   |
+| `getAddresses`                       | `GET /addresses` [🔗](https://docs.ethswarm.org/api/#tag/Connectivity/paths/~1addresses/get)                                                             | ✅✅✅   |
+| `getPeers`                           | `GET /peers` [🔗](https://docs.ethswarm.org/api/#tag/Connectivity/paths/~1peers/get)                                                                     | ✅✅✅   |
+| `getAllBalances`                     | `GET /balances` [🔗](https://docs.ethswarm.org/api/#tag/Balance/paths/~1balances/get)                                                                    | ❌✅✅   |
+| `getPeerBalance`                     | `GET /balances/:peer` [🔗](https://docs.ethswarm.org/api/#tag/Balance/paths/~1balances~1%7Baddress%7D/get)                                               | ❌✅✅   |
+| `getPastDueConsumptionBalances`      | `GET /consumed` [🔗](https://docs.ethswarm.org/api/#tag/Balance/paths/~1consumed/get)                                                                    | ❌✅✅   |
+| `getPastDueConsumptionPeerBalance`   | `GET /consumed/:peer` [🔗](https://docs.ethswarm.org/api/#tag/Balance/paths/~1consumed~1%7Baddress%7D/get)                                               | ❌✅✅   |
+| `getAllSettlements`                  | `GET /settlements` [🔗](https://docs.ethswarm.org/api/#tag/Settlements/paths/~1settlements/get)                                                          | ❌✅✅   |
+| `getSettlements`                     | `GET /settlements/:peer` [🔗](https://docs.ethswarm.org/api/#tag/Settlements/paths/~1settlements~1%7Baddress%7D/get)                                     | ❌✅✅   |
+| `getChequebookAddress`               | `GET /chequebook/address` [🔗](https://docs.ethswarm.org/api/#tag/Chequebook/paths/~1chequebook~1address/get)                                            | ❌✅✅   |
+| `getChequebookBalance`               | `GET /chequebook/balance` [🔗](https://docs.ethswarm.org/api/#tag/Chequebook/paths/~1chequebook~1balance/get)                                            | ❌✅✅   |
+| `getLastCheques`                     | `GET /chequebook/cheque` [🔗](https://docs.ethswarm.org/api/#tag/Chequebook/paths/~1chequebook~1cheque/get)                                              | ❌✅✅   |
+| `getLastChequesForPeer`              | `GET /chequebook/cheque/:peer` [🔗](https://docs.ethswarm.org/api/#tag/Chequebook/paths/~1chequebook~1cheque~1%7Bpeer-id%7D/get)                         | ❌✅✅   |
+| `getLastCashoutAction`               | `GET /chequebook/cashout/:peer` [🔗](https://docs.ethswarm.org/api/#tag/Chequebook/paths/~1chequebook~1cashout~1%7Bpeer-id%7D/get)                       | ❌✅✅   |
+| `cashoutLastCheque`                  | `POST /chequebook/cashout/:peer` [🔗](https://docs.ethswarm.org/api/#tag/Chequebook/paths/~1chequebook~1cashout~1%7Bpeer-id%7D/post)                     | ❌✅✅   |
+| `depositTokens`                      | `POST /chequebook/deposit` [🔗](https://docs.ethswarm.org/api/#tag/Chequebook/paths/~1chequebook~1deposit/post)                                          | ❌✅✅   |
+| `withdrawTokens`                     | `POST /chequebook/withdraw` [🔗](https://docs.ethswarm.org/api/#tag/Chequebook/paths/~1chequebook~1withdraw/post)                                        | ❌✅✅   |
+| `getAllPendingTransactions`          | `GET /transactions` [🔗](https://docs.ethswarm.org/api/#tag/Transaction/paths/~1transactions/get)                                                        | ❌✅✅   |
+| `getPendingTransaction`              | `GET /transactions/:id` [🔗](https://docs.ethswarm.org/api/#tag/Transaction/paths/~1transactions~1%7BtxHash%7D/get)                                      | ❌✅✅   |
+| `rebroadcastTransaction`             | `POST /transactions/:id` [🔗](https://docs.ethswarm.org/api/#tag/Transaction/paths/~1transactions~1%7BtxHash%7D/post)                                    | ❌✅✅   |
+| `cancelTransaction`                  | `DELETE /transactions/:id` [🔗](https://docs.ethswarm.org/api/#tag/Transaction/paths/~1transactions~1%7BtxHash%7D/delete)                                | ❌✅✅   |
+| `createTag`                          | `POST /tags` [🔗](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags/post)                                                                              | ❌✅✅   |
+| `retrieveTag`                        | `GET /tags/:id` [🔗](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1%7Buid%7D/get)                                                                 | ❌✅✅   |
+| `getAllTags`                         | `GET /tags` [🔗](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags/get)                                                                                | ❌✅✅   |
+| `deleteTag`                          | `DELETE /tags/:id` [🔗](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1%7Buid%7D/delete)                                                           | ❌✅✅   |
+| `updateTag`                          | `PATCH /tags/:id` [🔗](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1%7Buid%7D/patch)                                                             | ❌✅✅   |
+| `pin`                                | `POST /pins/:reference` [🔗](https://docs.ethswarm.org/api/#tag/Pinning/paths/~1pins~1%7Breference%7D/post)                                              | ✅✅✅   |
+| `getAllPins`                         | `GET /pins` [🔗](https://docs.ethswarm.org/api/#tag/Pinning/paths/~1pins/get)                                                                            | ✅✅✅   |
+| `getPin`                             | `GET /pins/:reference` [🔗](https://docs.ethswarm.org/api/#tag/Pinning/paths/~1pins~1%7Breference%7D/get)                                                | ✅✅✅   |
+| `isReferenceRetrievable`             | `GET /stewardship/:reference` [🔗](https://docs.ethswarm.org/api/#tag/Stewardship/paths/~1stewardship~1%7Breference%7D/get)                              | ✅✅✅   |
+| `reuploadPinnedData`                 | `PUT /stewardship/:reference` [🔗](https://docs.ethswarm.org/api/#tag/Stewardship/paths/~1stewardship~1%7Breference%7D/put)                              | ❌✅✅   |
+| `unpin`                              | `DELETE /pins/:reference` [🔗](https://docs.ethswarm.org/api/#tag/Pinning/paths/~1pins~1%7Breference%7D/delete)                                          | ✅✅✅   |
+| `getGrantees`                        | `GET /grantee/:reference` [🔗](https://docs.ethswarm.org/api/#tag/ACT/paths/~1grantee~1%7Breference%7D/get)                                              | ❌✅✅   |
+| `createGrantees`                     | `POST /grantee` [🔗](https://docs.ethswarm.org/api/#tag/ACT/paths/~1grantee/post)                                                                        | ❌✅✅   |
+| `patchGrantees`                      | `PATCH /grantee/:reference` [🔗](https://docs.ethswarm.org/api/#tag/ACT/paths/~1grantee~1%7Breference%7D/patch)                                          | ❌✅✅   |
+| `pssSend`                            | `POST /pss/send/:topic/:target` [🔗](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1send~1%7Btopic%7D~1%7Btargets%7D/post)     | ❌✅✅   |
+| `pssSubscribe` _Websocket_           | `GET /pss/subscribe/:topic` [🔗](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1subscribe~1%7Btopic%7D/get)                    | ❌❌✅   |
+| `pssReceive`                         | `GET /pss/subscribe/:topic` [🔗](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1subscribe~1%7Btopic%7D/get)                    | ❌❌✅   |
+| `getAllPostageBatch`                 | `GET /stamps` [🔗](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps/get)                                                                 | ❌✅✅   |
+| `getGlobalPostageBatches`            | `GET /batches` [🔗](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1batches/get)                                                               | ❌✅✅   |
+| `getPostageBatch`                    | `GET /stamps/:batchId` [🔗](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1%7Bbatch_id%7D/get)                                        | ❌✅✅   |
+| `getPostageBatchBuckets`             | `GET /stamps/:batchId/buckets` [🔗](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1%7Bbatch_id%7D~1buckets/get)                       | ❌✅✅   |
+| `createPostageBatch`                 | `POST /stamps/:amount/:depth` [🔗](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1%7Bamount%7D~1%7Bdepth%7D/post)                     | ❌✅✅   |
+| `topUpBatch`                         | `PATCH /stamps/topup/:batchId/:amount` [🔗](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1topup~1%7Bbatch_id%7D~1%7Bamount%7D/patch) | ❌✅✅   |
+| `diluteBatch`                        | `PATCH /stamps/dilute/:batchId/:depth` [🔗](https://docs.ethswarm.org/api/#tag/Postage-Stamps/paths/~1stamps~1dilute~1%7Bbatch_id%7D~1%7Bdepth%7D/patch) | ❌✅✅   |
+| `createEnvelope`                     | `POST /envelope/:reference` [🔗](https://docs.ethswarm.org/api/#tag/Envelope/paths/~1envelope~1%7Baddress%7D/post)                                       | ❌✅✅   |
+| `getStake`                           | `GET /stake` [🔗](https://docs.ethswarm.org/api/#tag/Staking/paths/~1stake/get)                                                                          | ❌❌✅   |
+| `depositStake`                       | `POST /stake` [🔗](https://docs.ethswarm.org/api/#tag/Staking/paths/~1stake~1%7Bamount%7D/post)                                                          | ❌❌✅   |
+
+### Utils
+
+#### General
+
+- `getCollectionSize`
+- `getFolderSize`
+
+#### PSS
+
+- `makeMaxTarget`
+
+#### Erasure Coding
+
+- `approximateOverheadForRedundancyLevel`
+- `getRedundancyStat`
+- `getRedundancyStats`
+
+#### Stamps
+
+- `getAmountForTtl`
+- `getDepthForCapacity`
+- `getStampCost`
+- `getStampEffectiveBytes`
+- `getStampMaximumCapacityBytes`
+- `getStampTtlSeconds`
+- `getStampUsage`
+
 ## Usage
 
 ### Upload via Swarm Gateway
@@ -77,7 +250,7 @@ main()
 async function main() {
   const bee = new Bee(SWARM_GATEWAY_URL)
   const { reference } = await bee.uploadData(NULL_STAMP, 'Hello, World!')
-  console.log(reference)
+  console.log(reference.toHex())
 }
 ```
 
@@ -99,7 +272,7 @@ async function getOrCreatePostageBatch() {
   if (usable) {
     batchId = usable.batchID
   } else {
-    batchId = await bee.createPostageBatch('500000000', 20)
+    batchId = await bee.buyStorage(Size.fromGigabytes(1), Duration.fromDays(7))
   }
 }
 ```
@@ -116,7 +289,7 @@ const bee = new Bee('http://localhost:1633')
 const uploadResult = await bee.uploadData(batchId, 'Bee is awesome!')
 const data = await bee.downloadData(uploadResult.reference)
 
-console.log(data.text()) // prints 'Bee is awesome!'
+console.log(data.toUtf8()) // prints 'Bee is awesome!'
 ```
 
 ### Upload data from a file input (React)
@@ -170,13 +343,6 @@ const bee = new Bee('http://localhost:1633', {
 })
 ```
 
-[**Check out our examples repo for some more ideas on how to use `bee-js`**](https://github.com/ethersphere/examples-js)
-
-## Documentation
-
-You can find the full documentation [here](https://bee-js.ethswarm.org/docs). The API reference documentation can be
-found [here](https://bee-js.ethswarm.org/docs/api).
-
 ## Contribute
 
 Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the
@@ -191,48 +357,24 @@ There are some ways you can make this module better:
 
 ### Setup
 
-Install project dependencies with
+Install project dependencies:
 
 ```sh
-npm i
+npm install
 ```
 
-### Test
-
-The tests run in both context: node and dom with Jest.
-
-To run the integration tests, you need to spin up local Bee cluster using our
-[`fdp-play`](https://github.com/fairDataSociety/fdp-play/) project. In order to do that you have to have locally Docker
-running on your machine, but afterwards you can just simply run `npm run bee`, which spins up the cluster and display
-Queen's logs. If you want to exit hit `CTRL+C`.
-
-If you want to skip creation of postage stamps every run of integration tests you can create stamps for both nodes and
-set them under env. variables `BEE_POSTAGE` and `BEE_PEER_POSTAGE`.
-
-By default, for integration tests two bee nodes are expected to run on localhost on addresses `http://localhost:1633`
-and `http://localhost:11633`. These are the default values for the `fdp-play` script. If you want to use custom setup,
-you can change the behavior of tests to different addresses using environment variables `BEE_API_URL` and
-`BEE_PEER_API_URL`.
-
-There are also browser tests by Puppeteer, which also provide integrity testing.
+Build the project:
 
 ```sh
-npm run test:browser
+npm run build
 ```
 
-The test HTML file which Puppeteer uses is the [test/testpage/testpage.html](test/testpage/testpage.html). To open and
-manually test BeeJS with developer console, it is necessary to build the library first with `npm run compile:browser`
-(running the browser tests `npm run test:browser` also builds the library).
+After making changes, link the package to your project by running `npm link` in the Bee-JS project root, and
+`npm link @ethersphere/bee-js` in your project root.
 
-### Compile code
-
-In order to compile NodeJS code run
-
-`npm run compile:node`
-
-or for Browsers
+### Test
 
-`npm run compile:browser`
+Tests are currently run against a mainnet Bee nodes. This is temporary and this section will be revised in the future.
 
 ## License
 

package/dist/cjs/bee-dev.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BeeDev = void 0;
+const cafe_utility_1 = require("cafe-utility");
+const _1 = require(".");
+const connectivity_1 = require("./modules/debug/connectivity");
+const http_1 = require("./utils/http");
+class BeeDev extends _1.Bee {
+    async getNodeAddresses(options) {
+        const requestOptions = super.getRequestOptionsForCall(options);
+        const response = await (0, http_1.http)(requestOptions, {
+            url: 'addresses',
+            responseType: 'json',
+        });
+        const body = cafe_utility_1.Types.asObject(response.data, { name: 'response.data' });
+        return {
+            overlay: new _1.PeerAddress(cafe_utility_1.Types.asString(body.overlay, { name: 'overlay' })),
+            underlay: [],
+            ethereum: new _1.EthAddress(cafe_utility_1.Types.asString(body.ethereum, { name: 'ethereum' })),
+            publicKey: new _1.PublicKey(cafe_utility_1.Types.asString(body.publicKey, { name: 'publicKey' })),
+            pssPublicKey: new _1.PublicKey(cafe_utility_1.Types.asString(body.pssPublicKey, { name: 'pssPublicKey' })),
+        };
+    }
+    async getTopology(options) {
+        const requestOptions = super.getRequestOptionsForCall(options);
+        const response = await (0, http_1.http)(requestOptions, {
+            url: `topology`,
+            responseType: 'json',
+        });
+        const body = cafe_utility_1.Types.asObject(response.data, { name: 'response.data' });
+        const bins = cafe_utility_1.Types.asObject(body.bins, { name: 'bins' });
+        return {
+            baseAddr: '0bab5ca208a980950604f900f2791613fc980676c2dee7dd92a4fdda5a54bf26',
+            population: cafe_utility_1.Types.asNumber(body.population, { name: 'population' }),
+            connected: cafe_utility_1.Types.asNumber(body.connected, { name: 'connected' }),
+            timestamp: cafe_utility_1.Types.asString(body.timestamp, { name: 'timestamp' }),
+            nnLowWatermark: cafe_utility_1.Types.asNumber(body.nnLowWatermark, { name: 'nnLowWatermark' }),
+            depth: cafe_utility_1.Types.asNumber(body.depth, { name: 'depth' }),
+            reachability: 'Public',
+            networkAvailability: 'Available',
+            bins: {
+                bin_0: (0, connectivity_1.asBin)(bins.bin_0, 'bin_0'),
+                bin_1: (0, connectivity_1.asBin)(bins.bin_1, 'bin_1'),
+                bin_2: (0, connectivity_1.asBin)(bins.bin_2, 'bin_2'),
+                bin_3: (0, connectivity_1.asBin)(bins.bin_3, 'bin_3'),
+                bin_4: (0, connectivity_1.asBin)(bins.bin_4, 'bin_4'),
+                bin_5: (0, connectivity_1.asBin)(bins.bin_5, 'bin_5'),
+                bin_6: (0, connectivity_1.asBin)(bins.bin_6, 'bin_6'),
+                bin_7: (0, connectivity_1.asBin)(bins.bin_7, 'bin_7'),
+                bin_8: (0, connectivity_1.asBin)(bins.bin_8, 'bin_8'),
+                bin_9: (0, connectivity_1.asBin)(bins.bin_9, 'bin_9'),
+                bin_10: (0, connectivity_1.asBin)(bins.bin_10, 'bin_10'),
+                bin_11: (0, connectivity_1.asBin)(bins.bin_11, 'bin_11'),
+                bin_12: (0, connectivity_1.asBin)(bins.bin_12, 'bin_12'),
+                bin_13: (0, connectivity_1.asBin)(bins.bin_13, 'bin_13'),
+                bin_14: (0, connectivity_1.asBin)(bins.bin_14, 'bin_14'),
+                bin_15: (0, connectivity_1.asBin)(bins.bin_15, 'bin_15'),
+                bin_16: (0, connectivity_1.asBin)(bins.bin_16, 'bin_16'),
+                bin_17: (0, connectivity_1.asBin)(bins.bin_17, 'bin_17'),
+                bin_18: (0, connectivity_1.asBin)(bins.bin_18, 'bin_18'),
+                bin_19: (0, connectivity_1.asBin)(bins.bin_19, 'bin_19'),
+                bin_20: (0, connectivity_1.asBin)(bins.bin_20, 'bin_20'),
+                bin_21: (0, connectivity_1.asBin)(bins.bin_21, 'bin_21'),
+                bin_22: (0, connectivity_1.asBin)(bins.bin_22, 'bin_22'),
+                bin_23: (0, connectivity_1.asBin)(bins.bin_23, 'bin_23'),
+                bin_24: (0, connectivity_1.asBin)(bins.bin_24, 'bin_24'),
+                bin_25: (0, connectivity_1.asBin)(bins.bin_25, 'bin_25'),
+                bin_26: (0, connectivity_1.asBin)(bins.bin_26, 'bin_26'),
+                bin_27: (0, connectivity_1.asBin)(bins.bin_27, 'bin_27'),
+                bin_28: (0, connectivity_1.asBin)(bins.bin_28, 'bin_28'),
+                bin_29: (0, connectivity_1.asBin)(bins.bin_29, 'bin_29'),
+                bin_30: (0, connectivity_1.asBin)(bins.bin_30, 'bin_30'),
+                bin_31: (0, connectivity_1.asBin)(bins.bin_31, 'bin_31'),
+            },
+        };
+    }
+}
+exports.BeeDev = BeeDev;