Hyperlane is an interchain messaging protocol designed to enable applications to communicate between blockchains. This protocol allows developers to share state across multiple blockchains, facilitating the creation of interchain applications that operate natively across various chains.
The Hyperlane repository currently hosts Hyperlane v3, which is the latest version. Previous versions, V2 and V1, are deprecated but can still be accessed in their respective branches:
Developers can find comprehensive documentation and resources for integrating with Hyperlane at the Hyperlane Documentation.
Hyperlane uses Foundry for development, a fast and modular toolkit for Ethereum application development. To set up Foundry on your machine:
Install foundryup
:
curl -L https://foundry.paradigm.xyz | bash
Install forge
, cast
, anvil
, and chisel
by running:
foundryup
For more information, refer to the Foundry Book.
This repository targets Node.js v20. It is recommended to use nvm (Node Version Manager) to manage your Node.js version:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
nvm install 20
nvm use 20
Hyperlane uses Yarn Workspaces for managing multiple packages within a single repository. Key commands include:
yarn install
yarn build
Hyperlane uses Pino for logging, which outputs structured JSON logs by default. The verbosity level and format can be configured using environment variables:
LOG_LEVEL=DEBUG|INFO|WARN|ERROR|OFF
LOG_FORMAT=PRETTY|JSON
For projects involving Rust, refer to the specific README in the rust
directory of the repository.
agents-2023-03-28
) and create a GitHub release with changelog details.release
script in package.json
for publishing, with specific instructions for alpha or beta versions.Hyperlane provides a robust framework for developing interchain applications, enabling secure, reliable, and scalable communication across multiple blockchains.