Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 29 additions & 3 deletions docs/build/opl/hyperlane/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Hyperlane's architecture consists of four key components:
- **[Relayers]**: Off-chain agents that transport messages between chains
- **[Validators]**: Fulfilling the security layer of the Hyperlane protocol

[Mailboxes]: https://docs.hyperlane.xyz/docs/protocol/mailbox
[Mailboxes]: https://docs.hyperlane.xyz/docs/protocol/core/mailbox
[ism]: https://docs.hyperlane.xyz/docs/protocol/ISM/modular-security
[Relayers]: https://docs.hyperlane.xyz/docs/protocol/agents/relayer
[Validators]: https://docs.hyperlane.xyz/docs/protocol/agents/validators
Expand All @@ -46,12 +46,38 @@ Hyperlane fees are called **Interchain Gas Payments** and are payed by the

For more info about the Interchain Gas Payments, consult the [Hyperlane documentation][igp]

[igp]: https://docs.hyperlane.xyz/docs/protocol/interchain-gas-payment
[igp]: https://docs.hyperlane.xyz/docs/protocol/core/interchain-gas-payment

## Hyperlane CLI

The [Hyperlane CLI][cli] is the official command-line tool for deploying and
managing Hyperlane infrastructure. It provides a comprehensive set of utilities
for:

- **Chain Configuration**: Set up and register new chains with the Hyperlane
network
- **Core Contract Deployment**: Deploy Hyperlane's core contracts (Mailbox,
ISM, etc.) to new chains
- **Warp Route Management**: Configure and deploy token bridges between chains
- **Message Testing**: Send test messages across chains to verify connectivity
- **Registry Management**: Interact with chain metadata and contract addresses

The CLI streamlines the process of connecting new chains to the Hyperlane
network, making cross-chain communication accessible to developers and chain
operators.

[cli]: https://docs.hyperlane.xyz/docs/reference/developer-tools/cli

## Hyperlane Core Deployment

For guidance on how to deploy the Hyperlane Core on Sapphire, refer to the
[official deploy documentation][hyperlane-deploy].

[hyperlane-deploy]: https://docs.hyperlane.xyz/docs/get-started-building#step-2%3A-deploy-hyperlane-core-infrastructure

## See also

<DocCardList items={[
findSidebarItem('/build/opl/hyperlane/cli'),
findSidebarItem('/build/opl/hyperlane/relayer'),
findSidebarItem('/build/opl/hyperlane/pingpong-example'),
]} />
47 changes: 0 additions & 47 deletions docs/build/opl/hyperlane/cli.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/build/opl/hyperlane/relayer.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: Run a Hyperlane Relayer

The easiest way to run a relayer is with the **[Hyperlane CLI]**.

[Hyperlane CLI]: https://docs.hyperlane.xyz/docs/reference/cli
[Hyperlane CLI]: https://docs.hyperlane.xyz/docs/reference/developer-tools/cli

1. Export your private key to be used with the CLI

Expand Down
4 changes: 4 additions & 0 deletions redirects.ts
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,10 @@ export const redirectsOptions: Options = {
to: '/general/manage-tokens/how-to-bridge-assets', // #859 Revamp bridging assets chapter
from: '/general/manage-tokens/how-to-transfer-eth-erc20-to-emerald-paratime',
},
{
to: '/build/opl/hyperlane/',
from: '/build/opl/hyperlane/cli', // #1264 Update Hyperlane
},
],
createRedirects(existingPath) {
// #119 Add /oasis-core/adr/* -> /adrs/* redirection
Expand Down
1 change: 0 additions & 1 deletion sidebarBuild.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ export const sidebarBuild: SidebarsConfig = {
id: 'build/opl/hyperlane/README',
},
items: [
'build/opl/hyperlane/cli',
'build/opl/hyperlane/relayer',
'build/opl/hyperlane/pingpong-example',
],
Expand Down