Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

Commit

Permalink
fix: ```sh tags
Browse files Browse the repository at this point in the history
  • Loading branch information
jcstein committed Oct 25, 2023
1 parent b07e2c6 commit 3c47ad0
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 42 deletions.
4 changes: 2 additions & 2 deletions docs/bootstrapper.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Make sure to have the Blobstream binary installed. Check [the Blobstream binary

Before starting the bootstrapper, we will need to init the store:

```ssh
```sh
blobstream bootstrapper init
```

Expand All @@ -28,7 +28,7 @@ The P2P private key is optional, and a new one will be generated automatically o

The `p2p` sub-command will help you set up this key if you want to use a specific one:

```ssh
```sh
blobstream bootstrapper p2p --help
```

Expand Down
10 changes: 5 additions & 5 deletions docs/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: Learn how to deploy the Blobstream smart contract.

The `deploy` is a helper command that allows deploying the Blobstream smart contract to a new EVM chain:

```ssh
```sh
blobstream deploy --help

Deploys the Blobstream contract and initializes it using the provided Celestia chain
Expand All @@ -32,21 +32,21 @@ Make sure to have the Blobstream binary installed. Check [the Blobstream binary

In order to deploy a Blobstream smart contract, you will need a funded EVM address and its private key. The `keys` command will help you set up this key:

```ssh
```sh
blobstream deploy keys --help
```

To import your EVM private key, there is the `import` subcommand to assist you with that:

```ssh
```sh
blobstream deploy keys evm import --help
```

This subcommand allows you to either import a raw ECDSA private key provided as plaintext, or import it from a file. The files are JSON keystore files encrypted using a passphrase like in [this example](https://geth.ethereum.org/docs/developers/dapp-developer/native-accounts).

After adding the key, you can check that it's added via running:

```ssh
```sh
blobstream deploy keys evm list
```

