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

blockchain hyperlane interchain monorepo

History

J M Rossy b63714ede8 Convert packages from CJS to ESM (#3531 ) ### Description - Reconfigure tsconfig and package.json for the utils, core, sdk, and helloworld packages - Update imports to use ESM syntax - Add patch for typechain to address [issue 898](https://github.com/dethcrypto/TypeChain/pull/898) ### Drive-by changes Improve package Readme content ### Related issues Fixes https://github.com/hyperlane-xyz/hyperlane-monorepo/issues/1354 ### Backward compatibility No: package consumers using CJS will need to modify their imports or update to ESM. See [this popular gist](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c#pure-esm-package) for details. ### Testing - [x] CI test coverage which invokes a lot of code via the CLI e2e - [x] Manually test in Warp UI by copying packages - [x] Publish beta packages and test in a few popular bundlers		8 months ago
..
logos	Implement WarpCore and Token classes (#3272 )	9 months ago
scripts	Replace Fallback/Retry providers with SmartProvider (#3032 )	11 months ago
src	Convert packages from CJS to ESM (#3531 )	8 months ago
.eslintrc	Graduate to yarn 4 🧶 (#2899 )	1 year ago
.gitignore	Update sdk gitignore	2 years ago
.mocharc.json	Convert packages from CJS to ESM (#3531 )	8 months ago
.npmignore	Remove abacus- prefix from directories (#267 )	3 years ago
CHANGELOG.md	Version Packages (#3495 )	8 months ago
README.md	Convert packages from CJS to ESM (#3531 )	8 months ago
hardhat.config.cts	Convert packages from CJS to ESM (#3531 )	8 months ago
package.json	Convert packages from CJS to ESM (#3531 )	8 months ago
tsconfig.json	Convert packages from CJS to ESM (#3531 )	8 months ago

README.md

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

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