Merge branch 'main' into 1360-update-router-protocol-docs

Author: njelich

.github/workflows/ci-lint.yml

@@ -29,4 +29,4 @@ jobs:
       - name: Mermaid diagrams synced with sources
         run: |
           yarn diagrams
-          git diff --exit-code
+          git diff --submodule=diff --exit-code

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "arrowParens": "always",
+  "bracketSpacing": false,
+  "bracketSameLine": true,
+  "printWidth": 80,
+  "proseWrap": "never",
+  "singleQuote": true,
+  "trailingComma": "all"
+}

docs/build/diagrams/opl-contract-flow.mmd.svg

@@ -1,25 +1,19 @@
 flowchart TB
- subgraph Origin["Origin"]
-        Sender["Sender"]
-        M_O[("Mailbox")]
+  subgraph Origin["Origin"]
+    Sender["Sender"]
+    M_O[("Mailbox")]
   end
- subgraph Destination["Destination"]
-        Recipient["Recipient"]
-        M_D[("Mailbox")]
-        ISM["InterchainSecurityModule"]
+  subgraph Destination["Destination"]
+    Recipient["Recipient"]
+    M_D[("Mailbox")]
+    ISM["InterchainSecurityModule"]
   end
-    Sender -- "1.dispatch(destination, recipient, body)" --> M_O
-    M_O -. "2.emit dispatch(sender, destination, recipient, body)" .-> Relayer(("Relayer"))
-    Relayer -- "3.process(metadata, message)" --> M_D
-    M_D -. "4.interchainSecurityModule()" .-> Recipient
-    M_D -- "5.verify(metadata, message)" --> ISM
-    M_D -- "6.handle(origin, sender, body)" --> Recipient
+  Sender -- "1.dispatch(destination, recipient, body)" --> M_O
+  M_O -. "2.emit dispatch(sender, destination, recipient, body)" .-> Relayer(("Relayer"))
+  Relayer -- "3.process(metadata, message)" --> M_D
+  M_D -. "4.interchainSecurityModule()" .-> Recipient
+  M_D -- "5.verify(metadata, message)" --> ISM
+  M_D -- "6.handle(origin, sender, body)" --> Recipient
 
-    style Sender fill:#FFFFFF,color:#000000,stroke-width:1px,stroke-dasharray: 0,stroke:#000000
-    style M_O stroke-width:1px,stroke-dasharray: 0,stroke:#000000,fill:#0500e2,color:#FFFFFF
-    style Recipient fill:#FFFFFF,color:#000000,stroke-width:1px,stroke-dasharray: 0,stroke:#000000
-    style M_D stroke-width:1px,stroke-dasharray: 0,stroke:#000000,fill:#0500e2,color:#FFFFFF
-    style ISM stroke-width:1px,stroke-dasharray: 0,stroke:#000000,fill:#0500e2,color:#FFFFFF
-    style Relayer stroke-width:1px,stroke-dasharray: 0,stroke:#000000,fill:#0500e2,color:#FFFFFF
-    style Origin fill:#BBDEFB,stroke:#000000
-    style Destination fill:#BBDEFB,stroke:#000000
+  class M_O,M_D,Relayer,ISM highlightNodes;
+  class Sender,Recipient endpointNode;

docs/build/diagrams/opl-hyperlane-flow.mmd

@@ -54,7 +54,7 @@ The network is agnostic in this regard. Anyone can run a ParaTime. It is complet
 
 ### **What consensus mechanism are you running? Is it BFT?**
 
-The Oasis Network uses Tendermint as its BFT consensus protocol. Given that the consensus layer uses a BFT protocol, the Oasis Network offers instant finality, meaning that once a block is finalized, it cannot be reverted (at least not for full nodes). A ParaTime commitment goes into a block and as such the ParaTime state is also finalized and cannot be reverted once a block is finalized.
+The Oasis Network uses CometBFT as its BFT consensus protocol. Given that the consensus layer uses a BFT protocol, the Oasis Network offers instant finality, meaning that once a block is finalized, it cannot be reverted (at least not for full nodes). A ParaTime commitment goes into a block and as such the ParaTime state is also finalized and cannot be reverted once a block is finalized.
 
 ### **Why doesn’t the Oasis Network do sharding? Does that mean it’s slow?**
 

docs/build/diagrams/opl-hyperlane-flow.mmd.svg

@@ -63,8 +63,10 @@ encrypting ParaTime's state.
 The [Advanced Vector Extensions 2 (AVX2)][AVX2] support enables faster Ed25519
 signature verification which in turn makes a node sync faster.
 
-The [Intel SGX] support is required if you want to run Paratime compute nodes
-that use a trusted execution environment (TEE). Intel maintains a comprehensive
+The [Intel SGX] support is required if you want to run ParaTime compute nodes
+for SGX-enabled ParaTimes (such as Sapphire and Cipher). Some ParaTimes like Emerald
+do not require SGX. Check the specific ParaTime documentation to determine if SGX is
+required for your use case. Intel maintains a comprehensive
 list of [processors that support Intel SGX].
 
 :::

docs/build/diagrams/opl-hyperlane-pingpong-flow.mmd.svg

@@ -9,7 +9,7 @@ description: Oasis Node Troubleshooting for Node Operators and Hackers
 Before you begin troubleshooting your Oasis Node we suggest you check all of the
 following:
 
-* Check that your current binary version is the latest listed on the Network Parameters page ([Mainnet](../mainnet/README.md), [Testnet](../testnet/README.md))
+* Check that your current binary version matches the version listed on the Network Parameters page ([Mainnet](../mainnet/README.md), [Testnet](../testnet/README.md))
   * Check the version on your localhost using `oasis-node --version`
   * Check the version on your server using `oasis-node --version`
 * If upgrading, make sure that you've wiped state (unless that is explicitly not required)
@@ -18,10 +18,7 @@ following:
   * Do you have the latest genesis?
   * Do you have the correct private key (or Ledger device).
   * If you're signing a transaction:
-    * Do you sufficient account balance to make the transaction?
-      * Run `oasis-node stake account info`
-    * Are you using the correct nonce?
-      * Run `oasis-node stake account info`
+    * Check your account balance and nonce using the [`oasis account show`](https://github.com/oasisprotocol/cli/blob/master/docs/account.md#show) command.
 * If you're generating a transaction:
   * Do you have the latest genesis?
 * If you're submitting a transaction: