Skip to content

Commit 7b6ca0a

Browse files
committed
docs: update info for router protocol and remove it from available options
1 parent 8dc7321 commit 7b6ca0a

File tree

3 files changed

+19
-24
lines changed

3 files changed

+19
-24
lines changed

docs/build/opl/README.mdx

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,23 @@ messages, please visit our [Gasless Transactions chapter].
4444

4545
## Message Bridges
4646

47-
You can integrate messaging bridges into your dApps using one of these four
47+
You can integrate messaging bridges into your dApps using one of these three
4848
methods:
4949

5050
- **[Hyperlane Protocol][hyperlane]**: A permissionless interoperability
5151
protocol that enables seamless cross-chain communication for developers.
52-
- **[Router Protocol CrossTalk][router]**: An extensible cross-chain framework
53-
that enables seamless state transitions across multiple chains.
5452
- **[OPL SDK]**: A wrapper provided by the Oasis Protocol that simplifies the
5553
integration of message bridging with Oasis’s privacy features.
5654
- **[Celer Inter-Chain Messaging (IM)][celer]**: A generalized message bridging
5755
solution by Celer, which lets you build more complex solutions.
5856

57+
Router Protocol had a [security incident][router-incident] and is at the moment not available.
58+
5959
### Comparison
6060

6161
| Protocol | Validator Network | Relayer | Fees |
6262
| ----------------------------- | ----------------------------------- | ------------------------------------------------------ | -------------------------------------------------------------------------------------- |
6363
| **[Hyperlane][hyperlane]** | Self-hosted or<br/>run by Hyperlane | Self-hosted or <br/>run by Hyperlane | Interchain Gas Payments on origin chain |
64-
| **[Router Protocol][router]** | Orchestrators (Router Chain) | Relayer (run by 3rd party) | Paid by the approved feepayer on the Routerchain |
6564
| **[OPL SDK]** | SGN (Celer) | Executor (self-hosted or <br/>hosted service by Celer) | SGN Fee: Paid via `msg.value` <br/> Executor Fee: Charged externally (Free on testnet) |
6665
| **[Celer IM][celer]** | SGN (Celer) | Executor (self-hosted or <br/>hosted service by Celer) | SGN Fee: Paid via `msg.value` <br/> Executor Fee: Charged externally (Free on testnet) |
6766

@@ -76,21 +75,23 @@ testing environments.
7675

7776
#### Production
7877

79-
**[Router Protocol][router]**: Battle-tested by ecosystem dApps like Neby and
80-
features the most active token pairs. Router provides a highly reliable,
81-
solution for cross-chain communication, making it a top recommendation
82-
for production-ready environments.
78+
**[Celer IM][celer] (OPL SDK)**: Celer IM is a working solution since 2023.
79+
80+
Hyperlane will soon be live on Sapphire Mainnet. If you don't need Mainnet
81+
support immediately, wait for it as it generally supports more chains.
82+
83+
Alternatively: Build your own privacy layer with [ROFL]
8384

8485
## Examples
8586

8687
<DocCardList items={[
8788
findSidebarItem('/build/opl/opl-sdk/ping-example'),
8889
findSidebarItem('/build/opl/celer/ping-example'),
8990
findSidebarItem('/build/opl/hyperlane/pingpong-example'),
90-
findSidebarItem('/build/opl/router-protocol/pingpong-example'),
9191
]} />
9292

9393
[OPL SDK]: ./opl-sdk/README.md
9494
[celer]: ./celer/README.md
95-
[router]: ./router-protocol/README.md
9695
[hyperlane]: ./hyperlane/README.md
96+
[router-incident]: https://routerprotocol.medium.com/incident-report-router-protocol-asset-bridge-exploit-and-response-833f5bb95a31
97+
[ROFL]: https://github.com/oasisprotocol/oasis-sdk/blob/main/docs/rofl/README.mdx

docs/build/opl/router-protocol/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ description: Cross-chain dApps with Router Protocol
44

55
# Router Protocol
66

7+
:::warning Temporarily Unavailable
8+
9+
Router Protocol had a [security incident] and is currently not available. They plan to return in a few months. This documentation is kept for reference and will be updated when Router Protocol resumes operations.
10+
11+
:::
12+
13+
[security incident]: https://routerprotocol.medium.com/incident-report-router-protocol-asset-bridge-exploit-and-response-833f5bb95a31
14+
715
Router Protocol offers two frameworks for cross-chain interactions:
816

917
- **Router CrossTalk**: Enables stateless and stateful cross-chain messaging

sidebarBuild.ts

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,6 @@ export const sidebarBuild: SidebarsConfig = {
8787
id: 'build/opl/README',
8888
},
8989
items: [
90-
9190
{
9291
type: 'category',
9392
label: 'Hyperlane Protocol',
@@ -101,19 +100,6 @@ export const sidebarBuild: SidebarsConfig = {
101100
'build/opl/hyperlane/pingpong-example',
102101
],
103102
},
104-
{
105-
type: 'category',
106-
label: 'Router Protocol',
107-
link: {
108-
type: 'doc',
109-
id: 'build/opl/router-protocol/README',
110-
},
111-
items: [
112-
'build/opl/router-protocol/pingpong-example',
113-
'build/opl/router-protocol/interface',
114-
'build/opl/router-protocol/approve',
115-
],
116-
},
117103
{
118104
type: 'category',
119105
label: 'OPL SDK',

0 commit comments

Comments
 (0)