venus

command module
v1.7.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 5, 2022 License: Apache-2.0, MIT Imports: 5 Imported by: 0

README

Project Venus Logo

Project Venus - 启明星


Venus 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 join a venus storage pool, please visit here.

Venus architecture

With key features like security, ease of use and distributed storage pool, the deployment of a node using Venus is quite different from the one using Lotus. Details of mining architecture can be found here.

Venus loosely describes a collection of modules that work together to realize a fully featured Filecoin implementation. List of stand-alone venus modules repos can be found here, each assuming different roles in the functioning of Filecoin.

Contribute

Venus 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

This project is dual-licensed under Apache 2.0 and MIT.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
app
cmd
Package commands implements the command to print the blockchain.
Package commands implements the command to print the blockchain.
fixtures
pkg
fvm
gen
net
net/exchange
Package exchange contains the ChainExchange server and client components.
Package exchange contains the ChainExchange server and client components.
util/blockstoreutil
blockstoreutil contains all the basic blockstore constructors used by lotus.
blockstoreutil contains all the basic blockstore constructors used by lotus.
vm
tools
venus-shared
actors
WARNING: This file has automatically been generated
WARNING: This file has automatically been generated
api
api/chain/v0
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
api/chain/v0/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
api/chain/v1
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
api/chain/v1/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
api/gateway/v0
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
api/gateway/v0/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
api/gateway/v1
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
api/gateway/v1/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
api/market
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
api/market/client
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
api/market/client/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
api/market/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
api/messager
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
api/messager/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
api/wallet
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
Code generated by github.com/filecoin-project/venus/venus-devtool/api-gen.
api/wallet/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL