Skip to content

Commit 2593da7

Browse files
committed
feat: update Bee docs for v2.8.1 changes
Signed-off-by: Yejin Kelly Joo <yejinkellyjoo@gmail.com>
1 parent fd34761 commit 2593da7

7 files changed

Lines changed: 100 additions & 29 deletions

File tree

docs/bee/installation/shell-script.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,6 @@ Usage:
9191
9292
Available Commands:
9393
start Start a Swarm node
94-
dev Start a Swarm node in development mode
9594
init Initialise a Swarm node
9695
deploy Deploy and fund the chequebook contract
9796
version Print version number

docs/bee/working-with-bee/configuration.md

Lines changed: 77 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ description: Documents all Bee configuration options available through YAML file
77
import Tabs from '@theme/Tabs';
88
import TabItem from '@theme/TabItem';
99

10-
1110
## Configuration Methods and Priority
1211

1312
There are three configuration methods, each with a different priority level. Configuration is processed in the following ascending order of preference:
@@ -22,7 +21,6 @@ All three methods may be used when running Bee using `bee start`.
2221
However when Bee is started as a service with tools like `systemctl` or `brew services`, only the YAML configuration file is supported by default.
2322
:::
2423

25-
2624
### Command Line Arguments
2725

2826
Run `bee help printconfig` in your terminal to list the available command-line arguments and config option flags:
@@ -35,7 +33,6 @@ Usage:
3533

