@@ -4,44 +4,65 @@ description: Hyperlane CLI for Sapphire
44
55# Hyperlane CLI
66
7- ::: info
7+ ## Introduction
88
9- The standard ** Hyperlane CLI** relies on the ` eth_getStorageAt ` method,
10- which is incompatible with ** Sapphire** by default. To address this, use the
11- ** [ custom branch] ** of the Hyperlane CLI or follow the guidance in the
12- [ Troubleshooting section] of Hyperlane.
9+ The [ Hyperlane CLI] [ cli ] is the official command-line tool for deploying and managing
10+ Hyperlane infrastructure. It provides a comprehensive set of utilities for:
1311
14- For more details about ` eth_getStorageAt ` on Sapphire, refer to the
15- [ Sapphire documentation] .
12+ - ** Chain Configuration** : Set up and register new chains with the Hyperlane
13+ network
14+ - ** Core Contract Deployment** : Deploy Hyperlane's core contracts (Mailbox, ISM,
15+ etc.) to new chains
16+ - ** Warp Route Management** : Configure and deploy token bridges between chains
17+ - ** Message Testing** : Send test messages across chains to verify connectivity
18+ - ** Registry Management** : Interact with chain metadata and contract addresses
1619
17- :::
20+ The CLI streamlines the process of connecting new chains to the Hyperlane
21+ network, making cross-chain communication accessible to developers and chain
22+ operators. This modified version includes compatibility fixes for Sapphire's
23+ unique storage requirements.
24+
25+ [ cli ] : https://docs.hyperlane.xyz/docs/reference/cli
1826
1927## Installation
2028
21- 1 . Clone the Sapphire-compatible branch:
22- ``` bash
23- git clone https://github.com/hyperlane-xyz/hyperlane-monorepo.git --branch pb/storage-workaround
24- cd hyperlane-monorepo
25- ```
29+ Install the Hyperlane CLI globally using npm:
30+
31+ ``` bash
32+ npm install -g @hyperlane-xyz/cli
33+ ```
34+
35+ Alternatively, you can run commands directly without installing globally:
36+
37+ ``` bash
38+ # Run via NPM's npx command
39+ npx @hyperlane-xyz/cli
2640
27- 2. Install dependencies and build the project:
28- ` ` ` bash
29- yarn install && yarn build
30- ` ` `
41+ # Or via Yarn's dlx command
42+ yarn dlx @hyperlane-xyz/cli
43+ ```
3144
3245## Usage
3346
34- Run the modified CLI:
47+ Once installed, you can run the CLI from anywhere in your terminal:
48+
3549``` bash
36- yarn workspace @ hyperlane-xyz/cli hyperlane
50+ hyperlane --help
3751```
3852
53+ To view available commands and options, use the help flag. Common commands
54+ include:
55+
56+ - ` hyperlane relayer ` - Start a relayer to facilitate message delivery between
57+ chains.
58+ For more information visited the our [ Relayer page] [ relayer ]
59+ - ` hyperlane send message ` - Send test messages across chains
60+
61+ [ relayer ] : ./relayer.md
62+
3963## Hyperlane Core Deployment
4064
41- For guidance on how to use the modified CLI for deploying the Hyperlane Core
42- on Sapphire, refer to the [official deploy documentation][hyperlane-deploy].
65+ For guidance on how to deploy the Hyperlane Core on Sapphire, refer to the
66+ [ official deploy documentation] [ hyperlane-deploy ] .
4367
44- [custom branch]: https://github.com/hyperlane-xyz/hyperlane-monorepo/tree/pb/storage-workaround
45- [Sapphire documentation]: https://github.com/oasisprotocol/sapphire-paratime/blob/main/docs/develop/deployment#caution-against-using-eth_getstorageat
46- [Troubleshooting section]: https://docs.hyperlane.xyz/docs/deploy-hyperlane-troubleshooting#eth_getstorageat-compatibility
4768[ hyperlane-deploy ] : https://docs.hyperlane.xyz/docs/deploy-hyperlane
0 commit comments