Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/bee/installation/build-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Prerequisites for installing directly from source are:
3. Checkout the required version:

```bash
git checkout v2.6.0
git checkout v2.8.0
```

4. Build the binary:
Expand All @@ -48,7 +48,7 @@ Prerequisites for installing directly from source are:
```

```
2.6.0
2.8.0
```

6. (optional) Additionally, you may also like to move the Bee binary to somewhere in your `$PATH`
Expand Down
14 changes: 7 additions & 7 deletions docs/bee/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: Provides comprehensive steps for deploying Bee nodes using Docker c
The following is a guide for installing a Bee node using Docker. Docker images for Bee are hosted at [Docker Hub](https://hub.docker.com/r/ethersphere/bee). Using Docker to operate your Bee node offers many benefits, such as ease of deployment and consistency across environments.

:::caution
In the examples below we specify the exact image version as 2.6.0. It's recommended to only use the exact version number tags. Make sure to check that you're on the latest version of Bee by reviewing the tags for Bee on [Docker Hub](https://hub.docker.com/r/ethersphere/bee/tags), and replace 2.6.0 in the commands below if there is a newer full release.
In the examples below we specify the exact image version as 2.8.0. It's recommended to only use the exact version number tags. Make sure to check that you're on the latest version of Bee by reviewing the tags for Bee on [Docker Hub](https://hub.docker.com/r/ethersphere/bee/tags), and replace 2.8.0 in the commands below if there is a newer full release.
:::

:::warning
Expand Down Expand Up @@ -39,13 +39,13 @@ docker run -d --name bee-1 \
-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
ethersphere/bee:2.8.0 start
```

Here is the same command in a single line in case you run into issues with the line breaks in the command above:

```bash
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 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.8.0 start
```

#### Command explained:
Expand All @@ -61,7 +61,7 @@ docker run -d --name bee-1 --restart always -p 127.0.0.1:1633:1633 -p 1634:1634
- **`-e BEE_PASSWORD="flummoxedgranitecarrot"`**: Sets the keystore password, make sure to replace with your own.
- **`-e BEE_BLOCKCHAIN_RPC_ENDPOINT="https://xdai.fairdatasociety.org"`**: Connects to the Gnosis Chain.
- **`-v bee-1:/home/bee/.bee`**: Persists node data in the `bee-1` volume.
- **`ethersphere/bee:2.6.0 start`**: Runs Bee version 2.6.0 and starts the node.
- **`ethersphere/bee:2.8.0 start`**: Runs Bee version 2.8.0 and starts the node.

This setup runs the Bee node in a container, with full node functionality, SWAP enabled, and connections to the Gnosis blockchain for chequebook and postage stamp management, while persisting its data using a volume.

Expand All @@ -77,7 +77,7 @@ If everything is set up correctly, you should see your Bee node listed:

```bash
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
37f4ad8b4060 ethersphere/bee:2.6.0 "bee start" 6 seconds ago Up 5 seconds 127.0.0.1:1633->1633/tcp, 0.0.0.0:1634->1634/tcp, :::1634->1634/tcp bee-1
37f4ad8b4060 ethersphere/bee:2.8.0 "bee start" 6 seconds ago Up 5 seconds 127.0.0.1:1633->1633/tcp, 0.0.0.0:1634->1634/tcp, :::1634->1634/tcp bee-1
```

And check the logs:
Expand Down Expand Up @@ -170,9 +170,9 @@ damage to hardware or loss of funds associated with the Ethereum account connect
No developers or entity involved will be liable for any claims and damages associated with your use,
inability to use, or your interaction with other nodes or the software.

version: 2.6.0-06a0aca7 - planned to be supported until 11 December 2024, please follow https://ethswarm.org/
version: 2.8.0-06a0aca7 - planned to be supported until 11 December 2024, please follow https://ethswarm.org/

"time"="2024-09-24 22:21:04.543661" "level"="info" "logger"="node" "msg"="bee version" "version"="2.6.0-06a0aca7"
"time"="2024-09-24 22:21:04.543661" "level"="info" "logger"="node" "msg"="bee version" "version"="2.8.0-06a0aca7"
"time"="2024-09-24 22:21:04.590823" "level"="info" "logger"="node" "msg"="swarm public key" "public_key"="02f0e59eafa3c5c06542c0a7a7fe9579c55a163cf1d28d9f6945a34469f88d1b2a"
"time"="2024-09-24 22:21:04.686430" "level"="info" "logger"="node" "msg"="pss public key" "public_key"="02ea739530bbf48eed49197f21660f3b6564709b95bf558dc3b472688c34096418"
"time"="2024-09-24 22:21:04.686464" "level"="info" "logger"="node" "msg"="using ethereum address" "address"="0x8288F1c8e3dE7c3bf42Ae67fa840EC61481D085e"
Expand Down
14 changes: 7 additions & 7 deletions docs/bee/installation/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@ Run the shell script using `curl` or `wget`:


