Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
antares-sw committed Oct 10, 2023
1 parent c1aac5c commit 782c04f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ the bottom of the page.
Create the vault config and mnemonic used to derive validator keys.

```bash
./v3-operator init
./operator init
```

```sh
Expand Down Expand Up @@ -103,7 +103,7 @@ It will allow you to restore the keys in case the Vault will get corrupted or lo
Creates deposit data and validator keystores for operator service:

```bash
./v3-operator create-keys
./operator create-keys
```

```sh
Expand Down Expand Up @@ -143,7 +143,7 @@ wallet for the gas expenses. The validator registration costs around 0.01 ETH wi
eye on your wallet balance, otherwise validators will stop registering.
```bash
./v3-operator create-wallet
./operator create-wallet
```
```sh
Expand Down Expand Up @@ -194,7 +194,7 @@ See [releases page](https://github.com/stakewise/v3-operator/releases) to downlo
binary file. Start the binary with the following command:
```sh
./v3-operator start --vault=0x3320ad928c20187602a2b2c04eeaa813fa899468 --consensus-endpoints=https://consensus.com --execution-endpoints=https://execution.com
./operator start --vault=0x3320ad928c20187602a2b2c04eeaa813fa899468 --consensus-endpoints=https://consensus.com --execution-endpoints=https://execution.com
```
Or you can use environment variables. Check [.env.example](.env.example) file for details
Expand Down Expand Up @@ -266,7 +266,7 @@ before running the operator.
```sh
export $(grep -v '^#' .env | xargs)
./v3-operator start
./operator start
```
## Remote signer
Expand Down Expand Up @@ -304,7 +304,7 @@ Notes:
`--remove-existing-keys` flag.
```bash
./v3-operator remote-signer-setup \
./operator remote-signer-setup \
--vault=0x3320ad928c20187602a2b2c04eeaa813fa899468 \
--remote-signer-url=http://signer:9000
```
Expand All @@ -331,10 +331,10 @@ Done. Successfully configured operator to use remote signer for 1 public key(s)!
#### `remote-signer-setup` upload keystores to web3signer
If `--remote-db-url` flag sepcified the command encrypts and loads validator keys from keystore files into the database
If `--remote-db-url` flag specified the command encrypts and loads validator keys from keystore files into the database
```bash
./v3-operator remote-signer-setup --remote-db-url postgresql://postgres:postgres@localhost:5432/web3signer --vaul=0x3320ad928c20187602a2b2c04eeaa813fa899468
./operator remote-signer-setup --remote-db-url postgresql://postgres:postgres@localhost:5432/web3signer --vault=0x3320ad928c20187602a2b2c04eeaa813fa899468
Loading keystores... [####################################] 10/10
Encrypting database keys...
Generated 10 validator keys, upload them to the database? [Y/n]: Y
Expand All @@ -351,7 +351,7 @@ Provide the operator with the URL to your remote signer instance
using the `--remote-signer-url` flag:
```bash
./v3-operator start --remote-signer-url=http://remote-signer:9000 ...
./operator start --remote-signer-url=http://remote-signer:9000 ...
```
You should see a message similar to this one after starting the operator:
Expand Down Expand Up @@ -406,7 +406,7 @@ will prefer local keystores.
Performs a voluntary exit for active vault validators.
```bash
./v3-operator validators-exit
./operator validators-exit
```
```sh
Expand Down Expand Up @@ -437,7 +437,7 @@ by using the following command:
1. Generate deposit data validators root for your vault.
```bash
./v3-operator get-validators-root
./operator get-validators-root
```
```sh
Expand All @@ -461,7 +461,7 @@ by using the following command:
### Recover vault data directory and keystores
```bash
./v3-operator recover
./operator recover
```
```sh
Expand Down Expand Up @@ -497,7 +497,7 @@ Keystores for vault {vault} successfully recovered to {keystores_dir}
Creates validator configuration files for Lighthouse, Prysm, and Teku clients to sign data using keys form database.
```bash
./v3-operator remote-db-validator
./operator remote-db-validator
Enter the recipient address for MEV & priority fees: 0xB31...1
Enter the endpoint of the web3signer service: https://web3signer-example.com
Enter the database connection string, ex. 'postgresql://username:pass@hostname/dbname': postgresql://postgres:postgres@localhost/web3signer
Expand Down Expand Up @@ -528,7 +528,7 @@ Fetch and decrypt keys for web3signer and store them as keypairs in the output_d
Set `DECRYPTION_KEY` env, use value generated by `update-db` command
```bash
./v3-operator remote-db-web3signer
./operator remote-db-web3signer
Enter the folder where web3signer keystores will be saved: /data/web3signer
Enter the database connection string, ex. 'postgresql://username:pass@hostname/dbname': postgresql://postgres:postgres@localhost/web3signer
Web3Signer now uses 7 private keys.
Expand Down
1 change: 1 addition & 0 deletions src/commands/remote_signer_setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ async def main(

if not credentials:
click.echo('Credentials list is empty')
return

click.echo(
f'Successfully generated {len(credentials)} key shares'
Expand Down

0 comments on commit 782c04f

Please sign in to comment.