Swarm

https://docs.ethswarm.org
Admin
Swarm is a decentralized data storage and distribution protocol that enables developers to build...
Tokens:189,400
Snippets:1,373
Trust Score:5.5
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install Bee Node using wget

Source: https://docs.ethswarm.org/docs/bee/installation/quick-start

Installs a specific version of the Bee node using the provided shell script via wget. This command downloads the script and executes it, providing an alternative to curl for automated setup.

```bash
wget -q -O - https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.6.0 bash  
```

--------------------------------

### Install Bee Node using curl

Source: https://docs.ethswarm.org/docs/bee/installation/quick-start

Installs a specific version of the Bee node using the provided shell script via curl. This command downloads the script and executes it, allowing for automated setup of a light node.

```bash
curl -s https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.6.0 bash  
```

--------------------------------

### Get Bee Node Help Information

Source: https://docs.ethswarm.org/docs/bee/installation/shell-script-install

This snippet illustrates how to access built-in help documentation for the Bee CLI. Running the 'bee' command provides entry points, while 'bee start -h' or 'bee --help' display configuration options and command-line arguments for the Bee node.

```shell
bee start -h
```

```shell
bee --help
```

--------------------------------

### Start Bee with Custom Configuration

Source: https://docs.ethswarm.org/docs/bee/working-with-bee/configuration

Example of starting the Bee node using the `bee start` command with a specific configuration file. The `--config` flag points to the YAML file containing the node's settings.

```bash
bee start --config $HOME/.bee.yaml
```

--------------------------------

### Verify Swarm-CLI Installation

Source: https://docs.ethswarm.org/docs/bee/installation/quick-start

Checks the installed version of the Swarm CLI. This command verifies that the swarm-cli has been successfully installed and is ready for use.

```bash
swarm-cli --version  
```

--------------------------------

### Installing Node.js Dependencies

Source: https://docs.ethswarm.org/docs/develop/manifests

Command to install the necessary Node.js dependencies for the example scripts, as defined in the 'package.json' file.

```bash
npm install
```

--------------------------------

### Verify Bee Installation

Source: https://docs.ethswarm.org/docs/bee/installation/quick-start

Checks the installed version of the Bee node. This command is used after the installation script has completed to ensure that Bee has been successfully installed and is accessible from the command line.

```bash
bee version  
```

--------------------------------

### Install Swarm-CLI using npm

Source: https://docs.ethswarm.org/docs/bee/installation/quick-start

Installs the Swarm CLI (Command Line Interface) globally using npm. This tool is essential for interacting with the Swarm network, including finding node addresses and initializing the node.

```bash
npm install --global @ethersphere/swarm-cli  
```

--------------------------------

### Start Swarm Full Node with Configuration

Source: https://docs.ethswarm.org/docs/bee/installation/shell-script-install

This command starts the Swarm 'bee' process as a full node. It requires initial token funding and specifies parameters like password, API address, and the blockchain RPC endpoint. The node will enable swap functionality and connect to the specified blockchain RPC.

```bash
bee start \
  --password flummoxedgranitecarrot \
  --full-node \
  --swap-enable \
  --api-addr 127.0.0.1:1633 \
  --blockchain-rpc-endpoint https://xdai.fairdatasociety.org
```

--------------------------------

### Configure Full Node via Command-Line

Source: https://docs.ethswarm.org/docs/bee/working-with-bee/configuration

Example command to start a Bee node configured as a full node using command-line arguments. It specifies password, enables full node functionality, swap, and a blockchain RPC endpoint.

```bash
bee start \
  --password mypassword \
  --full-node \
  --swap-enable \
  --blockchain-rpc-endpoint https://xdai.fairdatasociety.org
```

--------------------------------

### Get Welcome Message API - 200 OK Response Example

Source: https://docs.ethswarm.org/api

Example response for the GET /welcome-message endpoint, returning the configured P2P welcome message of the Swarm node.

```json
{
  "welcomeMessage": "string"
}
```

--------------------------------

### Start Ethereum Swarm Node with Docker

