Create CLI Submitter

.changeset/quiet-cheetahs-own.md

@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/sdk': patch
+---
+
+Exports submitter and transformer props types.

.changeset/sixty-avocados-double.md

@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/cli': minor
+---
+
+Add CLI-side submitter to use SDK submitter from CRUD and other command modules.

typescript/cli/src/submit/submit.ts

@@ -0,0 +1,105 @@
+import {
+  EV5GnosisSafeTxSubmitter,
+  EV5ImpersonatedAccountTxSubmitter,
+  EV5InterchainAccountTxTransformer,
+  EV5JsonRpcTxSubmitter,
+  MultiProvider,
+  TxSubmitterBuilder,
+  TxSubmitterInterface,
+  TxSubmitterType,
+  TxTransformerInterface,
+  TxTransformerType,
+} from '@hyperlane-xyz/sdk';
+import { ProtocolType } from '@hyperlane-xyz/utils';
+
+import { forkNetworkToMultiProvider, verifyAnvil } from '../deploy/dry-run.js';
+
+import {
+  SubmitterBuilderSettings,
+  SubmitterMetadata,
+  TransformerMetadata,
+} from './submitTypes.js';
+
+export async function getSubmitterBuilder<TProtocol extends ProtocolType>({
+  submitterMetadata,
+  transformersMetadata,
+  multiProvider,
+}: SubmitterBuilderSettings): Promise<TxSubmitterBuilder<TProtocol>> {
+  const submitter = await getSubmitter<TProtocol>(
+    multiProvider,
+    submitterMetadata,
+  );
+  const transformers = await getTransformers<TProtocol>(
+    multiProvider,
+    transformersMetadata,
+  );
+
+  return new TxSubmitterBuilder<TProtocol>(submitter, transformers);
+}
+
+async function getSubmitter<TProtocol extends ProtocolType>(
+  multiProvider: MultiProvider,
+  { type, settings }: SubmitterMetadata,
+): Promise<TxSubmitterInterface<TProtocol>> {
+  switch (type) {
+    case TxSubmitterType.JSON_RPC:
+      return new EV5JsonRpcTxSubmitter(multiProvider);
+    case TxSubmitterType.IMPERSONATED_ACCOUNT:
+      if (!settings)
+        throw new Error(
+          'Must provide EV5ImpersonatedAccountTxSubmitterProps for impersonated account submitter.',
+        );
+
+      await verifyAnvil();
+      await forkNetworkToMultiProvider(
+        multiProvider,
+        settings.eV5ImpersonatedAccountProps.chain,
+      );
+
+      return new EV5ImpersonatedAccountTxSubmitter(
+        multiProvider,
+        settings.eV5ImpersonatedAccountProps,
+      );
+    case TxSubmitterType.GNOSIS_SAFE:
+      if (!settings)
+        throw new Error(
+          'Must provide EV5GnosisSafeTxSubmitterProps for Gnosis safe submitter.',
+        );
+      return new EV5GnosisSafeTxSubmitter(
+        multiProvider,
+        settings.eV5GnosisSafeProps,
+      );
+    default:
+      throw new Error(`Invalid TxSubmitterType: ${type}`);
+  }
+}
+
+async function getTransformers<TProtocol extends ProtocolType>(
+  multiProvider: MultiProvider,
+  metadata: TransformerMetadata[],
+): Promise<TxTransformerInterface<TProtocol>[]> {
+  return Promise.all(
+    metadata.map(({ type, settings }) =>
+      getTransformer<TProtocol>(multiProvider, { type, settings }),
+    ),
+  );
+}
+
+async function getTransformer<TProtocol extends ProtocolType>(
+  multiProvider: MultiProvider,
+  { type, settings }: TransformerMetadata,
+): Promise<TxTransformerInterface<TProtocol>> {
+  switch (type) {
+    case TxTransformerType.ICA:
+      if (!settings)
+        throw new Error(
+          'Must provide EV5InterchainAccountTxTransformerProps for ICA transformer.',
+        );
+      return new EV5InterchainAccountTxTransformer(
+        multiProvider,
+        settings.eV5InterchainAccountProps,
+      );
+    default:
+      throw new Error(`Invalid TxTransformerType: ${type}`);
+  }
+}

typescript/cli/src/submit/submitTypes.ts

