Eudico is a modularised implementation of Lotus, itself an implementation of the Filecoin Distributed Storage Network. For more details about Filecoin, check out the Filecoin Spec. This is a work-in-progress, intended to enable easier experimentation with future protocol features, and is not meant to be used in the production network.

Note: The default eudico branch is the dev branch, please use with caution.

For complete instructions on how to build, install and setup eudico, please visit the Lotus documentation at https://docs.filecoin.io/get-started/lotus. Basic build instructions can be found further down in this readme.

Please send an email to [email protected]. See our security policy for more details.

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

• go-fil-markets which has its own kanban work tracker available here
• specs-actors which has its own kanban work tracker available here

Eudico is an 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:

1. Adhere to the standard Go formatting guidelines, e.g. Effective Go. Run go fmt.
2. Stick to the idioms and patterns used in the codebase. Familiar-looking code has a higher chance of being accepted than eerie code. Pay attention to commonly used variable and parameter names, avoidance of naked returns, error handling patterns, etc.
3. Comments: follow the advice on the Commentary section of Effective Go.
4. Minimize code churn. Modify only what is strictly necessary. Well-encapsulated changesets will get a quicker response from maintainers.
5. Lint your code with golangci-lint (CI will reject your PR if unlinted).
6. Add tests.
7. Title the PR in a meaningful way and describe the rationale and the thought process in the PR description.
8. Write clean, thoughtful, and detailed commit messages. This is even more important than the PR description, because commit messages are stored inside the Git history. One good rule is: if you are happy posting the commit message as the PR description, then it's a good commit message.

System-specific Software Dependencies:

Building Eudico 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 Eudico, 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 Eudico suite (eudico, eudico-miner, and eudico-worker).

1. Clone the repository:

   git clone https://github.com/filecoin-project/eudico.git
   cd eudico/

Note: The default branch eudico is the dev branch where the latest new features, bug fixes and improvement are in.

2. To join mainnet -- don't!

   If you are changing networks from a previous 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 Eudico 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.

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 the complete instructions. Note, if you are building the proof binaries from source, installing rustup is also needed.

5. Build and install Eudico:

   make clean all #mainnet
   
   # Or to join a testnet or devnet:
   make clean calibnet # Calibration with min 32GiB sectors
   
   sudo make eudico

   This will put eudico, eudico-miner and eudico-worker in /usr/local/bin.

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

6. You should now have Eudico installed. You can now start the Eudico daemon and sync the chain.

Dual-licensed under MIT + Apache 2.0