Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updare intro doc #225

Merged
merged 2 commits into from
Sep 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/master/Intro_to_Venus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Venus overview

Venus is one of the implementations of Filecoin storage network, which focuses on distributed architecture and a more concise division of functionalities. Storage resources are geographically dipersed, which means as long as there is internet connection a storage cluster can be connected to the Venus storage pool.

## Architecture

The venus components/modules includes includes [venus](https://github.com/filecoin-project/venus), [venus-auth](https://github.com/filecoin-project/venus-auth), [venus-miner](https://github.com/filecoin-project/venus-miner), [venus-messager](https://github.com/filecoin-project/venus-messager), [venus-gateway](https://github.com/ipfs-force-community/venus-gateway), [venus-wallet](https://github.com/filecoin-project/venus-wallet), [venus-sealer](https://github.com/filecoin-project/venus-sealer), and [venus-market](https://github.com/filecoin-project/venus-market). Based on functionalities, the components can be broken into shared components (chain services) and independent components. As a storage provider using chain services, it is no longer required to maintain chain synchronization, micro manage the sending of each message and more. As a chain services provider with hardware resources, it can build chain services for other storage providers and potentially charge service fees from them. For large storage providers, they can also take advantage of venus architecture to allow quicker expansion and easier maintenance.

The following figure demonstrates how each component interacts with each other. In this illustration, chain services is serving one storage provider and can easily scale to serve multiple storage providers.

![](../.vuepress/public/venus-cluster.png)

The following shows venus components to lotus components relationship.

* venus-auth --> token authentication service extend lotus jwt
* venus-miner --> lotus-miner block produce part & multi miner
* venus-sealer --> lotus-miner sealer scheduler part/wd
* venus-worker --> lotus-worker
* venus daemon --> lotus daemon
* venus-wallet -> lotus wallet part
* venus-messager --> lotus mpool
* venus-market --> lotus-miner market part

## How venus works

For more on how each venus components work, please go through this document [here](https://venus.filecoin.io/guide/#how-venus-works).
81 changes: 0 additions & 81 deletions docs/master/Introduction_to_venus_mining_pool.md

This file was deleted.