Source: https://docs.ethswarm.org/docs/bee/installation/docker

This command starts a previously created Docker container named 'bee-1'. Ensure that your node has sufficient xDAI for smart contract transactions before executing this command. This step is crucial for the node to issue required transactions and sync data.

```bash
docker start bee-1  

```

--------------------------------

### Install Bee Node using Shell Script with Wget

Source: https://docs.ethswarm.org/docs/bee/installation/shell-script-install

This command downloads and executes the Swarm Bee installation script using wget. It also allows specifying the Bee version via the TAG environment variable. Ensure wget is installed on your system.

```shell
wget -q -O - https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.6.0 bash
```

--------------------------------

### Monitor Bee Node Process with bashtop

Source: https://docs.ethswarm.org/docs/bee/installation/shell-script-install

This snippet shows how to launch the 'bashtop' command-line tool to monitor system processes, specifically filtering for the Bee node process. 'bashtop' needs to be installed separately. Users can interact with the tool to view process information and terminate the process.

```shell
bashtop  
```

--------------------------------

### Swarm Node Status Output (Initial)

Source: https://docs.ethswarm.org/docs/bee/installation/quick-start

An example output of the `swarm-cli status` command during the initial sync phase. It shows the API and version, but the Chainsync and Topology sections may indicate ongoing synchronization or initial errors.

```text
Bee  
API: http://localhost:1633 [OK]  
Version: 2.6.0-d0aa8b93  
Mode: light  
  
Chainsync  
Block: 39,566,742 / 41,710,807 (Δ 2,144,065)  
  
Topology  
ERROR Request failed with status code 503  
  
There may be additional information in the Bee logs.  

```

--------------------------------

### Start Swarm Bee Node (Linux)

Source: https://docs.ethswarm.org/docs/bee/installation/package-manager-install

Starts the Swarm Bee node service using systemctl on Linux systems. This command requires superuser privileges. It initiates the node process, allowing it to connect to the Swarm network and perform its functions.

```bash
sudo systemctl start bee
```

--------------------------------

### GET /websites/ethswarm/readiness

Source: https://docs.ethswarm.org/redocusaurus/plugin-redoc-0

Determines if the node is ready to start accepting traffic. This endpoint indicates the readiness state of the node.

```APIDOC
## GET /websites/ethswarm/readiness

### Description
Readiness endpoint indicates if node is ready to start accepting traffic.

### Method
GET

### Endpoint
/websites/ethswarm/readiness

### Responses
#### Success Response (200)
- Description: Indicates that node is ready

#### Error Response (400)
- Description: Indicates that node is not ready

#### Error Responses
- **Default**: Default response
```

--------------------------------

### Swarm Node Status Output (Fully Synced)

Source: https://docs.ethswarm.org/docs/bee/installation/quick-start

An example of the `swarm-cli status` output after the Swarm node has fully synchronized with the Gnosis Chain. It displays updated block information, connected peers, population, depth, and wallet/chequebook balances.

```text
Bee  
API: http://localhost:1633 [OK]  
Version: 2.6.0-d0aa8b93  
Mode: light  
  
Chainsync  
Block: 41,710,955 / 41,710,962 (Δ 7)  
  
Topology  
Connected Peers: 151  
Population: 2257  
Depth: 10  
  
Wallet  
xBZZ: 0.0000000000000000  
xDAI: 0.009787142484816165  
  
Chequebook  
Available xBZZ: 0.0000000000000000  
Total xBZZ: 0.0000000000000000  

```

--------------------------------

### Swarm Node Status Output (Chainsync Example)

Source: https://docs.ethswarm.org/docs/bee/installation/quick-start

A specific display of the 'Chainsync' section from the `swarm-cli status` output, illustrating the current block progress against the total blocks on the Gnosis Chain.

```text
Chainsync  
Block: 33,515,656 / 38,855,407 (Δ 5,339,751)  

```

--------------------------------

### Stake xBZZ for Storage Incentives

Source: https://docs.ethswarm.org/docs/bee/installation/package-manager-install

This command initiates a transaction to deposit a specified amount of xBZZ (10^18 wei in this example) into the staking contract via the Bee node's API. This is necessary for full nodes to receive rewards for providing storage capacity.

```bash
curl -X POST localhost:1633/stake/100000000000000000
```

--------------------------------

### Install Bee Client via Homebrew (MacOS)

Source: https://docs.ethswarm.org/docs/bee/installation/package-manager-install

Installs the Bee client on macOS using Homebrew. This involves tapping the Ethersphere repository and then installing the 'swarm-bee' package. Homebrew handles the configuration for running Bee as a background service.

```shell
brew tap ethersphere/tap
brew install swarm-bee

```

--------------------------------

### Install Bee Client via YUM (RPM)

Source: https://docs.ethswarm.org/docs/bee/installation/package-manager-install

Installs the Bee client on RPM-based systems using YUM. This process includes setting up the Ethersphere repository configuration and then installing the 'bee' package. This method also configures Bee to run as a background service.

```shell
echo "[ethersphere]
name=Ethersphere Repo
baseurl=https://repo.ethswarm.org/yum/
enabled=1
gpgcheck=0" | sudo tee /etc/yum.repos.d/ethersphere.repo

```

```shell
yum install bee

```

--------------------------------

### Get Node Status

Source: https://docs.ethswarm.org/docs/bee/installation/shell-script-install

Retrieves the current status of the Bee node, including sync progress, connected peers, and network information.

```APIDOC
## GET /status

### Description
Retrieves the current status of the Bee node, including sync progress, connected peers, and network information.

### Method
GET

### Endpoint
`/status`

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **overlay** (string) - The overlay address of the node.
- **proximity** (integer) - The proximity of the node.
- **beeMode** (string) - The operating mode of the Bee node (e.g., "full").
- **reserveSize** (integer) - The current size of the node's reserve.
- **reserveSizeWithinRadius** (integer) - The reserve size within the node's radius.
- **pullsyncRate** (number) - The rate at which the node is syncing chunks.
- **storageRadius** (integer) - The storage radius of the node.
- **connectedPeers** (integer) - The number of connected peers.
- **neighborhoodSize** (integer) - The size of the node's neighborhood.
- **batchCommitment** (integer) - The batch commitment value.
- **isReachable** (boolean) - Indicates if the node is reachable.
- **lastSyncedBlock** (integer) - The last block synced by the node.

#### Response Example
```json
{
  "overlay": "22dc155fe072e131449ec7ea2f77de16f4735f06257ebaa5daf2fdcf14267fd9",
  "proximity": 256,
  "beeMode": "full",
  "reserveSize": 686217,
  "reserveSizeWithinRadius": 321888,
  "pullsyncRate": 497.8747754074074,
  "storageRadius": 11,
  "connectedPeers": 148,
  "neighborhoodSize": 4,
  "batchCommitment": 74510761984,
  "isReachable": false,
  "lastSyncedBlock": 36172390
}
```
```

--------------------------------

### Initialize Writer Node Project with npm

Source: https://docs.ethswarm.org/docs/develop/tools-and-features/gsoc

Initializes a new Node.js project for a writer node. It creates a directory, sets up package.json with 'type': 'module', and installs the 'bee-js' library. Ensure Node.js and npm are installed.

```bash
mkdir writer-node
cd writer-node
npm init -y && npm pkg set type="module" && cat package.json
npm install bee-js --save
```

--------------------------------

### Navigating to the Manifests Directory

Source: https://docs.ethswarm.org/docs/develop/manifests

Command to change the current directory to the '/manifests' folder within the cloned 'examples' repository.

```bash
cd examples/manifests/
```

--------------------------------

### Start Bee Node in Background with Staking Enabled

Source: https://docs.ethswarm.org/docs/bee/installation/shell-script-install

This command starts the Bee node with specific configurations including a password, enabling full-node mode, enabling swap functionality, setting the API address, and connecting to a blockchain RPC endpoint. The `nohup` command ensures the process continues running after the terminal is closed, output is redirected to `bee.log`, and `&` runs the process in the background.

