Reference implementation of the Filecoin protocol, written in Go
Go to file
Łukasz Magiera efd86876b4
Merge pull request #5329 from filecoin-project/deps/update-pubsub
update go-libp2p-pubsub to v0.4.1
2021-01-12 17:58:33 +01:00
.circleci trigger testplans only on merge to master 2020-11-23 20:04:24 +01:00
.github move conformance tvx tool to lotus. 2020-09-27 20:10:05 +01:00
api feat: better CLI for wallet market withdraw and client info 2021-01-07 10:18:29 +01:00
build Merge pull request #5277 from filcloud/update-newest-version 2021-01-11 16:13:23 +01:00
chain Merge pull request #4192 from filecoin-project/schomatis/sync/remove-self-bypass 2021-01-12 14:52:50 +01:00
cli Merge pull request #5252 from filcloud/send-fund-check 2021-01-11 16:42:38 +01:00
cmd Merge pull request #5222 from filcloud/bench-env 2021-01-06 20:17:42 +01:00
conformance tvx extract: more tipset extraction goodness. 2020-12-27 18:58:35 +00:00
documentation Merge pull request #5277 from filcloud/update-newest-version 2021-01-11 16:13:23 +01:00
extern gofmt 2021-01-11 16:44:11 +01:00
gen refactor: FundManager 2020-11-10 19:44:26 -08: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 Fix race in blockstore test suite 2021-01-05 20:34:28 +01:00
lotuspond pond: Fix MpoolPushMessage call 2020-11-09 18:42:22 +01:00
markets markets: Fix deal expired panic 2020-12-17 12:01:51 +01:00
metrics add metrics for delayed blocks. 2020-12-10 14:52:05 +00:00
miner optimize code use existence var 2020-12-03 09:54:57 +08:00
node feat: better CLI for wallet market withdraw and client info 2021-01-07 10:18:29 +01:00
paychmgr fix: when waiting for deal commit messages, ignore unsuccessful messages 2020-12-14 12:30:52 +01:00
scripts bugfix: fixup devnet script 2020-11-22 00:11:39 +08:00
storage Refactor DefaultMessageSendSpec 2020-12-08 20:51:27 +01:00
system avoid global ResourceConstraints. 2020-12-02 22:26:30 +00:00
testplans Allow miners to filter (un)verified deals 2020-12-02 01:32:34 -05:00
tools use actor abstraction in metrics command 2020-10-11 20:31:20 -07:00
.codecov.yml fix code coverage ignore 2020-10-14 18:21:16 -07:00
.dockerignore add docker support 2019-12-05 11:31:32 +08:00
.gitignore add keygen outfile 2020-12-04 18:39:35 +08:00
.gitmodules remove oni submodule 2020-11-06 21:03:56 +01:00
.golangci.yml Lint everything 2020-08-20 20:46:36 -07:00
CHANGELOG.md Lotus version 1.4.0 2020-12-19 16:18:32 -05:00
go.mod update go-libp2p-pubsub to v0.4.1 2021-01-12 17:24:15 +02:00
go.sum update go-libp2p-pubsub to v0.4.1 2021-01-12 17:24:15 +02: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 Create a calibnet build option 2021-01-05 00:32:15 -05:00
README.md README.md: refine Contribute section. 2021-01-12 16:04:43 +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.

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