The open-source, canonical implementation of Farcaster's Snapchain network.
Snapchain is a data storage layer for the Farcaster network. It is a blockchain-like decentralized p2p network that stores data created by users of Farcaster's social network. Learn more about Snapchain's design from the whitepaper.
The main goals of this implementation are:
-
High Throughput: Written in Rust and aims to process at least 10,000 transactions per second.
-
Data Availability: Can be run in the cloud for under $1,000/month and provide real-time access to the entire network.
-
Canonical Implementation: Is the most accurate reference for how Snapchain and Farcaster should work.
Snapchain is currently in early alpha. Please check the release section of the specification for the latest timelines.
We welcome contributions from developers of all skill levels. Please look for issues labeled with "help wanted" to find good tickets to work on. If you are working on something that is not explicitly a ticket, we may or may not accept it. We encourage checking with someone on the team before spending a lot of time on something.
We will ban and report accounts that appear to engage in reputating farming by using LLMs or automated tools to generate PRs.
Before you begin, ensure you have the following installed:
- Rust (latest stable version)
- Cargo (comes with Rust)
- Protocol Buffers compiler (protoc)
- First clone the malachite repo and checkout the correct commit:
git clone [email protected]:informalsystems/malachite.git cd malachite git checkout 8a9f3702eb41199bc8a7f45139adba233a04744a # Remember to update GitHub workflow when changing cd code && cargo build - Then clone the snapchain repo and build it:
cd .. git clone https://github.com/farcasterxyz/snapchain-v0.git cd snapchain-v0 cargo build
After setting up your Rust toolchain above, you can run tests with:
cargo test
For development, you can run multiple nodes by running:
make dev
These will be configured to communicate with each other.
To query a node, you can run grpcurl from within the container:
docker compose exec node1 grpcurl -import-path proto -proto proto/rpc.proto list
You can remove any cached items by running:
make clean