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.

Sign up for GitHub

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

Jump to bottom

update zh join mining pool doc #127

Merged
merged 1 commit into from
Jul 6, 2021
Merged

update zh join mining pool doc #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions docs/.vuepress/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ module.exports = {
collapsable: false,
children: [
['', 'Overview'],
['How-To-Deploy-MingPool.md', 'How to deploy a mining pool'],
['Using-venus-Shared-Modules.md', 'How to join a mining pool'],
['How-To-Deploy-MingPool.md', 'How to deploy a storage pool'],
['Using-venus-Shared-Modules.md', 'How to join a storage pool'],
['Venus-replace-lotus.md', 'Migrate from Lotus'],
['Chain.md', 'Chain management'],
['How-To-Connect-Network.md', 'Connect to different network'],
Expand Down Expand Up @@ -147,8 +147,8 @@ module.exports = {
collapsable: false,
children: [
['', '启明星概要'],
['How-To-Deploy-MingPool.md', '如何部署矿池'],
['Using-venus-Shared-Modules.md', '如何加入矿池'],
['How-To-Deploy-MingPool.md', '如何部署存储池'],
['Using-venus-Shared-Modules.md', '如何加入存储池'],
['Venus-replace-lotus.md', '从Lotus迁移到Venus'],
['chain.md', '链维护'],
['How-To-Connect-Network.md', '加入不同网络'],
Expand Down
114 changes: 57 additions & 57 deletions docs/zh/guide/Using-venus-Shared-Modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
## 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!
考虑到庞大的初始硬件和Filecoin质押[投资](https://filscan.io/calculator)以及相关的运营成本，开始Filecoin挖掘是一项艰巨的任务。 囊括了安全性、易用性和分布式存储池的想法，Venus将帮助存储提供者，正如社区所说，把[全职工作](https://filecoinproject.slack.com/archives/CEGN061C5/p1610810730117900?thread_ts=1610809298.116800&cid=CEGN061C5)变成为一个严肃的爱好。 希望本教程能让您立即开始挖矿！

## How mining works
## 如何提供存储服务

There are two ways of getting started with mining using Venus.
有两种方法可以开始使用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!)--> (The rest of this tutorial will walk you through this way of deploying venus mining operation)
2. Deploy all required hardware and venus modules by yourself. (See [this](https://venus.filecoin.io/How-To-Deploy-MingPool.html) tutorial to learn more)
1. 部署最少的硬件并获得对第三方托管的共享venus模块的使用帐号。（本教程的其余部分将引导您完成这种部署Venus服务的方式）
2. 自行部署所有需要的硬件和venus模块。 （请参阅[这个](How-To-Deploy-MingPool.md)教程以了解更多信息）

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
## venus模块介绍

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.
根据其在挖矿集群中的作用，模块可以大致分为两类：共享和独立。 共享模块可以被认为是开始封装扇区所需的基础。 大多数与区块链的交互，如链同步、发送消息、赢得赢票等，都是由共享模块处理的。 这个想法是许多矿工都可以共用一组共享模块，从而减少维护成本。 独立模块处理封装和证明您的扇区。如果您选择使用第三方托管的共享Venus模块，您将花费大部分时间在独立模块上。 另请注意，`venus-wallet`模块可以作为共享或独立部署。

| name | role | shared/independent |
| ------------------------------------------------------------ | ----------------------------------------------------- | ------------------ |
Expand All @@ -25,47 +25,47 @@ Depending on its role in a mining cluster, modules could be loosely broken down
| [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.
下图展示了venus模块如何相互交互。

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

## Hardware requirements
## 硬件要求

Learn more about hardware requirements [here](https://docs.filecoin.io/mine/mining-architectures/#protocol-labs-example-architecture).
在[此处](https://github.com/filecoin-project/community-china/discussions/18)了解有关硬件要求的更多信息。

## Pre-requisites
## 前期准备

Before diving into deployment of your mining operation, please make sure you go through the following steps.
在深入部署您的挖矿操作之前，请确保您已完成以下步骤。

:::warning

It is recommended that you test your setup in nerpa or calibration network before deploying on mainnet.
建议您在部署到主网上之前在`nerpa` 或`calibration`网络中测试您的配置。

:::

### Setup your permanent storage
### 永久存储

Choose a network file system that you are familiar with (NFS for example) and deploy your storage cluster.
选择您熟悉的网络文件系统（例如 NFS）并部署您的存储集群。

### 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 said service and have them set it up for you.
如果您尝试连接到第三方托管的共享venus模块，联系上述服务的管理员并让他们为您设置。

:::tip

venus-wallet can be deployed as either a shared or independent module depend on your security requirement.
venus-wallet 可以部署为共享或独立模块，具体取决于您的安全要求。

:::

#### 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.
如果您是托管共享 venus 模块的管理员，请使用以下命令为您的矿工创建一个帐户。

```bash
# If miner doesn't have a <MINER_ID> yet, leave out --miner flag and use 'updateUser' when user inited their miner id
Expand All @@ -75,11 +75,11 @@ $ ./venus-auth genToken --perm write <ACCOUNT_NAME>
<AUTH_TOKEN_FOR_ACCOUNT_NAME>
```

### Software dependencies
### 软件依赖

You will need to have the following software installed before running venus.
在运行 venus 之前，您需要安装以下软件。

#### Build tools
#### 构建工具

Ubuntu/Debian:

Expand All @@ -95,13 +95,13 @@ sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.

#### Go

To build venus, you need a working installation of [Go 1.16 or higher](https://golang.org/dl/).
构建venus，您需要安装[Go 1.16 或更高版本](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:
将 `/usr/local/go/bin` 添加到您的路径并设置`go env`。对于大多数Linux系统，您可以运行以下内容：

```bash
echo "export PATH=$PATH:/usr/local/go/bin" >> ~/.bashrc && source ~/.bashrc
Expand All @@ -110,11 +110,11 @@ 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.
如果卡住，请参阅[官方Golang安装说明](https://golang.org/doc/install)。

## Install venus-wallet
## 安装venus-wallet

Download and compile the source code of venus-wallet.
下载并编译`Venus-wallet`的源代码。

```bash
$ git clone https://github.com/filecoin-project/venus-wallet.git
Expand All @@ -124,19 +124,19 @@ $ git checkout <RELEASE_TAG>
$ make
```

Run venus-wallet module in background.
在后台运行`venus-wallet`模块。

```bash
$ nohup ./venus-wallet run > wallet.log 2>&1 &
```

:::tip

Use `tail -f wallet.log` to monitor wallet log.
使用 `tail -f wallet.log` 来监控钱包日志。

:::

Setup a password for your venus-wallet.
为您的`venus-wallet`设置密码。

```bash
$ ./venus-wallet setpwd
Expand All @@ -147,11 +147,11 @@ Password set successfully

:::warning

Please keep backups of your password and store them properly.
请备份您的密码并妥善保存。

:::

Generate owner and worker addresses. (If you don't have an existing miner id)
生成owner和worker地址。（如果您没有现有的miner ID）

```bash
$ ./venus-wallet new bls
Expand All @@ -162,11 +162,11 @@ $ ./venus-wallet new bls

:::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).
如果您在`Nerpa`或`Calibration`上进行测试，则必须使用来自水龙头的测试币为您的所有地址提供资金。 对于 nerpa，请使用此[水龙头](https://faucet.nerpa.interplanetary.dev/funds.html)。对于校准网，请使用此[水龙头](https://faucet.calibration.fildev.network/funds.html)。

:::

Change `[APIRegisterHub]` section of `~/.venus_wallet/config.toml` using the credential you get from shared module admin.
使用您从共享模块管理员处获得的帐号信息更改 `~/.venus_wallet/config.toml`中的`[APIRegisterHub]` 部分。

```toml
[APIRegisterHub]
Expand All @@ -175,7 +175,7 @@ Token = "<AUTH_TOKEN_FOR_ACCOUNT_NAME>"
SupportAccounts = ["<ACCOUNT_NAME>"]
```

Restart venus-wallet so that the changes takes into effect.
重新启动`venus-wallet`以使更改生效。

```bash
# grep [PID] of venus-wallet process
Expand All @@ -187,13 +187,13 @@ $ nohup ./venus-wallet run > wallet.log 2>&1 &

:::tip

Using process controll like `systemmd` or `supervisord` is recommended.
建议使用`systemd`或`supervisord`等线程控制。

:::

## Install venus-sealer
## 安装venus-sealer

Download and compile the source code of venus-sealer.
下载并编译`venus-sealer`的源代码。

```bash
$ git clone https://github.com/filecoin-project/venus-sealer.git
Expand All @@ -204,9 +204,9 @@ $ make deps
$ make
```

### Initialize sealer with a new miner id
### 创建新的miner-id来初始化sealer

If you don't have a miner id yet, run the following command to initialize sealer.
如果您还没有miner-id，请运行以下命令来初始化sealer。

```bash
$ nohup ./venus-sealer init \
Expand Down Expand Up @@ -240,9 +240,9 @@ $ nohup ./venus-sealer init \
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 an existing miner id
### 使用现有的miner-id初始化sealer

If you already have a miner id, run the following command to initialize sealer.
如果您已经有miner-id，请运行以下命令来初始化sealer。

```bash
$ ./venus-sealer init \
Expand All @@ -268,39 +268,39 @@ $ ./venus-sealer init \
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.
运行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.
如果您是第一次运行sealer，它会开始下载证明参数，这可能需要相当长的时间。 如果您位于中国，请按照提示 [此处](../advanced/Tips-Running-In-China.md)加快流程。

:::

Attach permanent storage to sealer.
将永久存储连接到sealer。

```bash
$ ./venus-sealer storage attach --init --store <ABSOLUTE_PATH_OF_YOUR_PERMANENT_STORAGE> --seal <ABSOLUTE_PATH_OF_YOUR_SEALING_STORAGE>
```

Pledge a single sector.
封装一个扇区。

```bash
$ ./venus-sealer sectors pledge
```

Check ongoing sealing job.
检查正在进行的封装工作。

```bash
$ ./venus-sealer sealing
```

See `venus-sealer -h` for list of commands that sealer supports.
参见`venus-sealer -h` 获取sealer支持的命令列表。

```bash
$ ./venus-sealer -h
Expand Down Expand Up @@ -334,6 +334,6 @@ GLOBAL OPTIONS:
--version, -v print the version (default: false)
```

## Questions?
## 问题?

Find us on [Slack](https://filecoinproject.slack.com/archives/CEHHJNJS3)!
来[Slack](https://filecoinproject.slack.com/archives/CEHHJNJS3)上找我们吧！