awfeequdng / forest

🌲 Rust Filecoin Node Implementation

🌲 Forest

Forest is an implementation of Filecoin written in Rust. The implementation will take a modular approach to building a full Filecoin node in two parts — (i) building Filecoin’s security critical systems in Rust from the Filecoin Protocol Specification, specifically the virtual machine, blockchain, and node system, and (ii) integrating functional components for storage mining and storage & retrieval markets to compose a fully functional Filecoin node implementation.

❗Current development should be considered a work in progress.

Our crates:

crate	description
blockchain	Chain structures and syncing functionality
crypto	Verification and signature definitions
encoding	Forest encoding and decoding
ipld	IPLD data model for content-addressable data
node	Networking synchronization and storage
vm	State transition and actor, message and address definitions

Dependencies

rustc >= 1.40.0

Usage

# Clone repository
git clone https://github.com/chainsafe/forest
cd forest

# Install binary to $HOME/.cargo/bin and run node
make install
forest

Testing

cargo test

Documentation

https://chainsafe.github.io/forest/

Contributing

• Check out our contribution guidelines: CONTRIBUTING.md
• Have questions? Say hi on Discord!

License

Forest is dual licensed under MIT + Apache 2.0.