Reference Filecoin VM implementation (v4; dev)

This repository contains the reference implementation of the Filecoin VM (specs). It is written in Rust, and intended to be integrated via FFI into non-Rust clients (e.g. Lotus, Fuhon), or directly into Rust clients (e.g. Forest). FFI bindings for Go are provided in-repo, and developers are encouraged to contribute bindings for other languages.

See the Project Website for details.

Build requirements

• Install rustup.

Build instructions

$ git clone https://github.com/filecoin-project/ref-fvm.git
$ cd ref-fvm
$ make

Code structure

Here's what you'll find in each directory:

• /fvm
  • The core of the Filecoin Virtual Machine. The key concepts are:
    • Machine: an instantiation of the machine, anchored at a specific state root and epoch, ready to intake messages to be applied.
    • Executor: an object to execute messages on a Machine.
    • CallManager: tracks and manages the call stack for a given message.
    • Invocation container (conceptual layer, not explicitly appearing in code): the WASM instance + sandbox under which a given actor in the call stack runs.
    • Kernel: the environment attached to an invocation container for external interactions.
  • There are two API boundaries in the system:
    1. the boundary between the actor code and the Kernel, which is traversed by invoking Syscalls.
    2. the boundary between the FVM and the host node, represented by Externs.
  • Some parts of the FVM are based on the Forest implementation.
• /sdk
  • Reference SDK implementation to write Filecoin native actors, used by the canonical built-in actors through the Actors FVM Runtime shim.
  • User-defined FVM actors written in Rust can also use this SDK, although it is currently quite rough around the edges. In the next weeks, we expect to sweeten it for improved developer experience.
  • Alternative SDKs will emerge in the community. We also expect community teams to develop SDKs in other WASM-compilable languages such as Swift, Kotlin (using Kotlin Native), and even Go (via the TinyGo compiler).
• /shared
  • A crate of core types and primitives shared between the FVM and the SDK.
• /ipld
  • IPLD libraries. Some of which are based on, and adapted from, the Forest implementation.
• /testing/conformance
  • Contains the test vector runner, as well as benchmarking utilities on top of it.
  • The conformance test runner feeds the test vector corpus located at https://github.com/filecoin-project/fvm-test-vectors into ref-fvm, in order to validate spec conformance.
  • The benchmarking utilities use the criterion Rust library to measure the performance and overhead of ref-fvm across various facets.
  • See the instructions about how to run the tests and the benchmarks.
  • Disclaimers
    • Benchmarks are currently very slow to run, setup and teardown. This is due to using default WASM cache, and will be fixed soon.

Versioning

At least of 202409, ref-fvm follows this versioning scheme:

• Use the major version whenever we need to make large structural changes where maintaining backwards compatibility without accidentally introducing state mis-matches would be difficult. Basically, major versions drop support for prior network versions. This lets us import multiple copies of the FVM (one per major version) so we can continue to execute/explore old network state.
• Use the minor version to indicate potentially breaking rust API changes. Minor versions keep support for prior network versions. This is how most rust projects would use their major version.
• Use the patch version to indicate that the release is API (rust) compatible with the previous release. Patch releases may add support for new network versions (assuming the patch is on the latest major version), fix bugs, etc.

Below is the mapping between ref-fvm versions and the network upgrade versions they support:

These are relevant issues/discussions about changing FVM versioning:

• https://github.com/filecoin-project/ref-fvm/issues/358
• https://github.com/filecoin-project/ref-fvm/issues/1724

License

Dual-licensed: MIT, Apache Software License v2, by way of the Permissive License Stack.

actors and vm forked from ChainSafe/forest commit: 73e8f95a108902c6bef44ee359a8478663844e5b

lib.rs:

AMT crate for use as rust IPLD data structure

Data structure reference: https://github.com/ipld/specs/blob/51fab05b4fe4930d3d851d50cc1e5f1a02092deb/data-structures/vector.md