Merge pull request #110 from Fatman13/fatman13-join-venus-pool

doc for joining venus mining pool
filecoin-project · Jun 8, 2021 · 96aa5ee · 96aa5ee
2 parents c9dd3dc + cf14edd
commit 96aa5ee
Show file tree

Hide file tree

Showing 3 changed files with 314 additions and 2 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -27,7 +27,7 @@ module.exports = {
         ['vuepress-plugin-code-copy', true]
     ],
     head: [
-        ['link', {rel: 'icon', href: '/assets/icon-coin-128.png'}]
+        ['link', {rel: 'icon', href: '/assets/venus-logo.png'}]
     ],
     locales: {
         '/': {
@@ -75,7 +75,8 @@ module.exports = {
                         children: [
                             ['Home.md', 'Home'],
                             ['Overview.md', 'Overview'],
-                            ['How-To-Deploy-MingPool.md', 'How to deploy mingPool'],
+                            ['How-To-Deploy-MingPool.md', 'How to deploy mining pool'],
+                            ['Using-venus-Shared-Modules.md', 'How to join mining pool'],
                             ['Venus-replace-lotus.md', 'Venus replace Lotus'],
                             ['Tips-Running-In-China.md', 'Tips running in China'],
                             ['venus_load_balancing.md', 'Venus load balancing'],

diff --git a/docs/.vuepress/public/assets/venus-logo.png b/docs/.vuepress/public/assets/venus-logo.png
diff --git a/docs/Using-venus-Shared-Modules.md b/docs/Using-venus-Shared-Modules.md
@@ -0,0 +1,311 @@
+# Table of Contents
+
+[[TOC]]
+
+## Background
+
+Starting filecoin mining could be a daunting task given not only the large initial hardware and filecoin collateral [investment](https://filscan.io/calculator) but also the entailing operation commitment. With ideas of security, ease of use and distributed mining pool in mind, Venus implementation of filecoin will help miners turn, what community say, [a full time job](https://filecoinproject.slack.com/archives/CEGN061C5/p1610810730117900?thread_ts=1610809298.116800&cid=CEGN061C5) into a serious hobby. Hope this tutorial will get you started mining in no time! 
+
+## How mining works
+
+There are two ways of getting started with mining using Venus. 
+
+1. Deploy minimum hardware and gain access to a publicly hosted shared venus modules. (Checkout venus incubation center page to learn more on how you can get an account setup!)
+2. Deploy all required hardware and venus modules by yourself.
+
+After following the rest of the trutorial and successful deployment, you can start pledging sectors, grow power and evantually obtain block rewards through your contribution to the network's storage capacity!
+
+## Introducing venus modules
+
+Depending on its role in a mining cluster, modules could be loosely broken down into two category: shared and independent. Shared modules could be thought as the plumbings of what you need to start sealing sectors. Most of the dealings with the blockchain like chain synchronizations, sending messages, winning a block and etc are handled by the shared modules. The idea is that many miners could all use a set of shared modules, thus reducing overhead in maintainence. Independent modules handles sealing and proving of your sectors, where you will be spend most of your time if you choose to use a publicly hosted shared venus modules. Note also that venus-wallet module could be deployed as either shared or independent. 
+
+| name                                                         | role                                                  | shared/independent |
+| ------------------------------------------------------------ | ----------------------------------------------------- | ------------------ |
+| [venus](https://github.com/filecoin-project/venus)           | daemon for chain interactions                         | shared             |
+| [venus-miner](https://github.com/filecoin-project/venus-miner) | block winning and proving                             | shared             |
+| [venus-messager](https://github.com/filecoin-project/venus-messager) | chain message management                              | shared             |
+| [venus-auth](https://github.com/filecoin-project/venus-auth) | utility for authorized use of shared modules          | shared             |
+| [venus-gateway](https://github.com/ipfs-force-community/venus-gateway) | utility for controlled access point of shared modules | shared             |
+| [venus-wallet](https://github.com/filecoin-project/venus-wallet) | addresses/keys management                             | shared/independent |
+| [venus-sealer](https://github.com/filecoin-project/venus-sealer), [venus-worker](https://github.com/filecoin-project/venus-sealer) | job scheduling, sealing and proving                   | independent        |
+
+## Mining architecture
+
+Diagram below illustrates how venus modules interacts with one and another.
+
+<img src="/Users/fatman13/d2d2d/venus-docs/docs/zh/images/venus-arch.png" alt="./zh/images/venus-arch.png"  />
+
+## Hardware requirements
+
+Learn more about hardware requirements [here](https://docs.filecoin.io/mine/mining-architectures/#protocol-labs-example-architecture).
+
+## Pre-requisites
+
+Before diving into deployment of your mining operation, please make sure you check the following. It is recommended that you test your setup in nerpa and calibration network before deploying on mainnet.
+
+### Setup your permanent storage
+
+Choose a network file system that you are familiar with (NFS for example) and deploy your storage cluster.
+
+### Get your account setup in shared modules
+
+There are two ways to have your account setup.
+
+#### For miners connecting to shared modules
+
+If you are trying to connect to a hosted shared venus modules, like ones provided by venus incubation center, contact admin of the service and have them set it up for you.
+
+#### For admins of shared modules
+
+If you are an admin hosting shared venus modules, use the following command to create an account for your miner.
+
+```bash
+# If miner doesn't have <MINER_ID> yet, leave out --miner flag
+$ ./venus-auth addUser --name <ACCOUNT_NAME> --miner <MINER_ID>
+# The returned token is what miner have to add into their config file in order to gain access to your shared modules
+$ ./venus-auth genToken --perm write <ACCOUNT_NAME>
+<AUTH_TOKEN_FOR_ACCOUNT_NAME>
+```
+
+### Software dependencies
+
+You will need the following software installed before running venus.
+
+#### Build tools
+
+Ubuntu/Debian:
+
+```shell
+sudo apt install mesa-opencl-icd ocl-icd-opencl-dev gcc git bzr jq pkg-config curl clang build-essential hwloc libhwloc-dev wget -y && sudo apt upgrade -y
+```
+
+#### Go
+
+To build venus, you need a working installation of [Go 1.16 or higher](https://golang.org/dl/).
+
+```bash
+wget -c https://golang.org/dl/go1.16.2.linux-amd64.tar.gz -O - | sudo tar -xz -C /usr/local
+```
+
+Add `/usr/local/go/bin` to your path and setup `Go` env. For most Linux distributions you can run something like:
+
+```bash
+echo "export PATH=$PATH:/usr/local/go/bin" >> ~/.bashrc && source ~/.bashrc
+# setup go env
+go env -w GOPROXY=https://goproxy.io,direct
+go env -w GO111MODULE=on
+```
+
+See the [official Golang installation instructions](https://golang.org/doc/install) if you get stuck.
+
+## Install venus-wallet
+
+Download and compile the source code of venus-wallet.
+
+```bash
+$ git clone https://github.com/filecoin-project/venus-wallet.git
+# change directory to venus-wallet
+$ cd venus-wallet 
+# ?network
+$ make
+```
+
+Run venus-wallet module in background.
+
+```bash
+$ nohup ./venus-wallet run > wallet.log 2>&1 &
+```
+
+::: Tip 
+
+Use `tail -f wallet.log` to monitor wallet log.
+
+:::
+
+Setup a password for your venus-wallet.
+
+```bash
+$ ./venus-wallet setpwd
+Password:******
+Enter Password again:******
+```
+
+Generate owner and worker addresses. (If you don't have an existing miner id)
+
+```bash
+$ ./venus-wallet new bls
+<OWNER_ADDRESS>
+$ ./venus-wallet new bls
+<WORKER_ADDRESS>
+```
+
+::: Tip
+
+If you are testing on Nerpa or Calibration, you have to fund all your addresses with test coins from faucets. For nerpa, use this [faucet](https://faucet.nerpa.interplanetary.dev/funds.html). For calibration, use this [faucet](https://faucet.calibration.fildev.network/funds.html). :::
+
+Change `[APIRegisterHub]` section of of the config file using the credential you get from shared module admin.
+
+```toml
+[APIRegisterHub]
+RegisterAPI = ["/ip4/<IP_ADDRESS_OF_VENUS_WALLET>/tcp/45132"]
+Token = "<AUTH_TOKEN_FOR_ACCOUNT_NAME>"
+SupportAccounts = ["<ACCOUNT_NAME>"]
+```
+
+Restart venus-wallet so that the changes takes into effect.
+
+```bash
+# grep [PID] of venus-wallet process
+$ ps -ef | grep wallet
+# kill the process and restart
+$ kill [PID]
+$ nohup ./venus-wallet run > wallet.log 2>&1 &
+```
+
+::: Tip
+
+Using process controll like  `systemmd` or `supervisord` is recommended.
+
+:::
+
+## Install venus-sealer
+
+Download and compile the source code of venus-sealer.
+
+```bash
+$ git clone https://github.com/filecoin-project/venus-sealer.git
+$ cd venus-sealer
+# make dependency
+$ make deps
+$ make
+```
+
+### Initialize sealer with a new miner id
+
+If you don't have a miner id yet, run the following command to initialize sealer.
+
+```bash
+$ nohup ./venus-sealer init \
+--worker <WORKER_ADDRESS> \
+--owner <OWNER_ADDRESS>  \
+# Choose between 32G or 64G for mainnet
+--sector-size 512M \
+# Choose from nerpa, calibration. Leave out --network for mainet?
+--network nerpa \
+# Point to different shared venus modules
+--node-url /ip4/<IP_ADDRESS_OF_VENUS>/tcp/3453 \
+--messager-url /ip4/<IP_ADDRESS_OF_VENUS_MESSAGER>/tcp/3453 \
+--gateway-url /ip4/<IP_ADDRESS_OF_VENUS_GATEWAY>/tcp/3453 \
+--auth-token <AUTH_TOKEN_FOR_ACCOUNT_NAME> \
+# Flags sealer to not storing any sealed sectors on the machine it runs on
+--no-local-storage \
+--wallet-name ? \
+> sealer.log 2>&1 &
+
+# Check log to see if miner id is created succussfully
+2021-04-25T18:41:31.925+0800	INFO	main	venus-sealer/init.go:182	Checking if repo exists
+2021-04-25T18:41:31.926+0800	INFO	main	venus-sealer/init.go:217	Checking full node version
+2021-04-25T18:41:31.927+0800	INFO	main	venus-sealer/init.go:233	Initializing repo
+2021-04-25T18:41:31.928+0800	INFO	main	venus-sealer/init.go:309	Initializing libp2p identity
+2021-04-25T18:41:32.082+0800	INFO	main	venus-sealer/init.go:485	Pushed CreateMiner message: aaf489f9-af4b-4e4b-9084-018d43f05b7e
+2021-04-25T18:41:32.082+0800	INFO	main	venus-sealer/init.go:486	Waiting for confirmation
+2021-04-25T18:46:32.088+0800	INFO	main	venus-sealer/init.go:502	New miners address is: t01640 (t2cxzf7xvrqo3froqn2xgdqjdbydhkcrgakj7j3ma)
+# miner id on nerpa and calibration starts with "t", while miner id on mainnet starts with "f"
+2021-04-25T18:46:32.088+0800	INFO	main	venus-sealer/init.go:381	Created new miner: t01640
+2021-04-25T18:46:32.089+0800	INFO	main	venus-sealer/init.go:302	Sealer successfully created, you can now start it with 'venus-sealer run'
+```
+
+### Initialize sealer with a new miner id
+
+If you already have a miner id, run the following command to initialize sealer.
+
+```bash
+$ ./venus-sealer init \
+--actor <MINER_ID>  \
+# Choose from nerpa, calibration. Leave out --network for mainet?
+--network nerpa \
+# Point to different shared venus modules
+--node-url /ip4/<IP_ADDRESS_OF_VENUS>/tcp/3453 \
+--messager-url /ip4/<IP_ADDRESS_OF_VENUS_MESSAGER>/tcp/3453 \
+--gateway-url /ip4/<IP_ADDRESS_OF_VENUS_GATEWAY>/tcp/3453 \
+--auth-token <AUTH_TOKEN_FOR_ACCOUNT_NAME> \
+# Flags sealer to not storing any sealed sectors on the machine it runs on
+--no-local-storage \
+--wallet-name ?
+
+# Expected output
+2021-06-07T04:15:49.170+0800    INFO    main    venus-sealer/init.go:193        Checking if repo exists
+2021-06-07T04:15:49.170+0800    INFO    main    venus-sealer/init.go:205        Checking full node version
+2021-06-07T04:15:49.174+0800    INFO    main    venus-sealer/init.go:221        Initializing repo
+2021-06-07T04:15:49.175+0800    INFO    main    venus-sealer/init.go:334        Initializing libp2p identity
+2021-06-07T04:15:49.181+0800    INFO    main    venus-sealer/init.go:406        Created new miner: t02105
+2021-06-07T04:15:49.181+0800    INFO    main    venus-sealer/init.go:290        Sealer successfully created, you can now start it with 'venus-sealer run'
+```
+
+## Start pledging
+
+Run sealer.
+
+```bash
+$ nohup ./venus-sealer run >> sealer.log 2>&1 &
+```
+
+::: Tip 
+
+If you are running sealer for the 1st time, it will start to download proof parameters, which may take quite some time. If you are located in China, follow the tips [here](https://venus.filecoin.io/Tips-Running-In-China.html) to speed up the process.  :::
+
+Attach permanent storage to sealer.
+
+```bash
+$ ./venus-sealer storage attach --init --store --seal <ABSOLUTE_PATH_OF_YOUR_NETWORK_STORAGE>
+```
+
+Pledge a single sector.
+
+```bash
+$ ./venus-sealer sectors pledge 
+```
+
+Check current sealing job.
+
+```bash
+$ ./venus-sealer sealing
+```
+
+See `venus-sealer -h` for list of commands that sealer supports.
+
+```bash
+$ ./venus-sealer -h
+NAME:
+   venus-sealer - Filecoin decentralized storage network miner
+
+USAGE:
+   venus-sealer [global options] command [command options] [arguments...]
+
+VERSION:
+   1.4.1
+
+COMMANDS:
+   init      Initialize a venus sealer repo
+   run       Start a venus sealer process
+   sectors   interact with sector store
+   actor     manipulate the miner actor
+   info      Print miner info
+   sealing   interact with sealing pipeline
+   storage   manage sector storage
+   messager  message cmds
+   proving   View proving information
+   stop      Stop a running venus sealer
+   version   Print version
+   help, h   Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+   --actor value, -a value  specify other actor to check state for (read only)
+   --color                  (default: false)
+   --help, -h               show help (default: false)
+   --version, -v            print the version (default: false)
+```
+
+## Questions?
+
+Find us on [Slack](https://filecoinproject.slack.com/archives/CEHHJNJS3)!