feat: Modular Tx Submission – Create Transformer + Submitter + Builder Abstraction

[nbayindirli]

Description

• Adds modular transaction submission support for SDK clients, e.g. CLI.

To-do:

• Failing CI build due to linting Gnosis Safe package import
• Export to sdk/src/index.ts

Note:

• Built to eventually expand to Sealevel/CW support

Transformers

• Input: PopulatedTx[]
• Output: HTX[] (where HTX extends HyperlaneTx)
• Purpose: Given a set of populated transactions, transform those transactions into a set a HyperlaneTxs (for the corresponding submitter), e.g.

...
const somePopulatedTxs = ...
const transformer = new InterchainAccountTxTransformer(mp,o,d,p);
const populatedTxs = transformer.transformTxs(somePopulatedTxs);

Submitters

• Input: HTX[] (where HTX extends HyperlaneTx)
• Output: TxReceipt[] | ResponseData[]
• Purpose: Given a set of Hyperlane transactions, execute those transactions for the specified submitter (submitter of type HTX should enforce the transactions being passed are of type HTX), e.g.

...
const submitter = new GnosisSafeTxSubmitter(mp,c,p);
const txReceipts =  submitter.submitTxs(populatedTxs);
---
Client-side example: for each gnosisTxReceipt display transactionHash

Builder (Utilizes both Submitters & Transformer)

• Input: (TxTransformer<HTX> | TxTransformerType & Chain) & (TxSubmitter<HTX,HTR> | TxSubmitterType & Chain) & HTX[] (where HTX extends HyperlaneTx)
• Output: TxReceipt[] | *response data*
• Purpose: Given a submitter, an optional transformer, and a set of PopulatedTransactions, transform and submit all transactions, e.g.

...
const eV5builder = new TxSubmitterBuilder<EV5Transaction, EV5TransactionReceipt>();
let txReceipts = eV5builder.for(
  new GnosisSafeTxSubmitter(chainA)
).transform(
  InterchainAccountTxTransformer(chainB)
).submit(
  txs
);
txReceipts = eV5builder.for(
  new ImpersonatedAccountTxSubmitter(chainA)
).submit(txs);
txReceipts = eV5builder.for(
  new JsonRpcTxSubmitter(chainC)
).submit(txs);
---
Client-side example: for each txReceipt display transactionHash | response data

Drive-by changes

• None

Related issues

• Fixes [Epic][TxS] Modularize SDK TX Submission (w/ Transformers + Builder) #3547

Backward compatibility

• Yes

Testing

• Testing through CLI unit testing

[changeset-bot]

🦋 Changeset detected

Latest commit: a9ecb22

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 7 packages

Name	Type
@hyperlane-xyz/sdk	Minor
@hyperlane-xyz/cli	Minor
@hyperlane-xyz/helloworld	Minor
@hyperlane-xyz/infra	Minor
@hyperlane-xyz/core	Minor
@hyperlane-xyz/ccip-server	Minor
@hyperlane-xyz/utils	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.28%. Comparing base (cf727db) to head (a9ecb22).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3627   +/-   ##
=======================================
  Coverage   74.28%   74.28%           
=======================================
  Files         108      108           
  Lines        1217     1217           
  Branches      132      132           
=======================================
  Hits          904      904           
  Misses        297      297           
  Partials       16       16           

Components	Coverage Δ
core	84.61% <ø> (ø)
hooks	69.94% <ø> (ø)
isms	73.17% <ø> (ø)
token	63.77% <ø> (ø)
middlewares	77.48% <ø> (ø)

[yorhodes]

I'm a bit confused by the Tx type per submitter
ideally any TxSubmitter can take output from any Module.update(config)

[yorhodes]

submitter and transformer implementations look good
I still think we need to streamline the builder interface a bit to be extensible to future implementations

[nbayindirli]

submitter and transformer implementations look good I still think we need to streamline the builder interface a bit to be extensible to future implementations

Agreed– with the newest update you'll find:

• Comment resolution
• Functionality to allow multiple transforms to occur for a single submit
• Utilization of TypedTransaction & TypedTransactionReceipt, enabling the builder to be used cross-protocol (EV5, CW, Sealevel, etc.)
• for is now used instead of add when specifying a submitter for the builder

[paulbalaji]

suggested use of ProtocolTypedTransaction which could be useful across the submitter/builder classes

note: a drawback I can see of this is that if we decide to implement new submitter classes for different providers (e.g. viem/ethersv6), it would require tweaking some of the type maps - however I think this would be required to integrate these providers at the crud module level anyway

[yorhodes]

mostly looks good, please replace the stack-typescript implemenetation

[nbayindirli]

Note that this no longer builds due to registry work– merging this PR is therefore now blocked by migrating registry.ts to the SDK: #3689