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** in your wallet exists with the following command:

```sh
lotus wallet list
```

With your wallet address:

- Visit the [faucet](https://lotus-faucet.kittyhawk.wtf/miner.html)
- 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 pledge-sector
```

- 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-storage-miner state power
# returns total power

lotus-storage-miner state power <miner>

lotus-storage-miner state sectors <miner>
```

## Change nickname

Update `~/.lotus/config.toml` with:

```sh
[Metrics]
Nickname="fun"
```
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`

documentation: fixes formatting issue and removes copy issue 2019-12-18 21:46:09 +00:00			`Please ensure that at least one BLS address 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			```

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

			`- Visit the [faucet](https://lotus-faucet.kittyhawk.wtf/miner.html)`
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
Rename pledge-sector License: MIT Signed-off-by: Jakub Sztandera <kubuxu@protocol.ai> 2019-12-08 14:27:28 +00:00			`lotus-storage-miner pledge-sector`
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
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`lotus-storage-miner state power`
			`# returns total power`
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			`lotus-storage-miner state power <miner>`
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			`lotus-storage-miner state sectors <miner>`
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
documentation: current state of public documentation from https://docs.lotu.sh 2019-12-06 15:26:03 +00:00			`## Change nickname`

			Update `~/.lotus/config.toml` with:
documentation: small copy updates 2019-12-04 15:39:41 +00:00
documentation: revisions 2019-12-04 17:53:36 +00:00			```sh
documentation: small copy updates 2019-12-04 15:39:41 +00:00			`[Metrics]`
documentation: latest updates from feedback across team 2019-12-09 12:53:40 +00:00			`Nickname="fun"`
documentation: small copy updates 2019-12-04 15:39:41 +00:00			```