-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
75 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
description: Hyperlane Bridge | ||
--- | ||
|
||
# Hyperlane | ||
|
||
[Hyperlane] is a permissionless interoperability protocol that enables seamless | ||
cross-chain communication for developers. Its unique design allows deployment | ||
across various blockchain environments, including layer 1 chains, rollups, and | ||
app-chains, without the need for approvals or intermediaries. This empowers | ||
developers to build cross-chain applications with full control over their | ||
operations in a multi-chain ecosystem. | ||
|
||
Features of Hyperlane: | ||
|
||
- Modular Interchain Security Modules (ISMs) | ||
- Warp Routes for token transfers | ||
- Interchain Accounts (ICA) for cross-chain smart contract interactions | ||
- Interchain Queries (IQS) for remote data access | ||
|
||
[Hyperlane]: https://hyperlane.xyz/ | ||
|
||
## Hyperlane CLI on Sapphire | ||
|
||
The standard Hyperlane CLI relies on the `eth_getStorageAt` method, which is | ||
incompatible with Sapphire by default. To address this, a custom branch of the | ||
Hyperlane CLI has been created. You can find it here: | ||
[https://github.com/hyperlane-xyz/hyperlane-monorepo/tree/pb/storage-workaround](https://github.com/hyperlane-xyz/hyperlane-monorepo/tree/pb/storage-workaround) | ||
|
||
To use this modified CLI: | ||
1. Clone the branch to your local machine: | ||
|
||
``` | ||
git clone https://github.com/hyperlane-xyz/hyperlane-monorepo.git --branch pb/storage-workaround | ||
cd hyperlane-monorepo | ||
``` | ||
|
||
2. Install dependencies and build the project: | ||
|
||
``` | ||
yarn install && yarn build | ||
``` | ||
|
||
3. Run the modified CLI using the following command: | ||
|
||
``` | ||
yarn workspace @hyperlane-xyz/cli hyperlane | ||
``` | ||
|
||
For more details about `eth_getStorageAt`, refer to the [Sapphire documentation]. | ||
|
||
|
||
[Sapphire documentation]: https://github.com/oasisprotocol/sapphire-paratime/blob/main/docs/deployment.md#caution-against-using-eth_getstorageat | ||
|
||
### Hyperlane Deployment | ||
|
||
For guidance on deploying a new chain using the Hyperlane CLI, refer to the | ||
official documentation [here]. | ||
|
||
When deploying Hyperlane on Sapphire, use the modified CLI version described | ||
earlier to ensure compatibility with Sapphire’s environment. | ||
|
||
[here](https://docs.hyperlane.xyz/docs/deploy-hyperlane) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters