SDK v1.2.0

The 1.2.0 SDK brings significant improvements to the typings for core classes and an updated MultiProvider rebuilt from the ground up for flexibility and convenience. The updated contracts add new capabilities around gas payments (see GasRouter). 1.2.0 also adds SDK support for Gnosis chain.

Breaking Changes

• Removed Chain generic type argument from SDK classes (e.g. HyperlaneCore, HyperlaneDeployer, etc.)
• Redesigned MultiProvider interface
• Removed HyperlaneMessage and its utility functions
• Removed ChainConnection and chainConnectionConfigs

See the template app update for an example or migrating from 1.1.0 to 1.2.0: https://github.com/hyperlane-xyz/hyperlane-app-template/pull/44/files

What's Changed

• Fix HyperlaneRouterChecker's checkHyperlaneConnectionClient by @tkporter in #1660
• Add domain separator to validator announcement by @asaj in #1674
• Deploy to Gnosis by @nambrot in #1675
• Deploy and verify new TestQuerySender by @tkporter in #1694
• Leverage storage refunds in pausable guard by @yorhodes in #1696
• Add mainnet moonbeam IQS & ICA addresses to SDK by @tkporter in #1745
• Add whitelist to gas enforcement, whitelist interchain queries by @tkporter in #1732
• Gnosis logos and metadata touchups by @jmrossy in #1775
• Implement GasRouter by @yorhodes in #1621
• Use ValidatorAnnounce in relayer by @asaj in #1569
• Enroll ZKV/Staked to default ism by @nambrot in #1796
• Check bytecodes against constants by @nambrot in #1595
• Allow value in ICAs by @yorhodes in #1640
• adding MAX_MESSAGE_BODY_BYTES check to MockMailbox by @Defcon023 in #1799
• Add ISM to RouterDeployer.initConnectionClient by @yorhodes in #1829
• PI SDK support, Multiprovider refactor, Type loosening by @jmrossy in #1804

New Contributors

• @Defcon023 made their first contribution in #1799

Full Changelog: v1.1.0...v1.2.0

SDK v1.1.0

Includes new IGP addresses (#1572) and updates to the InterchainGasCalculator (#1645) as interchain gas payments begin to be enforced. See Migrating to Enforced Interchain Gas Payments for more context.

SDK v1.0.0

This is the first production release of the SDK and related packages for Hyperlane v2!

V2 brings many major improvements to the protocol. Some highlights include Sovereign Consensus, unified Mailbox contracts, and domain ID and chain ID equivalence. Simplicity and modularity are the hallmarks of this launch, and we hope you enjoy an improved developer experience.

V1 to V2 Migration Guide

Full Changelog: v0.5.5...v1.0.0

SDK v1.0.0-beta6

SDK prerelease updating environment names

SDK v1.0.0-beta5

Beta release of SDK for Hyperlane protocol v2

SDK v0.5.5

This minor release reduces the Mumbai finality block number requirement and includes progress on liquidity layer support.

What's Changed

• Add TokenBridge deployment by @nambrot in #1215
• Adding message leaf index to InterchainAccountRouter by @rabib in #1236
• TestQuerySender by @nambrot in #1222
• Fix type of leafIndex returned by getDispatchedMessages by @jmrossy in #1239
• Add cache to token price getter by @asaj in #1226
• Quickstart fixes by @nambrot in #1244
• Generalize verification by @yorhodes in #1230
• Check ACM address in HyperlaneRouterChecker by @tkporter in #1273
• Rename to LiquidityLayer by @nambrot in #1277
• Do not make empty queries to coingecko by @asaj in #1285
• Minor changes to verifications by @nambrot in #1291
• Support ICA/IQS functions without Call struct by @nambrot in #1307
• Deploy single-call middleware contracts by @nambrot in #1309
• Fix utils build by @tkporter in #1328
• Add PortalAdapter to LiquidityLayer by @nambrot in #1290
• Reduce mumbai finality blocks by @mattiecnvr in #1369
• Mumbai reorg period by @mattiecnvr in #1372

New Contributors

• @rabib made their first contribution in #1236

Full Changelog: v0.5.3...v0.5.5

SDK v0.5.3

What's Changed

• Fix HyperlaneCore and add tests by @asaj in #1221
• TokenBridgeRouter and CircleBridgeAdapter by @nambrot in #1212
• Increment versions to 0.5.3 by @jmrossy in #1223

Full Changelog: v0.5.2...v0.5.3

SDK v0.5.2

What's Changed

• Merge core and app packages by @nambrot in #1169
• Pass through signer in helloworld deploy script by @nambrot in #1173
• Connect signer in helloworld deploy.ts by @nambrot in #1174
• Merge ICA package by @nambrot in #1170
• Pass through the whole config by @nambrot in #1175
• Add foundry to core by @nambrot in #1171
• Add Goerli rollups by @nambrot in #1176
• Create script to merge ICA/ICQ/Create2 addresses into sdk consts by @jmrossy in #1210
• Adjust Goerli finality from 7 to 2 by @nambrot in #1213
• Remove some straggler references to Network instead of Chain by @jmrossy in #1211
• 0.5.2 release by @jmrossy in #1214

Breaking Changes

• The SDK's resolveNetworks has been renamed to resolveChains

Full Changelog: v0.5.1...v0.5.2

SDK v0.5.1

A minor release, mostly to publish artifacts from recent addition of Moonbeam support.

What's Changed

• Add Moonbeam artifacts by @nambrot in #1153
• Add InterchainQueryRouter implementation by @yorhodes in #1137
• 0.5.1 by @jmrossy in #1167

Full Changelog: v0.5.0...v0.5.1

SDK v0.5.0

See v0.5.0-beta0 release notes for major changes.

What's Changed (since beta0)

• Use estimateGas in msg debugger by @nambrot in #1109
• Add script to list validator indices by @nambrot in #1107
• Use more descriptive error message with no matching router by @nambrot in #1096
• Remove domain hash enforcement in ACM by @nambrot in #1080
• Deploy interchain accounts middleware by @yorhodes in #1059
• Move agent env vars from ABC_ prefix to HYP_ prefix by @tkporter in #1116
• Have a standard TestRecipient by @nambrot in #1121
• Remove unused TypedMemView npm dep by @yorhodes in #1124
• Deploy consistent Create2Factory, TestRecipient and InterchainAccountRouters by @nambrot in #1123
• Remove deprecated networks by @nambrot in #1136
• Export developer-relevant addresses as hyperlaneCoreAddresses by @nambrot in #1142
• Changes for chain removal by @nambrot in #1138
• Domain support in Mailboxes by @nambrot in #1143
• Package.json fixes for security and consistency by @jmrossy in #1147
• Bump packages to 0.5.0 by @jmrossy in #1151

Full Changelog: v0.5.0-beta0...v0.5.0