Skip to content

Feat: documentation for smart contracts #299

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.

Sign up for GitHub

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

Open
0xCardiE wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Feat: documentation for smart contracts #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f6ddcc
change order, add info and docs
0xCardiE Jul 31, 2025
01f66c5
info about all tasks
0xCardiE Oct 27, 2025
a0fe821
add contracts and deployment docs
0xCardiE Oct 27, 2025
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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

This repository contains the smart contracts for Swarm's storage incentives.

## 📚 Documentation

Comprehensive documentation is available in the [`docs/`](docs/) directory:
- [Overview](./docs/OVERVIEW.md) - System architecture and mechanics
- [PostageStamp](./docs/POSTAGE_STAMP.md) - Postage stamp batch management
- [PriceOracle](./docs/PRICE_ORACLE.md) - Dynamic pricing system
- [StakeRegistry](./docs/STAKING.md) - Staking for node operators
- [Redistribution](./docs/REDISTRIBUTION.md) - Schelling game details
- [Deployment Guide](./docs/DEPLOYMENT.md) - How to deploy contracts

# Overview

In order to distribute to upload content to the Swarm network, _batches_ of _postage stamps_ are purchased by nodes. These _stamps_ are then attached to content that is divided into 4kb chunks and then uploaded to the Swarm network. In order to distribute the proceeds from the sales of these _batches_, a [Schelling Co-ordination Game](https://en.wikipedia.org/wiki/Coordination_game) is implemented using the smart contracts contained in this repository, in order to identify nodes storing the canonical subset of valid chunks that fall within the radius of responsibility of each node in a _neighbourhood_ at the time of their application. Correct identification of this hash qualifies a node to apply to receive a reward comprising value arising from _expired_ _batches_.
Expand Down
Loading
Loading