@hyperlane-xyz/sdk

Hyperlane SDK

The Hyperlane SDK helps developers create and manage interchain applications.

For more details on Hyperlane concepts, see the documentation

Install

# Install with NPM
npm install @hyperlane-xyz/sdk

# Or with Yarn
yarn add @hyperlane-xyz/sdk

Note, this package uses ESM Modules

Contents

The SDK includes various classes for building, deploying, and testing multi-chain applications. Different abstractions serve different use cases. A few common utilities include:

• MultiProvider / MultiProtocolProvider: A utility for managing chain metadata, and RPC providers.
• HyperlaneApp / MultiProtocolApp: A base to extend for a multi-chain app.
• HyperlaneCore / MultiProtocolCore: A class for common interactions with Hyperlane core deployments.
• HyperlaneDeployer: The base class for executing multi-chain contract deployments.
• Token & WarpCore: Utilities for interacting with Warp Route deployments.

License

Apache 2.0