Merge pull request #1731 from filecoin-project/asr/docs

Documentation updates and fixes
This commit is contained in:
Whyrusleeping 2020-05-13 21:32:10 -07:00 committed by GitHub
commit d358da43f7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 17 additions and 54 deletions

View File

@ -163,13 +163,6 @@
"value": null,
"posts": []
},
{
"title": "Pond UI",
"slug": "en+dev-tools-pond-ui",
"github": "en/dev-tools-pond-ui.md",
"value": null,
"posts": []
},
{
"title": "Jaeger Tracing",
"slug": "en+dev-tools-jaeger-tracing",

View File

@ -1,3 +1,3 @@
# Development Tools
# Developer Tools
> This page is a work in progress
> Running a local network can be a great way to understand how Lotus works and test your setup.

View File

@ -73,7 +73,7 @@ Information on how to send a `cURL` request to the JSON-RPC API can be found
### What are the requests I can send over the JSON-RPC API?
Please have a look at the
[source code](https://github.com/filecoin-project/lotus/blob/master/api/api_common.go)
[source code](https://github.com/filecoin-project/lotus/blob/master/api/api_full.go)
for a list of methods supported by the JSON-RPC API.
## The Test Network
@ -88,12 +88,6 @@ community for testing purposes.
Nothing at all! Real-world incentives may be provided in a future phase of Testnet, but this is
yet to be confirmed.
### Will there be future phases of Testnet?
Yes, there will be at least one more phase of Testnet. We plan on introducing interoperable
[go-filecoin nodes](https://github.com/filecoin-project/go-filecoin#filecoin-go-filecoin)
in a future phase.
### How can I see the status of Testnet?
The [dashboard](https://stats.testnet.filecoin.io/) displays the status of the network as
@ -136,4 +130,9 @@ You can do so by changing the storage path variable for the second miner, e.g.,
### How do I setup my own local devnet?
Follow the instructions found [here](https://lotu.sh/en+setup-local-dev-net).
Follow the instructions found [here](https://lotu.sh/en+setup-local-dev-net).
### Are there any other implementations of Filecoin?
Yes! Check out the [go-filecoin](https://github.com/filecoin-project/go-filecoin#filecoin-go-filecoin)
implementation, which is fully interoperable with Lotus!

View File

@ -2,7 +2,7 @@
Lotus is an implementation of the **Filecoin Distributed Storage Network**. You can run the Lotus software client to join the **Filecoin Testnet**.
For more details about Filecoin, check out the [Filecoin Docs](https://docs.filecoin.io) and [Filecoin Spec](https://github.com/filecoin-project/specs).
For more details about Filecoin, check out the [Filecoin Docs](https://docs.filecoin.io) and [Filecoin Spec](https://filecoin-project.github.io/specs/).
## What can I learn here?
@ -11,7 +11,7 @@ For more details about Filecoin, check out the [Filecoin Docs](https://docs.file
- [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).
## What makes Lotus different?
## How is Lotus designed?
Lotus is architected modularly to keep clean API boundaries while using the same process. Installing Lotus will include two separate programs:

View File

@ -4,12 +4,6 @@
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, stored wallets and miners if you run into any errors. You can use this command:
```sh
rm -rf ~/.lotus ~/.lotusstorage
```
## Note: Using the Lotus Node from China
If you are trying to use `lotus` from China. You should set this **environment variable** on your machine:
@ -61,7 +55,7 @@ Here is an example of the response:
t1aswwvjsae63tcrniz6x5ykvsuotlgkvlulnqpsi
```
- Visit the [faucet](https://lotus-faucet.kittyhawk.wtf/funds.html) to add funds.
- Visit the [faucet](https://facuet.testnet.filecoin.io) to add funds.
- Paste the address you created.
- Press the send button.
@ -77,7 +71,7 @@ You will not see any attoFIL in your wallet if your **chain** is not fully synce
## Send FIL to another wallet
To send FIL to another wallet, use this command:
To send FIL to another wallet from your default account, use this command:
```
lotus send <target> <amount>

View File

@ -12,8 +12,6 @@ lotus-storage-miner set-price <price>
This command will set up your miner to accept deal proposals that meet the input price.
The price is inputted in FIL per GiB per epoch, and the default is 0.0000000005.
<!-- TODO: Add info about setting min piece size, max piece size, duration -->
## Ensure you can be discovered
Clients need to be able to find you in order to make storage deals with you.

View File

@ -28,7 +28,7 @@ lotus wallet new bls
With your wallet address:
- Visit the [faucet](https://lotus-faucet.kittyhawk.wtf/miner.html)
- Visit the [faucet](https://facuet.testnet.filecoin.io)
- Click "Create Miner"
- DO NOT REFRESH THE PAGE. THIS OPERATION CAN TAKE SOME TIME.

View File

@ -29,15 +29,4 @@ ERROR hello hello/hello.go:81 other peer has different genesis!
- repo is already locked
```
- You already have another lotus deamon running.
## Warning: get message get failed
Some errors will occur that do not prevent Lotus from working:
```sh
ERROR chainstore store/store.go:564 get message get failed: <Data CID>: blockstore: block not found
```
- Someone is requesting a **Data CID** from you that you don't have.
- You already have another lotus daemon running.

View File

@ -55,7 +55,7 @@ Check the status of a deal:
lotus client list-deals
```
- The `duration`, which represents how long the miner will keep your file hosted, is represented in blocks. Each block represents 45 seconds.
- The `duration`, which represents how long the miner will keep your file hosted, is represented in blocks. Each block represents 25 seconds.
Upon success, this command will return a **Deal CID**.

View File

@ -8,14 +8,4 @@ git pull origin master
# clean and remake the binaries
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, stored wallets and any miners you have set up:
```sh
rm -rf ~/.lotus ~/.lotusstorage
```
This command usually resolves any issues with running `lotus` commands but it is not always required for updates. We will share information about when resetting your chain data and miners is required for an update in the future.
```