From 3c45307b499c621a7d942db2c73109314474d595 Mon Sep 17 00:00:00 2001 From: Josh Stein <46639943+jcstein@users.noreply.github.com> Date: Wed, 4 Oct 2023 13:42:21 -0400 Subject: [PATCH] docs: implement "no click here" on QGB docs (#511) --- docs/bootstrapper.md | 2 +- docs/deploy.md | 6 +++--- docs/keys.md | 2 +- docs/orchestrator.md | 10 +++++----- docs/relayer.md | 12 ++++++------ 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/bootstrapper.md b/docs/bootstrapper.md index e34e420d..9b0abd33 100644 --- a/docs/bootstrapper.md +++ b/docs/bootstrapper.md @@ -6,7 +6,7 @@ To bootstrap the QGB P2P network, we use the bootstrapper QGB node type to accep ### Install the QGB binary -Make sure to have the QGB binary installed. Check [here](https://docs.celestia.org/nodes/qgb-binary) for more details. +Make sure to have the QGB binary installed. Check [the QGB binary page](https://docs.celestia.org/nodes/qgb-binary) for more details. ### Init the store diff --git a/docs/deploy.md b/docs/deploy.md index e0abb9b7..0108351b 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -26,7 +26,7 @@ Available Commands: ### Install the QGB binary -Make sure to have the QGB binary installed. Check [here](https://docs.celestia.org/nodes/qgb-binary) for more details. +Make sure to have the QGB binary installed. Check [the QGB binary page](https://docs.celestia.org/nodes/qgb-binary) for more details. ### Add keys @@ -42,7 +42,7 @@ To import your EVM private key, there is the `import` subcommand to assist you w qgb 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 [here](https://geth.ethereum.org/docs/developers/dapp-developer/native-accounts). +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: @@ -50,7 +50,7 @@ After adding the key, you can check that it's added via running: qgb deploy keys evm list ``` -For more information about the `keys` command, check the `keys` documentation in [here](https://github.com/celestiaorg/orchestrator-relayer/blob/main/docs/keys.md). +For more information about the `keys` command, check [the `keys` documentation](https://docs.celestia.org/nodes/qgb-keys). ### Deploy the contract diff --git a/docs/keys.md b/docs/keys.md index 97554f48..aa37e92d 100644 --- a/docs/keys.md +++ b/docs/keys.md @@ -240,7 +240,7 @@ I[2023-04-13|17:00:51.990] successfully closed store path=/ho #### EVM: Import file -For the second, it takes a JSON key file, as defined in [here](https://github.com/ethereum/eth-keyfile), and imports it to your keystore, so it can be used for signatures. +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 qgb orchestrator keys evm import file --help diff --git a/docs/orchestrator.md b/docs/orchestrator.md index dc77774e..cf225ad5 100644 --- a/docs/orchestrator.md +++ b/docs/orchestrator.md @@ -8,7 +8,7 @@ description: Learn about the QGB Orchestrator. -The role of the orchestrator is to sign attestations using its corresponding validator EVM private key. These attestations are generated within the QGB module of the Celestia-app state machine. To learn more about what attestations are, you can refer to this [link](https://github.com/celestiaorg/celestia-app/tree/main/x/qgb). +The role of the orchestrator is to sign attestations using its corresponding validator EVM private key. These attestations are generated within the QGB module of the Celestia-app state machine. To learn more about what attestations are, you can refer to [the QGB overview](https://github.com/celestiaorg/celestia-app/tree/main/x/qgb). ## How it works @@ -16,7 +16,7 @@ The orchestrator does the following: 1. Connect to a Celestia-app full node or validator node via RPC and gRPC and wait for new attestations 2. Once an attestation is created inside the QGB state machine, the orchestrator queries it. -3. After getting the attestation, the orchestrator signs it using the provided EVM private key. The private key should correspond to the EVM address provided when creating the validator. More details in [here](https://docs.celestia.org/nodes/validator-node/#setup-qgb-keys). +3. After getting the attestation, the orchestrator signs it using the provided EVM private key. The private key should correspond to the EVM address provided when creating the validator. Read [more about QGB keys](https://docs.celestia.org/nodes/qgb-keys/). 4. Then, the orchestrator pushes its signature to the P2P network it is connected to, via adding it as a DHT value. 5. Listen for new attestations and go back to step 2. @@ -48,7 +48,7 @@ To run an orchestrator, you will need to have access to the following: ### Install the QGB binary -Make sure to have the QGB binary installed. Check [here](https://docs.celestia.org/nodes/qgb-binary) for more details. +Make sure to have the QGB binary installed. Check [the QGB binary page](https://docs.celestia.org/nodes/qgb-binary) for more details. ### Init the store @@ -95,7 +95,7 @@ To import your EVM private key, there is the `import` subcommand to assist you w qgb 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 [here](https://geth.ethereum.org/docs/developers/dapp-developer/native-accounts). +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: @@ -103,7 +103,7 @@ After adding the key, you can check that it's added via running: qgb orchestrator keys evm list ``` -For more information about the `keys` command, check the `keys` documentation in [here](https://github.com/celestiaorg/orchestrator-relayer/blob/main/docs/keys.md). +For more information about the `keys` command, check [the `keys` documentation](https://docs.celestia.org/nodes/qgb-keys). ### Start the orchestrator diff --git a/docs/relayer.md b/docs/relayer.md index f0089bba..1e698521 100644 --- a/docs/relayer.md +++ b/docs/relayer.md @@ -7,11 +7,11 @@ description: Learn about the QGB Relayer. -The role of the relayer is to gather attestations' signatures from the orchestrators, and submit them to a target EVM chain. The attestations are generated within the QGB module of the Celestia-app state machine. To learn more about what attestations are, you can refer to this [link](https://github.com/celestiaorg/celestia-app/tree/main/x/qgb). +The role of the relayer is to gather attestations' signatures from the orchestrators, and submit them to a target EVM chain. The attestations are generated within the QGB module of the Celestia-app state machine. To learn more about what attestations are, you can refer to [the QGB overview](https://github.com/celestiaorg/celestia-app/tree/main/x/qgb). -Also, while every validator in the Celestia validator set needs to run an orchestrator, we only need one entity to run the relayer, and it can be anyone. Thus, if you're a validator, most likely you want to read the orchestrator documentation [here](https://github.com/celestiaorg/orchestrator-relayer/blob/main/docs/orchestrator.md). +Also, while every validator in the Celestia validator set needs to run an orchestrator, we only need one entity to run the relayer, and it can be anyone. Thus, if you're a validator, most likely you want to read [the orchestrator documentation](https://docs.celestia.org/nodes/qgb-orchestrator/). -Every relayer needs to target a QGB smart contract. This latter can be deployed, if not already, using the `qgb deploy` command. More details in [here](https://github.com/celestiaorg/orchestrator-relayer/blob/main/docs/deploy.md). +Every relayer needs to target a QGB smart contract. This latter can be deployed, if not already, using the `qgb deploy` command. More details in the [Deploy the QGB contract guide](https://docs.celestia.org/nodes/qgb-deploy/). ## How it works @@ -38,7 +38,7 @@ I[2023-04-26|00:04:28.175] waiting for routing table to populate targetnu ### Install the QGB binary -Make sure to have the QGB binary installed. Check [here](https://docs.celestia.org/nodes/qgb-binary) for more details. +Make sure to have the QGB binary installed. Check out the [Install the QGB binary page](https://docs.celestia.org/nodes/qgb-binary) for more details. ### Init the store @@ -83,7 +83,7 @@ To import your EVM private key, there is the `import` subcommand to assist you w qgb 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 [here](https://geth.ethereum.org/docs/developers/dapp-developer/native-accounts). +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: @@ -91,7 +91,7 @@ After adding the key, you can check that it's added via running: qgb relayer keys evm list ``` -For more information about the `keys` command, check the `keys` documentation in [here](https://github.com/celestiaorg/orchestrator-relayer/blob/main/docs/keys.md). +For more information about the `keys` command, check [the `keys` documentation](https://docs.celestia.org/nodes/qgb-keys). ### Start the relayer