OpenViSTAI · Agents · Blockchain · Crypto
Submit a project
Menu
Protocols

Lotus

Lotus is a Go-based reference implementation of the Filecoin protocol and distributed storage network, with command-line software for running and interacting with Filecoin network services.

Explore the practical guide ↓

Independent OpenViST project profile, based on linked sources.

Lotus — OpenViST project profile in Protocols.
OpenViST project illustration. See the linked sources for product details.
Understand the project

Practical overview

When it fits

Use Lotus when you need the software implementation to run Filecoin network services or to develop against the Filecoin protocol, rather than a hosted interface for managing storage.

Who it is for

  • Operators building Lotus to join a Filecoin network.
  • Developers creating tools or storage-network software that interacts with or builds on the Filecoin protocol.

Documented uses

  • Build and install the Lotus suite for a selected Filecoin network.
  • Start a Lotus daemon and sync the chain after installation.
  • Develop tools and storage-network software based on the Filecoin implementation.
Before you choose

Requirements & limits

  • The target network determines which release, branch, tag or commit to build.
  • The documented build requires Go 1.26.8 or later and operating-system-specific dependencies.
  • The basic build uses prebuilt proof binaries; compiling proof binaries from source adds Rust as a prerequisite.
  • The default master branch is a development branch, while the README directs mainnet users to the latest release.

Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.

Source-based practical guide

Set up Lotus API access with filecoin.js on Calibration

Set up a local Calibration Lotus node and a Node.js project configured to query the Lotus API.

Before you start

  • Familiarity with Filecoin, Lotus, and the Lotus command line.
  • Node.js and NPM, plus the dependencies listed on the Lotus installation page.
  • A local Lotus node and test FIL in a wallet for the tutorial’s verification steps.

Steps

  1. Clone the Lotus repository, identify and check out the latest release tag, or check out a specific release if needed.

  2. Build and install the Calibration version with the command below and sudo make install.

    Documented command
    make clean calibnet

  3. Download the latest Calibration chain snapshot using the CID listed under Genesis CAR file, then sync the node; the tutorial notes that syncing can take several hours. Create a wallet and request test FIL from the faucet, then enable remote API access on the node.

  4. Create a Node.js project with mkdir build-with-lotus && cd build-with-lotus && npm init, then install the client library with the command below.

    Documented command
    npm install filecoin.js

Expected outcome

The Calibration node and Node.js project are set up for the next documented stage: writing and running a filecoin.js script to connect to the node and query its API.

Guide limitations

  • The guide does not include the snapshot CID, wallet/faucet procedure, or steps to enable remote API access; follow the linked installation and API tutorial for those details.
  • The node must finish syncing before the tutorial’s sync verification indicates it is ready.
  • Some Lotus API calls require an authorization token.
Documentation 1 ↗Documentation 2 ↗Documentation 3 ↗
Evidence and transparency

Sources & review

Official repository ↗Guide documentation ↗Guide documentation ↗
Source record details
Source availability
Active
Sources checked
17 October 2026
Original website title
filecoin-project/lotus · Official homepage title · retained in its source language
How we review sourcesSuggest a correction