3634
Available Commands:
3735
start Start a Swarm node
38-
dev Start in dev mode. WARNING: This command will be deprecated soon.
3936
init Initialise a Swarm node
4037
deploy Deploy and fund the chequebook contract
4138
version Print version number
@@ -62,22 +59,29 @@ Flags:
6259
--autotls-ca-endpoint string autotls certificate authority endpoint (default "https://acme-v02.api.letsencrypt.org/directory")
6360
--autotls-domain string autotls domain (default "libp2p.direct")
6461
--autotls-registration-endpoint string autotls registration endpoint (default "https://registration.libp2p.direct")
62+
--block-sync-interval uint block number cache sync interval in blocks (default 10)
6563
--block-time uint chain block time (default 5)
64+
--blockchain-rpc-dial-timeout duration blockchain rpc TCP dial timeout (default 30s)
6665
--blockchain-rpc-endpoint string rpc blockchain endpoint
66+
--blockchain-rpc-idle-timeout duration blockchain rpc idle connection timeout (default 1m30s)
67+
--blockchain-rpc-keepalive duration blockchain rpc TCP keepalive interval (default 30s)
68+
--blockchain-rpc-tls-timeout duration blockchain rpc TLS handshake timeout (default 10s)
6769
--bootnode strings initial nodes to connect to (default [/dnsaddr/mainnet.ethswarm.org])
6870
--bootnode-mode cause the node to always accept incoming connections
71+
--bzz-token-address string bzz token contract address
6972
--cache-capacity uint cache capacity in chunks, multiply by 4096 to get approximate capacity in bytes (default 1000000)
7073
--cache-retrieval enable forwarded content caching (default true)
7174
--chequebook-enable enable chequebook (default true)
72-
--chequebook-min-balance string minimum chequebook balance required for incoming full-node peers in BZZ (default "11")
73-
--chequebook-verification enable chequebook verification for incoming full-node peers (default false)
75+
--chequebook-min-balance string minimum chequebook token balance required for verification, in token small units (default 11 BZZ) (default "110000000000000000")
76+
--chequebook-verification reject full-node hive/handshake records that carry no chequebook address
7477
--cors-allowed-origins strings origins with CORS headers enabled
7578
--data-dir string data directory (default "/home/bee/.bee")
7679
--db-block-cache-capacity uint size of block cache of the database in bytes (default 33554432)
7780
--db-disable-seeks-compaction disables db compactions triggered by seeks (default true)
7881
--db-open-files-limit uint number of open files allowed by database (default 200)
7982
--db-write-buffer-size uint size of the database write buffer in bytes (default 33554432)
8083
--full-node cause the node to start in full mode
84+
--gas-limit-fallback uint gas limit fallback when estimation fails for contract transactions (default 500000)
8185
-h, --help help for printconfig
8286
--mainnet triggers connect to main net bootnodes. (default true)
8387
--minimum-gas-tip-cap uint minimum gas tip cap in wei for transactions, 0 means use suggested gas tip cap
@@ -119,7 +123,7 @@ Flags:
119123
--tracing-port string port to send tracing data
120124
--tracing-service-name string service name identifier for tracing (default "bee")
121125
--transaction-debug-mode skips the gas estimate step for contract transactions
122-
--use-postage-snapshot bootstrap node using postage snapshot from the network
126+
--use-simd-hashing use SIMD BMT hasher (available only on linux amd64 platforms)
123127
--verbosity string log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace (default "info")
124128
--warmup-time duration maximum node warmup duration; proceeds when stable or after this time (default 5m0s)
125129
--welcome-message string send a welcome message string during handshakes
@@ -158,31 +162,43 @@ bee printconfig
158162
# allow to advertise private CIDRs to the public network
159163
allow-private-cidrs: false
160164
# HTTP API listen address
161-
api-addr: 0.0.0.0:1633
165+
api-addr: 127.0.0.1:1633
162166
# autotls certificate authority endpoint
163167
autotls-ca-endpoint: https://acme-v02.api.letsencrypt.org/directory
164168
# autotls domain
165169
autotls-domain: libp2p.direct
166170
# autotls registration endpoint
167171
autotls-registration-endpoint: https://registration.libp2p.direct
172+
# block number cache sync interval in blocks
173+
block-sync-interval: "10"
168174
# chain block time
169175
block-time: "5"
176+
# blockchain rpc TCP dial timeout
177+
blockchain-rpc-dial-timeout: 30s
170178
# rpc blockchain endpoint
171-
blockchain-rpc-endpoint: https://rpc.gnosischain.com
179+
blockchain-rpc-endpoint: ""
180+
# blockchain rpc idle connection timeout
181+
blockchain-rpc-idle-timeout: 1m30s
182+
# blockchain rpc TCP keepalive interval
183+
blockchain-rpc-keepalive: 30s
184+
# blockchain rpc TLS handshake timeout
185+
blockchain-rpc-tls-timeout: 10s
172186
# initial nodes to connect to
173187
bootnode:
174188
- /dnsaddr/mainnet.ethswarm.org
175189
# cause the node to always accept incoming connections
176190
bootnode-mode: false
191+
# bzz token contract address
192+
bzz-token-address: ""
177193
# cache capacity in chunks, multiply by 4096 to get approximate capacity in bytes
178194
cache-capacity: "1000000"
179195
# enable forwarded content caching
180196
cache-retrieval: true
181197
# enable chequebook
182198
chequebook-enable: true
183-
# minimum chequebook balance required for incoming full-node peers in BZZ
184-
chequebook-min-balance: "11"
185-
# enable chequebook verification for incoming full-node peers
199+
# minimum chequebook token balance required for verification, in token small units (default 11 BZZ)
200+
chequebook-min-balance: "110000000000000000"
201+
# reject full-node hive/handshake records that carry no chequebook address
186202
chequebook-verification: false
187203
# config file (default is $HOME/.bee.yaml)
188204
config: /home/bee/.bee.yaml
@@ -199,11 +215,13 @@ db-open-files-limit: "200"
199215
# size of the database write buffer in bytes
200216
db-write-buffer-size: "33554432"
201217
# cause the node to start in full mode
202-
full-node: "true"
218+
full-node: false
219+
# gas limit fallback when estimation fails for contract transactions
220+
gas-limit-fallback: "500000"
203221
# help for printconfig
204222
help: false
205223
# triggers connect to main net bootnodes.
206-
mainnet: "true"
224+
mainnet: true
207225
# minimum gas tip cap in wei for transactions, 0 means use suggested gas tip cap
208226
minimum-gas-tip-cap: "0"
209227
# minimum radius storage threshold
@@ -225,7 +243,7 @@ p2p-wss-addr: :1635
225243
# Enable Secure WebSocket P2P connections
226244
p2p-wss-enable: false
227245
# password for decrypting keys
228-
password: 427067e9514e93613b861fef5561c6
246+
password: ""
229247
# path to a file that contains password for decrypting keys
230248
password-file: ""
231249
# percentage below the peers payment threshold when we initiate settlement
@@ -247,7 +265,7 @@ price-oracle-address: ""
247265
# redistribution contract address
248266
redistribution-address: ""
249267
# reserve capacity doubling
250-
reserve-capacity-doubling: "0"
268+
reserve-capacity-doubling: 0
251269
# ENS compatible API endpoint for a TLD and with contract address, can be repeated, format [tld:][contract-addr@]url
252270
resolver-options: []
253271
# forces the node to resync postage contract data
@@ -263,7 +281,7 @@ static-nodes: []
263281
# enable storage incentives feature
264282
storage-incentives-enable: true
265283
# enable swap
266-
swap-enable: "true"
284+
swap-enable: false
267285
# swap factory addresses
268286
swap-factory-address: ""
269287
# initial deposit if deploying a new chequebook
@@ -282,10 +300,10 @@ tracing-port: ""
282300
tracing-service-name: bee
283301
# skips the gas estimate step for contract transactions
284302
transaction-debug-mode: false
285-
# bootstrap node using postage snapshot from the network
286-
use-postage-snapshot: false
303+
# use SIMD BMT hasher (available only on linux amd64 platforms)
304+
use-simd-hashing: false
287305
# log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace
288-
verbosity: "4"
306+
verbosity: info
289307
# maximum node warmup duration; proceeds when stable or after this time
290308
warmup-time: 5m0s
291309
# send a welcome message string during handshakes
@@ -574,7 +592,6 @@ blockchain-rpc-endpoint: https://xdai.fairdatasociety.org
574592
575593
We recommend you [run your own Gnosis Chain node](https://docs.gnosischain.com/node/), but you may also consider using a paid RPC endpoint provider such as [GetBlock](https://getblock.io/).
576594
577-
578595
### RPC Providers
579596
580597
While we recommend running your own Gnosis Chain node for your RPC endpoint, you may wish to use a third party provider instead.
@@ -583,6 +600,40 @@ For a comprehensive list of RPC providers, refer to the [Gnosis Chain documentat
583600
584601
For running a light node or for testing out a single full node you can use the free RPC endpoint provided by the Fair Data Society: `https://xdai.fairdatasociety.org`.
585602
603+
### Block number sync interval
604+
605+
Bee periodically reads the current block number from your blockchain RPC endpoint and estimates it locally in between those reads, which significantly reduces how often it calls the RPC.
606+
The `block-sync-interval` option controls how frequently the real block number is refreshed:
607+
608+
```yaml
609+
## bee.yaml
610+
block-sync-interval: 10
611+
```
612+
613+
- The default is `10`, so operators who want the default do not need to set anything.
614+
- A higher value means fewer RPC calls, at the cost of a slightly staler block-number estimate.
615+
- `1` refreshes the block number as often as possible.
616+
- `0` is not allowed; the node treats it as "no interval" and clamps it to `1`.
617+
618+
The equivalent flag is `--block-sync-interval` and the environment variable is `BEE_BLOCK_SYNC_INTERVAL`.
619+
This is especially useful for operators on paid or rate-limited RPC providers who want to lower request volume.
620+
621+
## SIMD hashing (Optional)
622+
623+
Bee can use a hardware-accelerated (SIMD) implementation of its chunk hasher, a frequent and CPU-intensive operation.
624+
On supported hardware this noticeably lowers the CPU cost of hashing, which speeds up uploads and other hashing-heavy work.
625+
626+
This is **opt-in and off by default**.
627+
It is currently available **only on Linux x86-64 (amd64)**; on all other platforms (Windows, macOS, ARM) the node automatically falls back to the standard hasher, with no action required and no regression.
628+
629+
To enable it, set the `use-simd-hashing` option:
630+
631+
```yaml
632+
## bee.yaml
633+
use-simd-hashing: true
634+
```
635+
636+
The equivalent flag is `--use-simd-hashing` and the environment variable is `BEE_USE_SIMD_HASHING`.
586637
587638
## Configuring Swap Initial Deposit (Optional)
588639
@@ -601,20 +652,22 @@ To enable chequebook verification, set `chequebook-verification` to `true`:
601652
chequebook-verification: true
602653
```
603654
604-
The default minimum balance threshold is **11 BZZ**. To configure a different threshold, set `chequebook-min-balance` to the desired amount in BZZ:
655+
The default minimum balance threshold is **11 BZZ**.
656+
The value is set in the token's smallest unit (PLUR), where 1 BZZ = 10^16 PLUR, so the default is `110000000000000000`.
657+
To configure a different threshold, set `chequebook-min-balance` accordingly:
605658
606659
```yaml
607660
## bee.yaml
608661
chequebook-verification: true
609-
chequebook-min-balance: "11"
662+
chequebook-min-balance: "110000000000000000" # 11 BZZ, expressed in PLUR
610663
```
611664
612665
Or using command-line flags:
613666
614667
```bash
615668
bee start \
616669
--chequebook-verification \
617-
--chequebook-min-balance 11
670+
--chequebook-min-balance 110000000000000000
618671
```
619672
620673
:::info
@@ -646,7 +699,6 @@ nat-addr: "123.123.123.123:1634"
646699
647700
Ensure `nat-addr` and `nat-wss-addr` if used are set to valid `host:port` values — invalid values prevent the node from starting.
648701
649-
650702
## ENS Resolution (Optional)
651703
652704
The [ENS](https://ens.domains/) domain resolution system is used to host websites on Bee, and in order to use this your Bee must be connected to a mainnet Ethereum blockchain node. We recommend you run your own ethereum node. An option for resource restricted devices is geth+nimbus and a guide can be found [here](https://ethereum-on-arm-documentation.readthedocs.io/en/latest/). Other options include [dappnode](https://dappnode.com/), [nicenode](https://www.nicenode.xyz/), [stereum](https://stereum.net/) and [avado](https://ava.do/).
@@ -680,4 +732,4 @@ warmup-time: 30s
680732
681733
Make sure to fund your node with Sepolia ETH rather than xDAI to pay for gas on the Sepolia testnet. There are many public faucets you can use to obtain Sepolia ETH, such as [this one from Infura](https://www.infura.io/faucet/sepolia).
682734
683-
To get Sepolia BZZ (sBZZ) you can use [this Uniswap market](https://app.uniswap.org/swap?outputCurrency=0x543dDb01Ba47acB11de34891cD86B675F04840db&inputCurrency=ETH), just make sure that you've switched to the Sepolia network in your browser wallet.
735+
To get Sepolia BZZ (sBZZ) you can use [this Uniswap market](https://app.uniswap.org/swap?outputCurrency=0x543dDb01Ba47acB11de34891cD86B675F04840db&inputCurrency=ETH), just make sure that you've switched to the Sepolia network in your browser wallet.

docs/bee/working-with-bee/upgrade.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,22 @@ Nodes should not be shut down or updated in the middle of a round they are playi
1515
:::
1616

1717

18+
## Version compatibility and upgrade path
19+
20+
The Swarm network has a **minimum supported Bee version**.
21+
It is currently **v2.8.0**, the release which introduced a breaking p2p protocol change, so nodes running an older protocol can no longer connect to the network.
22+
23+
When upgrading across a breaking protocol change, do not skip the release that introduced it.
24+
Upgrade *through* that version so any one-time data migrations run while they still exist in the code, since Bee removes old migration and compatibility code once a version is no longer supported.
25+
26+
Bee v2.8.1 is **non-disruptive for nodes already on v2.8.0**: it makes no breaking p2p protocol changes, so you can upgrade in place using the steps below.
27+
28+
:::warning
29+
**If you are running Bee v2.6.0 or older:** Bee v2.8.1 removes the last of the v2.6.0 backward-compatibility code, so you cannot upgrade to it directly.
30+
Either upgrade stepwise (**v2.6.0 → v2.8.0 → v2.8.1**) so the data migrations run, or reinstall the node fresh on v2.8.1.
31+
:::
32+
33+
1834
### Ubuntu / Debian
1935

2036
To upgrade Bee, first stop the Bee service:

docs/develop/resources-md.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ description: A curated list of Swarm developer resources — docs, SDKs, example
4444
- [Pinning content](/docs/develop/tools-and-features/pinning) — Keep content locally pinned to your node
4545
- [Run a local gateway proxy](/docs/develop/tools-and-features/gateway-proxy) — Serve Swarm content over HTTP
4646
- [Start a private test network](/docs/develop/tools-and-features/starting-a-test-network) — Local multi-node dev environment
47-
- [Dev mode](/docs/develop/tools-and-features/bee-dev-mode)Instant stamps, no funding needed
47+
- [bee-factory](/docs/develop/tools-and-features/bee-dev-mode)Local Swarm dev stack, no real funds needed
4848

4949
## Examples
5050

docs/develop/tools-and-features/dev-mode.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ description: Documentation for bee-factory, the recommended local Swarm developm
1010
The `bee dev` command is no longer available. Please use `bee-factory` for local development instead.
1111
:::
1212

13+
To test against a real public network instead of a local stack, you can also run a node against the [Sepolia testnet](../../bee/working-with-bee/configuration.md#sepolia-testnet-configuration).
14+
1315
## Requirements
1416

1517
- Node.js ≥ 18

docs/develop/tools-and-features/introduction.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ their own Bee node, for the time being you will need to make use of the [Gateway
5454

5555
### Local Development with bee-factory
5656

57-
If you want to test Swarm-based applications without spending real xBZZ, [bee-factory](./dev-mode.md) is the recommended tool. It starts a full local stack — 5 Bee nodes plus a local Anvil blockchain — with a single command. The older `bee dev` mode has been sunset in favour of bee-factory.
57+
If you want to test Swarm-based applications without spending real xBZZ, [bee-factory](./dev-mode.md) is the recommended tool.
58+
It starts a full local stack — 5 Bee nodes plus a local Anvil blockchain — with a single command.
59+
The `bee dev` mode was removed in Bee v2.8.1; use bee-factory instead.
5860

5961

6062
### Starting a Test Network

static/llms.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ This is the documentation for [Swarm](https://www.ethswarm.org/) and its referen
6767
- [GSOC](https://docs.ethswarm.org/docs/develop/tools-and-features/gsoc): Graffiti SOC for pub/sub messaging patterns
6868
- [Add Access Control (usage)](https://docs.ethswarm.org/docs/develop/act): Encrypt content for specific recipients using ACT
6969
- [Gateway Proxy](https://docs.ethswarm.org/docs/develop/tools-and-features/gateway-proxy): Proxy for browser-based Swarm access
70-
- [Developer Mode](https://docs.ethswarm.org/docs/develop/tools-and-features/bee-dev-mode): Run Bee without blockchain for local testing
70+
- [bee-factory](https://docs.ethswarm.org/docs/develop/tools-and-features/bee-dev-mode): Local Swarm development stack (5 Bee nodes plus a local chain) started with a single command
7171
- [Starting a Private Network](https://docs.ethswarm.org/docs/develop/tools-and-features/starting-a-test-network): Multi-node test clusters
7272
- [Dynamic Content](https://docs.ethswarm.org/docs/develop/dynamic-content): Updatable content using feeds
7373
- [Ultra Light Nodes](https://docs.ethswarm.org/docs/develop/ultra-light-nodes): Minimal nodes for lightweight client use cases

0 commit comments

Comments
 (0)