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

blockchain hyperlane interchain monorepo

History

Paul Balaji c47ebdbf59 feat: verify contracts deployed from infra (#3243 )		9 months ago
..
logos	Add plume SVG logos (#3261 )	9 months ago
scripts	Replace Fallback/Retry providers with SmartProvider (#3032 )	12 months ago
src	feat: verify contracts deployed from infra (#3243 )	9 months ago
.eslintrc	Graduate to yarn 4 🧶 (#2899 )	1 year ago
.gitignore	Update sdk gitignore	2 years ago
.mocharc.json	SDK - interchain gas calculator (#318 )	3 years ago
.npmignore	Remove abacus- prefix from directories (#267 )	3 years ago
CHANGELOG.md	Version Packages (#3232 )	10 months ago
README.md	Minimal multi-protocol SDK support (#2529 )	1 year ago
hardhat.config.ts	fix:enable `DefaultFallbackRoutingIsm` through non-factory deployment (#3009 )	12 months ago
package.json	Version Packages (#3232 )	10 months ago
tsconfig.json	feat:remove create-key circular dependency (#3159 )	10 months ago

README.md

Hyperlane SDK

The Hyperlane SDK helps developers create and manage interchain applications.

For details on how to use the various abstractions and utilities, 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.

Deployment, testing, and development classes

Classes for deploying, testing, and building applications using Hyperlane are included in the SDK. See the docs for details.

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