SDK v1.3.4

Version 1.3.4 brings some improvements to Ethers.js providers usage in MultiProvider. See #2129 for details.

What's Changed

• Add checkConfig to HyperlaneRouterDeployer by @asaj in #2156
• Various SDK tweaks and fixes by @jmrossy in #2129
• Minor fixes to get LL deploys running smoothly by @nambrot in #2125
• Verify proxy even if implementation is verified by @nambrot in #2164
• Deploy gnosis IQS by @nambrot in #2044

Breaking Changes:

• Rename RpcPagination to RpcPaginationOptions
• Rename providerBuilder to defaultProviderBuilder
• Remove RetryProvider
• Remove unused events functions, including getEvents, queryAnnotatedEvents, Annotated, and TSContract

Full Changelog: v1.3.3...v1.3.4

Agents April 14, 2023

• Significant improvements to the agent config loading process to provide easier to read errors such as:

Error: ParsingError

config_path: `arbitrumgoerli.addresses.mailbox`
env_path: `HYP_BASE_ARBITRUMGOERLI_ADDRESSES_MAILBOX`
error: Invalid input length

• A new reference page of agent config values https://docs.hyperlane.xyz/docs/operators/agent-configuration/configuration-reference
• More defaults for agent config to reduce boilerplate configuration
• More intelligent RPC error handling which uses context to determine whether an error is worth retrying or not
• New estimated time to sync when indexing along with better (and less verbose) logs
• A bugfix for validators mailbox state queries

Breaking Changes

No changes should be required to run the the new agents.

Docker Image

gcr.io/abacus-labs-dev/hyperlane-agent:debafb9-20230414-183521

What's Changed

• Fix E2E test by @asaj in #2011
• Added additional error context to missing values by @mattiecnvr in #2007
• Agent release process by @nambrot in #2003
• Build only the agent bins in docker by @mattiecnvr in #2006
• Write agent config for core and IGP deploys by @asaj in #2051
• Use interfaces in agents by @asaj in #2022
• Scaffolding for multiple ISM types in the relayer by @asaj in #2028
• Rust Fuel Updates by @mattiecnvr in #2029
• RPC Error Handling by @mattiecnvr in #2021
• Better Indexing by @mattiecnvr in #2036
• Lag count in Validator agent by @asaj in #2073
• Better Agent Configuration Parsing by @mattiecnvr in #2070
• Remove txsubmission type by @mattiecnvr in #2094
• Fix payment enforcement config parsing bug by @mattiecnvr in #2093
• Add link to reference by @mattiecnvr in #2092
• More handling for eth_feeHistory by @mattiecnvr in #2095

Full Changelog: agents-1.0.1...agents-2023-04-14

SDK v1.3.0

1.3.0 brings mostly under-the-hood changes to the SDK to improve code organization and and enable better experiences for the deployment tools. There were a few small breaking changes to deployment related classes, see section below.

What's Changed

• Deploy new TestRecipients & blacklist old one on testnet by @tkporter in #1957
• Use bytecode deployer for ICA auth by @yorhodes in #1914
• Interoperable Interchain Accounts by @asaj in #1832
• Add non-struct API for IQS and ICA middlewares by @asaj in #1989
• Add Aggregation ISM by @asaj in #1737
• Refactor IGP related code out of HyperlaneCore by @asaj in #1907
• Merge deploy scripting by @yorhodes in #2015
• Better Portal logging by @nambrot in #1970
• Regenerate test fixtures and unskip hardhat tests by @yorhodes in #2035
• Add checkers for middlewares by @asaj in #2030
• Use interfaces in agents by @asaj in #2022
• Remove ProxiedContract and infer types by @asaj in #2042
• Do not check StorageGasOracle's owner by @asaj in #2052
• Release 1.3.0 by @asaj in #2056

Breaking Changes

The methods in HyperlaneDeployer and HyperlaneCoreDeployer have been adjusted. If you're using those directly you will need to make adjustments. See commit for details: https://github.com/hyperlane-xyz/hyperlane-monorepo/pull/1907/files#diff-d7cca311f7d4f14bfccd5868fb0f88cdc31fb90c22dd6e6441c242dc8d62037c