Expand All @@ -56,7 +56,7 @@ For more information about the `keys` command, check [the `keys` documentation](

Now, we can deploy the Blobstream contract to a new EVM chain:

```ssh
```sh
blobstream deploy \
--evm.chain-id 4 \
--evm.contract-address 0x27a1F8CE94187E4b043f4D57548EF2348Ed556c7 \
Expand Down
38 changes: 19 additions & 19 deletions docs/keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ As specified above, aside from the difference in the default home directory, the

The examples will use the orchestrator command to access the keys. However, the same behaviour applies to the other commands as well.

```ssh
```sh
blobstream orchestrator keys --help

Blobstream keys manager
Expand All @@ -71,7 +71,7 @@ The first subcommand of the `keys` command is `evm`. This latter allows managing

The EVM keys are `ECDSA` keys using the `secp256k1` curve. The implementation uses `geth` file system keystore [implementation](https://geth.ethereum.org/docs/developers/dapp-developer/native-accounts). Thus, keys can be used interchangeably with any compatible software.

```ssh
```sh
blobstream orchestrator keys evm --help

Blobstream EVM keys manager
Expand Down Expand Up @@ -102,7 +102,7 @@ evmKs = keystore.NewKeyStore(evmKeyStorePath(path), keystore.StandardScryptN, ke

The `add` subcommand allows creating a new EVM private key and storing it in the keystore:

```ssh
```sh
blobstream orchestrator keys evm add --help

create a new EVM address
Expand All @@ -115,7 +115,7 @@ The passphrase of the key encryption can be passed as a flag. But it is advised

After creating a new key, you will see its corresponding address printed:

```ssh
```sh
blobstream orchestrator keys evm add

I[2023-04-13|14:16:11.387] successfully opened store path=/home/midnight/.orchestrator
Expand All @@ -128,7 +128,7 @@ I[2023-04-13|14:16:30.534] successfully closed store path=/ho

The `delete` subcommand allows deleting an EVM private key from store via providing its corresponding address:

```ssh
```sh
blobstream orchestrator keys evm delete --help

delete an EVM addresses from the key store
Expand All @@ -143,7 +143,7 @@ After running the command, you will be prompted to enter the passphrase for the

Then, you will be prompted to confirm that you want to delete that private key. Make sure to verify if you're deleting the right one because once deleted, it can no longer be recovered!

```ssh
```sh
blobstream orchestrator keys evm delete 0x27a1F8CE94187E4b043f4D57548EF2348Ed556c7

I[2023-04-13|15:01:41.308] successfully opened store path=/home/midnight/.orchestrator
Expand All @@ -159,7 +159,7 @@ I[2023-04-13|15:01:45.534] successfully closed store path=/ho

The `list` subcommand allows listing the existing keys in the keystore:

```ssh
```sh
blobstream orchestrator keys evm list

I[2023-04-13|16:08:45.084] successfully opened store path=/home/midnight/.orchestrator
Expand All @@ -174,7 +174,7 @@ You could specify a different home using the `--home` flag to list the keys in a

The `update` subcommand allows changing the EVM private key passphrase to a new one. It takes as argument the `0x` prefixed EVM address corresponding to the private key we want to edit.

```ssh
```sh
blobstream orchestrator evm update --help

update an EVM account passphrase
Expand All @@ -185,7 +185,7 @@ Usage:

Example:

```ssh
```sh
blobstream orchestrator evm update 0x7Dd8F9CAfe6D25165249A454F2d0b72FD149Bbba

I[2023-04-13|16:21:17.139] successfully opened store path=/home/midnight/.orchestrator
Expand All @@ -204,7 +204,7 @@ The `--home` can be specified if the store is not in the default directory.

The `import` subcommand allows importing existing private keys into the keystore. It has two subcommands: `ecdsa` and `file`. The first allows importing a private key in plaintext, while the other allows importing a private key from a JSON file secured with a passphrase.

```ssh
```sh
blobstream orchestrator keys evm import --help

import evm keys to the keystore
Expand All @@ -228,7 +228,7 @@ For the first one, it takes as argument the private key in plaintext. Then, it p

Example:

```ssh
```sh
blobstream orchestrator keys evm import ecdsa da6ed55cb2894ac2c9c10209c09de8e8b9d109b910338d5bf3d747a7e1fc9eb7

I[2023-04-13|17:00:48.617] successfully opened store path=/home/midnight/.orchestrator
Expand All @@ -242,7 +242,7 @@ I[2023-04-13|17:00:51.990] successfully closed store path=/ho

For the second, it takes a JSON key file, as defined in [@ethereum/eth-keyfile](https://github.com/ethereum/eth-keyfile), and imports it to your keystore, so it can be used for signatures.

```ssh
```sh
blobstream orchestrator keys evm import file --help

import an EVM address from a file
Expand All @@ -253,7 +253,7 @@ Usage:

For example, if we have a file in the current directory containing a private key, we could run the following:

```ssh
```sh
blobstream orchestrator keys evm import file UTC--2023-04-13T15-00-50.302148204Z--966e6f22781ef6a6a82bbb4db3df8e225dfd9488

I[2023-04-13|17:31:53.307] successfully opened store path=/home/midnight/.orchestrator
Expand All @@ -272,7 +272,7 @@ Similar to the above EVM keystore, the P2P store has similar subcommands for han

To access the P2P keystore, run the following:

```ssh
```sh
blobstream orchestrator keys p2p

Blobstream p2p keys manager
Expand All @@ -298,7 +298,7 @@ The `orchestrator` could be replaced by `relayer` and the only difference would

The `add` subcommand creates a new p2p key to the p2p store:

```ssh
```sh
blobstream orchestrator keys p2p add --help

create a new Ed25519 P2P address
Expand All @@ -309,7 +309,7 @@ Usage:

It takes as argument an optional `<nickname>` which would be the name that we can use to reference that private key. If not specified, an incremental nickname will be assigned.

```ssh
```sh
blobstream orchestrator keys p2p add

I[2023-04-13|17:38:17.289] successfully opened store path=/home/midnight/.orchestrator
Expand All @@ -326,7 +326,7 @@ The nickname will be needed in case the orchestrator needs to use a specific pri

The `delete` subcommand will delete a P2P private key from store referenced by its nickname:

```ssh
```sh
blobstream orchestrator keys p2p delete --help

delete an Ed25519 P2P private key from store
Expand All @@ -339,7 +339,7 @@ Usage:

The `import` subcommand will import an existing Ed25519 private key to the store. It takes as argument the nickname that we wish to save the private key under, and the actual private key in hex format without `0x`:

```ssh
```sh
blobstream orchestrator keys p2p import --help

import an existing p2p private key
Expand All @@ -352,7 +352,7 @@ Usage:

The `list` subcommand lists the existing P2P private keys in the store:

```ssh
```sh
blobstream orchestrator keys p2p list --help

list existing p2p addresses
Expand Down
20 changes: 10 additions & 10 deletions docs/orchestrator.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Make sure to have the Blobstream binary installed. Check [the Blobstream binary

Before starting the orchestrator, we will need to init the store:

```ssh
```sh
blobstream orchestrator init
```

Expand All @@ -77,7 +77,7 @@ The P2P private key is optional, and a new one will be generated automatically o

The `keys` command will help you set up these keys:

```ssh
```sh
blobstream orchestrator keys --help
```

Expand All @@ -91,15 +91,15 @@ To register an EVM address for your validator, check the section [Register EVM A

To import your EVM private key, there is the `import` subcommand to assist you with that:

```ssh
```sh
blobstream orchestrator keys evm import --help
```

This subcommand allows you to either import a raw ECDSA private key provided as plaintext, or import it from a file. The files are JSON keystore files encrypted using a passphrase like in [this example](https://geth.ethereum.org/docs/developers/dapp-developer/native-accounts).

After adding the key, you can check that it's added via running:

```ssh
```sh
blobstream orchestrator keys evm list
```

Expand All @@ -111,7 +111,7 @@ Now that we have the store initialized, we can start the orchestrator. Make sure

The orchestrator accepts the following flags:

```ssh
```sh
blobstream orchestrator start --help

Starts the Blobstream orchestrator to sign attestations
Expand All @@ -122,7 +122,7 @@ Usage:

To start the orchestrator in the default home directory, run the following:

```ssh
```sh
blobstream orchestrator start \
--core.grpc.host localhost \
--core.grpc.port 9090 \
Expand Down Expand Up @@ -151,15 +151,15 @@ To edit an EVM address for a certain validator, its corresponding account needs

First, you should get your validator `valoper` address. To do so, run the following:

```ssh
```sh
celestia-appd keys show <validator_account> --bech val
```

This assumes that you're using the default home directory, the default keystore etc. If not, make sure to add the flags that correspond to your situation.

To check which EVM address is registered for your `valoper` address, run the following:

```ssh
```sh
celestia-appd query blobstream evm <validator_valoper_address>
```

Expand All @@ -176,7 +176,7 @@ celestia-appd tx blobstream register \

Example command output:

```ssh
```sh
code: 0
codespace: ""
data: 12300A2E2F63656C65737469612E7167622E76312E4D7367526567697374657245564D41646472657373526573706F6E7365
Expand Down Expand Up @@ -256,7 +256,7 @@ txhash: 4199EA959A2CFEFCD4726D8D8F7B536458A46A27318D3483A4E9614F560606BC

Now, you can verify that the EVM address has been updated using the following command:

```ssh
```sh
celestia-appd query blobstream evm <validator_valoper_address>
```

Expand Down
12 changes: 6 additions & 6 deletions docs/relayer.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Make sure to have the Blobstream binary installed. Check out the [Install the Bl

Before starting the relayer, we will need to init the store:

```ssh
```sh
blobstream relayer init
```

Expand All @@ -67,7 +67,7 @@ The P2P private key is optional, and a new one will be generated automatically o

The `keys` command will help you set up these keys:

```ssh
```sh
blobstream relayer keys --help
```

Expand All @@ -79,15 +79,15 @@ Because EVM keys are important, we provide a keystore that will help manage them

To import your EVM private key, there is the `import` subcommand to assist you with that:

```ssh
```sh
blobstream relayer keys evm import --help
```

This subcommand allows you to either import a raw ECDSA private key provided as plaintext, or import it from a file. The files are JSON keystore files encrypted using a passphrase like [in this example](https://geth.ethereum.org/docs/developers/dapp-developer/native-accounts).

After adding the key, you can check that it's added via running:

```ssh
```sh
blobstream relayer keys evm list
```

Expand All @@ -99,7 +99,7 @@ Now that we have the store initialized, and we have a target Blobstream smart co

The relayer accepts the following flags:

```ssh
```sh
blobstream relayer start --help

Runs the Blobstream relayer to submit attestations to the target EVM chain
Expand All @@ -110,7 +110,7 @@ Usage:

To start the relayer using the default home directory, run the following:

```ssh
```sh
/bin/blobstream relayer start \
--evm.contract-address=0x27a1F8CE94187E4b043f4D57548EF2348Ed556c7 \
--core.rpc.host=localhost \
Expand Down

0 comments on commit 3c47ad0

Please sign in to comment.