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.
2229 Commits
483 Branches
322 Tags
230 MiB
 
 
 
 
 
 
Tag: Branch: Tree: 12840964b9
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '12840964b9'
${ noResults }
hyperlane-monorepo/typescript/sdk
History
github-actions[bot] cb9c2aa571
Version Packages (#3910) 		6 months ago
..
logos Implement WarpCore and Token classes (#3272) 9 months ago
scripts Replace Fallback/Retry providers with SmartProvider (#3032) 12 months ago
src ci: temporarily skip a flaky test (#3940) 6 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 (#3910) 6 months ago
README.md chore: update outdated info in Readme files (#3830) 6 months ago
hardhat.config.cts Convert packages from CJS to ESM (#3531) 8 months ago
package.json Version Packages (#3910) 6 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

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.

License

Apache 2.0