Reference implementation of the Filecoin protocol, written in Go
Go to file
2021-06-08 09:17:40 +05:30
.circleci Merge pull request #6280 from filecoin-project/feat/pieceread-outside-scheduler 2021-06-07 18:11:44 +02:00
.github Fix codeql with go 1.16 2021-06-02 12:49:11 +02:00
api merged master 2021-06-08 09:17:40 +05:30
AppDir/usr/share/icons appimage 2021-06-02 12:16:09 +02:00
blockstore fix: spelling 2021-04-28 22:08:37 -07:00
build finished rebasing PR 2021-06-07 16:02:15 +05:30
chain Fix state manager::Call() 2021-06-03 17:09:42 -04:00
cli remove read task type and run gen and docsgen 2021-06-07 15:03:06 +05:30
cmd merged master 2021-06-08 09:17:40 +05:30
conformance Merge remote-tracking branch 'origin/feat/nv13' into feat/nv13-1.11 2021-05-31 21:38:34 +02:00
documentation merged master 2021-06-08 09:17:40 +05:30
extern merged master 2021-06-08 09:17:40 +05:30
gateway remove duplicated vars. 2021-05-19 18:17:38 +01:00
gen api stub codegen 2021-04-03 13:12:59 +02:00
genesis Allow starting networks from arbitrary actor versions 2021-05-26 12:48:14 -04:00
journal Centralize everything on ipfs/go-log/v2 2021-04-06 15:04:32 +02:00
lib Remove log line when tracing is not configured 2021-05-26 10:45:04 -07:00
lotuspond Merge master into feat/nv13 2021-05-27 12:28:20 +02:00
markets merged master 2021-06-08 09:17:40 +05:30
metrics Merge pull request #6056 from filecoin-project/feat/vm-metrics 2021-04-18 17:07:16 +02:00
miner Merge pull request #6358 from filecoin-project/chore/better_winning_log_harder 2021-05-31 20:59:08 +02:00
node merged master 2021-06-08 09:17:40 +05:30
paychmgr Fix tests 2021-04-06 12:24:58 +02:00
scripts remove temporary edits 2021-06-03 10:44:48 -07:00
snap homeplug 2021-06-06 23:07:59 -07:00
storage Merge remote-tracking branch 'origin/feat/nv13' into feat/nv13-1.11 2021-06-01 21:06:58 +02:00
system avoid global ResourceConstraints. 2020-12-02 22:26:30 +00:00
testplans testplans: lotus-soup: new images with filecoin-ffi ; use default WPoStChallengeWindow 2021-06-07 11:28:24 +02:00
tools Merge remote-tracking branch 'origin/master' into feat/v1-api 2021-04-13 14:24:22 +02: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 remove rice-box.go from gitignore 2021-06-02 12:16:09 +02:00
.gitmodules remove extern/blst 2021-01-20 16:19:07 +01:00
.golangci.yml lint: don't skip builtin 2021-03-25 17:21:56 -07:00
AppImageBuilder.yml include appimage on release 2021-06-03 00:05:43 -07:00
CHANGELOG.md Merge branch 'master' into releases 2021-05-17 17:24:29 -04:00
Dockerfile.lotus Go 1.16 in Dockerfile 2021-06-02 14:42:48 +02:00
go.mod merged master 2021-06-08 09:17:40 +05:30
go.sum merged master 2021-06-08 09:17:40 +05:30
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 Add interop network 2021-06-03 22:43:27 +00:00
README.md Update required golang version to 1.16 2021-06-02 12:29:49 +02: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