Skip to content

Commit 6c90304

Browse files
committed
docs: update hyperlane
1 parent f525064 commit 6c90304

File tree

5 files changed

+34
-52
lines changed

5 files changed

+34
-52
lines changed

docs/build/opl/hyperlane/README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Hyperlane's architecture consists of four key components:
3434
- **[Relayers]**: Off-chain agents that transport messages between chains
3535
- **[Validators]**: Fulfilling the security layer of the Hyperlane protocol
3636

37-
[Mailboxes]: https://docs.hyperlane.xyz/docs/protocol/mailbox
37+
[Mailboxes]: https://docs.hyperlane.xyz/docs/protocol/core/mailbox
3838
[ism]: https://docs.hyperlane.xyz/docs/protocol/ISM/modular-security
3939
[Relayers]: https://docs.hyperlane.xyz/docs/protocol/agents/relayer
4040
[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
4646

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

49-
[igp]: https://docs.hyperlane.xyz/docs/protocol/interchain-gas-payment
49+
[igp]: https://docs.hyperlane.xyz/docs/protocol/core/interchain-gas-payment
50+
51+
## Hyperlane CLI
52+
53+
The [Hyperlane CLI][cli] is the official command-line tool for deploying and
54+
managing Hyperlane infrastructure. It provides a comprehensive set of utilities
55+
for:
56+
57+
- **Chain Configuration**: Set up and register new chains with the Hyperlane
58+
network
59+
- **Core Contract Deployment**: Deploy Hyperlane's core contracts (Mailbox,
60+
ISM, etc.) to new chains
61+
- **Warp Route Management**: Configure and deploy token bridges between chains
62+
- **Message Testing**: Send test messages across chains to verify connectivity
63+
- **Registry Management**: Interact with chain metadata and contract addresses
64+
65+
The CLI streamlines the process of connecting new chains to the Hyperlane
66+
network, making cross-chain communication accessible to developers and chain
67+
operators.
68+
69+
[cli]: https://docs.hyperlane.xyz/docs/reference/developer-tools/cli
70+
71+
## Hyperlane Core Deployment
72+
73+
For guidance on how to deploy the Hyperlane Core on Sapphire, refer to the
74+
[official deploy documentation][hyperlane-deploy].
75+
76+
[hyperlane-deploy]: https://docs.hyperlane.xyz/docs/get-started-building#step-2%3A-deploy-hyperlane-core-infrastructure
5077

5178
## See also
5279

5380
<DocCardList items={[
54-
findSidebarItem('/build/opl/hyperlane/cli'),
5581
findSidebarItem('/build/opl/hyperlane/relayer'),
5682
findSidebarItem('/build/opl/hyperlane/pingpong-example'),
5783
]} />

docs/build/opl/hyperlane/cli.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

docs/build/opl/hyperlane/relayer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: Run a Hyperlane Relayer
1111

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

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

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

redirects.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,10 @@ export const redirectsOptions: Options = {
429429
to: '/general/manage-tokens/how-to-bridge-assets', // #859 Revamp bridging assets chapter
430430
from: '/general/manage-tokens/how-to-transfer-eth-erc20-to-emerald-paratime',
431431
},
432+
{
433+
to: '/build/opl/hyperlane/',
434+
from: '/build/opl/hyperlane/cli', // #1264 Update Hyperlane
435+
},
432436
],
433437
createRedirects(existingPath) {
434438
// #119 Add /oasis-core/adr/* -> /adrs/* redirection

sidebarBuild.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,6 @@ export const sidebarBuild: SidebarsConfig = {
9797
id: 'build/opl/hyperlane/README',
9898
},
9999
items: [
100-
'build/opl/hyperlane/cli',
101100
'build/opl/hyperlane/relayer',
102101
'build/opl/hyperlane/pingpong-example',
103102
],

0 commit comments

Comments
 (0)