Skip to content

Commit

Permalink
Prefix manual setup doc shell commands with $
Browse files Browse the repository at this point in the history
Having the `$` is an indicator to the reader that those commands are
meant to be run in a bash-style shell, rather than some other repl or
anywhere else.
  • Loading branch information
Beau Shinkle committed Feb 5, 2021
1 parent c567179 commit 3689c0a
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions docs/manual-setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,38 +26,38 @@ To run the test script, please use Node `v14.3.0`.
We recommend using https://github.com/nvm-sh/nvm[nvm] to manage node versions easily.
You can install both versions by doing:
```
nvm install 11.15.0
nvm install 14.3.0
$ nvm install 11.15.0
$ nvm install 14.3.0
```
And use the specific version:
```
nvm use 11.15.0
nvm use 14.3.0
$ nvm use 11.15.0
$ nvm use 14.3.0
```

== Installing the system
. Initialize local `geth` using:
+
```
./initialize-geth.sh
$ ./initialize-geth.sh
```
+
You can skip this step if your local geth is already initialized. This script clears all Ethereum client data, initilizes genesis block, and funds five accounts. All client data are kept in the working directory of this project so all the data used for other projects stay untouched.

. Run local `geth` node using:
+
```
./run-geth.sh
$ ./run-geth.sh
```
. Run local Bitcoin Core node and ElectrumX using:
+
```
./run-bitcoin.sh
$ ./run-bitcoin.sh
```
. Run Keep & tBTC installation script:
+
```
./install.sh
$ ./install.sh
```
+
This script will fetch `keep-core`, `keep-ecdsa`, and `tbtc` source code, deploy contracts of `keep-core`, `keep-ecdsa`, and `tbtc`. It will also build `keep-core` and `keep-ecdsa` off-chain clients.
Expand All @@ -76,20 +76,20 @@ The above installation script will configure:

To run the `keep-core` client use:
```
./run-core-1.sh
$ ./run-core-1.sh
```

It is enough to run one `keep-core` client to generate a group and produce relay entries. Setting up more than one client locally is possible but consumes more resources.

To run `keep-ecdsa` clients use:
```
./run-ecdsa-1.sh
$ ./run-ecdsa-1.sh
```
```
./run-ecdsa-2.sh
$ ./run-ecdsa-2.sh
```
```
./run-ecdsa-3.sh
$ ./run-ecdsa-3.sh
```

There are at least 3 `keep-ecdsa` clients needed to open a keep. Setting up more than three clients locally is possible but consumes more resources.
Expand All @@ -100,14 +100,14 @@ Before the beacon is able to produce a first relay entry, genesis needs to happe

Genesis should be triggered after `keep-core` client started with:
```
cd keep-core
KEEP_ETHEREUM_PASSWORD="password" ./keep-core --config configs/config.local.1.toml relay genesis
$ cd keep-core
$ KEEP_ETHEREUM_PASSWORD="password" ./keep-core --config configs/config.local.1.toml relay genesis
```

Bonded ECDSA keep factory from `keep-ecdsa` contracts requests for new relay entry to reseed after each signer selection but it is also possible to request for a new relay entry manually with:
```
cd keep-core
KEEP_ETHEREUM_PASSWORD="password" ./keep-core --config configs/config.local.1.toml relay request
$ cd keep-core
$ KEEP_ETHEREUM_PASSWORD="password" ./keep-core --config configs/config.local.1.toml relay request
```

== How to interact with the system
Expand All @@ -124,14 +124,14 @@ end-to-end tests. Before you start interacting, make sure you:

To run the Keep Dashboard dApp invoke:
```
./run-keep-dashboard.sh
$ ./run-keep-dashboard.sh
```

=== tBTC dApp

To run the tBTC dApp against the local Bitcoin network invoke:
```
./run-tbtc-dapp.sh
$ ./run-tbtc-dapp.sh
```

=== Testing the Deposit/Redemption Flow
Expand Down Expand Up @@ -218,9 +218,9 @@ Confirm all of the transactions and verify that the TBTC has left your wallet. Y

To run the automated end-to-end scenario switch to Node 14.3.0:
```
nvm use 14.3.0
$ nvm use 14.3.0
```
Then invoke:
```
./run-e2e-test.sh
$ ./run-e2e-test.sh
```

0 comments on commit 3689c0a

Please sign in to comment.