```shell
nohup bee start \
  --password flummoxedgranitecarrot \
  --full-node \
  --swap-enable \
  --api-addr 127.0.0.1:1633 \
  --blockchain-rpc-endpoint https://xdai.fairdatasociety.org > bee.log 2>&1 &
```

--------------------------------

### Verify Bee Installation

Source: https://docs.ethswarm.org/docs/bee/installation/shell-script-install

This command checks if the Bee installation was successful by running the 'bee' executable. A successful execution will display the Bee version and available commands.

```shell
bee
```

--------------------------------

### Initialize Service Node Project with bee-js

Source: https://docs.ethswarm.org/docs/develop/tools-and-features/gsoc

Initializes a new Node.js project for a service node, sets it to use ES modules, and installs the bee-js library. This is the first step in setting up a service node to listen for GSOC messages.

```bash
mkdir service-node
cd service-node
npm init -y && npm pkg set type="module" && cat package.json
npm install bee-js --save
```

--------------------------------

### Start Swarm Bee Node (macOS)

Source: https://docs.ethswarm.org/docs/bee/installation/package-manager-install

Starts the Swarm Bee node service using Homebrew services on macOS. This command registers and runs the Bee node as a background service. Ensure Homebrew is installed and the swarm-bee formula is available.

```bash
brew services start swarm-bee
```

--------------------------------

### Cloning the Swarm Examples Repository

Source: https://docs.ethswarm.org/docs/develop/manifests

Command to clone the 'ethersphere/examples' repository, which contains example scripts for managing Swarm manifests.

```bash
git clone git@github.com:ethersphere/examples.git
```

--------------------------------

### Start Bee Node using Docker

Source: https://docs.ethswarm.org/docs/bee/installation/docker

This command initiates a Bee node using Docker. It maps ports, sets environment variables for node configuration (API address, full node status, swap enablement, password, blockchain RPC endpoint), and mounts a volume for data persistence. It's recommended to use specific image version tags and secure the API endpoint.

```docker
docker run -d --name bee-1 \
  --restart always \
  -p 127.0.0.1:1633:1633 \
  -p 1634:1634 \
  -e BEE_API_ADDR=":1633" \
  -e BEE_FULL_NODE="true" \
  -e BEE_SWAP_ENABLE="true" \
  -e BEE_PASSWORD="flummoxedgranitecarrot" \
  -e BEE_BLOCKCHAIN_RPC_ENDPOINT="https://xdai.fairdatasociety.org" \
  -v bee-1:/home/bee/.bee \
  ethersphere/bee:2.6.0 start  

```

```docker
docker run -d --name bee-1 --restart always -p 127.0.0.1:1633:1633 -p 1634:1634 -e BEE_API_ADDR=":1633" -e BEE_FULL_NODE="true" -e BEE_SWAP_ENABLE="true" -e BEE_PASSWORD="flummoxedgranitecarrot" -e BEE_BLOCKCHAIN_RPC_ENDPOINT="https://xdai.fairdatasociety.org" -v bee-1:/home/bee/.bee ethersphere/bee:2.6.0 start  

```

--------------------------------

### Get Topology API - 200 OK Response Example

Source: https://docs.ethswarm.org/api

Provides an example of the JSON response when successfully retrieving the network topology using the GET /topology endpoint. It includes details about the node's base address, population, connected peers, and detailed metrics for each bin.

