Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 3.45 KB

README.md

File metadata and controls

55 lines (34 loc) · 3.45 KB
Raw

Project Venus Logo

Damocles

Damocles is a solution for Filecoin storage power clusters, focusing on growing and maintaining said storage power. Compared with lotus, it tries to make breakthroughs in the following aspects:

  • Simplifies sealing state machine
  • More efficient usage of resources through optimized procedures
  • Taking advantages of Venus chain service and Venus storage deal service to maximize storage providing performance
  • Multi miner_id support and collaboration

Damocles is composed of damocles-worker and damocles-manager. The former is used for PoRep computations and latter is used for sector management and interactions with Filecoin chain.

Building & Documentation

For instructions on how to quickly bootstrap your storage power service using damocles, please visit here.

For instructions on more intricate details of damocles configurations, please visit here.

Venus Architecture

Venus architecture mianly compose of three parts: chain service, storage deal service and storage power service. Learn more about each of them here.

Related Components

Venus loosely describes a collection of components 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.

Here are some resources to help you get started:

Development environment

  1. Install flox
  2. Activate the environment with flox activate

Community

For general help in using damocles, please refer to the documentation hosted within the repo. For additional help, you can use one of these channels to ask a question:

  • Slack (For live discussion with the Community)
  • GitHub (Feature/Bug reports, Contributions)
  • Twitter (Get the news fast)
  • Meetups (A monthly online meetup about Venus in general)
  • I'm feeling lucky (Pick up a good first issue now!)