lotus/documentation/en/mining.md

# Storage Mining

Here are instructions to learn how to perform storage mining. For hardware specifications please read [this](https://docs.lotu.sh/en+hardware-mining).

It is useful to [join the Testnet](https://docs.lotu.sh/en+join-testnet) prior to attempting storage mining for the first time.

## Note: Using the Lotus Storage Miner from China

If you are trying to use `lotus-storage-miner` from China. You should set this **environment variable** on your machine.

```sh
IPFS_GATEWAY="https://proof-parameters.s3.cn-south-1.jdcloud-oss.com/ipfs/"
```

## Get started

Please ensure that at least one **BLS address** (starts with `t3`) in your wallet exists with the following command:

```sh
lotus wallet list
```

If you do not have a bls address, create a new bls wallet:

```sh
lotus wallet new bls
```

With your wallet address:

- Visit the [faucet](https://faucet.testnet.filecoin.io)
- Click "Create Miner"
- DO NOT REFRESH THE PAGE. THIS OPERATION CAN TAKE SOME TIME.

The task will be complete when you see:

```sh
New storage miners address is: <YOUR_NEW_MINING_ADDRESS>
```

## Initialize the storage miner

In a CLI window, use the following command to start your miner:

```sh
lotus-storage-miner init --actor=ACTOR_VALUE_RECEIVED --owner=OWNER_VALUE_RECEIVED
```

Example

```sh
lotus-storage-miner init --actor=t01424 --owner=t3spmep2xxsl33o4gxk7yjxcobyohzgj3vejzerug25iinbznpzob6a6kexcbeix73th6vjtzfq7boakfdtd6a
```

You will have to wait some time for this operation to complete.

## Mining

To mine:

```sh
lotus-storage-miner run
```

If you are downloading **Filecoin Proof Parameters**, the download can take some time.

Get information about your miner:

```sh
lotus-storage-miner info
# example: miner id `t0111`
```

**Seal** random data to start producing **PoSts**:

```sh
lotus-storage-miner sectors pledge
```

- Warning: On Linux configurations, this command will write data to `$TMPDIR` which is not usually the largest partition. You should point the value to a larger partition if possible.

Get **miner power** and **sector usage**:

```sh
lotus state power
# returns total power

lotus state power <miner>

lotus state sectors <miner>
```

## Performance tuning

### `FIL_PROOFS_MAXIMIZE_CACHING=1` Environment variable

This env var can be used with `lotus-storage-miner`, `lotus-seal-worker`, and `lotus-bench` to make the precommit1 step faster at the cost of some memory use (1x sector size)

### `FIL_PROOFS_USE_GPU_COLUMN_BUILDER=1` Environment variable

This env var can be used with `lotus-storage-miner`, `lotus-seal-worker`, and `lotus-bench` to enable experimental precommit2 GPU acceleration

### Setting multiaddresses

Set multiaddresses for the miner to listen on in a miner's `config.toml` file 
(by default, it is located at `~/.lotusminer/config.toml`). The `ListenAddresses` in this file should be interface listen addresses (usually `/ip4/0.0.0.0/tcp/PORT`), and the `AnnounceAddresses` should match the addresses being passed to `set-addrs`.

The addresses passed to `set-addrs` parameter in the commands below should be currently active and dialable; confirm they are before entering them.

Once the config file has been updated, set the on-chain record of the miner's listen addresses:
 
 ```
 lotus-miner actor set-addrs <multiaddr_1> <multiaddr_2> ... <multiaddr_n>
```

This updates the `MinerInfo` object in the miner's actor, which will be looked up
when a client attempts to make a deal. Any number of addresses can be provided.

Example:

```
 lotus-miner actor set-addrs /ip4/123.123.73.123/tcp/12345 /ip4/223.223.83.223/tcp/23456 
```
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`# Storage Mining`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00
documentation: fixes formatting issue and removes copy issue 2019-12-18 21:46:09 +00:00			`Here are instructions to learn how to perform storage mining. For hardware specifications please read [this](https://docs.lotu.sh/en+hardware-mining).`
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00
documentation: fixes formatting issue and removes copy issue 2019-12-18 21:46:09 +00:00			`It is useful to [join the Testnet](https://docs.lotu.sh/en+join-testnet) prior to attempting storage mining for the first time.`
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00
desktop: updates proof parameter step with environment variable 2019-12-23 05:39:26 +00:00			`## Note: Using the Lotus Storage Miner from China`
documentation: makes it easy to discover the v20 proof parameters 2019-12-18 22:48:52 +00:00
desktop: updates proof parameter step with environment variable 2019-12-23 05:39:26 +00:00			If you are trying to use `lotus-storage-miner` from China. You should set this environment variable on your machine.
documentation: makes it easy to discover the v20 proof parameters 2019-12-18 22:48:52 +00:00
			```sh
desktop: updates proof parameter step with environment variable 2019-12-23 05:39:26 +00:00			`IPFS_GATEWAY="https://proof-parameters.s3.cn-south-1.jdcloud-oss.com/ipfs/"`
documentation: makes it easy to discover the v20 proof parameters 2019-12-18 22:48:52 +00:00			```
documentation: latest updates from feedback across team 2019-12-09 12:53:40 +00:00
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`## Get started`

docs: Provide clearer instructions around bls wallets for miners 2020-02-12 23:36:56 +00:00			Please ensure that at least one BLS address (starts with `t3`) in your wallet exists with the following command:
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00
			```sh
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`lotus wallet list`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00			```

docs: Provide clearer instructions around bls wallets for miners 2020-02-12 23:36:56 +00:00			`If you do not have a bls address, create a new bls wallet:`

			```sh
			`lotus wallet new bls`
			```

documentation: latest updates from feedback across team 2019-12-09 12:53:40 +00:00			`With your wallet address:`

Fix 3 typos 2020-05-14 22:27:47 +00:00			`- Visit the [faucet](https://faucet.testnet.filecoin.io)`
documentation: support for scripting auth environment variables 2019-12-10 10:01:26 +00:00			`- Click "Create Miner"`
documentation: latest updates from feedback across team 2019-12-09 12:53:40 +00:00			`- DO NOT REFRESH THE PAGE. THIS OPERATION CAN TAKE SOME TIME.`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00
documentation: latest updates from feedback across team 2019-12-09 12:53:40 +00:00			`The task will be complete when you see:`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			```sh
documentation: latest updates from feedback across team 2019-12-09 12:53:40 +00:00			`New storage miners address is: <YOUR_NEW_MINING_ADDRESS>`
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			```
documentation: light copy adjustments before major revision 2019-12-02 00:08:53 +00:00
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`## Initialize the storage miner`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00
documentation: latest updates from feedback across team 2019-12-09 12:53:40 +00:00			`In a CLI window, use the following command to start your miner:`

documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00			```sh
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`lotus-storage-miner init --actor=ACTOR_VALUE_RECEIVED --owner=OWNER_VALUE_RECEIVED`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00			```

documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`Example`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00
			```sh
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`lotus-storage-miner init --actor=t01424 --owner=t3spmep2xxsl33o4gxk7yjxcobyohzgj3vejzerug25iinbznpzob6a6kexcbeix73th6vjtzfq7boakfdtd6a`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00			```

documentation: latest updates from feedback across team 2019-12-09 12:53:40 +00:00			`You will have to wait some time for this operation to complete.`
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00
			`## Mining`

			`To mine:`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00
			```sh
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`lotus-storage-miner run`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00			```

documentation: fixes formatting issue and removes copy issue 2019-12-18 21:46:09 +00:00			`If you are downloading Filecoin Proof Parameters, the download can take some time.`
documentation: support for scripting auth environment variables 2019-12-10 10:01:26 +00:00
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`Get information about your miner:`

			```sh
			`lotus-storage-miner info`
			# example: miner id `t0111`
			```
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00
documentation: small copy updates 2019-12-04 15:39:41 +00:00			`Seal random data to start producing PoSts:`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00
			```sh
docs: seal-worker updates 2020-05-12 19:09:40 +00:00			`lotus-storage-miner sectors pledge`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00			```

documentation: fixes formatting issue and removes copy issue 2019-12-18 21:46:09 +00:00			- Warning: On Linux configurations, this command will write data to `$TMPDIR` which is not usually the largest partition. You should point the value to a larger partition if possible.
documentation: mining updates from recent TestNet updates 2019-12-11 12:29:48 +00:00
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`Get miner power and sector usage:`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00
			```sh
Update mining.md lotus-storage-miner state power should be changed to lotus state power 2020-06-27 15:16:24 +00:00			`lotus state power`
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`# returns total power`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00
Update mining.md lotus-storage-miner state power should be changed to lotus state power 2020-06-27 15:16:24 +00:00			`lotus state power <miner>`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00
Update mining.md lotus-storage-miner state power should be changed to lotus state power 2020-06-27 15:16:24 +00:00			`lotus state sectors <miner>`
documentation: removes old docs folder, adds new documentation folder with organized content 2019-12-01 08:21:20 +00:00			```
docs: document some mining-related env vars 2020-05-12 19:37:23 +00:00
			`## Performance tuning`

			### `FIL_PROOFS_MAXIMIZE_CACHING=1` Environment variable

			This env var can be used with `lotus-storage-miner`, `lotus-seal-worker`, and `lotus-bench` to make the precommit1 step faster at the cost of some memory use (1x sector size)

			### `FIL_PROOFS_USE_GPU_COLUMN_BUILDER=1` Environment variable

			This env var can be used with `lotus-storage-miner`, `lotus-seal-worker`, and `lotus-bench` to enable experimental precommit2 GPU acceleration
Update mining.md 2020-07-29 10:59:39 +00:00
			`### Setting multiaddresses`

Update mining.md 2020-07-30 06:57:25 +00:00			Set multiaddresses for the miner to listen on in a miner's `config.toml` file
			(by default, it is located at `~/.lotusminer/config.toml`). The `ListenAddresses` in this file should be interface listen addresses (usually `/ip4/0.0.0.0/tcp/PORT`), and the `AnnounceAddresses` should match the addresses being passed to `set-addrs`.
Update mining.md 2020-07-29 10:59:39 +00:00
Update mining.md 2020-07-30 06:57:25 +00:00			The addresses passed to `set-addrs` parameter in the commands below should be currently active and dialable; confirm they are before entering them.

			`Once the config file has been updated, set the on-chain record of the miner's listen addresses:`
Update mining.md 2020-07-29 10:59:39 +00:00
			```
			`lotus-miner actor set-addrs <multiaddr_1> <multiaddr_2> ... <multiaddr_n>`
			```

Update mining.md 2020-07-30 06:57:25 +00:00			This updates the `MinerInfo` object in the miner's actor, which will be looked up
Update mining.md 2020-07-29 10:59:39 +00:00			`when a client attempts to make a deal. Any number of addresses can be provided.`

Update mining.md 2020-07-30 06:57:25 +00:00			`Example:`
Update mining.md 2020-07-29 10:59:39 +00:00
			```
			`lotus-miner actor set-addrs /ip4/123.123.73.123/tcp/12345 /ip4/223.223.83.223/tcp/23456`
			```