Full Changelog: v1.2.3...v1.3.0

Agents 1.0.1

• Added support for Sepolia
• Significant improvements to logging verbosity and clarity, wrote custom debug formants and decreased external lib logging levels
• Scraper refresh; new database format and easier data querying
• Support for default signer configurations with defaultSigner that will be used for all chains without chains.<chainname>.signer
• Fixed issues with string/number parsing in configs, most numbers should be valid as a string or number now
• Fixed a bug with using less than 30 gwei for transactions on polygon
• Reworked relayer retry queues and backoff scaling
• Housekeeping:
  • Package updates
  • rust version bump
  • removed gelato code
  • cleaned up config defaults

Breaking Changes

Relayer & Validator

• Updates to default configuration (removed null/empty strings and changed logging defaults to pretty and info)

Relayer

• Removed Gelato support

Scraper

• New database schema, non-migrateable, requires re-indexing
• New chainstoscrape configuration

See #1923 for the details

Docker image

gcr.io/abacus-labs-dev/hyperlane-agent:5bf8aed-20230323-140136

What's Changed

• Add Sepolia by @nambrot in #1930
• fix: index the message with zero nonce. by @serejke in #1925
• Support default signer configuration by @mattiecnvr in #1908
• Move to estimateRetryableTicket to get L2 gas for arbitrum chains by @tkporter in #1949
• Remove gelato support by @mattiecnvr in #1946
• Better context to track down errors during init by @mattiecnvr in #1911
• Change ethereum finality in config 14 -> 20 by @tkporter in #1959
• Add first pass at code owners by @yorhodes in #1958
• Require >30 gwei for Polygon by @nambrot in #1952
• Reduce IGP indexer verbosity by @nambrot in #1965
• Indicate why metadata could not be fetched on debug by @mattiecnvr in #1905
• Better rust package management by @mattiecnvr in #1975
• Reduce external logging by @mattiecnvr in #1974
• Change relayer backoff scaling by @mattiecnvr in #1973
• Scraper Refresh by @mattiecnvr in #1932
• Set origin of metric by @nambrot in #1981
• Serial-submitter rework by @mattiecnvr in #1978
• Rust updates by @mattiecnvr in #1979
• Update config defaults by @mattiecnvr in #1972
• Use legacy feature for ethers-contract by @tkporter in #2001

New Contributors

• @serejke made their first contribution in #1925

Full Changelog: agents-1.0.0...agents-1.0.1

SDK 1.2.3

SDK 1.2.3 adds a number of minor fixes and also rotation of a goerli RPC URL

What's Changed

• Change ethereum finality in config 14 -> 20 by @tkporter in #1959
• Fix explorerAddressURL when no signer by @nambrot in #1962

New Contributors

• @serejke made their first contribution in #1925

Full Changelog: v1.2.2...v1.2.3

SDK v1.2.2

SDK 1.2.2 adds support for the Sepholia testnet and minor fixes/improvements to interchain gas payments!

What's Changed

• Update gas oracle exchange rates & IGP bytecode hash by @tkporter in #1919
• Validator metadata name matches key by @nambrot in #1918
• Check IGP ownership, transfer IGP ownership in the initializer by @tkporter in #1895
• Minor SDK refactor by @asaj in #1904
• Support DefaultIsmInterchainGasPaymaster in checker & govern by @tkporter in #1926
• Add Sepolia by @nambrot in #1930

Full Changelog: v1.2.1...v1.2.2

SDK v1.2.1

The 1.2.1 updates bring bug fixes for Permissionless Interoperability and interchain gas payments. Also minor improvements to the MultiProvider interface and a Zod schema for validating ChainMetadata objects.

What's Changed

• Proxy middlewares in SDK deployers by @yorhodes in #1838
• On chain gas oracles in the IGP by @tkporter in #1765
• Improve MultiProvider explorer url handling by @jmrossy in #1898

Full Changelog: v1.2.0...v1.2.1

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