Skip to content

Commit

Permalink
Minor useability updates (#1005)
Browse files Browse the repository at this point in the history
* Adds lcli to the makefile

* Update docs

* Set genesis fork version to default
  • Loading branch information
AgeManning authored Apr 15, 2020
1 parent be7aaa3 commit d3dfd72
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 18 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ EF_TESTS = "tests/ef_tests"
# Binaries will most likely be found in `./target/release`
install:
cargo install --path lighthouse --force --locked
cargo install --path lcli --force --locked

# Runs the full workspace tests in **release**, without downloading any additional
# test vectors.
Expand Down
24 changes: 8 additions & 16 deletions book/src/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Typical users may install `lighthouse` to `CARGO_HOME` with `cargo install
`PATH` environment variable"](https://www.rust-lang.org/tools/install) for more
information.

For develeopers, we recommend building Lighthouse using the `$ cargo build --release
For developers, we recommend building Lighthouse using the `$ cargo build --release
--bin lighthouse` command and executing binaries from the
`<lighthouse-repository>/target/release` directory. This is more ergonomic when
modifying and rebuilding regularly.
Expand All @@ -33,7 +33,6 @@ modifying and rebuilding regularly.
Each binary supports the `--help` flag, this is the best source of
documentation.


```bash
$ lighthouse beacon_node --help
```
Expand All @@ -42,22 +41,15 @@ $ lighthouse beacon_node --help
$ lighthouse validator_client --help
```

## Beacon Node

The `$ lighthouse beacon_node` (or `$ lighthouse bn`) command has two primary
tasks:
## Creating a new database/testnet

- **Resuming** an existing database with `$ lighthouse bn`.
- **Creating** a new testnet database using `$ lighthouse bn testnet`.
Lighthouse should run out-of-the box and connect to the current testnet
maintained by Sigma Prime.

## Creating a new database

Use the `$ lighthouse bn testnet` command (see [testnets](./testnets.md) for
more information).
However, for developers, testnets can be created by following the instructions
outlined in [testnets](./testnets.md). The steps listed here will create a
local database specified to a new testnet.

## Resuming from an existing database

Once a database has been created, it can be resumed by running `$ lighthouse bn`.

Presently, you are not allowed to call `$ lighthouse bn` unless you have first
created a database using `$ lighthouse bn testnet`.
Once a database/testnet has been created, it can be resumed by running `$ lighthouse bn`.
2 changes: 1 addition & 1 deletion book/src/local-testnets.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Once you have `lcli` installed, create a new testnet directory with:
lcli new-testnet
```

> - This will create a "mainnet" spec testnet. To create a minimal spec use `lcli --spec minim new-testnet`.
> - This will create a "mainnet" spec testnet. To create a minimal spec use `lcli --spec minimal new-testnet`.
> - The `lcli new-testnet` command has many options, use `lcli new-testnet --help` to see them.
### 1.3 Create a genesis state
Expand Down
2 changes: 1 addition & 1 deletion lcli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ fn main() {
.long("genesis-fork-version")
.value_name("HEX")
.takes_value(true)
.default_value("0x01030307") // [1, 3, 3, 7]
.default_value("0x00000000")
.help("Used to avoid reply attacks between testnets. Recommended to set to
non-default."),
)
Expand Down

0 comments on commit d3dfd72

Please sign in to comment.