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.
 
 
 
 
 
 
hyperlane-monorepo/typescript/sdk
github-actions[bot] 203df396dd
Version Packages (#2972)
1 year ago
..
logos Add chain logos (#2793) 1 year ago
src Remove ISM requirement for warp route deploys (#2936) 1 year 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 (#2972) 1 year ago
README.md Minimal multi-protocol SDK support (#2529) 1 year ago
hardhat.config.ts Merge ICA package (#1170) 2 years ago
package.json Version Packages (#2972) 1 year ago
tsconfig.json V3 agents rebase (#2746) 1 year 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

Contents

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