Forest is an implementation of Filecoin written in Rust. The implementation will take a modular approach to building a full Filecoin node in Rust from the Filecoin Protocol Specification, specifically the virtual machine, blockchain, and node system.
Our crates:
| component | description/crates |
|---|---|
forest |
the command-line interface and daemon (1 crate/workspace) |
node |
the networking stack and storage (7 crates) |
blockchain |
the chain structure and synchronization (6 crates) |
vm |
state transition and actors, messages, addresses (9 crates) |
key_management |
Filecoin account management (1 crate) |
crypto |
cryptographic functions, signatures, and verification (1 crate) |
encoding |
serialization library for encoding and decoding (1 crate) |
ipld |
the IPLD model for content-addressable data (9 crates) |
types |
the forest types (2 crates) |
utils |
the forest toolbox (12 crates) |
Dependencies
- Rust
rustc >= 1.58.1 - Rust WASM target
wasm32-unknown-unknown
rustup install stable
rustup target add wasm32-unknown-unknown
- OS Base-Devel/Build-Essential
- Clang compiler
- OpenCL bindings
# Ubuntu
sudo apt install build-essential clang ocl-icd-opencl-dev
# Archlinux
sudo pacman -S base-devel clang ocl-icd
Installation
# Clone repository
git clone --recursive https://github.com/chainsafe/forest
cd forest
# Install binary to $HOME/.cargo/bin and run node
make install
forest
To create release binaries, checkout the latest tag and compile with the release feature.
git checkout $TAG
cargo build --release --bin forest --features release
Config
Run the node with custom config and bootnodes
forest --config /path/to/your_config.toml
Example of config options available:
data_dir = "" genesis_file = "" [network] listening_multiaddr = "" bootstrap_peers = ["" ]
Example of a multiaddress: "/ip4/54.186.82.90/tcp/1347/p2p/12D3K1oWKNF7vNFEhnvB45E9mw2B5z6t419W3ziZPLdUDVnLLKGs"
Forest will look for config files in the following order and priority:
- Paths passed to the command line via the
--configflag. - The environment variable
FOREST_CONFIG_PATH, if no config was passed through command line arguments. - If none of the above are found, Forest will look in the systems default configuration directory (
$XDG_CONFIG_HOMEon Linux systems). - After all locations are exhausted and a config file is not found, a default configuration is assumed and used.
Logging
The Forest logger uses Rust's log filtering options with the RUST_LOG environment variable. For example:
RUST_LOG="debug,forest_libp2p::service=info" forest
Will show all debug logs by default, but the forest_libp2p::service logs will be limited to info
Testing
# To run base tests
cargo test # use `make test-release` for longer compilation but faster execution
# To pull serialization vectors submodule and run serialization and conformance tests
make test-vectors
# To run all tests and all features enabled
make test-all
Joining the testnet
Build with the interopnet config with:
make interopnet
# Run and import past the state migrations to latest network version
./target/release/forest --import-snapshot ./types/networks/src/interopnet/snapshot.car
Importing the snapshot only needs to happen during the first run. Following this, to restart the daemon run:
./target/release/forest
Interacting with Forest via CLI
When the Forest daemon is started, an admin token will be displayed. You will need this for commands that require a higher level of authorization (like a password). Forest, as mentioned above, uses multiaddresses for networking. This is no different in the CLI. To set the host and the port to use, if not using the default port or using a remote host, set the FULLNODE_API_INFO environment variable. This is also where you can set a token for authentication.
FULLNODE_API_INFO=":/ip4//tcp//http
Note that if a token is not present in the FULLNODE_API_INFO env variable, the colon is removed.
Forest developers will prepend this variable to CLI commands over using export on Linux or its equivalant on Windows. This will look like the following:
FULLNODE_API_INFO="..." forest auth api-info -p admin
Documentation
Work in progress.
Contributing
- Check out our contribution guidelines: CONTRIBUTING.md
- Have questions? Say hi on Discord!
ChainSafe Security Policy
Reporting a Security Bug
We take all security issues seriously, if you believe you have found a security issue within a ChainSafe project please notify us immediately. If an issue is confirmed, we will take all necessary precautions to ensure a statement and patch release is made in a timely manner.
Please email a description of the flaw and any related information (e.g. reproduction steps, version) to security at chainsafe dot io.
License
Forest is dual licensed under MIT + Apache 2.0.
| x64 | 
| x64 | 
| x64 | soon(TM) | 
| Compile from Source | | 
| x64 | 
| x64 | soon | 
| x64 | soon | 
| Compile from Source | | 
31 Dec 12, 2022
7 Nov 24, 2022
184 Dec 13, 2022
23 Jul 3, 2022
11 Jan 26, 2023
3 Sep 6, 2024
296 Dec 31, 2022
49 Dec 9, 2022
72 Sep 23, 2022
183 Sep 8, 2022
1.2k Dec 27, 2022
611 Dec 25, 2022
123 Dec 27, 2022
13 Dec 20, 2022
137 Dec 29, 2022
109 Dec 13, 2022
7 Jun 29, 2022
5 Mar 7, 2022
34 Dec 19, 2022