CipherLabs
/
hyperlane-monorepo
mirror of https://github.com/hyperlane-xyz/hyperlane-monorepo
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
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.
2123 Commits
482 Branches
322 Tags
223 MiB
 
 
 
 
 
 
Tag: Branch: Tree: a91677a3da
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'a91677a3da'
${ noResults }
hyperlane-monorepo/typescript/sdk
History
Lee a91677a3da
Return entire deployedContracts object (#3617) 		7 months ago
..
logos Implement WarpCore and Token classes (#3272) 9 months ago
scripts Replace Fallback/Retry providers with SmartProvider (#3032) 12 months ago
src Return entire deployedContracts object (#3617) 7 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

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.

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