docs: document that the QGB p2p network is a separate one (#330)

* docs: document that the QGB p2p network is a separate one * docs: document that the QGB p2p network is a separate one
celestiaorg · Apr 28, 2023 · 611c85b · 611c85b
1 parent d4adc4c
commit 611c85b
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,8 @@ If you are a Celestia-app validator, all you need to do is run the orchestrator.
 
 If you want to post commitments on an EVM chain, you will need to deploy a new QGB contract and run a relayer. Check [here](https://github.com/celestiaorg/orchestrator-relayer/blob/main/docs/relayer.md) for relayer docs and [here](https://github.com/celestiaorg/orchestrator-relayer/blob/main/docs/deploy.md) for how to deploy a new QGB contract.
 
+Note: the QGB P2P network is a separate network than the consensus or the data availability one. Thus, you will need its specific bootstrappers to be able to connect to it.
+
 ## Contributing
 
 ### Tools

diff --git a/docs/orchestrator.md b/docs/orchestrator.md
@@ -14,6 +14,16 @@ The orchestrator does the following:
 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.
 
+The orchestrator connects to a separate P2P network than the consensus or the data availability one. So, we will provide bootstrappers for that one.
+
+This means that even if the consensus node is already connected to the consensus network, if the orchestrator doesn't start with a list of bootstrapper to its specific network, then, it will not work and will output the following logs:
+
+```text
+I[2023-04-26|00:04:08.175] waiting for routing table to populate        targetnumberofpeers=1 currentcount=0
+I[2023-04-26|00:04:18.175] waiting for routing table to populate        targetnumberofpeers=1 currentcount=0
+I[2023-04-26|00:04:28.175] waiting for routing table to populate        targetnumberofpeers=1 currentcount=0
+```
+
 ## How to run
 
 ### Install the QGB binary

diff --git a/docs/relayer.md b/docs/relayer.md
@@ -19,6 +19,16 @@ The relayer works as follows:
 5. Once the relayer finds more than 2/3s signatures, it submits them to the target QGB smart contract where they get validated.
 6. Listen for new attestations and go back to step 2.
 
+The relayer connects to a separate P2P network than the consensus or the data availability one. So, we will provide bootstrappers for that one.
+
+This means that even if the consensus node is already connected to the consensus network, if the relayer doesn't start with a list of bootstrapper to its specific network, then, it will not work and will output the following logs:
+
+```text
+I[2023-04-26|00:04:08.175] waiting for routing table to populate        targetnumberofpeers=1 currentcount=0
+I[2023-04-26|00:04:18.175] waiting for routing table to populate        targetnumberofpeers=1 currentcount=0
+I[2023-04-26|00:04:28.175] waiting for routing table to populate        targetnumberofpeers=1 currentcount=0
+```
+
 ## How to run
 
 ### Install the QGB binary