diff --git a/README.md b/README.md index 442891a5e..71ed015e1 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,10 @@ All work is tracked via issues. An attempt at keeping an up-to-date view on rema ## Building -*Dependencies:* +We currently only provide the option to build lotus from source. Binary installation options are coming soon! +In order to run lotus, please do the following: +1. Make sure you have these dependencies installed: - go (1.13 or higher) - gcc (7.4.0 or higher) - git @@ -18,25 +20,37 @@ All work is tracked via issues. An attempt at keeping an up-to-date view on rema - jq - pkg-config -*Building:* + +2. Clone this repo & `cd` into it +``` +$ git clone https://github.com/filecoin-project/lotus.git +$ cd lotus/ +``` + +3. Build and install the source code ``` $ make +$ sudo make install ``` +Now, you should be able to perform the commands listed below. + ## Devnet ### Node setup If you have run lotus before and want to remove all previous data: `rm -rf ~/.lotus ~/.lotusstorage` -[You can copy `lotus` and `lotus-storage-miner` to your `$GOPATH/bin` or `$PATH`, or reference all lotus commands below from your local build directory with `./lotus`] - The following sections describe how to use the lotus CLI. Alternately you can run lotus nodes and miners using the [Pond GUI](#pond). ### Genesis & Bootstrap The current lotus build will automatically join the lotus Devnet using the genesis and bootstrap files in the `build/` directory. No configuration is needed. +### Genesis & Bootstrap + +The current lotus build will automatically join the lotus Devnet using the genesis and bootstrap files in the `build/` directory. No configuration is needed. + ### Start Daemon ```sh @@ -56,6 +70,8 @@ You can follow sync status with: $ watch lotus sync status ``` +[It may take a few minutes for the chain to finish syncing. You will see `Height: 0` until the full chain is synced and validated.] + ### Basics @@ -65,19 +81,18 @@ $ lotus wallet new bls t3... ``` -Grab some funds from faucet - go to http://147.75.80.29:777/, paste the address +Grab some funds from faucet - go to http://lotus-faucet.kittyhawk.wtf:777/, paste the address you just created, and press Send. (You can also generate a public key address using secp256k1 with `lotus wallet new secp256k1`. BLS signatures use less space so will have lower fees.) -Check the wallet balance: +Check the wallet balance (balance is listed in attoFIL, where 1 attoFIL = 10^-18 FIL): ```sh $ lotus wallet balance [optional address (t3...)] ``` (NOTE: If you see an error like `actor not found` after executing this command, -it means that either there are no transactions to this address on chain - using -faucet should 'fix' this, or your node isn't fully synced). +it means that either your node isn't fully synced or there are no transactions to this address yet on chain. If the latter, using the faucet should 'fix' this). ### Mining @@ -86,7 +101,7 @@ cover pledge collateral: ```sh $ lotus state pledge-collateral 1234 -$ lotus wallet balance t3... +$ lotus wallet balance [t3...] 8999 ``` (Balance must be higher than the returned pledge collateral for the next step to work) @@ -127,12 +142,6 @@ $ lotus-storage-miner state power $ lotus-storage-miner state sectors ``` -You can view a list of miners with: - -```sh -$ lotus state list-miners -``` - ### Stage Data Import some data: @@ -156,14 +165,17 @@ $ lotus client local (It is possible for a Client to make a deal with a Miner on the same lotus Node.) ```sh +# List all miners in the system. Choose one to make a deal with. +$ lotus state list-miners + # List asks proposed by a miner $ lotus client query-ask -# Propose a deal with a miner +# Propose a deal with a miner. Price is in attoFIL/byte/block. Duration is # of blocks. $ lotus client deal ``` -For example `$ lotus client deal bafkre...qvtjsi t0111 36000 12` proposes a deal to store CID `bafkre...qvtjsi` with miner `t0111` at price `36000` for a duration of `12` blocks. +For example `$ lotus client deal bafkre...qvtjsi t0111 36000 12` proposes a deal to store CID `bafkre...qvtjsi` with miner `t0111` at price `36000` for a duration of `12` blocks. If successful, the `client deal` command will return a deal CID. ### Search & Retrieval @@ -270,4 +282,4 @@ Lotus has tracing built into many of its internals. To view the traces, first do For more details, see [this document](./docs/tracing.md). ## License -Dual-licensed under [MIT](https://github.com/filecoin-project/lotus/blob/master/LICENSE-MIT) + [Apache 2.0](https://github.com/filecoin-project/lotus/blob/master/LICENSE-APACHE) +Dual-licensed under [MIT](https://github.com/filecoin-project/lotus/blob/master/LICENSE-MIT) + [Apache 2.0](https://github.com/filecoin-project/lotus/blob/master/LICENSE-APACHE) \ No newline at end of file