:::tip
We specify `TAG=v2.6.0` to indicate which Bee version to install. You can find available versions in the ["releases" section](https://github.com/ethersphere/bee/releases) of the Bee GitHub repo.
We specify `TAG=v2.8.0` to indicate which Bee version to install. You can find available versions in the ["releases" section](https://github.com/ethersphere/bee/releases) of the Bee GitHub repo.
:::

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

OR

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

Verify installation:
Expand Down Expand Up @@ -109,7 +109,7 @@ damage to hardware or loss of funds associated with the Ethereum account connect
No developers or entity involved will be liable for any claims and damages associated with your use,
inability to use, or your interaction with other nodes or the software.

version: 2.6.0-390a402e - planned to be supported until 22 April 2025, please follow https://ethswarm.org/
version: 2.8.0-390a402e - planned to be supported until 22 April 2025, please follow https://ethswarm.org/

"time"="2025-03-04 11:13:10.113050" "level"="info" "logger"="node" "msg"="bee version" "version"="2.6.0-390a402e"
"time"="2025-03-04 11:13:10.164801" "level"="info" "logger"="node" "msg"="swarm public key" "public_key"="02b19880b8d024eac3bf8afa3fa85b31b72fcfd491cebc6af78ddd85ff97f65416"
Expand Down Expand Up @@ -184,7 +184,7 @@ swarm-cli status
```bash
Bee
API: http://localhost:1633 [OK]
Version: 2.6.0-d0aa8b93
Version: 2.8.0-d0aa8b93
Mode: light

Chainsync
Expand Down Expand Up @@ -214,7 +214,7 @@ swarm-cli status
```bash
Bee
API: http://localhost:1633 [OK]
Version: 2.6.0-d0aa8b93
Version: 2.8.0-d0aa8b93
Mode: light

Chainsync
Expand All @@ -235,7 +235,7 @@ Total xBZZ: 0.0000000000000000
noah@NoahM16:~$ swarm-cli status
Bee
API: http://localhost:1633 [OK]
Version: 2.6.0-d0aa8b93
Version: 2.8.0-d0aa8b93
Mode: light

Chainsync
Expand Down
6 changes: 3 additions & 3 deletions docs/bee/installation/shell-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Below is a step-by-step guide for installing and setting up your Bee node using
Run the install shell script using either `curl` or `wget`:

:::caution
In the example below, the version is specified using `TAG=v2.6.0`. Check the [latest Bee releases](https://github.com/ethersphere/bee/tags) and if needed, update the command to install the most recent version (note that in tags containing "rc," the abbreviation stands for "release candidate", and these versions should be used for testing purposes only).
In the example below, the version is specified using `TAG=v2.8.0`. Check the [latest Bee releases](https://github.com/ethersphere/bee/tags) and if needed, update the command to install the most recent version (note that in tags containing "rc," the abbreviation stands for "release candidate", and these versions should be used for testing purposes only).
:::

:::info
Expand Down Expand Up @@ -61,15 +61,15 @@ values={[
<TabItem value="curl">

```bash
curl -s https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.6.0 bash
curl -s https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v2.8.0 bash
```
</TabItem>
<TabItem value="wget">

**wget**

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

Expand Down
2 changes: 1 addition & 1 deletion docs/bee/working-with-bee/bee-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -548,7 +548,7 @@ The `/health` endpoint provides a quick status check for your Bee node which sim
```bash
{
"status": "ok",
"version": "2.6.0-d0aa8b93",
"version": "2.8.0-d0aa8b93",
"apiVersion": "7.3.0"
}
```
Expand Down
39 changes: 39 additions & 0 deletions docs/bee/working-with-bee/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ Flags:
--cache-capacity uint cache capacity in chunks, multiply by 4096 to get approximate capacity in bytes (default 1000000)
--cache-retrieval enable forwarded content caching (default true)
--chequebook-enable enable chequebook (default true)
--chequebook-min-balance string minimum chequebook balance required for incoming full-node peers in BZZ (default "11")
--chequebook-verification enable chequebook verification for incoming full-node peers (default false)
--cors-allowed-origins strings origins with CORS headers enabled
--data-dir string data directory (default "/home/bee/.bee")
--db-block-cache-capacity uint size of block cache of the database in bytes (default 33554432)
Expand Down Expand Up @@ -178,6 +180,10 @@ cache-capacity: "1000000"
cache-retrieval: true
# enable chequebook
chequebook-enable: true
# minimum chequebook balance required for incoming full-node peers in BZZ
chequebook-min-balance: "11"
# enable chequebook verification for incoming full-node peers
chequebook-verification: false
# config file (default is $HOME/.bee.yaml)
config: /home/bee/.bee.yaml
# origins with CORS headers enabled
Expand Down Expand Up @@ -582,6 +588,39 @@ For running a light node or for testing out a single full node you can use the f

When running your Bee node with SWAP enabled for the first time, your node will deploy a 'chequebook' contract using the canonical factory contract which is deployed by Swarm. Once the chequebook is deployed, Bee will (optionally) deposit a certain amount of xBZZ in the chequebook contract so that it can pay other nodes in return for their services. The amount of xBZZ transferred to the chequebook is set by the `swap-initial-deposit` configuration setting (it may be left at the default value of zero or commented out).

## Chequebook Verification (Optional)

Full node operators can optionally require that incoming peer connections come from nodes that maintain a minimum chequebook balance. When enabled, the node checks the chequebook balance of each incoming full-node peer and rejects connections from peers whose balance falls below the configured threshold.

This feature is **disabled by default** and only applies to full nodes with chequebook and chain functionality enabled. Light nodes skip chequebook verification regardless of configuration. Remote peers do not need to enable chequebook verification themselves in order to be accepted — only the verifying node needs to have it enabled.

To enable chequebook verification, set `chequebook-verification` to `true`:

```yaml
## bee.yaml
chequebook-verification: true
```

The default minimum balance threshold is **11 BZZ**. To configure a different threshold, set `chequebook-min-balance` to the desired amount in BZZ:

```yaml
## bee.yaml
chequebook-verification: true
chequebook-min-balance: "11"
```

Or using command-line flags:

```bash
bee start \
--chequebook-verification \
--chequebook-min-balance 11
```

:::info
Chequebook verification is an optional defense layer for full node operators who want to avoid connecting to peers that do not maintain a sufficient chequebook balance. It was introduced in Bee v2.8.0.
:::

## NAT address

Swarm is all about sharing and storing chunks of data. To enable other Bees (also known as _peers_) to connect to your Bee, you must
Expand Down
10 changes: 8 additions & 2 deletions docs/bee/working-with-bee/staking.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,12 @@ Stake density determines the weighted chances of nodes within a neighborhood of

Generally speaking, the minimum required stake of 10 xBZZ is sufficient, and rewards can be better maximized by operating more nodes over a greater range of neighborhoods rather than increasing stake. However this may not be true for all node operators depending on how many different neighborhoods they operate nodes in, and it also may change as network dynamics continue to evolve (join the `#node-operators` [Discord channel](https://discord.com/channels/799027393297514537/811553590170353685) to stay up to date with the latest discussions about staking and network dynamics).

### Chequebook verification

Full node operators can optionally enable chequebook verification to reject incoming peers whose chequebook balance falls below a configurable threshold. This can help filter out poorly funded peers from your node's connections.

Chequebook verification is disabled by default and can be enabled with the `--chequebook-verification` flag. The default minimum balance threshold is 11 BZZ and can be adjusted with `--chequebook-min-balance`. See the [configuration page](./configuration.md#chequebook-verification-optional) for details.

## Neighborhood Hopping

:::warning
Expand Down Expand Up @@ -473,12 +479,12 @@ curl -s http://localhost:1633/health | jq

To confirm a successful update, check that the value for the `"version"` field in the results corresponds to the version number of the [latest](https://github.com/ethersphere/bee/releases/latest) Bee release.

For example, if the latest version was 2.6.0, it would look like this:
For example, if the latest version was 2.8.0, it would look like this:

```bash
{
"status": "ok",
"version": "2.6.0-d0aa8b93",
"version": "2.8.0-d0aa8b93",
"apiVersion": "7.3.0"
}
```
Expand Down
Loading