Getting started
Welcome to Hyperlane! Here are some resources to help you get started building on the modular interoperability stack.
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:
- Warp Routes enable token representations of popular tokens like ETH or USDC on your chain with a working UI out of the box.
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.
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.
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.
Looking for some inspiration? Check out these example applications that have been built on top of Hyperlane
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.