feat(sdk): add SignerSendTransactionOptions to IMultiProtocolSigner (#8277)

Author: Mo-Hussain

.changeset/sdk-signer-options.md

@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/sdk': minor
+---
+
+An optional `options` parameter was added to `sendAndConfirmTransaction()` on `IMultiProtocolSigner`, reusing `SendTransactionOptions` from `MultiProvider`. The EVM adapter passes options (including `waitConfirmations`) directly through to `MultiProvider.sendTransaction()`. Other protocol adapters accept but ignore the parameter. This is a non-breaking change.

typescript/sdk/src/index.ts

@@ -956,3 +956,4 @@ export {
 } from './signers/turnkeyClient.js';
 export { TurnkeyEvmSigner } from './signers/evm/turnkey.js';
 export { TurnkeySealevelSigner } from './signers/svm/turnkey.js';
+export { IMultiProtocolSigner } from './signers/types.js';

typescript/sdk/src/signers/cosmos/cosmjs.ts

@@ -4,6 +4,7 @@ import { GasPrice, SigningStargateClient } from '@cosmjs/stargate';
 import { Address, ProtocolType, assert, strip0x } from '@hyperlane-xyz/utils';
 
 import { MultiProtocolProvider } from '../../providers/MultiProtocolProvider.js';
+import { SendTransactionOptions } from '../../providers/MultiProvider.js';
 import { CosmJsNativeTransaction } from '../../providers/ProviderType.js';
 import { ChainName } from '../../types.js';
 import { IMultiProtocolSigner } from '../types.js';
@@ -56,6 +57,7 @@ export class CosmosNativeMultiProtocolSignerAdapter implements IMultiProtocolSig
 
   async sendAndConfirmTransaction(
     tx: CosmJsNativeTransaction,
+    _options?: SendTransactionOptions,
   ): Promise<string> {
     await this.signer.simulate(
       this.accountAddress,

typescript/sdk/src/signers/evm/ethersv5.ts

@@ -6,7 +6,10 @@ import { Address, ProtocolType, assert } from '@hyperlane-xyz/utils';
 
 import { ChainTechnicalStack } from '../../metadata/chainMetadataTypes.js';
 import { MultiProtocolProvider } from '../../providers/MultiProtocolProvider.js';
-import { MultiProvider } from '../../providers/MultiProvider.js';
+import {
+  MultiProvider,
+  SendTransactionOptions,
+} from '../../providers/MultiProvider.js';
 import { EthersV5Transaction } from '../../providers/ProviderType.js';
 import { ChainName } from '../../types.js';
 import { IMultiProtocolSigner } from '../types.js';
@@ -49,10 +52,14 @@ export class EvmMultiProtocolSignerAdapter implements IMultiProtocolSigner<Proto
     return this.multiProvider.getSignerAddress(this.chainName);
   }
 
-  async sendAndConfirmTransaction(tx: EthersV5Transaction): Promise<string> {
+  async sendAndConfirmTransaction(
+    tx: EthersV5Transaction,
+    options?: SendTransactionOptions,
+  ): Promise<string> {
     const res = await this.multiProvider.sendTransaction(
       this.chainName,
       tx.transaction,
+      options,
     );
 
     return res.transactionHash;

typescript/sdk/src/signers/radix/radix-toolkit.ts

@@ -6,6 +6,7 @@ import {
 } from '@hyperlane-xyz/radix-sdk';
 
 import { MultiProtocolProvider } from '../../providers/MultiProtocolProvider.js';
+import { SendTransactionOptions } from '../../providers/MultiProvider.js';
 import { RadixTransaction } from '../../providers/ProviderType.js';
 import { ChainName } from '../../types.js';
 import { IMultiProtocolSigner } from '../types.js';
@@ -37,7 +38,10 @@ export class RadixMultiProtocolSignerAdapter implements IMultiProtocolSigner<Pro
     return this.signer.getSignerAddress();
   }
 
-  async sendAndConfirmTransaction(tx: RadixTransaction): Promise<string> {
+  async sendAndConfirmTransaction(
+    tx: RadixTransaction,
+    _options?: SendTransactionOptions,
+  ): Promise<string> {
     try {
       await this.signer.estimateTransactionFee({
         transaction: tx.transaction,

typescript/sdk/src/signers/starknet/starknetjs.ts

@@ -4,6 +4,7 @@ import { Account as StarknetAccount } from 'starknet';
 import { ProtocolType, assert } from '@hyperlane-xyz/utils';
 
 import { MultiProtocolProvider } from '../../providers/MultiProtocolProvider.js';
+import { SendTransactionOptions } from '../../providers/MultiProvider.js';
 import { StarknetJsTransaction } from '../../providers/ProviderType.js';
 import { ChainName } from '../../types.js';
 import { IMultiProtocolSigner } from '../types.js';
@@ -35,7 +36,10 @@ export class StarknetMultiProtocolSignerAdapter implements IMultiProtocolSigner<
     return this.signer.address;
   }
 
-  async sendAndConfirmTransaction(tx: StarknetJsTransaction): Promise<string> {
+  async sendAndConfirmTransaction(
+    tx: StarknetJsTransaction,
+    _options?: SendTransactionOptions,
+  ): Promise<string> {
     const { entrypoint, calldata, contractAddress } = tx.transaction;
     assert(entrypoint, 'entrypoint is required for starknet transactions');
 

typescript/sdk/src/signers/svm/solana-web3js.ts

@@ -12,6 +12,7 @@ import { Address, ProtocolType, rootLogger, sleep } from '@hyperlane-xyz/utils';
 
 import { SEALEVEL_PRIORITY_FEES } from '../../consts/sealevel.js';
 import { MultiProtocolProvider } from '../../providers/MultiProtocolProvider.js';
+import { SendTransactionOptions } from '../../providers/MultiProvider.js';
 import { SolanaWeb3Transaction } from '../../providers/ProviderType.js';
 import { ChainName } from '../../types.js';
 import { IMultiProtocolSigner } from '../types.js';
@@ -109,7 +110,10 @@ export class SvmMultiProtocolSignerAdapter implements IMultiProtocolSigner<Proto
   /**
    * Send and confirm a pre-built transaction (IMultiProtocolSigner interface)
    */
-  async sendAndConfirmTransaction(tx: SolanaWeb3Transaction): Promise<string> {
+  async sendAndConfirmTransaction(
+    tx: SolanaWeb3Transaction,
+    _options?: SendTransactionOptions,
+  ): Promise<string> {
     return this.signAndConfirm(tx.transaction);
   }
 

typescript/sdk/src/signers/types.ts

@@ -1,10 +1,12 @@
 import { Address, ProtocolType } from '@hyperlane-xyz/utils';
 
+import { SendTransactionOptions } from '../providers/MultiProvider.js';
 import { ProtocolTypedTransaction } from '../providers/ProviderType.js';
 
 export interface IMultiProtocolSigner<TProtocol extends ProtocolType> {
   address(): Promise<Address>;
   sendAndConfirmTransaction(
     tx: ProtocolTypedTransaction<TProtocol>,
+    options?: SendTransactionOptions,
   ): Promise<string>;
 }