cerc-io/lotus
16
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 27 Wiki Activity

documentation: testnet update

Browse Source
This commit is contained in:
wwwjim 2019-12-11 07:38:04 -08:00
parent 1511f52c7f
commit ead62f2cf8
16 changed files with 47 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/cn/join-devnet.md → documentation/cn/join-testnet.md
View File

@ -1,3 +1,3 @@
# Join DevNet
# Join TestNet
工作正在进行中

2
documentation/en/api.md
View File

@ -4,7 +4,7 @@ Here is an early overview of how to make API calls.
Implementation details for the **JSON-RPC** package are [here](https://github.com/filecoin-project/lotus/tree/master/lib/jsonrpc).
## Overview
## Overview: How do you modify the config.toml to change the API endpoint?
API requests are made against `127.0.0.1:1234` unless you modify `.lotus/config.toml`.

2
documentation/en/dev-tools-pond-ui.md
View File

@ -27,6 +27,6 @@ Don't leave Pond unattended for more than 10 hours, the web client will eventual
## Troubleshooting
- Turn it off and on - Start at the top
- `rm -rf ~/.lotus ~/.lotusstorage/`
- `rm -rf ~/.lotus ~/.lotusstorage/`, this command will delete chain sync data, stored wallets, and other configurations so be careful.
- Verify you have the correct versions of dependencies
- If stuck on a bad fork, try `lotus chain sethead --genesis`

4
documentation/en/getting-started.md
View File

@ -7,7 +7,7 @@ For more details about Filecoin, check out the [Filecoin Spec](https://github.co
## What can I learn here?
- How to install Lotus on [Arch Linux](https://docs.lotu.sh/en+install-lotus-arch), [Ubuntu](https://docs.lotu.sh/en+install-lotus-ubuntu), or [MacOS](https://docs.lotu.sh/en+install-lotus-macos).
- Joining the [Lotus DevNet](https://docs.lotu.sh/en+join-devnet).
- Joining the [Lotus TestNet](https://docs.lotu.sh/en+join-testnet).
- [Storing](https://docs.lotu.sh/en+storing-data) or [retrieving](https://docs.lotu.sh/en+retrieving-data) data.
- Mining Filecoin using the **Lotus Storage Miner** in your [CLI](https://docs.lotu.sh/en+mining).
@ -18,6 +18,6 @@ Lotus is architected modularly to keep clean API boundaries while using the same
- The **Lotus Node**
- The **Lotus Storage Miner**
The **Lotus Storage Miner** is intended to be run on the machine that manages a single storage miner instance, and is meant to communicate with the **Lotus Node** via the websockets **JSON-RPC** API for all of the chain interaction needs.
The **Lotus Storage Miner** is intended to be run on the machine that manages a single storage miner instance, and is meant to communicate with the **Lotus Node** via the websocket **JSON-RPC** API for all of the chain interaction needs.
This way, a mining operation may easily run a **Lotus Storage Miner** or many of them, connected to one or many **Lotus Node** instances.

12
documentation/en/hardware-mining.md
View File

@ -10,17 +10,17 @@ BECAUSE OF THIS, OUR STANDARD TESTING CONFIGURATION FOR FILECOIN MAINNET CAN AND
The setup below is a minimal example for sealing 32 GiB sectors on Lotus:
* 3 TB of hard drive space.
* 2 TB of hard drive space.
* 8 core CPU
* 128 GB of RAM
* 128 GiB of RAM
## TestNet discoveries
* 256GB **NVMe** Swap on an SSD for anyone that has 128GB RAM to avoid out of memory issues while mining.
* If you only have 128GiB of ram, enabling 256GB of **NVMe** swap on an SSD will help you avoid out-of-memory issues while mining.
## Benchmarked GPUs
GPUs are a must for getting **block rewards**. Here are a few that have been tried in the past:
GPUs are a must for getting **block rewards**. Here are a few that have been confirmed to generate **SNARKs** quickly enough to successfully mine blocks on the Lotus TestNet.
* GeForce RTX 2080 Ti
* GeForce RTX 2080 SUPER
@ -31,7 +31,7 @@ GPUs are a must for getting **block rewards**. Here are a few that have been tri
## Testing other GPUs
If you want to test other GPUs, such as the GeForce GTX 1660, you can use the following configuration flag:
If you want to test a GPU that is not explicitly supported, you can use the following configuration flag:
```sh
BELLMAN_CUSTOM_GPU="<NAME>:<NUMBER_OF_CORES>"
@ -43,7 +43,7 @@ Here is an example of trying a GeForce GTX 1660 ti with 1536 cores.
BELLMAN_CUSTOM_GPU="GeForce GTX 1660 Ti:1536"
```
To get the number of cores for your GPU, you will need to check your cards specifications.
To get the number of cores for your GPU, you will need to check your card’s specifications.
## Benchmarking

2
documentation/en/hardware.md
View File

@ -2,6 +2,6 @@
> This page is a work in progress. Exact mining requirements are still in the works.
Lotus can build and run on most [Linux](https://ubuntu.com/) and [MacOS](https://www.apple.com/macos) systems with at least 8GB of RAM.
Lotus can build and run on most [Linux](https://ubuntu.com/) and [MacOS](https://www.apple.com/macos) systems with at least 8GiB of RAM.
Windows is not yet supported.

4
documentation/en/install-lotus-arch.md
View File

@ -37,8 +37,8 @@ cd lotus/
Install
```sh
make clean all
make clean && make all
sudo make install
```
After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus DevNet](https://docs.lotu.sh/en+join-devnet).
After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus TestNet](https://docs.lotu.sh/en+join-testnet).

10
documentation/en/install-lotus-macos.md
View File

@ -42,11 +42,7 @@ In your terminal, enter this command to install Homebrew:
Use the command `brew install` to install the following packages:
```sh
brew install go
brew install bzr
brew install jq
brew install pkg-config
brew install rustup
brew install go bzr jq pkg-config rustup
```
## Clone
@ -59,8 +55,8 @@ cd lotus/
## Build
```sh
make clean all
make clean && make all
sudo make install
```
After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus DevNet](https://docs.lotu.sh/en+join-devnet).
After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus TestNet](https://docs.lotu.sh/en+join-testnet).

4
documentation/en/install-lotus-ubuntu.md
View File

@ -40,8 +40,8 @@ cd lotus/
Install
```sh
make clean all
make clean && make all
sudo make install
```
After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus DevNet](https://docs.lotu.sh/en+join-devnet).
After installing Lotus, you can run the `lotus` command directly from your CLI to see usage documentation. Next, you can join the [Lotus TestNet](https://docs.lotu.sh/en+join-testnet).

18
documentation/en/join-devnet.md → documentation/en/join-testnet.md
View File

@ -1,10 +1,10 @@
# Join DevNet
# Join TestNet
## Introduction
Anyone can set up a **Lotus Node** and connect to the **Lotus DevNet**. This is the best way to explore the current CLI and the **Filecoin Decentralized Storage Market**.
Anyone can set up a **Lotus Node** and connect to the **Lotus TestNet**. This is the best way to explore the current CLI and the **Filecoin Decentralized Storage Market**.
If you have installed older versions, you may need to clear existing chain data and miners if you run into any errors. You can use this command:
If you have installed older versions, you may need to clear existing chain data, stored wallets and miners if you run into any errors. You can use this command:
```sh
rm -rf ~/.lotus ~/.lotusstorage
@ -26,7 +26,7 @@ lotus net peers | wc -l
In order to connect to the network, you need to be connected to at least 1 peer. If you’re seeing 0 peers, read our [troubleshooting notes](https://docs.lotu.sh/en+setup-troubleshooting).
## Synchronize
## Chain sync
While the daemon is running, the next requirement is to sync the chain. Run the command below to start the chain sync progress. To see current chain height, visit the [network stats page](http://stats.testnet.filecoin.io/).
@ -35,15 +35,17 @@ lotus sync wait
```
* This step will take anywhere between 30 minutes to a few hours.
* You will be able to perform **Lotus DevNet** operations after it is finished.
* You will be able to perform **Lotus TestNet** operations after it is finished.
## Create your first address
Initialize a wallet using BLS signature formats:
```sh
lotus wallet new bls
```
Here is an example of the response
Here is an example of the response:
```sh
t3vhfme4qfvegqaz7m7q6o6afjcs67n6kpzv7t2eozio4chwpafwa2y4l7zhwd5eom7jmihzdg4s52dpvnclza
@ -55,7 +57,7 @@ t3vhfme4qfvegqaz7m7q6o6afjcs67n6kpzv7t2eozio4chwpafwa2y4l7zhwd5eom7jmihzdg4s52dp
## Check wallet address balance
Wallet balances in the Lotus DevNet are in **FIL**, the smallest denomination of FIL is an **attoFil**, where 1 attoFil = 10^-18 FIL.
Wallet balances in the Lotus TestNet are in **FIL**, the smallest denomination of FIL is an **attoFil**, where 1 attoFil = 10^-18 FIL.
```sh
lotus wallet balance <YOUR_NEW_ADDRESS>
@ -73,4 +75,4 @@ lotus send <target> <amount>
## Monitor the dashboard
To see the latest network activity, including **chain block height**, **block height**, **blocktime**, **total network power**, largest **block producer miner**, check out the [monitoring dashboard](https://lotus-metrics.kittyhawk.wtf).
To see the latest network activity, including **chain block height**, **block height**, **blocktime**, **total network power**, largest **block producer miner**, check out the [monitoring dashboard](https://stats.testnet.filecoin.io).

8
documentation/en/mining-troubleshooting.md
View File

@ -1,10 +1,14 @@
# Mining Troubleshooting
## Bellman Lockfile
The **Bellman** lockfile is created to lock a GPU for a process. This bug can occur when this file isn't properly cleaned up:
```sh
mining block failed: computing election proof: github.com/filecoin-project/lotus/miner.(*Miner).mineOne
```
This bug occurs when the storage miner can't acquire the `bellman.lock`. To fix it you need to stop the `lotus-storage-miner` and remove `/tmp/bellman.lock`
This bug occurs when the storage miner can't acquire the `bellman.lock`. To fix it you need to stop the `lotus-storage-miner` and remove `/tmp/bellman.lock`.
## Your miner is not ready
@ -13,7 +17,7 @@ lotus-storage-miner info
# WARN main lotus-storage-miner/main.go:73 failed to get api endpoint: (/Users/myrmidon/.lotusstorage) %!w(*errors.errorString=&{API not running (no endpoint)}):
```
If you see this, that means your **Lotus Storage Miner** isn't ready yet.
If you see this, that means your **Lotus Storage Miner** isn't ready yet. You need to finish [syncing the chain](https://docs.lotu.sh/en+join-testnet).
## Your computer is too slow

2
documentation/en/mining.md
View File

@ -2,7 +2,7 @@
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 DevNet](https://docs.lotu.sh/en+join-devnet) prior to attempting storage mining for the first time.
It is useful to [join the TestNet](https://docs.lotu.sh/en+join-testnet) prior to attempting storage mining for the first time.
NOTE: While a miner is running, there will be many `WARN` and `ERROR` logs.

2
documentation/en/setting-a-static-port.md
View File

@ -1,6 +1,6 @@
# Static Ports
For a **storage deal**, you can set a static port for the **Lotus Storage Miner**.
Depending on how your network is set up, you may need to set a static port to successfully connect to peers to perform storage deals with your **Lotus Storage Miner**.
## Setup

2
documentation/en/setup-troubleshooting.md
View File

@ -1,6 +1,6 @@
# Setup Troubleshooting
Here is a command that will delete your chain data and any miners you have set up:
Here is a command that will delete your chain data, stored wallets, stored data and any miners you have set up:
```sh
rm -rf ~/.lotus ~/.lotusstorage

12
documentation/en/storing-data.md
View File

@ -2,9 +2,11 @@
> There are recent bug reports with these instructions. If you happen to encounter any problems, please create a [GitHub issue](https://github.com/filecoin-project/lotus/issues/new) and a maintainer will address the problem as soon as they can.
Here are instructions for how to store data on the **Lotus DevNet**.
Here are instructions for how to store data on the **Lotus TestNet**.
## Adding a file
## Adding a file locally
Adding a file locally allows you to make miner deals on the **Lotus TestNet**.
```sh
lotus client import ./your-example-file.txt
@ -12,7 +14,7 @@ lotus client import ./your-example-file.txt
Upon success, this command will return a **Data CID**.
## List local files
## List your local files
The command to see a list of files by `CID`, `name`, `size` in bytes, and `status`:
@ -27,7 +29,7 @@ bafkreierupr5ioxn4obwly4i2a5cd2rwxqi6kwmcyyylifxjsmos7hrgpe Development/sample-1
bafkreieuk7h4zs5alzpdyhlph4lxkefowvwdho3a3pml6j7dam5mipzaii Development/sample-2.txt 30618 ok
```
## Make a Miner Deal on DevNet
## Make a Miner Deal on Lotus TestNet
Get a list of all miners that can store data:
@ -52,4 +54,4 @@ lotus client deal <Data CID> <miner> <price> <duration>
Upon success, this command will return a **Deal CID**.
To retrieve this file it must be sealed. If the **Lotus Storage Miner** is not running on a machine designed for sealing, the process will take a very long time.
The storage miner will need to **seal** the file before it can be retrieved. If the **Lotus Storage Miner** is not running on a machine designed for sealing, the process will take a very long time.

4
documentation/en/updating-lotus.md
View File

@ -7,12 +7,12 @@ If you installed Lotus on your machine, you can upgrade to the latest version by
git pull origin master
# clean and remake the binaries
make clean build
make clean && make build
```
Sometimes when you run Lotus after a pull, certain commands such as `lotus daemon` may break.
Here is a command that will delete your chain data and any miners you have set up:
Here is a command that will delete your chain data, stored wallets and any miners you have set up:
```sh
rm -rf ~/.lotus ~/.lotusstorage