@@ -0,0 +1,30 @@
+import type {
+  EV5GnosisSafeTxSubmitterProps,
+  EV5ImpersonatedAccountTxSubmitterProps,
+  EV5InterchainAccountTxTransformerProps,
+  MultiProvider,
+  TxSubmitterType,
+  TxTransformerType,
+} from '@hyperlane-xyz/sdk';
+
+export interface SubmitterBuilderSettings {
+  submitterMetadata: SubmitterMetadata;
+  transformersMetadata: TransformerMetadata[];
+  multiProvider: MultiProvider;
+}
+export interface SubmitterMetadata {
+  type: TxSubmitterType;
+  settings?: SubmitterSettings;
+}
+export interface TransformerMetadata {
+  type: TxTransformerType;
+  settings?: TransformerSettings;
+}
+
+interface SubmitterSettings {
+  eV5GnosisSafeProps: EV5GnosisSafeTxSubmitterProps;
+  eV5ImpersonatedAccountProps: EV5ImpersonatedAccountTxSubmitterProps;
+}
+interface TransformerSettings {
+  eV5InterchainAccountProps: EV5InterchainAccountTxTransformerProps;
+}

typescript/sdk/src/index.ts

@@ -304,14 +304,21 @@ export {
   protocolToDefaultProviderBuilder,
 } from './providers/providerBuilders.js';
 export { TxSubmitterInterface } from './providers/transactions/submitter/TxSubmitterInterface.js';
-export { TxSubmitterType } from './providers/transactions/submitter/TxSubmitterTypes.js';
+export {
+  TxSubmitterType,
+  EV5GnosisSafeTxSubmitterProps,
+  EV5ImpersonatedAccountTxSubmitterProps,
+} from './providers/transactions/submitter/TxSubmitterTypes.js';
 export { TxSubmitterBuilder } from './providers/transactions/submitter/builder/TxSubmitterBuilder.js';
 export { EV5GnosisSafeTxSubmitter } from './providers/transactions/submitter/ethersV5/EV5GnosisSafeTxSubmitter.js';
 export { EV5ImpersonatedAccountTxSubmitter } from './providers/transactions/submitter/ethersV5/EV5ImpersonatedAccountTxSubmitter.js';
 export { EV5JsonRpcTxSubmitter } from './providers/transactions/submitter/ethersV5/EV5JsonRpcTxSubmitter.js';
 export { EV5TxSubmitterInterface } from './providers/transactions/submitter/ethersV5/EV5TxSubmitterInterface.js';
 export { TxTransformerInterface } from './providers/transactions/transformer/TxTransformerInterface.js';
-export { TxTransformerType } from './providers/transactions/transformer/TxTransformerTypes.js';
+export {
+  TxTransformerType,
+  EV5InterchainAccountTxTransformerProps,
+} from './providers/transactions/transformer/TxTransformerTypes.js';
 export { EV5InterchainAccountTxTransformer } from './providers/transactions/transformer/ethersV5/EV5InterchainAccountTxTransformer.js';
 export { EV5TxTransformerInterface } from './providers/transactions/transformer/ethersV5/EV5TxTransformerInterface.js';
 export { GasRouterDeployer } from './router/GasRouterDeployer.js';

typescript/sdk/src/providers/transactions/submitter/TxSubmitterInterface.ts

@@ -1,6 +1,5 @@
 import { ProtocolType } from '@hyperlane-xyz/utils';
 
