Lotus is an implementation of the Filecoin Distributed Storage Network. For more details about Filecoin, check out the Filecoin Spec.
Note: The default
master
branch is the dev branch, please use with caution. For the latest stable version, checkout the most recentLatest release
.
For complete instructions on how to build, install and setup lotus, please visit https://docs.filecoin.io/get-started/lotus. Basic build instructions can be found further down in this readme.
Please send an email to security@filecoin.org. See our security 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:
Lotus is a universally open project and welcomes contributions of all kinds: code, docs, and more. However, before making a contribution, we ask you to heed these recommendations:
When implementing a change:
go fmt
.golangci-lint
(CI will reject your PR if unlinted).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 libhwloc-dev
For other distributions you can find the required dependencies here. For instructions specific to macOS, you can find them here.
To build Lotus, you need a working installation of Go 1.16.4 or higher:
wget -c https://golang.org/dl/go1.16.4.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 the official Golang installation instructions if you get stuck.
Once all the dependencies are installed, you can build and install the Lotus suite (lotus
, lotus-miner
, and lotus-worker
).
Clone the repository:
git clone https://github.com/filecoin-project/lotus.git
cd lotus/
Note: The default branch master
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 the latest release here.
To join mainnet, checkout the latest release.
If you are changing networks from a previous Lotus installation or there has been a network reset, read the Switch 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 the Filecoin 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 the master branch corresponds to mainnet.
If you are in China, see "Lotus: tips when running in China".
This build instruction uses the prebuilt proofs binaries. If you want to build the proof binaries from source check the complete instructions. Note, if you are building the proof binaries from source, installing rustup is also needed.
Build and install Lotus:
make clean all #mainnet
# Or to join a testnet or devnet:
make clean calibnet # Calibration with min 32GiB sectors
make clean nerpanet # Nerpa with min 512MiB sectors
sudo make install
This will put lotus
, lotus-miner
and lotus-worker
in /usr/local/bin
.
lotus
will use the $HOME/.lotus
folder by default for storage (configuration, chain data, wallets, etc). See advanced options for information on how to customize the Lotus folder.
You should now have Lotus installed. You can now start the Lotus daemon and sync the chain.
Dual-licensed under MIT + Apache 2.0
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。