The home for Hyperlane core contracts, sdk packages, and other infrastructure

blockchain hyperlane interchain monorepo

History

Lee dcb67e97da Token deployer yb route (#3435 ) ### Description Adds yield-bearing warp routes to CLI `create` and `deploy` ### Drive-by changes - hyperlane config create warp - Add logic to prompt user `Do you want this warp route to be yield-bearing (i.e. deposits into ERC-4626 vault)?` - If yes - Prompt `Enter the ERC-4626 vault address` - Otherwise, `Enter the collateral token address` - warp-token will be created with `base.address` set to the vault address - Updated prompt flow ``` Select base chain with the original token to warp sepolia? Are you creating a route for the native token of the base chain (e.g. Ether on Ethereum)? no Is this an NFT (i.e. ERC-721)? no Do you want this warp route to be yield-bearing (i.e. deposits into ERC-4626 vault)? // If yes Enter the ERC-4626 vault address // If not a warp route Enter the collateral token address ``` - hyperlane deploy warp - Adds logic to check if `base.type == collateralVault`, make sure that `base.address` exists (and not address(0)). - Deploys `HypERC20CollateralVaultDeposit.sol` using `base.address` - Update example/warp-route-deployment.yaml - Made some quality of life fixes - Add more details to logs - Add `yarn dev` in sdk to use `tsc --watch`. Similar to what's in the cli ### Related issues #3416 ### Backward compatibility Yes ### Testing Use this mock vault: 0xa2ecc6478d0aa9f4423a118c9a2d2b4bcf178a5b Manual/Unit Tests		9 months ago
..
examples	Token deployer yb route (#3435 )	9 months ago
src	Token deployer yb route (#3435 )	9 months ago
.eslintignore	Main-to-v3 update and V3 CLI (#2818 )	1 year ago
.eslintrc	Main-to-v3 update and V3 CLI (#2818 )	1 year ago
.gitignore	Main-to-v3 update and V3 CLI (#2818 )	1 year ago
.mocharc.json	Various CLI fixes and UX improvements (#2952 )	1 year ago
CHANGELOG.md	Version Packages (#3444 )	9 months ago
README.md	Main-to-v3 update and V3 CLI (#2818 )	1 year ago
ci-test.sh	Fix bug with HypCollateral warp route deployments (#3442 )	9 months ago
cli.ts	CLI version check (#3277 )	10 months ago
logger.ts	fix: add warning for advanced ism config usage (#3160 )	10 months ago
package.json	Version Packages (#3444 )	9 months ago
tsconfig.json	Main-to-v3 update and V3 CLI (#2818 )	1 year ago

README.md

Hyperlane CLI

The Hyperlane CLI is a command-line tool written in Typescript that facilitates common operations on Hyperlane, such as deploying the core contracts and/or warp routes to new chains.

Hyperlane 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.

Setup

Node 16 or newer is required.

Option 1: Global install:

# Install with NPM
npm install -g @hyperlane-xyz/cli
# Or uninstall old versions
npm uninstall -g @hyperlane-xyz/cli

Option 2: Temp install:

# Run via NPM's npx command
npx @hyperlane-xyz/cli
# Or via Yarn's dlx command
yarn dlx @hyperlane-xyz/cli

Option 3: Run from source:

git clone https://github.com/hyperlane-xyz/hyperlane-monorepo.git
cd hyperlane-monorepo
yarn install && yarn build
cd typescript/cli
yarn hyperlane

Common commands

View help: hyperlane --help

Create a core deployment config: hyperlane config create

Run hyperlane core deployments: hyperlane deploy core

Run warp route deployments: hyperlane deploy warp

View SDK contract addresses: hyperlane chains addresses

Send test message: hyperlane send message