Skip to content
Open
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ test
*.csv
# LLM Tools
.claude
# Link checker reports
link-reports/
2 changes: 1 addition & 1 deletion docs/bee/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Therefore, the rule is, each node must have:

### How can I add Gnosis / Sepolia to Metamask?

You can easily add Sepolia or Gnosis to metamask using the [official guide from Metamask](https://support.metamask.io/networks-and-sidechains/managing-networks/how-to-add-a-custom-network-rpc/).
You can easily add Sepolia or Gnosis to metamask using the [official guide from Metamask](https://support.metamask.io/configure/networks/how-to-add-a-custom-network-rpc/).

If you are using a different wallet which does not have an easy option for adding networks like Metamask does, then you may need to add the networks manually. You need to fill in four pieces of information to do so:

Expand Down
2 changes: 1 addition & 1 deletion docs/bee/installation/connectivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ swarm, below you will find a detailed guide to navigating your way
through your network and making it out into the wild so you can buzz
around fellow bees and maximize your chances of earning xBZZ. If
you still have problems, please join us in our [Discord
server](https://discord.gg/wdghaQsGq5) and we'll help you find the
server](https://discord.gg/kHRyMNpw7t) and we'll help you find the
way! 🐝 🐝 🐝 🐝 🐝

:::warning
Expand Down
2 changes: 1 addition & 1 deletion docs/bee/installation/hive.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ Configure your nodes as desired, but ensure that the values `api-addr`, `data-di

### Monitoring

See the [logging section](./../working-with-bee/logs-and-files.md) for more information on how to access your node's metrics. Share your community creations (such as [swarmMonitor](https://github.com/doristeo/SwarmMonitoring) - thanks doristeo!) in the [#node-operators](https://discord.gg/X3ph5yGRFU) channel of our Discord server so we can add you to our list of all things that are [awesome](https://github.com/ethersphere/awesome-swarm) and Swarm. 🧡
See the [logging section](./../working-with-bee/logs-and-files.md) for more information on how to access your node's metrics. Share your community creations (such as [swarmMonitor](https://github.com/doristeo/SwarmMonitoring) - thanks doristeo!) in the [#node-operators](https://discord.gg/kHRyMNpw7t) channel of our Discord server so we can add you to our list of all things that are [awesome](https://github.com/ethersphere/awesome-swarm) and Swarm. 🧡
6 changes: 3 additions & 3 deletions docs/bee/installation/package-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Config: /etc/bee/bee.yaml

Bee requires a Gnosis Chain RPC endpoint to function. By default this is expected to be found at ws://localhost:8546.

Please see https://docs.ethswarm.org/docs/installation/install for more details on how to configure your node.
Please see https://docs.ethswarm.org/docs/bee/installation/getting-started for more details on how to configure your node.

After you finish configuration run 'sudo bee-get-addr' and fund your node with XDAI, and also XBZZ if so desired.

Expand All @@ -122,7 +122,7 @@ When Bee is installed using a package manager, a `bee.yaml` file containing the
While this package manager install guide uses the `bee.yaml` file for setting configuration options, there are [several other available methods for setting node options](./../working-with-bee/configuration.md).
:::

After installation, you can check that the file was successfully generated and contains the [default configuration](https://github.com/ethersphere/bee/blob/master/packaging) for your system:
After installation, you can check that the file was successfully generated and contains the [default configuration](https://github.com/ethersphere/bee/tree/master/packaging) for your system:

<Tabs
defaultValue="linux"
Expand Down Expand Up @@ -427,7 +427,7 @@ Success! The Bee API is now listening!
Next, let's see if we have connected with any peers by sending a query to the Bee API (port 1633 by default - `localhost:1633`).

:::info
Here we are using the `jq` [utility](https://stedolan.github.io/jq/) to parse our javascript. Use your package manager to install `jq`, or simply remove everything after and including the first `|` to view the raw json without it.
Here we are using the `jq` [utility](https://jqlang.github.io/jq/) to parse our javascript. Use your package manager to install `jq`, or simply remove everything after and including the first `|` to view the raw json without it.
:::

```bash
Expand Down
4 changes: 2 additions & 2 deletions docs/bee/working-with-bee/bee-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ id: bee-api
description: Comprehensive reference for Bee's HTTP API endpoints enabling programmatic access to node management uploads downloads and monitoring.
---

The Bee HTTP API is the primary interface to a running Bee node. API-endpoints can be queried using familiar HTTP requests, and will respond with semantically accurate [HTTP status and error codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) as well as data payloads in [JSON](https://www.json.org/json-en.html) format where appropriate.
The Bee HTTP API is the primary interface to a running Bee node. API-endpoints can be queried using familiar HTTP requests, and will respond with semantically accurate [HTTP status and error codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status) as well as data payloads in [JSON](https://www.json.org/json-en.html) format where appropriate.

The Bee API provides full access to all core functionalities of a Bee node, including uploading, downloading, staking, postage stamp batch purchasing and management, and node monitoring. By default, it runs on port `:1633`.

Expand Down Expand Up @@ -43,7 +43,7 @@ curl -s http://localhost:1633/peers | jq '.peers | length'
Great! We can see that we are currently connected with 23 other nodes!

:::info
Here we are using the `jq` command line utility to count the amount of objects in the `peers` array in the JSON response we have received from our API, learn more about how to install and use `jq` [here](https://stedolan.github.io/jq/).
Here we are using the `jq` command line utility to count the amount of objects in the `peers` array in the JSON response we have received from our API, learn more about how to install and use `jq` [here](https://jqlang.github.io/jq/).
:::

Let's review a handful of endpoints which will provide you with important information relevant to detecting and diagnosing problems with your nodes.
Expand Down
4 changes: 2 additions & 2 deletions docs/bee/working-with-bee/cashing-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ curl -X POST http://localhost:1633/chequebook/cashout/d7881307e793e389642ea73345
```

You may check the status of your transaction using the [xDAI
Blockscout](https://blockscout.com/xdai/mainnet).
Blockscout](https://gnosis.blockscout.com/).

Finally, we can now see the status of the cashout transaction by sending a GET request to the same URL.

Expand Down Expand Up @@ -201,7 +201,7 @@ curl -X POST http://localhost:1633/chequebook/deposit\?amount\=1000 | jq
}
```

You may then use [Blockscout](https://blockscout.com/xdai/mainnet) to
You may then use [Blockscout](https://gnosis.blockscout.com/) to
track your transaction and make sure it completed successfully.

## Managing uncashed cheques
Expand Down
2 changes: 1 addition & 1 deletion docs/bee/working-with-bee/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -610,7 +610,7 @@ Ensure `nat-addr` and `nat-wss-addr` if used are set to valid `host:port` values

## ENS Resolution (Optional)

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.io/), [nicenode](https://www.nicenode.xyz/), [stereum](https://stereum.net/) and [avado](https://ava.do/).
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/).

If you do not wish to run your own Ethereum node, you may use a blockchain RPC service provider such as [Infura](https://infura.io). After signing up for Infura, simply set your `--resolver-options` to `https://mainnet.infura.io/v3/your-api-key`.

Expand Down
2 changes: 1 addition & 1 deletion docs/bee/working-with-bee/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ rate(bee_swap_cheques_sent[1d])
rate(bee_swap_cheques_rejected[1d])
```

Share your creations in the [#node-operators](https://discord.gg/X3ph5yGRFU) channel of our Discord server!
Share your creations in the [#node-operators](https://discord.gg/kHRyMNpw7t) channel of our Discord server!
2 changes: 0 additions & 2 deletions docs/concepts/DISC/erasure-coding.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ Specifically, data is divided into **m** chunks, and **k** additional chunks are

For an 8KB image, if we set **m = 2** and **k = 1**, we create 3 chunks (2 original + 1 redundant). As long as any 2 of these 3 chunks are available, we can reconstruct the original data. By increasing **k** to 4, we can tolerate the loss of up to 4 chunks while still recovering the original data.

![Erasure Code Example](https://www.ethswarm.org/uploads/erasure-coding-01.png)

### Levels of Protection

In Swarm's implementation of erasure coding, there are five levels of protection, None, Medium, Strong, Insane, and Paranoid. For each level, the **m** and **k** values have been adjusted in order to meet a certain level of data protection:
Expand Down
2 changes: 1 addition & 1 deletion docs/desktop/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Next simply send your xDAI to that address. Before sending, make sure you have s
| **New RPC URL:** | https://xdai.fairdatasociety.org |
| **Chain ID:**| 100 |
| **Symbol:**| xDai |
| **Block Explorer URL (Optional):**| https://blockscout.com/xdai/mainnet |
| **Block Explorer URL (Optional):**| https://gnosis.blockscout.com/ |

![](/img/config4.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/contribute/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Welcome to the Dev area! We love PR's! 🐝

We would would love you to get involved with our [Github repo](https://github.com/ethersphere/bee).

Connect with other Bee developers over at the official [Discord Server](https://discord.gg/wdghaQsGq5). Sign up and get involved with our buzzing hive of daily dev chat.
Connect with other Bee developers over at the official [Discord Server](https://discord.gg/kHRyMNpw7t). Sign up and get involved with our buzzing hive of daily dev chat.

- If you would like to contribute, please read the [coding guidelines](https://github.com/ethersphere/bee/blob/master/CODING.md) before you get started.

Expand Down
4 changes: 0 additions & 4 deletions docs/develop/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,10 +338,6 @@ Full script:
Before running the third script, make sure that you have updated your `.env` variable `SCRIPT_03_MANIFEST` with the manifest reference returned by the second script (see terminal output from `Updated manifest reference:`).
:::

Full script:

* [`script-03.js`](https://github.com/ethersphere/examples/blob/main/manifests/directory/script-03.js)

This is done by:

1. Locating the existing file entry
Expand Down
14 changes: 8 additions & 6 deletions docs/develop/host-your-website.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,17 @@ The guides below assume you already have a registered ENS domain name. By using
:::

:::tip FIX FOR ENS NOT WORKING ON LOCALHOST
If the site doesn’t load from localhost, it’s probably an with the resolver RPC (the RPC endpoint for the Ethereum node used to resolve your ENS domain name).
If the site doesn’t load from localhost, it’s may be an issue with the resolver RPC (the RPC endpoint for the Ethereum node used to resolve your ENS domain name). This is even more likely if you are using a free RPC since they generally don't come with the same guarantees as paid ones.

Some endpoints, such as:
Some endpoints, such as...

```
https://cloudflare-eth.com
```

may not resolve properly on localhost.
...may not resolve properly on localhost. Even if they previously worked, it may be the case that the RPC has been [changed or removed](https://developers.cloudflare.com/web3/reference/migration-guide/?utm_source=chatgpt.com).



As of the writing of this guide, both of these free and public endpoints work reliably for localhost resolution:

Expand All @@ -37,7 +39,7 @@ https://eth-mainnet.public.blastapi.io

Alternatively, you can run your own Ethereum node and use that as the RPC.
:::

## Host a Site With **swarm-cli**

This guide shows you how to get your website hosted on Swarm with just a few simple commands by using `swarm-cli` from your terminal.
Expand All @@ -54,7 +56,7 @@ This guide shows you how to get your website hosted on Swarm with just a few sim
### Upload & Access by Hash


You can download the example website files from the [ethersphere/examples](https://github.com/ethersphere/examples/tree/main/basic-static-website) repository.
You can download the example website files from the [ethersphere/examples](https://github.com/ethersphere/examples/tree/main/website) repository.


#### Uploading the Website
Expand Down Expand Up @@ -286,7 +288,7 @@ For developers building apps, tools, or automated deployments, `bee-js` offers p
* A running Bee node (either a [standard installation](./../bee/installation/quick-start.md) or [Swarm Desktop](./../desktop/install.md))
* A valid postage stamp batch
* Node.js (18+) and `@ethersphere/bee-js` installed in your project
* Static website files (HTML, CSS, etc.) - feel free to use the [provided example site](https://github.com/ethersphere/examples/tree/main/basic-static-website)
* Static website files (HTML, CSS, etc.) - feel free to use the [provided example site](https://github.com/ethersphere/examples/tree/main/website)
* (Optional for part one - "Upload & Access by Hash") An ENS domain which you [previously registered](https://support.ens.domains/en/articles/7882582-how-to-register-a-eth-name)


Expand Down
4 changes: 2 additions & 2 deletions docs/develop/multi-author-blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -786,12 +786,12 @@ const cfg = JSON.parse(readFileSync("config.json", "utf-8"));
const indexTopic = Topic.fromString(cfg.topics.index);
const indexOwner = new EthAddress(cfg.admin.owner);
const indexReader = bee.makeFeedReader(indexTopic, indexOwner);
const indexResult = await indexReader.download();
const indexResult = await indexReader.downloadReference();
console.log("Index feed at index:", indexResult.feedIndex.toBigInt());

// Download the authors.json manifest
const authorsData = await bee.downloadFile(indexResult.reference);
const authors = JSON.parse(new TextDecoder().decode(authorsData.data));
const authors = JSON.parse(authorsData.data.toUtf8());

console.log(`\n${authors.length} authors in blog:\n`);

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/tools-and-features/bee-js.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ description: Documentation for the JavaScript library providing programmatic acc

bee-js is Bee's complementary JavaScript library. It is the technology underpinning [swarm-cli](./../../bee/working-with-bee/swarm-cli.md) and [Swarm Desktop](./../../desktop/introduction.md) and is a powerful tool for building completely decentralized apps.

See the [bee-js](https://bee-js.ethswarm.org/) documentation for detailed information on using and installing the library.
See the [bee-js](https://bee-js.ethswarm.org/docs/) documentation for detailed information on using and installing the library.

2 changes: 1 addition & 1 deletion docs/develop/tools-and-features/chunk-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ more info read [The Book of Swarm](https://www.ethswarm.org/the-book-of-swarm-2.

Although all chunks must satisfy the constraints of either being addressed by the BMT hash of their payload, or assigned by the owner of an Ethereum private key pair, so much more is possible. How else can you use the DISC to distribute and store your data? We're excited to see what you come up with! 💡

Share your creations in the [#develop-on-swarm](https://discord.gg/C6dgqpxZkU) channel of our [Discord Server](https://discord.gg/wdghaQsGq5).
Share your creations in the [#builders](https://discord.gg/8SMCfvm3kw) channel of our [Discord Server](https://discord.gg/kHRyMNpw7t).
4 changes: 2 additions & 2 deletions docs/develop/tools-and-features/feeds.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ a little data juggling and crypto magic. For the easiest route, see
[the bee-js feeds functionality](./bee-js.md) and
[swarm-cli](./../../bee/working-with-bee/swarm-cli.md), or for the super 1337,
share your implementations in other languages in the
[#develop-on-swarm](https://discord.gg/C6dgqpxZkU) channel of our
[Discord Server](https://discord.gg/wdghaQsGq5).
[#builders](https://discord.gg/8SMCfvm3kw) channel of our
[Discord Server](https://discord.gg/kHRyMNpw7t).
:::

### What are Feeds?
Expand Down
4 changes: 2 additions & 2 deletions docs/develop/tools-and-features/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ over the swarm.

If you want your users to be able to access Swarm without running
their own Bee node, for the time being you will need to make use of the [Gateway Proxy tool](https://github.com/ethersphere/gateway-proxy). Join us in the
[#develop-on-swarm](https://discord.gg/C6dgqpxZkU) room in our
[Discord Server](https://discord.gg/wdghaQsGq5) for more information on how to make your Swarm based applications accessible to everyone.
[#builders](https://discord.gg/8SMCfvm3kw) room in our
[Discord Server](https://discord.gg/kHRyMNpw7t) for more information on how to make your Swarm based applications accessible to everyone.



Expand Down
4 changes: 2 additions & 2 deletions docs/develop/tools-and-features/starting-a-test-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ curl -s http://localhost:1733/topology | jq .connected
No connections yet? Right! Let's remedy that!

:::info
Here we are using the `jq` command line utility to count the amount of objects in the `peers` array in the JSON response we have received from our API, learn more about how to install and use `jq` [here](https://stedolan.github.io/jq/).
Here we are using the `jq` command line utility to count the amount of objects in the `peers` array in the JSON response we have received from our API, learn more about how to install and use `jq` [here](https://jqlang.github.io/jq/).
:::

### Making a network
Expand All @@ -119,7 +119,7 @@ curl localhost:1633/addresses | jq
}
```

Here, we get firstly the **overlay address** - this is the permanent address Swarm uses as your anonymous identity in the network and secondly, a list of all the [multiaddresses](https://docs.libp2p.io/reference/glossary/#multiaddr), which are physical network addresses at which you node can be found by peers.
Here, we get firstly the **overlay address** - this is the permanent address Swarm uses as your anonymous identity in the network and secondly, a list of all the [multiaddresses](https://libp2p.io/docs/peers/#peer-ids-in-multiaddrs), which are physical network addresses at which you node can be found by peers.

Note the addresses starting with an `/ip4`, followed by `127.0.0.1`, which is the `localhost` internal network in your computer. Now we can use this full address to be the bootnode of our second node so that when it starts up, it goes to this address and both nodes become peers of each other. Let's add this into our config_2.yaml file.

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/upload-and-download.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Uploading to Swarm has two steps: (1) **buy storage** as a **postage stamp batch

The `bee-js` library is the **official SDK for building Swarm-based applications**. It works in both **browser** and **Node.js** environments and **greatly simplifies development** compared with using the Bee HTTP API directly. It is the recommended method for developing applications on Swarm.

Refer to the [`bee-js` documentation](https://bee-js.ethswarm.org/) for more usage guides.
Refer to the [`bee-js` documentation](https://bee-js.ethswarm.org/docs/) for more usage guides.

:::tip
**Environment-specific methods:**
Expand Down
Loading