-import { ChainName } from '../../../types.js';
 import {
   ProtocolTypedProvider,
   ProtocolTypedReceipt,
@@ -14,10 +13,6 @@ export interface TxSubmitterInterface<TProtocol extends ProtocolType> {
    * Defines the type of tx submitter.
    */
   txSubmitterType: TxSubmitterType;
-  /**
-   * The chain to submit transactions on.
-   */
-  chain: ChainName;
   /**
    * The provider to use for transaction submission.
    */

typescript/sdk/src/providers/transactions/submitter/TxSubmitterTypes.ts

@@ -1,5 +1,19 @@
+import { Address } from '@hyperlane-xyz/utils';
+
+import { ChainName } from '../../../types.js';
+
 export enum TxSubmitterType {
   JSON_RPC = 'JSON RPC',
   IMPERSONATED_ACCOUNT = 'Impersonated Account',
   GNOSIS_SAFE = 'Gnosis Safe',
 }
+
+export interface EV5GnosisSafeTxSubmitterProps {
+  chain: ChainName;
+  safeAddress: Address;
+}
+
+export interface EV5ImpersonatedAccountTxSubmitterProps {
+  chain: ChainName;
+  address: Address;
+}

typescript/sdk/src/providers/transactions/submitter/builder/TxSubmitterBuilder.ts

@@ -3,7 +3,6 @@ import { Logger } from 'pino';
 import { rootLogger } from '@hyperlane-xyz/utils';
 import { ProtocolType } from '@hyperlane-xyz/utils';
 
-import { ChainName } from '../../../../types.js';
 import {
   ProtocolTypedReceipt,
   ProtocolTypedTransaction,
@@ -35,7 +34,6 @@ export class TxSubmitterBuilder<TProtocol extends ProtocolType>
   implements TxSubmitterInterface<TProtocol>
 {
   public readonly txSubmitterType: TxSubmitterType;
-  public readonly chain: ChainName;
 
   protected readonly logger: Logger = rootLogger.child({
     module: 'submitter-builder',
@@ -46,7 +44,6 @@ export class TxSubmitterBuilder<TProtocol extends ProtocolType>
     private currentTransformers: TxTransformerInterface<TProtocol>[] = [],
   ) {
     this.txSubmitterType = this.currentSubmitter.txSubmitterType;
-    this.chain = this.currentSubmitter.chain;
   }
 
   /**

typescript/sdk/src/providers/transactions/submitter/ethersV5/EV5GnosisSafeTxSubmitter.ts

@@ -3,18 +3,16 @@ import { Logger } from 'pino';
 
 import { Address, assert, rootLogger } from '@hyperlane-xyz/utils';
 
-import { ChainName } from '../../../../types.js';
 // @ts-ignore
 import { getSafe, getSafeService } from '../../../../utils/gnosisSafe.js';
 import { MultiProvider } from '../../../MultiProvider.js';
-import { TxSubmitterType } from '../TxSubmitterTypes.js';
+import {
+  EV5GnosisSafeTxSubmitterProps,
+  TxSubmitterType,
+} from '../TxSubmitterTypes.js';
 
 import { EV5TxSubmitterInterface } from './EV5TxSubmitterInterface.js';
 
-interface EV5GnosisSafeTxSubmitterProps {
-  safeAddress: Address;
-}
-
 export class EV5GnosisSafeTxSubmitter implements EV5TxSubmitterInterface {
   public readonly txSubmitterType: TxSubmitterType =
     TxSubmitterType.GNOSIS_SAFE;
@@ -25,25 +23,31 @@ export class EV5GnosisSafeTxSubmitter implements EV5TxSubmitterInterface {
 
   constructor(
     public readonly multiProvider: MultiProvider,
-    public readonly chain: ChainName,
     public readonly props: EV5GnosisSafeTxSubmitterProps,
   ) {}
 
   public async submit(...txs: PopulatedTransaction[]): Promise<void> {
     const safe = await getSafe(
-      this.chain,
+      this.props.chain,
       this.multiProvider,
       this.props.safeAddress,
     );
-    const safeService = await getSafeService(this.chain, this.multiProvider);
+    const safeService = await getSafeService(
+      this.props.chain,
+      this.multiProvider,
+    );
     const nextNonce: number = await safeService.getNextNonce(
       this.props.safeAddress,
     );
     const safeTransactionBatch: any[] = txs.map(
-      ({ to, data, value }: PopulatedTransaction) => {
+      ({ to, data, value, chainId }: PopulatedTransaction) => {
+        assert(to, 'Invalid PopulatedTransaction: Missing to field');
+        assert(data, 'Invalid PopulatedTransaction: Missing data field');
+        assert(chainId, 'Invalid PopulatedTransaction: Missing chainId field');
+        const txChain = this.multiProvider.getChainName(chainId);
         assert(
-          to && data,
-          'Invalid PopulatedTransaction: Missing required field to or data.',
+          txChain === this.props.chain,
+          `Invalid PopulatedTransaction: Cannot submit ${txChain} tx to ${this.props.chain} submitter.`,
         );
         return { to, data, value: value?.toString() ?? '0' };
       },
@@ -55,13 +59,13 @@ export class EV5GnosisSafeTxSubmitter implements EV5TxSubmitterInterface {
     const safeTransactionData: any = safeTransaction.data;
     const safeTxHash: string = await safe.getTransactionHash(safeTransaction);
     const senderAddress: Address = await this.multiProvider.getSignerAddress(
-      this.chain,
+      this.props.chain,
     );
     const safeSignature: any = await safe.signTransactionHash(safeTxHash);
     const senderSignature: string = safeSignature.data;
 
     this.logger.debug(
-      `Submitting transaction proposal to ${this.props.safeAddress} on ${this.chain}: ${safeTxHash}`,
+      `Submitting transaction proposal to ${this.props.safeAddress} on ${this.props.chain}: ${safeTxHash}`,
     );
 
     return safeService.proposeTransaction({

typescript/sdk/src/providers/transactions/submitter/ethersV5/EV5ImpersonatedAccountTxSubmitter.ts

@@ -3,19 +3,16 @@ import { PopulatedTransaction } from 'ethers';
 import { Logger } from 'pino';
 
 import { rootLogger } from '@hyperlane-xyz/utils';
-import { Address } from '@hyperlane-xyz/utils';
 
-import { ChainName } from '../../../../types.js';
 import { impersonateAccount } from '../../../../utils/fork.js';
 import { MultiProvider } from '../../../MultiProvider.js';
-import { TxSubmitterType } from '../TxSubmitterTypes.js';
+import {
+  EV5ImpersonatedAccountTxSubmitterProps,
+  TxSubmitterType,
+} from '../TxSubmitterTypes.js';
 
 import { EV5JsonRpcTxSubmitter } from './EV5JsonRpcTxSubmitter.js';
 
-interface EV5ImpersonatedAccountTxSubmitterProps {
-  address: Address;
-}
-
 export class EV5ImpersonatedAccountTxSubmitter extends EV5JsonRpcTxSubmitter {
   public readonly txSubmitterType: TxSubmitterType =
     TxSubmitterType.IMPERSONATED_ACCOUNT;
@@ -26,18 +23,17 @@ export class EV5ImpersonatedAccountTxSubmitter extends EV5JsonRpcTxSubmitter {
 
   constructor(
     public readonly multiProvider: MultiProvider,
-    public readonly chain: ChainName,
     public readonly props: EV5ImpersonatedAccountTxSubmitterProps,
   ) {
-    super(multiProvider, chain);
+    super(multiProvider);
   }
 
   public async submit(
     ...txs: PopulatedTransaction[]
   ): Promise<TransactionReceipt[]> {
     const impersonatedAccount = await impersonateAccount(this.props.address);
-    this.multiProvider.setSigner(this.chain, impersonatedAccount);
-    super.multiProvider.setSigner(this.chain, impersonatedAccount);
+    this.multiProvider.setSharedSigner(impersonatedAccount);
+    super.multiProvider.setSharedSigner(impersonatedAccount);
     return await super.submit(...txs);
   }
 }

typescript/sdk/src/providers/transactions/submitter/ethersV5/EV5JsonRpcTxSubmitter.ts

@@ -2,9 +2,8 @@ import { TransactionReceipt } from '@ethersproject/providers';
 import { ContractReceipt, PopulatedTransaction } from 'ethers';
 import { Logger } from 'pino';
 
-import { rootLogger } from '@hyperlane-xyz/utils';
+import { assert, rootLogger } from '@hyperlane-xyz/utils';
 
-import { ChainName } from '../../../../types.js';
 import { MultiProvider } from '../../../MultiProvider.js';
 import { TxSubmitterType } from '../TxSubmitterTypes.js';
 
@@ -17,22 +16,21 @@ export class EV5JsonRpcTxSubmitter implements EV5TxSubmitterInterface {
     module: 'json-rpc-submitter',
   });
 
-  constructor(
-    public readonly multiProvider: MultiProvider,
-    public readonly chain: ChainName,
-  ) {}
+  constructor(public readonly multiProvider: MultiProvider) {}
 
   public async submit(
     ...txs: PopulatedTransaction[]
   ): Promise<TransactionReceipt[]> {
     const receipts: TransactionReceipt[] = [];
     for (const tx of txs) {
+      assert(tx.chainId, 'Invalid PopulatedTransaction: Missing chainId field');
+      const txChain = this.multiProvider.getChainName(tx.chainId);
       const receipt: ContractReceipt = await this.multiProvider.sendTransaction(
-        this.chain,
+        txChain,
         tx,
       );
       this.logger.debug(
-        `Submitted PopulatedTransaction on ${this.chain}: ${receipt.transactionHash}`,
+        `Submitted PopulatedTransaction on ${txChain}: ${receipt.transactionHash}`,
       );
       receipts.push(receipt);
     }