The home for Hyperlane core contracts, sdk packages, and other infrastructure
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Le Yu 252f2d468c Add stateProofHelper tests. Update read access for proof test-data 4 months ago
.changeset feat(HypERC20App): Support proxiedFactories in HypERC20App, extend HypERC20Checker with ProxiedRouterChecker (#4312) 4 months ago
.codespell feat: deploy to `zircuit` (#4265) 4 months ago
.github feat: Report git commit hash as agent metadata (#4282) 4 months ago
.husky export tx provider from sdk & remove safe util from infra (#3694) 7 months ago
.yarn Convert packages from CJS to ESM (#3531) 8 months ago
rust feat: panics upon startup when RPC issues occur include the offending chain (#4323) 4 months ago
solidity Add stateProofHelper tests. Update read access for proof test-data 4 months ago
tools/grafana feat: validator dashboard template (#4097) 5 months ago
typescript chore: Enable no-restricted-imports eslint rule (#4329) 4 months ago
vectors Support cosmos contract byte lengths other than 32 (#3147) 11 months ago
.dockerignore feat: Report git commit hash as agent metadata (#4282) 4 months ago
.eslintignore Convert packages from CJS to ESM (#3531) 8 months ago
.eslintrc chore: Enable no-restricted-imports eslint rule (#4329) 4 months ago
.gitattributes feat: Hyperlane AVS contracts (#3651) 7 months ago
.gitignore V3 agents rebase (#2746) 1 year ago
.gitmodules add polygon hook and ism (#3038) 7 months ago
.lintstagedrc Fix prettier + githook (#503) 3 years ago
.nvmrc chore: add .nvmrc to specify node version (#3712) 7 months ago
.prettierignore Sealevel (#2404) 1 year ago
.prettierrc Convert packages from CJS to ESM (#3531) 8 months ago
.registryrc chore: enroll worldchain, xlayer, cheesechain, zircuit validators (#4313) 4 months ago
.yarnrc.yml Upgrade to yarn 4.0.2 1 year ago
CODE_OF_CONDUCT.md Merge branch 'main' into cli-2.0 6 months ago
CONTRIBUTING.md Add code spellcheck CI job (#3467) 8 months ago
DISCLAIMER.md Hyperlane packages and typescript rebrand (#1077) 2 years ago
Dockerfile feat: fully testing ICA ownership with tooling (#4245) 4 months ago
LICENSE.md chore: add APACHE2.0 license 4 years ago
README.md docs: Add jq as prerequisite since yarn install won't work without it (#4262) 4 months ago
codecov.yml chore: use new forge feature for filtering coverage (#4318) 4 months ago
funding.json chore: create `funding.json` (#3919) 6 months ago
mono.code-workspace chore: Add some more useful vscode extensions (#4113) 5 months ago
package.json ci: fix slither (#3956) 6 months ago
rust-toolchain Merge main to v3 (#2812) 1 year ago
tsconfig.json feat: Improve WarpCore validation errors (#4116) 5 months ago
yarn.lock Add optimism-bedrock, succinctx packages. Update remappings 4 months ago

README.md

Hyperlane

GitHub Actions codecov Foundry License: MIT

Versioning

Note this is the branch for Hyperlane v3.

V2 is deprecated in favor of V3. The code for V2 can be found in the v2 branch. For V1 code, refer to the v1 branch.

Overview

Hyperlane is an interchain messaging protocol that allows applications to communicate between blockchains.

Developers can use Hyperlane to share state between blockchains, allowing them to build interchain applications that live natively across multiple chains.

To read more about interchain applications, how the protocol works, and how to integrate with Hyperlane, please see the documentation.

Working on Hyperlane

Prerequisites

Install jq

You need jq installed on your machine. You can download it from official page or use a package manager of your choice.

Foundry

First ensure you have Foundry installed on your machine.

Run the following to install foundryup:

curl -L https://foundry.paradigm.xyz | bash

Then run foundryup to install forge, cast, anvil and chisel.

foundryup

Check out the Foundry Book for more information.

Node

This repository targets v20 of node. We recommend using nvm to manage your node version.

To install nvm

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash

To install version 20

nvm install 20
nvm use 20

You should change versions automatically with the .nvmrc file.

Workspaces

This monorepo uses Yarn Workspaces. Installing dependencies, building, testing, and running prettier for all packages can be done from the root directory of the repository.

  • Installing dependencies

    yarn install
    
  • Building

    yarn build
    

If you are using VSCode, you can launch the multi-root workspace with code mono.code-workspace, install the recommended workspace extensions, and use the editor settings.

Logging

The typescript tooling uses Pino based logging, which outputs structured JSON logs by default. The verbosity level and style can be configured with environment variables:

LOG_LEVEL=DEBUG|INFO|WARN|ERROR|OFF
LOG_FORMAT=PRETTY|JSON

Rust

See rust/README.md

Release Agents

  • Tag the commit with the current date in the format agents-yyyy-mm-dd; e.g. agents-2023-03-28.
  • Create a Github Release with a changelog against the previous version titled Agents MMMM DD, YYYY, e.g. Agents March 28, 2023.
  • Include the agent docker image tag in the description of the release
  • Create a summary of change highlights
  • Create a "breaking changes" section with any changes required
  • Deploy agents with the new image tag (if it makes sense to)

Releasing packages to NPM

We use changesets to release to NPM. You can use the release script in package.json to publish.

For an alpha or beta version, follow the directions here.