Skip to content

docs: update/remove info for router protocol #1394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update/remove info for router protocol #1394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions docs/build/opl/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,24 +44,23 @@ messages, please visit our [Gasless Transactions chapter].

## Message Bridges

You can integrate messaging bridges into your dApps using one of these four
You can integrate messaging bridges into your dApps using one of these three
methods:

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

Router Protocol had a [security incident][router-incident] and is at the moment not available.

### Comparison

| Protocol | Validator Network | Relayer | Fees |
| ----------------------------- | ----------------------------------- | ------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| **[Hyperlane][hyperlane]** | Self-hosted or<br/>run by Hyperlane | Self-hosted or <br/>run by Hyperlane | Interchain Gas Payments on origin chain |
| **[Router Protocol][router]** | Orchestrators (Router Chain) | Relayer (run by 3rd party) | Paid by the approved feepayer on the Routerchain |
| **[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) |
| **[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) |

Expand All @@ -76,21 +75,23 @@ testing environments.

#### Production

**[Router Protocol][router]**: Battle-tested by ecosystem dApps like Neby and
features the most active token pairs. Router provides a highly reliable,
solution for cross-chain communication, making it a top recommendation
for production-ready environments.
**[Celer IM][celer] (OPL SDK)**: Celer IM is a working solution since 2023.

Hyperlane will soon be live on Sapphire Mainnet. If you don't need Mainnet
support immediately, wait for it as it generally supports more chains.

Alternatively: Build your own privacy layer with [ROFL]

## Examples

<DocCardList items={[
findSidebarItem('/build/opl/opl-sdk/ping-example'),
findSidebarItem('/build/opl/celer/ping-example'),
findSidebarItem('/build/opl/hyperlane/pingpong-example'),
findSidebarItem('/build/opl/router-protocol/pingpong-example'),
]} />

[OPL SDK]: ./opl-sdk/README.md
[celer]: ./celer/README.md
[router]: ./router-protocol/README.md
[hyperlane]: ./hyperlane/README.md
[router-incident]: https://routerprotocol.medium.com/incident-report-router-protocol-asset-bridge-exploit-and-response-833f5bb95a31
[ROFL]: https://github.com/oasisprotocol/oasis-sdk/blob/main/docs/rofl/README.mdx
8 changes: 8 additions & 0 deletions docs/build/opl/router-protocol/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ description: Cross-chain dApps with Router Protocol

# Router Protocol

:::warning Temporarily Unavailable

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.

:::

[security incident]: https://routerprotocol.medium.com/incident-report-router-protocol-asset-bridge-exploit-and-response-833f5bb95a31

Router Protocol offers two frameworks for cross-chain interactions:

- **Router CrossTalk**: Enables stateless and stateful cross-chain messaging
Expand Down
14 changes: 0 additions & 14 deletions sidebarBuild.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ export const sidebarBuild: SidebarsConfig = {
id: 'build/opl/README',
},
items: [

{
type: 'category',
label: 'Hyperlane Protocol',
Expand All @@ -102,19 +101,6 @@ export const sidebarBuild: SidebarsConfig = {
'build/opl/hyperlane/pingpong-example',
],
},
{
type: 'category',
label: 'Router Protocol',
link: {
type: 'doc',
id: 'build/opl/router-protocol/README',
},
items: [
'build/opl/router-protocol/pingpong-example',
'build/opl/router-protocol/interface',
'build/opl/router-protocol/approve',
],
},
Comment on lines -105 to -117
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just comment it out for now. And then we'll remove complete guides in a year or so, if Router decides not to come back.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also reference in the comment this PR.

{
type: 'category',
label: 'OPL SDK',
Expand Down