Reference implementation of the Filecoin protocol, written in Go
Go to file
2021-03-25 15:29:20 +01:00
.circleci make: Fix parallel gen 2021-03-25 15:21:57 +01:00
.github Update proving-issues.md 2021-02-27 00:55:55 -05:00
api api: struct.go -> proxy_gen.go 2021-03-25 15:11:37 +01:00
blockstore Merge pull request #5794 from filecoin-project/fix/atomic-first 2021-03-25 13:29:59 +01:00
build make: Fix parallel gen 2021-03-25 15:21:57 +01:00
chain Merge remote-tracking branch 'origin/master' into feat/v1-api 2021-03-25 14:13:21 +01:00
cli Merge apistruct with the api package 2021-03-25 15:10:08 +01:00
cmd Merge apistruct with the api package 2021-03-25 15:10:08 +01:00
conformance Merge branch 'master' into refactor/lib/blockstore 2021-02-28 19:55:23 +00:00
documentation make docsgen work with versioned api 2021-03-23 17:20:56 +01:00
extern Merge pull request #5801 from filecoin-project/fix/fsm-input-stuck 2021-03-12 19:02:15 +01:00
gen api: struct.go -> proxy_gen.go 2021-03-25 15:11:37 +01:00
genesis port to v2 imports 2020-10-21 12:16:23 -07:00
journal unshare the journal 2020-10-09 13:23:07 -07:00
lib backupds: handle log bool in shed 2021-03-24 21:26:24 +01:00
lotuspond Generate v3 methods for pond 2021-01-28 19:01:28 +01:00
markets Fix unseal comment 2021-03-22 14:39:03 +01:00
metrics Merge apistruct with the api package 2021-03-25 15:10:08 +01:00
miner add godocs to miner objects. 2021-03-25 13:02:19 +01:00
node Merge apistruct with the api package 2021-03-25 15:10:08 +01:00
paychmgr fix paychmgr constructor to take an easier to implement interface 2021-03-12 00:39:20 -08:00
scripts bugfix: fixup devnet script 2020-11-22 00:11:39 +08:00
storage wdpost: Always head tipset to get randomness 2021-03-11 09:59:26 +01:00
system avoid global ResourceConstraints. 2020-12-02 22:26:30 +00:00
testplans Fix lotus-soup build 2021-03-25 15:29:20 +01:00
tools digitalocean pass test (#5721) 2021-03-25 13:25:11 +01:00
.codecov.yml Add misc tooling to codecov ignore list 2021-01-13 17:07:27 +01:00
.dockerignore add docker support 2019-12-05 11:31:32 +08:00
.gitignore OpenRPC Support (#5843) 2021-03-19 19:22:46 +01:00
.gitmodules remove extern/blst 2021-01-20 16:19:07 +01:00
.golangci.yml Lint everything 2020-08-20 20:46:36 -07:00
CHANGELOG.md Fix CHANGELOG for Lotus v.1.5.3 2021-03-24 00:13:31 -04:00
Dockerfile.lotus add job to build docker image and push to AWS ECR private repo 2021-01-20 16:27:19 +01:00
go.mod OpenRPC Support (#5843) 2021-03-19 19:22:46 +01:00
go.sum OpenRPC Support (#5843) 2021-03-19 19:22:46 +01:00
LICENSE-APACHE Add basic readme and licenses 2019-08-01 21:26:11 -07:00
LICENSE-MIT Add basic readme and licenses 2019-08-01 21:26:11 -07:00
Makefile make: Fix parallel gen 2021-03-25 15:21:57 +01:00
README.md README: refine Contribute section. 2021-01-12 16:59:48 +00:00
SECURITY.md Update SECURITY.md (#5246) 2020-12-23 00:48:25 -03:00

Project Lotus Logo

Project Lotus - 莲


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

Building & Documentation

For instructions on how to build, install and setup lotus, please visit https://docs.filecoin.io/get-started/lotus.

Reporting a Vulnerability

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:

Contribute

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:

  1. If the proposal entails a protocol change, please first submit a Filecoin Improvement Proposal.
  2. If the change is complex and requires prior discussion, open an issue or a discussion to request feedback before you start working on a pull request. This is to avoid disappointment and sunk costs, in case the change is not actually needed or accepted.
  3. Please refrain from submitting PRs to adapt existing code to subjective preferences. The changeset should contain functional or technical improvements/enhancements, bug fixes, new features, or some other clear material contribution. Simple stylistic changes are likely to be rejected in order to reduce code churn.

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.

License

Dual-licensed under MIT + Apache 2.0