Skip to content

Commit e2ec8e6

Browse files
authored
Merge pull request #753 from ethersphere/develop-on-swarm-revisions
first draft of develop on swarm revisions
2 parents b39f14a + d0527d5 commit e2ec8e6

28 files changed

+640
-404
lines changed

docs/bee/installation/docker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ version: 2.6.0-06a0aca7 - planned to be supported until 11 December 2024, please
203203
"time"="2024-09-24 22:21:19.664897" "level"="info" "logger"="node" "msg"="waiting to sync postage contract data, this may take a while... more info available in Debug loglevel"
204204
```
205205
206-
Your node will take some time to finish [syncing postage contract data](https://docs.ethswarm.org/docs/develop/access-the-swarm/buy-a-stamp-batch/) as indicated by the final line:
206+
Your node will take some time to finish [syncing postage contract data](https://docs.ethswarm.org/docs/develop/tools-and-features/buy-a-stamp-batch/) as indicated by the final line:
207207
208208
```bash
209209
"msg"="waiting to sync postage contract data, this may take a while... more info available in Debug loglevel"
@@ -354,7 +354,7 @@ You may also check out the [configuration guide](/docs/bee/working-with-bee/conf
354354
355355
356356
### Access the Swarm
357-
If you'd like to start uploading or downloading files to Swarm, [start here](/docs/develop/access-the-swarm/introduction).
357+
If you'd like to start uploading or downloading files to Swarm, [start here](/docs/develop/introduction).
358358
359359
### Explore the API
360360
The [Bee API](/docs/bee/working-with-bee/bee-api) is the primary method for interacting with Bee and getting information about Bee. After installing Bee and getting it up and running, it's a good idea to start getting familiar with the API.

docs/bee/installation/fund-your-node.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ id: fund-your-node
77
Bee nodes require **xDAI** (for gas fees) and **xBZZ** (for storage and bandwidth) to function properly. The amount needed depends on your node type and use case.
88

99
### xDAI is Required For:
10-
- **Buying Postage Stamps** ([Uploading Data](/docs/develop/access-the-swarm/buy-a-stamp-batch))
10+
- **Buying Postage Stamps** ([Uploading Data](/docs/develop/tools-and-features/buy-a-stamp-batch))
1111
- **Stake Management Transactions** ([Staking](/docs/bee/working-with-bee/staking/))
1212
- **Storage Incentives Transactions** ([Redistribution Game](/docs/concepts/incentives/redistribution-game/) )
1313
- **Chequebook Deployment** ([Bandwidth Payments](/docs/concepts/incentives/bandwidth-incentives/))

docs/bee/installation/package-manager.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ curl -s localhost:1633/peers | jq ".peers | length"
439439
440440
Perfect! We are accumulating peers, this means you are connected to
441441
the network, and ready to start [using
442-
Bee](/docs/develop/access-the-swarm/introduction) to [upload and
442+
Bee](/docs/develop/introduction) to [upload and
443443
download](/docs/develop/access-the-swarm/upload-and-download) content or host
444444
and browse [websites](/docs/develop/access-the-swarm/host-your-website) hosted
445445
on the Swarm network.
@@ -470,7 +470,7 @@ Storage incentive rewards are only available for full nodes which are providing
470470
471471
472472
### Access the Swarm
473-
If you'd like to start uploading or downloading files to Swarm, [start here](/docs/develop/access-the-swarm/introduction).
473+
If you'd like to start uploading or downloading files to Swarm, [start here](/docs/develop/introduction).
474474
475475
### Explore the API
476476
The [Bee API](/docs/bee/working-with-bee/bee-api) is the primary method for interacting with Bee and getting information about Bee. After installing Bee and getting it up and running, it's a good idea to start getting familiar with the API.

docs/bee/installation/quick-start.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ A "light" node can download and upload data from Swarm but does not share its di
1616
- [Node.js (v18 or higher)](https://nodejs.org/)
1717
- [npm (Node Package Manager)](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
1818
- [`curl`](https://curl.se/) or [`wget`](https://www.gnu.org/software/wget/) (Check with `curl --version` or `wget --version`)
19-
- [~0.20 xBZZ on Gnosis Chain](/docs/bee/installation/fund-your-node)
20-
- [~0.01 xDAI on Gnosis Chain](/docs/bee/installation/fund-your-node)
19+
- [~0.20 xBZZ on Gnosis Chain](/docs/bee/installation/fund-your-node#how-to-get-xbzz)
20+
- [~0.01 xDAI on Gnosis Chain](/docs/bee/installation/fund-your-node#how-to-get-xdai)
2121

2222
:::info
2323
Although `BZZ` is the official symbol of the token on both Ethereum and Gnosis Chain, the term `xBZZ` is widely used by the Swarm community and in documentation to indicate that it is BZZ on Gnosis Chain (not Ethereum).
@@ -256,5 +256,5 @@ Total xBZZ: 0.0000000000000000
256256
257257
## Next Steps
258258
259-
With your node now fully synced, you're ready start [uploading and downloading](/docs/develop/access-the-swarm/upload-and-download) or start learning how to [develop on Swarm](/docs/develop/introduction).
259+
With your node now fully synced, you're ready start start learning how to [develop on Swarm](/docs/develop/introduction).
260260

docs/bee/installation/shell-script.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@ version: 2.2.0-06a0aca7 - planned to be supported until 11 December 2024, please
432432
433433
Here we can see that after our node has been funded, it was able to issue the transactions for deploying the chequebook contract, which is a prerequisite for running a staking node.
434434
435-
Next your node will begin to sync [postage stamp data](/docs/develop/access-the-swarm/buy-a-stamp-batch), which can take ~5 to 10 minutes. You will see this log message while your node is syncing postage stamp data:
435+
Next your node will begin to sync [postage stamp data](/docs/develop/tools-and-features/buy-a-stamp-batch), which can take ~5 to 10 minutes. You will see this log message while your node is syncing postage stamp data:
436436
437437
```bash
438438
"time"="2024-09-24 22:21:19.664897" "level"="info" "logger"="node" "msg"="waiting to sync postage contract data, this may take a while... more info available in Debug loglevel"
@@ -626,7 +626,7 @@ You may also check out the [configuration guide](/docs/bee/working-with-bee/conf
626626
627627
628628
### Access the Swarm
629-
If you'd like to start uploading or downloading files to Swarm, [start here](/docs/develop/access-the-swarm/introduction).
629+
If you'd like to start uploading or downloading files to Swarm, [start here](/docs/develop/introduction).
630630
631631
### Explore the API
632632
The [Bee API](/docs/bee/working-with-bee/bee-api) is the primary method for interacting with Bee and getting information about Bee. After installing Bee and getting it up and running, it's a good idea to start getting familiar with the API.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Detailed information about Bee API endpoints can be found in the [API reference
1717

1818
## Interacting With the API
1919

20-
You can interact with the Bee API using standard HTTP requests, allowing you to programmatically access all of your Bee node's various functions such as [purchasing stamp batches](/docs/develop/access-the-swarm/buy-a-stamp-batch), [uploading and downloading](/docs/develop/access-the-swarm/upload-and-download), [staking](/docs/bee/working-with-bee/staking), and more.
20+
You can interact with the Bee API using standard HTTP requests, allowing you to programmatically access all of your Bee node's various functions such as [purchasing stamp batches](/docs/develop/tools-and-features/buy-a-stamp-batch), [uploading and downloading](/docs/develop/access-the-swarm/upload-and-download), [staking](/docs/bee/working-with-bee/staking), and more.
2121

2222
### Alternatives for Working with the API
2323

docs/bee/working-with-bee/node-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Bee can operate in different modes, each tailored to specific use cases:
1919
| Feature | Full Node | Light Node | Ultra-Light Node |
2020
| ----------------------------------------------------------------------- | --------- | ---------- | ---------------- |
2121
| Free tier [downloads](/docs/develop/access-the-swarm/upload-and-download) ||||
22-
| [Uploading](/docs/develop/access-the-swarm/upload-and-download) (Can purchase [postage stamp batches](/docs/develop/access-the-swarm/buy-a-stamp-batch)) ||||
22+
| [Uploading](/docs/develop/access-the-swarm/upload-and-download) (Can purchase [postage stamp batches](/docs/develop/tools-and-features/buy-a-stamp-batch)) ||||
2323
| Can exceed free tier downloads ||||
2424
| Storage sharing ||||
2525
| [Storage incentives](/docs/bee/working-with-bee/staking/) ||||

docs/bee/working-with-bee/swarm-cli.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,33 @@ title: Swarm CLI
33
id: swarm-cli
44
---
55

6-
Swarm CLI is a command line based application which simplifies interactions with the Bee API. It allows you to accomplish most common tasks using easy to understand commands. It also greatly simplifies certain more complex tasks, such as as the management of [feeds](/docs/develop/tools-and-features/feeds).
6+
**Swarm‑CLI** is a command‑line tool powered by `bee-js` that makes it easy to interact with your Bee node directly from the command line. It’s friendlier than working with the raw Bee HTTP API and faster than writing a custom `bee-js` script when you just want to perform an action from the terminal.
7+
8+
:::tip
9+
`swarm-cli` is the recommended method for interaction with your Bee node from the command line. Unless you have explicit need to use the Bee API directly, `swarm-cli` is generally the better option.
10+
:::
11+
12+
Common uses:
13+
14+
* Check your node: `swarm-cli status`
15+
* Add stake:
16+
* Upload files or a static site: `swarm-cli upload <path>` (will prompt to pick or create a postage batch)
17+
* Download content: `swarm-cli download <reference> -o <output>`
18+
* Inspect and manage postage batches: `swarm-cli ...` (use `--help` to see stamp-related commands)
19+
20+
**Why use it?**
21+
22+
* **No scaffolding needed** — run direct commands without creating a project
23+
* **Interactive prompts** — it guides you through common tasks such as stamp purchasing and selection using interactive prompts
24+
* **Smart option inference** — it infers options based on your input (e.g., batch selection, index page, content type) so you don’t need deep Bee API knowledge
25+
* **Powered by `bee-js`** — stays aligned with the latest Bee features
26+
27+
It also greatly simplifies certain more complex tasks, such as as the management of [feeds](/docs/develop/tools-and-features/feeds).
728

829
For installation and usage instructions, [see the README](https://github.com/ethersphere/swarm-cli/blob/master/README.md).
930

1031
To check the latest version, see the Swarm CLI [releases page](https://github.com/ethersphere/swarm-cli/releases).
1132

12-
For further support and information, [join the Swarm Discord server](https://discord.com/invite/GU22h2utj6).
33+
For further support and information, [join the Swarm Discord server](https://discord.com/invite/GU22h2utj6).
34+
35+

docs/concepts/DISC/erasure-coding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Note that this guarantee of retrievability is for each 128 chunk segment, and th
3535

3636
## Usage
3737

38-
For usage instructions, see the [erasure coding page in the "Develop" section](/docs/develop/access-the-swarm/erasure-coding).
38+
For usage instructions, see the [erasure coding page in the "Develop" section](/docs/develop/tools-and-features/erasure-coding).
3939

4040
## Cost Calculation
4141

docs/concepts/access-control.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ id: access-control
66
The Access Control Trie (ACT) implements the operation of encryption at the chunk level, with the presence of a decryption/encryption key being the only distinction between accessing private and public data.
77

88
:::info
9-
This article describes the high level concepts and functionalities of ACT. If you're ready to try it out for yourself, please refer to this [hands on usage guide with specific details](/docs/develop/tools-and-features/act).
9+
This article describes the high level concepts and functionalities of ACT. If you're ready to try it out for yourself, please refer to this [hands on usage guide with specific details](/docs/develop/access-the-swarm/act/).
1010
:::
1111

1212
In decentralized public data storage systems like Swarm, data is distributed across multiple nodes. Ensuring

0 commit comments

Comments
 (0)