You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CLAUDE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ The `prebuild` npm hook runs automatically before `build` and does three things,
57
57
58
58
## Content conventions (from CODING.md)
59
59
60
-
-**Wrap long lines**with newlines — keeps git diffs small and reduces merge conflicts.
60
+
-**One sentence per line**— put a newline after every sentence instead of hard-wrapping at a fixed width; keeps git diffs small and reduces merge conflicts.
61
61
-**Minimize unrelated edits** (e.g. don't reflow a whole paragraph to fix one typo) for the same reason.
62
62
-**`Swarm` vs `swarm`**: capital `Swarm` = the project / main network; lowercase `swarm` = a swarm of bee nodes (Bee supports running multiple). Capital `Bee` = the Go client; lowercase `bee` = any Swarm-protocol client.
63
63
-**Version bumps**: automated by the `update-openapi` workflow on each new stable Bee release (literal find-and-replace of the semver in the install docs). Only bump by hand for out-of-band corrections, across the whole `docs/` folder.
-Please wrap long lines using `newline` characters, so that the `git`
4
-
line diffs result in fewer merge conflicts.
3
+
-Write each sentence on its own line: put a newline after every sentence, rather than hard-wrapping lines at a fixed column width.
4
+
This keeps `git`line diffs small and produces fewer merge conflicts, without the awkward mid-sentence breaks that fixed-width wrapping causes.
5
5
6
-
- Don't change things unnecessarily (e.g. if you reindent an entire
7
-
paragraph when you're fixing a single typo, then you unnecessarily
8
-
increase the probability for merge conflicts).
6
+
- Don't change things unnecessarily (e.g. if you reindent an entire paragraph when you're fixing a single typo, then you unnecessarily increase the probability for merge conflicts).
9
7
10
-
- Prefer `npm ci` instead of `npm install`, and only include the
11
-
`package-lock.json` file in your commit when you know what you are
- Prefer `npm ci` instead of `npm install`, and only include the `package-lock.json` file in your commit when you know what you are doing.
9
+
For further explanation see this [stackoverflow question](https://stackoverflow.com/questions/48524417/should-the-package-lock-json-file-be-added-to-gitignore).
14
10
15
11
## Swarm vs. swarm, and uppercasing in general
16
12
17
-
`Swarm`, with a capital, refers to the project and the main network,
18
-
e.g.:
13
+
`Swarm`, with a capital, refers to the project and the main network, e.g.:
19
14
20
15
> Swarm uses the content hashes as addresses
21
16
22
17
> As of today, the Swarm mainnet consists of `n` number of nodes
23
18
24
-
`swarm`, in lower case, refers to a swarm of bee nodes. Note that the
25
-
Bee client supports running/forming multiple Swarm swarms, i.e. you
26
-
can even run your own!
19
+
`swarm`, in lower case, refers to a swarm of bee nodes.
20
+
Note that the Bee client supports running/forming multiple Swarm swarms, i.e. you can even run your own!
27
21
28
22
> when your node joins the designated swarm
29
23
30
-
[`Bee`](https://github.com/ethersphere/bee), with a capital, refers to
31
-
a specific bee client, written in the `go` programming language, while
32
-
`bee`, in lower case, refers to any worker that can join a swarm
33
-
(e.g. any client implementation that speaks the Swarm protocol).
24
+
[`Bee`](https://github.com/ethersphere/bee), with a capital, refers to a specific bee client, written in the `go` programming language, while `bee`, in lower case, refers to any worker that can join a swarm (e.g. any client implementation that speaks the Swarm protocol).
Copy file name to clipboardExpand all lines: docs/bee/working-with-bee/configuration.md
+77-25Lines changed: 77 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,6 @@ description: Documents all Bee configuration options available through YAML file
7
7
import Tabs from '@theme/Tabs';
8
8
import TabItem from '@theme/TabItem';
9
9
10
-
11
10
## Configuration Methods and Priority
12
11
13
12
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`.
22
21
However when Bee is started as a service with tools like `systemctl` or `brew services`, only the YAML configuration file is supported by default.
23
22
:::
24
23
25
-
26
24
### Command Line Arguments
27
25
28
26
Run `bee help printconfig` in your terminal to list the available command-line arguments and config option flags:
@@ -35,7 +33,6 @@ Usage:
35
33
36
34
Available Commands:
37
35
start Start a Swarm node
38
-
dev Start in dev mode. WARNING: This command will be deprecated soon.
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/).
576
594
577
-
578
595
### RPC Providers
579
596
580
597
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
583
600
584
601
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`.
585
602
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`.
586
637
587
638
## Configuring Swap Initial Deposit (Optional)
588
639
@@ -601,20 +652,22 @@ To enable chequebook verification, set `chequebook-verification` to `true`:
601
652
chequebook-verification: true
602
653
```
603
654
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 setin 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:
605
658
606
659
```yaml
607
660
## bee.yaml
608
661
chequebook-verification: true
609
-
chequebook-min-balance: "11"
662
+
chequebook-min-balance: "110000000000000000" # 11 BZZ, expressed in PLUR
Ensure `nat-addr` and `nat-wss-addr` if used are set to valid `host:port` values — invalid values prevent the node from starting.
648
701
649
-
650
702
## ENS Resolution (Optional)
651
703
652
704
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
680
732
681
733
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).
682
734
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.
Copy file name to clipboardExpand all lines: docs/bee/working-with-bee/upgrade.md
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,22 @@ Nodes should not be shut down or updated in the middle of a round they are playi
15
15
:::
16
16
17
17
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.
0 commit comments