```json
{
  "baseAddr": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
  "population": 0,
  "connected": 0,
  "timestamp": "string",
  "nnLowWatermark": 0,
  "depth": 0,
  "reachability": "Unknown",
  "networkAvailability": "Unknown",
  "bins": {
    "property1": {
      "population": 0,
      "connected": 0,
      "disconnectedPeers": [
        {
          "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
          "metrics": {
            "lastSeenTimestamp": 0,
            "sessionConnectionRetry": 0,
            "connectionTotalDuration": 0,
            "sessionConnectionDuration": 0,
            "sessionConnectionDirection": "string",
            "latencyEWMA": 0,
            "reachability": "string",
            "healthy": true
          }
        }
      ],
      "connectedPeers": [
        {
          "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
          "metrics": {
            "lastSeenTimestamp": 0,
            "sessionConnectionRetry": 0,
            "connectionTotalDuration": 0,
            "sessionConnectionDuration": 0,
            "sessionConnectionDirection": "string",
            "latencyEWMA": 0,
            "reachability": "string",
            "healthy": true
          }
        }
      ]
    },
    "property2": {
      "population": 0,
      "connected": 0,
      "disconnectedPeers": [
        {
          "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
          "metrics": {
            "lastSeenTimestamp": 0,
            "sessionConnectionRetry": 0,
            "connectionTotalDuration": 0,
            "sessionConnectionDuration": 0,
            "sessionConnectionDirection": "string",
            "latencyEWMA": 0,
            "reachability": "string",
            "healthy": true
          }
        }
      ],
      "connectedPeers": [
        {
          "address": "36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f",
          "metrics": {
            "lastSeenTimestamp": 0,
            "sessionConnectionRetry": 0,
            "connectionTotalDuration": 0,
            "sessionConnectionDuration": 0,
            "sessionConnectionDirection": "string",
            "latencyEWMA": 0,
            "reachability": "string",
            "healthy": true
          }
        }
      ]
    }
  }
}
```

--------------------------------

### Full Node YAML Configuration

Source: https://docs.ethswarm.org/docs/bee/working-with-bee/configuration

Example YAML configuration snippet for setting up a full Bee node. This includes enabling full node, swap, and specifying a blockchain RPC endpoint.

```yaml
full-node: true
swap-enable: true
blockchain-rpc-endpoint: "https://xdai.fairdatasociety.org"
```

--------------------------------

### Install Bee Node using Shell Script with Curl

Source: https://docs.ethswarm.org/docs/bee/installation/shell-script-install

This command downloads and executes the Swarm Bee installation script using curl. It allows specifying the Bee version using the TAG environment variable. Ensure curl is installed on your system.

```shell
curl -s https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.6.0 bash
```

--------------------------------

### Access Bee CLI Help Documentation

Source: https://docs.ethswarm.org/docs/bee/installation/docker

Displays the built-in help documentation for the Bee command-line interface. This can be used to understand available commands and configuration options.

```bash
bee --help
```

```bash
bee start --help
```

--------------------------------

### Install bee-js SDK

Source: https://docs.ethswarm.org/docs/develop/host-your-website

Installs the @ethersphere/bee-js library, which is required for interacting with Swarm nodes programmatically.

```bash
npm install @ethersphere/bee-js  

```

--------------------------------

### Readiness Endpoint - 200 OK Response Example

Source: https://docs.ethswarm.org/api

Example of a successful response (HTTP 200) from the GET /readiness endpoint, indicating that the Swarm node is ready to accept traffic.

```json
OK.
```

--------------------------------

### Install Bee Client via APT (Debian/Ubuntu)

Source: https://docs.ethswarm.org/docs/bee/installation/package-manager-install

Installs the Bee client on Debian-based systems using APT. This involves fetching the GPG key, configuring the APT repository, updating the package list, and finally installing the 'bee' package. Bee will be configured to run as a background service.

```shell
curl -fsSL https://repo.ethswarm.org/apt/gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/ethersphere-apt-keyring.gpg

```

```shell
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/ethersphere-apt-keyring.gpg] https://repo.ethswarm.org/apt \
  * *" | sudo tee /etc/apt/sources.list.d/ethersphere.list > /dev/null

```

```shell
sudo apt-get update
sudo apt-get install bee

```

--------------------------------

### GET /readiness - Readiness endpoint

Source: https://docs.ethswarm.org/api

Indicates if the node is ready to start accepting traffic.

```APIDOC
## GET /readiness

### Description
Indicates if the node is ready to start accepting traffic.

### Method
GET

### Endpoint
`/v1/readiness`

### Responses
#### Success Response (200)
OK.

#### Error Response (400)
Bad request.
- **message** (string) - Error message.
- **code** (integer) - Error code.
```

