Repository files navigation

Lotus is an implementation of the Filecoin Distributed Storage Network. For more details about Filecoin, check out theFilecoin Spec.

For complete instructions on how to build, install and setup lotus, please visithttps://lotus.filecoin.io. Basic build instructions can be found further down in this readme.

Please send an email tosecurity@filecoin.org. See oursecurity policy for more details.

These repos are independent and reusable modules, but are tightly integrated into Lotus to make up a fully featured Filecoin implementation:

• go-fil-markets which has its ownkanban work tracker available here
• builtin-actors

We welcome contributions to Lotus! Please see ourContributing Guide for more details on how to get started.

System-specific Software Dependencies:

Building Lotus requires some system dependencies, usually provided by your distribution.

Ubuntu/Debian:

sudo apt install mesa-opencl-icd ocl-icd-opencl-dev gcc git bzr jq pkg-config curl clang build-essential hwloc libhwloc-dev wget -y && sudo apt upgrade -y

Fedora:

sudo dnf -y install gcc make git bzr jq pkgconfig mesa-libOpenCL mesa-libOpenCL-devel opencl-headers ocl-icd ocl-icd-devel clang llvm wget hwloc hwloc-devel

For other distributions you can find the required dependencieshere. For instructions specific to macOS, you can find themhere.

To build Lotus, you need a working installation ofGo 1.23.7 or higher:

wget -c https://golang.org/dl/go1.23.7.linux-amd64.tar.gz -O -| sudo tar -xz -C /usr/local

TIP:You'll need to add/usr/local/go/bin to your path. For most Linux distributions you can run something like:

echo"export PATH=$PATH:/usr/local/go/bin">>~/.bashrc&&source~/.bashrc

See theofficial Golang installation instructions if you get stuck.

Once all the dependencies are installed, you can build and install the Lotus suite (lotus,lotus-miner, andlotus-worker).

1. Clone the repository:

   git clone https://github.com/filecoin-project/lotus.gitcd lotus/

Note: The default branchmaster is the dev branch where the latest new features, bug fixes and improvement are in. However, if you want to run lotus on Filecoin mainnet and want to run a production-ready lotus, get thelatest release.

2. To join mainnet, checkout thelatest release.

   If you are changing networks from a previous Lotus installation or there has been a network reset, read theSwitch networks guide before proceeding.

   For networks other than mainnet, look up the current branch or tag/commit for the network you want to join in theFilecoin networks dashboard, then build Lotus for your specific network below.

   git checkout<tag_or_branch># For example:git checkout<vX.X.X># tag for a release

   Currently, the latest code on themaster branch corresponds to mainnet.

3. If you are in China, see "Lotus: tips when running in China".

4. This build instruction uses the prebuilt proofs binaries. If you want to build the proof binaries from source check thecomplete instructions. Note, if you are building the proof binaries from source,installing rustup is also needed.

5. Build and install Lotus:

   make clean all#mainnet# Or to join a testnet or devnet:make clean calibnet# Calibration with min 32GiB sectorssudo make install

   This will putlotus,lotus-miner andlotus-worker in/usr/local/bin.

   lotus will use the$HOME/.lotus folder by default for storage (configuration, chain data, wallets, etc). Seeadvanced options for information on how to customize the Lotus folder.

6. You should now have Lotus installed. You can nowstart the Lotus daemon and sync the chain.

7. (Optional) Follow theSetting Up Prometheus and Grafana guide for detailed instructions on setting up a working monitoring system running against a local running lotus node.

Dual-licensed underMIT +Apache 2.0