Getting started
Welcome to Hyperlane! Here are some resources to help you get started building on the modular interoperability stack.
For blockchain developers
Permissionless interoperability
If you have deployed your own chain or rollup and want interoperability for that chain, you can deploy Hyperlane to your chain. Here's how:
Deploy Hyperlane to the chain of your choice
Warp Routes enable token representations of popular tokens like ETH or USDC on your chain with a working UI out of the box.
For application developers
Once Hyperlane exists on your desired chains, you can use one of the APIs provided. For each of the APIs, we have Quickstarts that folks can use to quickly try out the APIs and see how easy it is to use them. We highly recommend trying the quickstarts first to get a feel for the APIs before diving into the API reference pages.
Accounts API
You can use the accounts API to have an account make function calls on another chain. For example, a DAO can easily own assets on other chains without needing any remote smart contracts.
Accounts quickstart
Accounts API reference
Queries API
You can use the queries API to read state from a remote chain. For example, you can read a price feed or ENS name on Ethereum from BSC.
Queriesquickstart
Queries API reference
Messaging API
Anything that doesn't fit in the above, you can use Hyperlane messaging to send and receive arbitrary bytes between your contracts on different chains for maximum flexibility.
Messaging quickstart
Messaging API reference
Example applications
Looking for some inspiration? Check out these example applications that have been built on top of Hyperlane
Hyperlane Explorer
The Explorer is an excellent tool that allows you to track the status of messages sent over Hyperlane, including messages from/to chains that you deployed Hyperlane on. The Exploreralso has an API that you can use to show the status in your user interface.
Help and support
If you need help using Hyperlane, please reach out on Discord or Twitter!
If you're running into issues once you've begun using Hyperlane, such as messages not getting processed or delivered properly, transaction failures, or other issues check out the Troubleshooting/Developer FAQ pages.
Last updated