--------------------------------

### Generate Protobuf

Source: https://docs.ethswarm.org/docs/develop/contribute/introduction

Automates the process of installing `protoc-gen-gogofaster` and generating Go code from protocol buffer files using the Makefile.

```APIDOC
## Makefile Rule: protobuf

### Description
This Makefile rule automates the installation of the `protoc-gen-gogofaster` plugin and the subsequent generation of Go code from `.proto` files.

### Method
Command Line

### Endpoint
N/A

### Parameters
None

### Request Example
```bash
make protobuf
```

### Response
#### Success Response
Go code files are generated in the appropriate directories.

#### Response Example
```json
{
  "example": "Output indicating successful installation and code generation."
}
```
```

--------------------------------

### Get Connected Peers

Source: https://docs.ethswarm.org/docs/develop/tools-and-features/starting-a-test-network

Retrieves a list of peers that the current node is connected to.

```APIDOC
## GET /peers

### Description
Retrieves a list of peers that the current node is connected to.

### Method
GET

### Endpoint
/peers

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
```bash
curl -s http://localhost:1633/peers | jq
```

### Response
#### Success Response (200)
- **peers** (array) - A list of connected peer information.

#### Response Example
(Response will vary based on connected peers)
```

--------------------------------

### Create bee.yaml on Linux

Source: https://docs.ethswarm.org/docs/bee/installation/package-manager-install

Creates a new bee.yaml configuration file at the default Linux path (/etc/bee/) using `touch` and then opens it for editing with `vi`. This is a fallback if the configuration file is missing.

```shell
sudo touch /etc/bee/bee.yaml
sudo vi /etc/bee/bee.yaml
```

--------------------------------

### Example Deployment Workflow: Vite Build Command

Source: https://docs.ethswarm.org/docs/develop/dynamic-content

The initial step in a typical deployment workflow for a dynamic SPA on Swarm, involving building the Vite project to generate static assets.

```bash
npm run build

```

--------------------------------

### Get Node Addresses

Source: https://docs.ethswarm.org/docs/develop/tools-and-features/starting-a-test-network

Retrieves the network addresses of a Swarm node, including overlay, underlay, and Ethereum addresses.

```APIDOC
## GET /addresses

### Description
Retrieves the network addresses of a Swarm node, including overlay, underlay, and Ethereum addresses.

### Method
GET

### Endpoint
/addresses

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
```bash
curl localhost:1633/addresses | jq
```

### Response
#### Success Response (200)
- **overlay** (string) - The overlay address of the node.
- **underlay** (array) - A list of multiaddresses representing the physical network addresses of the node.
- **ethereum** (string) - The Ethereum address of the node.
- **publicKey** (string) - The public key of the node.
- **pssPublicKey** (string) - The PSS public key of the node.

#### Response Example
```json
{
  "overlay": "b1978be389998e8c8596ef3c3a54214e2d4db764898ec17ec1ad5f19cdf7cc59",
  "underlay": [
    "/ip4/127.0.0.1/tcp/1634/p2p/QmQHgcpizgoybDtrQXCWRSGdTP526ufeMFn1PyeGd1zMEZ",
    "/ip4/172.25.128.69/tcp/1634/p2p/QmQHgcpizgoybDtrQXCWRSGdTP526ufeMFn1PyeGd1zMEZ",
    "/ip6/::1/tcp/1634/p2p/QmQHgcpizgoybDtrQXCWRSGdTP526ufeMFn1PyeGd1zMEZ"
  ],
  "ethereum": "0xd22cc790e2aef341827e1e49cc631d2a16898cd9",
  "publicKey": "023b26ce8b78ed8cdb07f3af3d284c95bee5e038e7c5d0c397b8a5e33424f5d790",
  "pssPublicKey": "039ceb9c1f0afedf79991d86d89ccf4e96511cf656b43971dc3e878173f7462487"
}
```
```

--------------------------------

### Light Node YAML Configuration

Source: https://docs.ethswarm.org/docs/bee/working-with-bee/configuration

Example YAML configuration snippet for setting up a light Bee node. This disables full node functionality but keeps swap enabled, requiring a blockchain RPC endpoint.

```yaml
full-node: false
swap-enable: true
blockchain-rpc-endpoint: "https://xdai.fairdatasociety.org"
```

--------------------------------

### Stake Node

Source: https://docs.ethswarm.org/docs/bee/installation/shell-script-install

Stakes a specified amount of xBZZ to the node. This operation is essential for enabling staking features and earning rewards.

```APIDOC
## POST /stake/{amount}

### Description
Stakes a specified amount of xBZZ to the node. The amount should be provided in PLUR units (1 PLUR = 1e-16 xBZZ).

### Method
POST

### Endpoint
`/stake/{amount}`

### Parameters
#### Path Parameters
- **amount** (string) - Required - The amount of xBZZ to stake, in PLUR units.

### Request Example
```bash
curl -XPOST localhost:1633/stake/100000000000000000
```

### Response
#### Success Response (200)
- **txHash** (string) - The transaction hash of the staking operation.

#### Response Example
```json
{
  "txHash": "0x258d64720fe7abade794f14ef3261534ff823ef3e2e0011c431c31aea75c2dd5"
}
```
```

```APIDOC
## GET /stake

### Description
Retrieves the currently staked amount for the node.

### Method
GET

### Endpoint
`/stake`

### Parameters
None

### Request Example
```bash
curl localhost:1633/stake
```

### Response
#### Success Response (200)
- **stakedAmount** (string) - The total amount staked in PLUR units.

#### Response Example
```json
{
  "stakedAmount": "100000000000000000"
}
```
```

--------------------------------

### Set Welcome Message API - 200 OK Response Example

Source: https://docs.ethswarm.org/api

Example successful response (HTTP 200) after setting the P2P welcome message. It confirms the operation and provides version information.

```json
{
  "status": "ok",
  "version": "string",
  "apiVersion": "0.0.0"
}
```

--------------------------------

### Get Connected Peers

Source: https://docs.ethswarm.org/docs/bee/installation/package-manager-install

Retrieve the list of connected peers to your Bee node. This helps in understanding your node's connectivity within the Swarm network.

```APIDOC
## Get Connected Peers

### Description
This endpoint retrieves the number of peers your Bee node is connected to.

### Method
GET

### Endpoint
`localhost:1633/peers`

### Parameters
None

### Request Example
```bash
curl -s localhost:1633/peers | jq ".peers | length"
```

### Response
#### Success Response (200)
- **integer** - The count of connected peers.

#### Response Example
```json
87
```
```

--------------------------------

### Swarm Bee Node Startup Output and Warnings

Source: https://docs.ethswarm.org/docs/bee/installation/package-manager-install

Illustrates typical output and log messages during the startup of a Swarm Bee node. It highlights essential information like version, network addresses, and potential warnings, such as the need for sufficient xDAI to deploy the chequebook contract for bandwidth incentives.

```log
"time"="2024-09-24 18:15:34.428546" "level"="info" "logger"="node" "msg"="swarm public key" "public_key"="0373fe2ab33ab836635fc35864cf708fa0f4a775c0cf76ca851551e7787b58d040"
"time"="2024-09-24 18:15:34.520716" "level"="info" "logger"="node" "msg"="using ethereum address" "address"="0x1A801dd3ec955E905ca424a85C3423599bfb0E66"
"time"="2024-09-24 18:15:38.160249" "level"="info" "logger"="node/chequebook" "msg"="no chequebook found, deploying new one."
"time"="2024-09-24 18:15:38.728534" "level"="warning" "logger"="node/chequebook" "msg"="cannot continue until there is at least min xDAI (for Gas) available on address" "min_amount"="0.0003750000017" "address"="0x1A801dd3ec955E905ca424a85C3423599bfb0E66"
```
Tokens:
Raw