Package Exports

@hyperlane-xyz/sdk
@hyperlane-xyz/sdk/dist/consts/chainMetadata
@hyperlane-xyz/sdk/dist/consts/chainMetadata.js
@hyperlane-xyz/sdk/dist/index.js
@hyperlane-xyz/sdk/logos/black/arbitrum.svg
@hyperlane-xyz/sdk/logos/black/avalanche.svg
@hyperlane-xyz/sdk/logos/black/bsc.svg
@hyperlane-xyz/sdk/logos/black/celo.svg
@hyperlane-xyz/sdk/logos/black/ethereum.svg
@hyperlane-xyz/sdk/logos/black/moonbeam.svg
@hyperlane-xyz/sdk/logos/black/optimism.svg
@hyperlane-xyz/sdk/logos/black/polygon.svg
@hyperlane-xyz/sdk/logos/color/arbitrum.svg
@hyperlane-xyz/sdk/logos/color/avalanche.svg
@hyperlane-xyz/sdk/logos/color/bsc.svg
@hyperlane-xyz/sdk/logos/color/celo.svg
@hyperlane-xyz/sdk/logos/color/ethereum.svg
@hyperlane-xyz/sdk/logos/color/moonbeam.svg
@hyperlane-xyz/sdk/logos/color/optimism.svg
@hyperlane-xyz/sdk/logos/color/polygon.svg

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@hyperlane-xyz/sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

Constants

The names and relevant metadata for all Hyperlane-supported chains are included in this SDK, including public RPC and Explorer urls. It also includes the addresses for all Hyperlane core contracts and middleware.

Classes for development, deployment, and testing

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.

Chain Logos

The SDK contains SVG files for all Hyperlane-supported chains. They can be imported from the /logos folder.

import ArbitrumBlack from '@hyperlane-xyz/sdk/logos/black/arbitrum.svg';
import ArbitrumColor from '@hyperlane-xyz/sdk/logos/color/arbitrum.svg';

License

Apache 2.0

@hyperlane-xyz/sdk