Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Free, public rpc warning #734

Merged
merged 2 commits into from
Mar 18, 2025
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
2 changes: 1 addition & 1 deletion docs/bee/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ If you are using a different wallet which does not have an easy option for addin
#### Gnosis Chain

Network name: Gnosis
RPC URL: https://rpc.gnosischain.com
RPC URL: https://xdai.fairdatasociety.org
Chain ID: 100
Currency symbol: XDAI

Expand Down
10 changes: 7 additions & 3 deletions docs/bee/installation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,19 @@ A reliable, high-speed internet connection is recommended when running a full no

### RPC Endpoint

:::warning
***Free public RPC endpoints are discouraged*** since they may enforce rate limiting or may not store the historical smart contract data required by Bee nodes. [Read more](/docs/bee/working-with-bee/configuration#setting-blockchain-rpc-endpoint).
:::

An [RPC (Remote Procedure Call) endpoint](/docs/references/glossary#rpc-endpoint) is required to allow your node to interact with **Gnosis Chain**, which is required for transactions like purchasing postage stamps, staking xBZZ, and storage incentives related transactions.

Bee nodes use the **`--blockchain-rpc-endpoint`** configuration option to specify which Gnosis Chain RPC service to connect to.

This can be:

- A **public and free endpoint**, such as those offered by [Fair Data Society](https://xdai.fairdatasociety.org) or other free RPC providers listed in the [Gnosis Chain documentation](https://docs.gnosischain.com/tools/RPC%20Providers/).
- A **private and paid endpoint** provided by third-party services typically offers higher reliability and better performance.
- A [self-hosted Gnosis Chain node](https://docs.gnosischain.com/node), giving full control over blockchain interactions but requiring additional setup and maintenance.
- A [self-hosted Gnosis Chain node](https://docs.gnosischain.com/node), giving full control over blockchain interactions but requiring additional setup and maintenance (recommended).
- A **private and paid endpoint** from a third-party service provider.
- A **public and free endpoint**, such as this free one from the Fair Data Society: `https://xdai.fairdatasociety.org`

:::info
A well-maintained list of both free and paid RPC endpoint providers can be found in the [Gnosis Chain documentation](https://docs.gnosischain.com/tools/RPC%20Providers/).
Expand Down
32 changes: 23 additions & 9 deletions docs/bee/working-with-bee/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -500,20 +500,34 @@ A password is required for all modes, and can either be set directly in text thr

## Setting Blockchain RPC endpoint

Full and light Bee nodes require a Gnosis Chain RPC endpoint so they can interact with and deploy their chequebook contract, see the latest view of the current postage stamp batches, and interact with and top-up postage stamp batches. A blockchain RPC endpoint is not required for nodes running in ultra-light mode.
We recommend you [run your own Gnosis Chain node](https://docs.gnosischain.com/node/) if you are planning to run a full node, and especially if you plan to run a [hive of nodes](/docs/bee/installation/hive).
If you do not wish to run your own Gnosis Chain node and are willing to trust a third party, you may also consider using an RPC endpoint provider such as [GetBlock](https://getblock.io/).
For running a light node or for testing out a single full node you may also consider using one of the [free public RPC endpoints](https://docs.gnosischain.com/tools/RPC%20Providers/) listed in the Gnosis Chain documentation. However, these endpoint providers offer no [SLA](https://en.wikipedia.org/wiki/Service-level_agreement) or availability guarantees and are therefore not recommended for full node operators.
To set your RPC endpoint provider, specify it with the `blockchain-rpc-endpoint` value, which is set to an empty string by default.
:::warning
A RPC endpoint for *a full archival Gnosis Chain node is required* since a Bee node must sync all data starting from when the [postage stamp smart contract was created](https://gnosisscan.io/tx/0x3427deb106b30a7d23f7ce9d2465f2d83945948c5aeddba55337c318fb56ec25).

The free RPC endpoint offered by the Fair Data Society (https://xdai.fairdatasociety.org) will work since it is a full archival node, but running Bee with other public free RPC endpoints from non-archive nodes will result in the `storage: not found` error.

If you do encounter the `storage: not found` error, update your RPC endpoint to one for a full archival node, and restart your node with the `resync` option set to `true`.
:::

Full and light Bee nodes require a Gnosis Chain RPC endpoint in order to sync blockchain data and issue transactions (not required for ultra-light nodes).

To set your RPC endpoint, specify it with the `blockchain-rpc-endpoint` value, which is set to an empty string by default.

```yaml
## bee.yaml
blockchain-rpc-endpoint: https://rpc.gnosis.gateway.fm
blockchain-rpc-endpoint: https://xdai.fairdatasociety.org
```

:::info
The gateway.fm RPC endpoint in the example is great for learning how to set up Bee, but for the sake of security and reliability it's recommended that you run your [run your own Gnosis Chain node](https://docs.gnosischain.com/node/) rather than relying on a third party provider.
:::
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/).


### RPC Providers

While we recommend running your own Gnosis Chain node for your RPC endpoint, you may wish to use a third party provider instead.

For a comprehensive list of RPC providers, refer to the [Gnosis Chain documentation](https://docs.gnosischain.com/tools/RPC%20Providers/). The list includes both free and paid RPC providers (refer to [warning above](#setting-blockchain-rpc-endpoint) about free RPC providers).

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`.


## Configuring Swap Initial Deposit (Optional)

Expand Down
9 changes: 7 additions & 2 deletions docs/desktop/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ To modify the RPC endpoint, first navigate to the ***Settings*** tab:

![](/img/config1.png)

From the ***Settings*** tab, expand the API Settings section and click the pen button next to Blockchain RPC URL to edit the default RPC. You can choose any valid Gnosis Chain RPC, either from your own Gnosis node or a service provider. You can find a list of paid and free RPC options from the [Gnosis Chain docs](https://docs.gnosischain.com/tools/RPC%20Providers/). For this example we will use the free endpoint - *https://rpc.gnosischain.com/*.
From the ***Settings*** tab, expand the API Settings section and click the pen button next to Blockchain RPC URL to edit the default RPC. You can choose any valid Gnosis Chain RPC, either from your own Gnosis node or a service provider. You can find a list of paid and free RPC options from the [Gnosis Chain docs](https://docs.gnosischain.com/tools/RPC%20Providers/). For this example we will use the free endpoint - *https://xdai.fairdatasociety.org*.

:::warning
Other ***free public RPC endpoints are discouraged,*** since they may enforce rate limiting or may not store the historical smart contract data required by Bee nodes. [Read more](/docs/bee/working-with-bee/configuration#setting-blockchain-rpc-endpoint).
:::


![](/img/config2.png)

Expand Down Expand Up @@ -41,7 +46,7 @@ Next simply send your xDAI to that address. Before sending, make sure you have s
| Field | Value |
|--------------|-----------|
|**Network name:**|Gnosis|
| **New RPC URL:** | https://rpc.gnosischain.com |
| **New RPC URL:** | https://xdai.fairdatasociety.org |
| **Chain ID:**| 100 |
| **Symbol:**| xDai |
| **Block Explorer URL (Optional):**| https://blockscout.com/xdai/mainnet |
Expand Down