diff --git a/docs/build/opl/hyperlane/README.md b/docs/build/opl/hyperlane/README.md index d7dd94c3da..2977fed1e9 100644 --- a/docs/build/opl/hyperlane/README.md +++ b/docs/build/opl/hyperlane/README.md @@ -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 @@ -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 diff --git a/docs/build/opl/hyperlane/cli.md b/docs/build/opl/hyperlane/cli.md deleted file mode 100644 index b0755f8317..0000000000 --- a/docs/build/opl/hyperlane/cli.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -description: Hyperlane CLI for Sapphire ---- - -# Hyperlane CLI - -:::info - -The standard **Hyperlane CLI** relies on the `eth_getStorageAt` method, -which is incompatible with **Sapphire** by default. To address this, use the -**[custom branch]** of the Hyperlane CLI or follow the guidance in the -[Troubleshooting section] of Hyperlane. - -For more details about `eth_getStorageAt` on Sapphire, refer to the -[Sapphire documentation]. - -::: - -## Installation - -1. Clone the Sapphire-compatible branch: - ```bash - git clone https://github.com/hyperlane-xyz/hyperlane-monorepo.git --branch pb/storage-workaround - cd hyperlane-monorepo - ``` - -2. Install dependencies and build the project: - ```bash - yarn install && yarn build - ``` - -## Usage - -Run the modified CLI: -```bash -yarn workspace @hyperlane-xyz/cli hyperlane -``` - -## Hyperlane Core Deployment - -For guidance on how to use the modified CLI for deploying the Hyperlane Core -on Sapphire, refer to the [official deploy documentation][hyperlane-deploy]. - -[custom branch]: https://github.com/hyperlane-xyz/hyperlane-monorepo/tree/pb/storage-workaround -[Sapphire documentation]: https://github.com/oasisprotocol/sapphire-paratime/blob/main/docs/develop/deployment#caution-against-using-eth_getstorageat -[Troubleshooting section]: https://docs.hyperlane.xyz/docs/deploy-hyperlane-troubleshooting#eth_getstorageat-compatibility -[hyperlane-deploy]: https://docs.hyperlane.xyz/docs/deploy-hyperlane diff --git a/docs/build/opl/hyperlane/relayer.md b/docs/build/opl/hyperlane/relayer.md index 708fe03324..108c2b780d 100644 --- a/docs/build/opl/hyperlane/relayer.md +++ b/docs/build/opl/hyperlane/relayer.md @@ -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 diff --git a/redirects.ts b/redirects.ts index 9e85fc7293..e6b9872ed4 100644 --- a/redirects.ts +++ b/redirects.ts @@ -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 diff --git a/sidebarBuild.ts b/sidebarBuild.ts index 63a6e707ab..e76628c60d 100644 --- a/sidebarBuild.ts +++ b/sidebarBuild.ts @@ -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', ],