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

Commit

Permalink
chore(docs): update QGB to "Blobstream" (#514)
Browse files Browse the repository at this point in the history
* chore: update non-programmatic instances of QGB to "Blobstream"

* format with prettier

* cleanup extra *

* docs: update qgb -> blobstream

* Update docs/deploy.md

Co-authored-by: CHAMI Rachid <[email protected]>

---------

Co-authored-by: CHAMI Rachid <[email protected]>
  • Loading branch information
jcstein and rach-id authored Oct 11, 2023
1 parent bf009a2 commit 2c0446f
Show file tree
Hide file tree
Showing 5 changed files with 162 additions and 162 deletions.
22 changes: 11 additions & 11 deletions docs/bootstrapper.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# QGB bootstrapper
# Blobstream bootstrapper

To bootstrap the QGB P2P network, we use the bootstrapper QGB node type to accept connections from freshly created orchestrators/relayers and share its peer table with them.
To bootstrap the Blobstream P2P network, we use the bootstrapper Blobstream node type to accept connections from freshly created orchestrators/relayers and share its peer table with them.

## How to run

### Install the QGB binary
### Install the Blobstream binary

Make sure to have the QGB binary installed. Check [the QGB binary page](https://docs.celestia.org/nodes/qgb-binary) for more details.
Make sure to have the Blobstream binary installed. Check [the Blobstream binary page](https://docs.celestia.org/nodes/blobstream-binary) for more details.

### Init the store

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

```ssh
qgb bootstrapper init
blobstream bootstrapper init
```

By default, the store will be created un `~/.bootstrapper`. However, if you want to specify a custom location, you can use the `--home` flag. Or, you can use the following environment variable:

| Variable | Explanation | Default value | Required |
|---------------------|-------------------------------------|-------------------|----------|
| ------------------- | ----------------------------------- | ----------------- | -------- |
| `BOOTSTRAPPER_HOME` | Home directory for the bootstrapper | `~/.bootstrapper` | Optional |

### Add keys
Expand All @@ -29,28 +29,28 @@ 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
qgb bootstrapper p2p --help
blobstream bootstrapper p2p --help
```

### Start the bootstrapper

Now that we have the store initialized, we can start the bootstrapper:

```shell
qgb bootstrapper
blobstream bootstrapper

QGB P2P network bootstrapper command
Blobstream P2P network bootstrapper command

Usage:
qgb bootstrapper [command]
blobstream bootstrapper [command]

Aliases:
bootstrapper, bs

Flags:
-h, --help help for bootstrapper

Use "qgb bootstrapper [command] --help" for more information about a command.
Use "blobstream bootstrapper [command] --help" for more information about a command.
```

### Open the P2P port
Expand Down
44 changes: 22 additions & 22 deletions docs/deploy.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,63 @@
---
sidebar_label: Deploy the QGB contract
description: Learn how to deploy the QGB smart contract.
sidebar_label: Deploy the Blobstream contract
description: Learn how to deploy the Blobstream smart contract.
---

# Deploy the QGB contract
# Deploy the Blobstream contract

<!-- markdownlint-disable MD013 -->

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

```ssh
qgb deploy --help
blobstream deploy --help
Deploys the QGB contract and initializes it using the provided Celestia chain
Deploys the Blobstream contract and initializes it using the provided Celestia chain
Usage:
qgb deploy <flags> [flags]
qgb deploy [command]
blobstream deploy <flags> [flags]
blobstream deploy [command]
Available Commands:
keys QGB keys manager
keys Blobstream keys manager
```

## How to run

### Install the QGB binary
### Install the Blobstream binary

Make sure to have the QGB binary installed. Check [the QGB binary page](https://docs.celestia.org/nodes/qgb-binary) for more details.
Make sure to have the Blobstream binary installed. Check [the Blobstream binary page](https://docs.celestia.org/nodes/blobstream-binary) for more details.

### Add keys

In order to deploy a QGB smart contract, you will need a funded EVM address and its private key. The `keys` command will help you set up this key:
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
qgb deploy keys --help
blobstream deploy keys --help
```

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

```ssh
qgb deploy keys evm import --help
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
qgb deploy keys evm list
blobstream deploy keys evm list
```

For more information about the `keys` command, check [the `keys` documentation](https://docs.celestia.org/nodes/qgb-keys).
For more information about the `keys` command, check [the `keys` documentation](https://docs.celestia.org/nodes/blobstream-keys).

### Deploy the contract

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

```ssh
qgb deploy \
blobstream deploy \
--evm.chain-id 4 \
--evm.contract-address 0x27a1F8CE94187E4b043f4D57548EF2348Ed556c7 \
--core.grpc.host localhost \
Expand All @@ -68,8 +68,8 @@ qgb deploy \

The `latest` can be replaced by the following:

- `latest`: to deploy the QGB contract starting from the latest validator set.
- `earliest`: to deploy the QGB contract starting from genesis.
- `nonce`: you can provide a custom nonce on where you want the QGB to start. If the provided nonce is not a `Valset` attestation, then the one before it will be used to deploy the QGB smart contract.
- `latest`: to deploy the Blobstream contract starting from the latest validator set.
- `earliest`: to deploy the Blobstream contract starting from genesis.
- `nonce`: you can provide a custom nonce on where you want Blobstream to start. If the provided nonce is not a `Valset` attestation, then the one before it will be used to deploy the Blobstream smart contract.

And, now you will see the QGB smart contract address in the logs along with the transaction hash.
And, now you will see the Blobstream smart contract address in the logs along with the transaction hash.
Loading

0 comments on commit 2c0446f

Please sign in to comment.