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
7 changes: 7 additions & 0 deletions .claude/settings.local.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"permissions": {
"allow": [
"Bash(cat:*)"
]
}
}
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,7 @@ resources
# Generated content
/src/pages/awesome-swarm.mdx
test
*.zip
*.zip
*.csv
# Tools
.claude
1 change: 1 addition & 0 deletions docs/bee/faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Bee FAQ
id: bee-faq
description: Addresses common questions about running Bee nodes including setup installation troubleshooting and blockchain interactions.
---

## Running a Bee Node
Expand Down
1 change: 1 addition & 0 deletions docs/bee/installation/build-from-source.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Build from Source
id: build-from-source
description: Guides developers through compiling Bee directly from source code using Go git and make with step-by-step instructions.
---

Bee is written using the [Go](https://golang.org) language.
Expand Down
1 change: 1 addition & 0 deletions docs/bee/installation/connectivity.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Connectivity
id: connectivity
description: Explains network setup and NAT configuration to ensure Bee nodes can communicate with peers on both private and public networks.
---

To fully connect to the swarm, your Bee node needs to be able to both
Expand Down
1 change: 1 addition & 0 deletions docs/bee/installation/docker.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Docker Install
id: docker
description: Provides comprehensive steps for deploying Bee nodes using Docker containers with volume management and network configuration.
---

# Docker Install
Expand Down
1 change: 1 addition & 0 deletions docs/bee/installation/fund-your-node.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Fund Your Node
id: fund-your-node
description: Outlines xDAI and xBZZ token requirements by use case and provides guidance on acquiring tokens from exchanges and faucets.
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions docs/bee/installation/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Getting Started
id: getting-started
description: Introduces Bee node types their requirements and available installation methods to help users choose appropriate setup approaches.
---

*If you want to get a Bee node up and running ASAP, check out the [Quick Start](/docs/bee/installation/quick-start) guide.*
Expand Down
1 change: 1 addition & 0 deletions docs/bee/installation/hive.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Hive
id: hive
description: Describes tools and orchestration methods for managing multiple Bee nodes using Docker Compose Helm or manual configuration.
---

Due to the mechanics of Swarm's [storage incentives](/docs/concepts/incentives/redistribution-game), node operators may wish to run multiple nodes in order to maximize earning potential. Read [The Book of Swarm](https://www.ethswarm.org/the-book-of-swarm-2.pdf) for more information on how the
Expand Down
1 change: 1 addition & 0 deletions docs/bee/installation/package-manager.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Package Manager Install
id: package-manager-install
description: Guides installation using system package managers (APT RPM Homebrew) with background service configuration and management.
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/bee/installation/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Quickstart
id: quick-start
description: Accelerates Bee setup with shell script installation and swarm-cli tools enabling rapid node deployment and network interaction.
---

This guide will help you install and run a Bee [light node](/docs/bee/working-with-bee/node-types) using the [shell script](/docs/bee/installation/shell-script-install) install method. After explaining how to install and start the node, the guide then explains how to use the [`swarm-cli` command line tool](/docs/bee/working-with-bee/swarm-cli) to find your node's address, fund your node, and fully initialize it so that it is ready interact with the network.
Expand Down
1 change: 1 addition & 0 deletions docs/bee/installation/set-target-neighborhood.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Set Target Neighborhood
id: set-target-neighborhood
description: Explains how to strategically assign node neighborhoods using Swarmscan data to optimize staking rewards and network resilience.
---

In older versions of Bee, [neighborhood](/docs/concepts/DISC/neighborhoods) assignment was random by default. However, we can maximize a node's chances of winning xBZZ and also strengthen the resiliency of the network by strategically assigning neighborhoods to new nodes (see the [staking section](/docs/bee/working-with-bee/staking) for more details).
Expand Down
1 change: 1 addition & 0 deletions docs/bee/installation/shell-script.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Shell Script Install
id: shell-script-install
description: Provides flexible installation using an automated shell script supporting Linux and macOS with customizable configuration options.
---

import Tabs from '@theme/Tabs';
Expand Down
3 changes: 3 additions & 0 deletions docs/bee/installation/verify.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
description: Reference documentation for node verification procedures.
---
verify.md

https://github.com/ethersphere/bee/pull/1581
1 change: 1 addition & 0 deletions docs/bee/working-with-bee/backups.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Backups
id: backups
description: Details critical backup procedures for keys password and node data across various installation methods and platforms.
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
1 change: 1 addition & 0 deletions docs/bee/working-with-bee/bcrypt.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Bcrypt hashing utility
id: bcrypt
description: Shows how to generate and validate bcrypt password hashes using Bee's built-in utilities or external tools.
---

In order to generate a valid admin password hash you can use any available bcrypt compatible tools, both [online](https://bcrypt-generator.com/) and offline (htpasswd).
Expand Down
1 change: 1 addition & 0 deletions docs/bee/working-with-bee/bee-api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Bee API
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.
Expand Down
1 change: 1 addition & 0 deletions docs/bee/working-with-bee/cashing-out.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Cashing Out
id: cashing-out
description: Explains how to withdraw earned xBZZ rewards and manage cheques through the bandwidth incentives SWAP system.
---

There are two different types of cashing out. The first type is cashing out xBZZ rewards earned from staking and providing storage services (this method also allows for withdrawal of the native xDAI token). The second type is for the withdrawal of xBZZ earned through bandwidth incentives (SWAP). Both types are explained below:
Expand Down
1 change: 1 addition & 0 deletions docs/bee/working-with-bee/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Configuration
id: configuration
description: Documents all Bee configuration options available through YAML files environment variables and command-line flags.
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/bee/working-with-bee/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Introduction
id: introduction
description: Overview of node operation topics including configuration API access backups monitoring and upgrade procedures.
---

In this section we cover everything a node operator needs to know about working with Bee:
Expand Down
1 change: 1 addition & 0 deletions docs/bee/working-with-bee/logs-and-files.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Logging in Bee
id: logs-and-files
description: Guides log access rotation verbosity levels and structured logging integration with monitoring tools like Prometheus and Grafana.
---

# Logging in Bee
Expand Down
1 change: 1 addition & 0 deletions docs/bee/working-with-bee/monitoring.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Monitoring Your Node
id: monitoring
description: Explains how to monitor Bee node metrics using Prometheus and Grafana for tracking cheque rates and network performance.
---

Your Bee node is equipped with tools to help you understand what your Bee has been up to!
Expand Down
1 change: 1 addition & 0 deletions docs/bee/working-with-bee/node-types.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Node Types
id: node-types
description: Compares full light and ultra-light node types with their features requirements and configuration for different use cases.
---


Expand Down
3 changes: 2 additions & 1 deletion docs/bee/working-with-bee/staking.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Staking
id: staking
description: Walkthrough of depositing xBZZ to participate in the storage incentives redistribution game and earn network rewards.
---

## Quickstart Guide
Expand Down Expand Up @@ -107,7 +108,7 @@ After staking you should [check your node's status](/docs/bee/working-with-bee/s
### Step 4: Monitor & Maximize Rewards

✅ Make sure you are using a stable Gnosis Chain [RPC endpoint](/docs/bee/working-with-bee/configuration#setting-blockchain-rpc-endpoint).
✅ [Check your node's status](/docs/bee/working-with-bee/staking#check-redistribution-status) to ensure it's operating properly.
✅ [Check your node's status](/docs/bee/working-with-bee/staking#check-status) to ensure it's operating properly.
✅ [Check `/rchash`](/docs/bee/working-with-bee/bee-api#rchash) to ensure your node's performance is sufficient.


Expand Down
1 change: 1 addition & 0 deletions docs/bee/working-with-bee/swarm-cli.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Swarm CLI
id: swarm-cli
description: Introduces swarm-cli command-line tool that simplifies node interaction uploads downloads and batch management.
---

**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.
Expand Down
1 change: 1 addition & 0 deletions docs/bee/working-with-bee/uninstalling-bee.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Uninstalling Bee
id: uninstalling-bee
description: Instructions for cleanly removing Bee installations across different operating systems and package managers.
---

Choose the appropriate uninstallation method based on how Bee was installed:
Expand Down
1 change: 1 addition & 0 deletions docs/bee/working-with-bee/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Upgrading Bee
id: upgrading-bee
description: Procedures for safely upgrading Bee to latest versions while preserving keys avoiding round disruption and cashing out rewards.
---

It's very important to keep Bee up to date to benefit from security updates and ensure you are able to properly interact with the Swarm network. The [#node-operators](https://discord.com/channels/799027393297514537/811553590170353685) channel is an excellent resource for any of your questions regarding node operation.
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/DISC/DISC.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: DISC
id: disc
description: Overview of Swarm's Distributed Immutable Storage of Chunks system using Kademlia neighborhoods and synchronization protocols.
---

import bos_fig_2_7 from '/static/img/bos_fig_2_7.jpg';
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/DISC/erasure-coding.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Erasure Coding
id: erasure-coding
description: Explains optional data protection technique using redundant chunks at multiple protection levels to ensure reliable data recovery.
---

Erasure coding (also known as erasure code) is an efficient and flexible approach to data protection which is an optional feature for Swarm uploads. It is a technique that increases data protection by enabling the recovery of original data even when some encoded chunks are lost or corrupted. When used, it ensures that data on Swarm can always be accessed reliably, even if some nodes or entire neighborhoods go offline. Refer to the [official erasure coding paper](https://papers.ethswarm.org/p/erasure/) for more in depth details.
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/DISC/kademlia.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Kademlia
id: kademlia
description: Details distributed hash table algorithm using XOR distance metrics for efficient decentralized lookups and network routing.
---

import bos_fig_2_3 from '/static/img/bos_fig_2_3.jpg';
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/DISC/neighborhoods.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Neighborhoods
id: neighborhoods
description: Describes proximity-based node groupings that share storage responsibilities using proximity order to determine neighborhoods.
---

In Swarm, a neighborhood refers to an area of responsibility within the network, where nodes in proximity to one another share the task of storing and maintaining data chunks. Nodes within a neighborhood replicate chunks to ensure that if one node goes offline, other nodes in the neighborhood can still retrieve and serve the content.
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/access-control.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Access Control
id: access-control
description: Introduces Access Control Trie (ACT) for managing encryption and permissions in decentralized storage with content sharing capabilities.
---

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.
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/incentives/bandwidth-incentives.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Bandwidth Incentives (SWAP)
id: bandwidth-incentives
description: Explains SWAP protocol for managing bandwidth resource exchange between nodes using cheques and off-chain accounting.
---

The Swarm Accounting Protocol (SWAP) is a protocol used to manage the exchange of bandwidth resources between nodes. SWAP ensures that node operators collaborate in routing messages and data while protecting the network against frivolous use of bandwidth. The protocol combines off-chain peer-to-peer based accounting with on-chain settlement through the chequebook contract.
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/incentives/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Incentives Overview
id: overview
description: Describes dual incentive mechanisms combining storage incentives for data retention and bandwidth incentives for data relay.
---

import { globalVariables } from '/src/config/globalVariables'
Expand Down
3 changes: 2 additions & 1 deletion docs/concepts/incentives/postage-stamps.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Postage Stamps
id: postage-stamps
description: Details prepaid batch system for uploading data to Swarm with dynamic pricing based on network redundancy signals.
---

Postage stamps are used to pay for storing data on Swarm. They are purchased in batches, granting a prepaid right to store data on Swarm, similar to how real-world postage stamps pay for mail delivery.
Expand Down Expand Up @@ -42,7 +43,7 @@ Each batch of stamps has two key parameters, `batch depth` and `amount`, which a
### Batch Depth

:::caution
The minimum value for `depth` is 17, however higher depths are recommended for most use cases due to the [mechanics of stamp batch utilisation](#batch-utilisation). See [the depths utilisation table](#effective-utilisation-table) to help decide which depth is best for your use case.
The minimum value for `depth` is 17, however higher depths are recommended for most use cases due to the [mechanics of stamp batch utilisation](#batch-utilisation). See [the depths utilisation table](#effective-utilisation-tables) to help decide which depth is best for your use case.
:::

`Batch depth` determines how much data can be stored by a batch. The number of chunks which can be stored (stamped) by a batch is equal to $$2^{batchDepth}$$.
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/incentives/price-oracle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Price Oracle
id: price-oracle
description: Describes smart contract mechanism for dynamically adjusting postage stamp prices based on network utilization data.
---

The job of the [oracle contract](https://github.com/ethersphere/storage-incentives/blob/master/src/PriceOracle.sol) is to set the price of postage stamps. The oracle contract uses data from the [redistribution contract](https://github.com/ethersphere/storage-incentives/blob/master/src/Redistribution.sol) in order to set the appropriate price for postage stamps through the [postage stamp contract](https://github.com/ethersphere/storage-incentives/blob/master/src/PostageStamp.sol). The data from the redistribution contract is used to calculate a "utilisation signal". This signal is an indicator of how much the Swarm network’s data storage capacity is being utilized. Specifically, the signal is a measure of data redundancy on the network. Redundancy is a measure of how many copies of each piece of data can be stored by the network. The protocol targets a fourfold level of data redundancy as a safe minimum.
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/incentives/redistribution-game.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Redistribution Game
id: redistribution-game
description: Explains game-theoretic system distributing xBZZ from postage stamps to full nodes that honestly store data.
---

The redistribution game distributes xBZZ collected from [postage stamp](/docs/concepts/incentives/postage-stamps) purchases, rewarding nodes for providing storage. Redistribution rewards incentivize nodes to continue providing storage to the network. The game is designed so that the most profitable strategy for participants is to store their assigned data honestly.
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Introduction
id: introduction
description: Overview of Swarm's peer-to-peer infrastructure the Bee client and the Swarm Foundation's mission for decentralized storage.
---


Expand Down
1 change: 1 addition & 0 deletions docs/concepts/pss.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: PSS
id: pss
description: Explains Postal Service over Swarm messaging protocol enabling secure private and efficient communication between network nodes.
---

PSS, or Postal Service over Swarm, is a messaging protocol that enables users to send and receive messages over Swarm. It is an essential component of Swarm's infrastructure, providing secure, private, and efficient communication between nodes.
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/what-is-swarm.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: What is Swarm?
id: what-is-swarm
description: Details Swarm's four-layer architecture including underlay overlay data access and application layers for decentralized storage.
---

import bos_fig_1_1 from '/static/img/bos_fig_1_1.jpg';
Expand Down
1 change: 1 addition & 0 deletions docs/desktop/access-content.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Access Content
id: access-content
description: Guide for using Swarm Desktop application to download and retrieve content from the Swarm network.
---

Accessing content on Swarm using Swarm Desktop is easy. All you need to get started is the Swarm hash for the content you wish to access. Whenever content is [uploaded to Swarm](/docs/desktop/upload-content) a Swarm hash is generated as a reference to that content.
Expand Down
1 change: 1 addition & 0 deletions docs/desktop/backup-restore.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Backup and Restore
id: backup-restore
description: Instructions for backing up and restoring wallet keys and data in the Swarm Desktop application.
---

## Create a Backup
Expand Down
1 change: 1 addition & 0 deletions docs/desktop/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Configuration
id: configuration
description: Explains configuration options and settings available in the Swarm Desktop user interface.
---


Expand Down
1 change: 1 addition & 0 deletions docs/desktop/install.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Install
id: install
description: Provides installation instructions for the Swarm Desktop GUI application on Windows macOS and Linux.
---

## Download and Install Swarm Desktop
Expand Down
1 change: 1 addition & 0 deletions docs/desktop/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Introduction
id: introduction
description: Overview of Swarm Desktop graphical interface for managing nodes uploading and downloading content.
---

![](/img/swarm-desktop.png)
Expand Down
1 change: 1 addition & 0 deletions docs/desktop/postage-stamps.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Postage Stamps
id: postage-stamps
description: Guide for purchasing and managing postage stamp batches through the Swarm Desktop interface.
---


Expand Down
1 change: 1 addition & 0 deletions docs/desktop/publish-a-website.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Publish a Website
id: publish-a-website
description: Step-by-step instructions for uploading and hosting websites on Swarm using the Desktop application.
---

## Step by Step Guide
Expand Down
Loading