chore: constrain the connection input of sendTransaction to the m…

…inimum interface actually required
anza-xyz · Nov 29, 2023 · 341e3dc · 341e3dc
1 parent fe542c2
commit 341e3dc
Show file tree

Hide file tree

Showing 14 changed files with 89 additions and 76 deletions.
diff --git a/packages/core/base/src/adapter.ts b/packages/core/base/src/adapter.ts
@@ -1,10 +1,24 @@
-import type { Connection, PublicKey, SendOptions, Signer, Transaction, TransactionSignature } from '@solana/web3.js';
+import type { Commitment, PublicKey, SendOptions, Signer, Transaction, TransactionSignature } from '@solana/web3.js';
 import EventEmitter from 'eventemitter3';
 import { type WalletError, WalletNotConnectedError } from './errors.js';
 import type { SupportedTransactionVersions, TransactionOrVersionedTransaction } from './transaction.js';
 
 export { EventEmitter };
 
+type BlockhashFetcher = (config?: {
+    commitment?: Commitment;
+    minContextSlot?: number;
+}) => Promise<{ blockhash: string }>;
+
+export interface ConnectionContext {
+    commitment?: Commitment;
+    getLatestBlockhash: BlockhashFetcher;
+    sendRawTransaction(
+        rawTransaction: Buffer | Uint8Array | Array<number>,
+        options?: SendOptions
+    ): Promise<TransactionSignature>;
+}
+
 export interface WalletAdapterEvents {
     connect(publicKey: PublicKey): void;
     disconnect(): void;
@@ -35,7 +49,7 @@ export interface WalletAdapterProps<Name extends string = string> {
     disconnect(): Promise<void>;
     sendTransaction(
         transaction: TransactionOrVersionedTransaction<this['supportedTransactionVersions']>,
-        connection: Connection,
+        connectionContext: ConnectionContext,
         options?: SendTransactionOptions
     ): Promise<TransactionSignature>;
 }
@@ -96,13 +110,13 @@ export abstract class BaseWalletAdapter<Name extends string = string>
 
     abstract sendTransaction(
         transaction: TransactionOrVersionedTransaction<this['supportedTransactionVersions']>,
-        connection: Connection,
+        connectionContext: ConnectionContext,
         options?: SendTransactionOptions
     ): Promise<TransactionSignature>;
 
     protected async prepareTransaction(
         transaction: Transaction,
-        connection: Connection,
+        blockhashFetchingContext: Readonly<{ getLatestBlockhash: BlockhashFetcher }>,
         options: SendOptions = {}
     ): Promise<Transaction> {
         const publicKey = this.publicKey;
@@ -112,7 +126,7 @@ export abstract class BaseWalletAdapter<Name extends string = string>
         transaction.recentBlockhash =
             transaction.recentBlockhash ||
             (
-                await connection.getLatestBlockhash({
+                await blockhashFetchingContext.getLatestBlockhash({
                     commitment: options.preflightCommitment,
                     minContextSlot: options.minContextSlot,
                 })

diff --git a/packages/core/base/src/signer.ts b/packages/core/base/src/signer.ts
@@ -1,7 +1,8 @@
 import type { SolanaSignInInput, SolanaSignInOutput } from '@solana/wallet-standard-features';
-import type { Connection, TransactionSignature } from '@solana/web3.js';
+import type { TransactionSignature } from '@solana/web3.js';
 import {
     BaseWalletAdapter,
+    type ConnectionContext,
     type SendTransactionOptions,
     type WalletAdapter,
     type WalletAdapterProps,
@@ -26,7 +27,7 @@ export abstract class BaseSignerWalletAdapter<Name extends string = string>
 {
     async sendTransaction(
         transaction: TransactionOrVersionedTransaction<this['supportedTransactionVersions']>,
-        connection: Connection,
+        connectionContext: ConnectionContext,
         options: SendTransactionOptions = {}
     ): Promise<TransactionSignature> {
         let emit = true;
@@ -47,7 +48,7 @@ export abstract class BaseSignerWalletAdapter<Name extends string = string>
 
                     const rawTransaction = transaction.serialize();
 
-                    return await connection.sendRawTransaction(rawTransaction, options);
+                    return await connectionContext.sendRawTransaction(rawTransaction, options);
                 } catch (error: any) {
                     // If the error was thrown by `signTransaction`, rethrow it and don't emit a duplicate event
                     if (error instanceof WalletSignTransactionError) {
@@ -60,15 +61,15 @@ export abstract class BaseSignerWalletAdapter<Name extends string = string>
                 try {
                     const { signers, ...sendOptions } = options;
 
-                    transaction = await this.prepareTransaction(transaction, connection, sendOptions);
+                    transaction = await this.prepareTransaction(transaction, connectionContext, sendOptions);
 
                     signers?.length && transaction.partialSign(...signers);
 
                     transaction = await this.signTransaction(transaction);
 
                     const rawTransaction = transaction.serialize();
 
-                    return await connection.sendRawTransaction(rawTransaction, sendOptions);
+                    return await connectionContext.sendRawTransaction(rawTransaction, sendOptions);
                 } catch (error: any) {
                     // If the error was thrown by `signTransaction`, rethrow it and don't emit a duplicate event
                     if (error instanceof WalletSignTransactionError) {

diff --git a/packages/wallets/alpha/src/adapter.ts b/packages/wallets/alpha/src/adapter.ts
@@ -1,4 +1,4 @@
-import type { EventEmitter, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
+import type { ConnectionContext, EventEmitter, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
 import {
     BaseMessageSignerWalletAdapter,
     scopePollingDetectionStrategy,
@@ -15,7 +15,7 @@ import {
     WalletSignMessageError,
     WalletSignTransactionError,
 } from '@solana/wallet-adapter-base';
-import type { Connection, SendOptions, Transaction, TransactionSignature } from '@solana/web3.js';
+import type { SendOptions, Transaction, TransactionSignature } from '@solana/web3.js';
 import { PublicKey } from '@solana/web3.js';
 
 interface AlphaWalletEvents {
@@ -158,7 +158,7 @@ export class AlphaWalletAdapter extends BaseMessageSignerWalletAdapter {
 
     async sendTransaction(
         transaction: Transaction,
-        connection: Connection,
+        connectionContext: ConnectionContext,
         options: SendTransactionOptions = {}
     ): Promise<TransactionSignature> {
         try {
@@ -168,11 +168,11 @@ export class AlphaWalletAdapter extends BaseMessageSignerWalletAdapter {
             try {
                 const { signers, ...sendOptions } = options;
 
-                transaction = await this.prepareTransaction(transaction, connection, sendOptions);
+                transaction = await this.prepareTransaction(transaction, connectionContext, sendOptions);
 
                 signers?.length && transaction.partialSign(...signers);
 
-                sendOptions.preflightCommitment = sendOptions.preflightCommitment || connection.commitment;
+                sendOptions.preflightCommitment = sendOptions.preflightCommitment || connectionContext.commitment;
 
                 const { signature } = await wallet.signAndSendTransaction(transaction, sendOptions);
                 return signature;

diff --git a/packages/wallets/avana/src/adapter.ts b/packages/wallets/avana/src/adapter.ts
@@ -1,4 +1,4 @@
-import type { EventEmitter, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
+import type { ConnectionContext, EventEmitter, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
 import {
     BaseMessageSignerWalletAdapter,
     scopePollingDetectionStrategy,
@@ -15,7 +15,7 @@ import {
     WalletSignMessageError,
     WalletSignTransactionError,
 } from '@solana/wallet-adapter-base';
-import type { Connection, SendOptions, Transaction, TransactionSignature } from '@solana/web3.js';
+import type { SendOptions, Transaction, TransactionSignature } from '@solana/web3.js';
 import { PublicKey } from '@solana/web3.js';
 
 interface AvanaWalletEvents {
@@ -160,7 +160,7 @@ export class AvanaWalletAdapter extends BaseMessageSignerWalletAdapter {
 
     async sendTransaction(
         transaction: Transaction,
-        connection: Connection,
+        connectionContext: ConnectionContext,
         options: SendTransactionOptions = {}
     ): Promise<TransactionSignature> {
         try {
@@ -170,11 +170,11 @@ export class AvanaWalletAdapter extends BaseMessageSignerWalletAdapter {
             try {
                 const { signers, ...sendOptions } = options;
 
-                transaction = await this.prepareTransaction(transaction, connection, sendOptions);
+                transaction = await this.prepareTransaction(transaction, connectionContext, sendOptions);
 
                 signers?.length && transaction.partialSign(...signers);
 
-                sendOptions.preflightCommitment = sendOptions.preflightCommitment || connection.commitment;
+                sendOptions.preflightCommitment = sendOptions.preflightCommitment || connectionContext.commitment;
 
                 const { signature } = await wallet.signAndSendTransaction(transaction, sendOptions);
                 return signature;

diff --git a/packages/wallets/censo/src/adapter.ts b/packages/wallets/censo/src/adapter.ts
@@ -1,5 +1,5 @@
 import type { CensoWallet } from '@censo-custody/solana-wallet-adapter';
-import type { SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
+import type { ConnectionContext, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
 import {
     BaseSignerWalletAdapter,
     WalletConfigError,
@@ -12,7 +12,7 @@ import {
     WalletReadyState,
     WalletSignTransactionError,
 } from '@solana/wallet-adapter-base';
-import type { Connection, PublicKey, Transaction, TransactionSignature } from '@solana/web3.js';
+import type { PublicKey, Transaction, TransactionSignature } from '@solana/web3.js';
 
 interface CensoWindow extends Window {
     censo?: CensoWallet;
@@ -124,15 +124,20 @@ export class CensoWalletAdapter extends BaseSignerWalletAdapter {
 
     async sendTransaction(
         transaction: Transaction,
-        connection: Connection,
+        _connectionContext: ConnectionContext,
         options: SendTransactionOptions = {}
     ): Promise<TransactionSignature> {
         try {
             const wallet = this._wallet;
             if (!wallet) throw new WalletNotConnectedError();
 
             try {
-                return await wallet.sendTransaction(transaction, connection, options);
+                return await wallet.sendTransaction(
+                    transaction,
+                    // @ts-ignore
+                    undefined, // This parameter is not used. See https://www.npmjs.com/package/@censo-custody/solana-wallet-adapter?activeTab=code
+                    options
+                );
             } catch (error: any) {
                 throw new WalletSignTransactionError(error?.message, error);
             }

diff --git a/packages/wallets/coinbase/src/adapter.ts b/packages/wallets/coinbase/src/adapter.ts
@@ -1,4 +1,4 @@
-import type { EventEmitter, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
+import type { ConnectionContext, EventEmitter, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
 import {
     BaseMessageSignerWalletAdapter,
     scopePollingDetectionStrategy,
@@ -14,7 +14,7 @@ import {
     WalletSendTransactionError,
     WalletSignTransactionError,
 } from '@solana/wallet-adapter-base';
-import type { Connection, SendOptions, Transaction, TransactionSignature } from '@solana/web3.js';
+import type { SendOptions, Transaction, TransactionSignature } from '@solana/web3.js';
 import { PublicKey } from '@solana/web3.js';
 
 interface CoinbaseWalletEvents {
@@ -149,7 +149,7 @@ export class CoinbaseWalletAdapter extends BaseMessageSignerWalletAdapter {
 
     async sendTransaction(
         transaction: Transaction,
-        connection: Connection,
+        connectionContext: ConnectionContext,
         options: SendTransactionOptions = {}
     ): Promise<TransactionSignature> {
         try {
@@ -159,11 +159,11 @@ export class CoinbaseWalletAdapter extends BaseMessageSignerWalletAdapter {
             try {
                 const { signers, ...sendOptions } = options;
 
-                transaction = await this.prepareTransaction(transaction, connection, sendOptions);
+                transaction = await this.prepareTransaction(transaction, connectionContext, sendOptions);
 
                 signers?.length && transaction.partialSign(...signers);
 
-                sendOptions.preflightCommitment = sendOptions.preflightCommitment || connection.commitment;
+                sendOptions.preflightCommitment = sendOptions.preflightCommitment || connectionContext.commitment;
 
                 const { signature } = await wallet.signAndSendTransaction(transaction, sendOptions);
                 return signature;

diff --git a/packages/wallets/nufi/src/adapter.ts b/packages/wallets/nufi/src/adapter.ts
@@ -1,4 +1,4 @@
-import type { EventEmitter, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
+import type { ConnectionContext, EventEmitter, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
 import {
     BaseMessageSignerWalletAdapter,
     isVersionedTransaction,
@@ -16,13 +16,7 @@ import {
     WalletSignMessageError,
     WalletSignTransactionError,
 } from '@solana/wallet-adapter-base';
-import type {
-    Connection,
-    Transaction,
-    TransactionSignature,
-    TransactionVersion,
-    VersionedTransaction,
-} from '@solana/web3.js';
+import type { Transaction, TransactionSignature, TransactionVersion, VersionedTransaction } from '@solana/web3.js';
 import { PublicKey } from '@solana/web3.js';
 
 interface NufiWalletEvents {
@@ -161,7 +155,7 @@ export class NufiWalletAdapter extends BaseMessageSignerWalletAdapter {
 
     async sendTransaction<T extends Transaction | VersionedTransaction>(
         transaction: T,
-        connection: Connection,
+        connectionContext: ConnectionContext,
         options: SendTransactionOptions = {}
     ): Promise<TransactionSignature> {
         try {
@@ -174,11 +168,11 @@ export class NufiWalletAdapter extends BaseMessageSignerWalletAdapter {
                 if (isVersionedTransaction(transaction)) {
                     signers?.length && transaction.sign(signers);
                 } else {
-                    transaction = (await this.prepareTransaction(transaction, connection, sendOptions)) as T;
+                    transaction = (await this.prepareTransaction(transaction, connectionContext, sendOptions)) as T;
                     signers?.length && (transaction as Transaction).partialSign(...signers);
                 }
 
-                sendOptions.preflightCommitment = sendOptions.preflightCommitment || connection.commitment;
+                sendOptions.preflightCommitment = sendOptions.preflightCommitment || connectionContext.commitment;
                 const { signature } = await wallet.signAndSendTransaction(transaction);
                 return signature;
             } catch (error: any) {

diff --git a/packages/wallets/phantom/src/adapter.ts b/packages/wallets/phantom/src/adapter.ts
@@ -1,4 +1,4 @@
-import type { EventEmitter, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
+import type { ConnectionContext, EventEmitter, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
 import {
     BaseMessageSignerWalletAdapter,
     isIosAndRedirectable,
@@ -18,7 +18,6 @@ import {
     WalletSignTransactionError,
 } from '@solana/wallet-adapter-base';
 import type {
-    Connection,
     SendOptions,
     Transaction,
     TransactionSignature,
@@ -193,7 +192,7 @@ export class PhantomWalletAdapter extends BaseMessageSignerWalletAdapter {
 
     async sendTransaction<T extends Transaction | VersionedTransaction>(
         transaction: T,
-        connection: Connection,
+        connectionContext: ConnectionContext,
         options: SendTransactionOptions = {}
     ): Promise<TransactionSignature> {
         try {
@@ -206,11 +205,11 @@ export class PhantomWalletAdapter extends BaseMessageSignerWalletAdapter {
                 if (isVersionedTransaction(transaction)) {
                     signers?.length && transaction.sign(signers);
                 } else {
-                    transaction = (await this.prepareTransaction(transaction, connection, sendOptions)) as T;
+                    transaction = (await this.prepareTransaction(transaction, connectionContext, sendOptions)) as T;
                     signers?.length && (transaction as Transaction).partialSign(...signers);
                 }
 
-                sendOptions.preflightCommitment = sendOptions.preflightCommitment || connection.commitment;
+                sendOptions.preflightCommitment = sendOptions.preflightCommitment || connectionContext.commitment;
 
                 const { signature } = await wallet.signAndSendTransaction(transaction, sendOptions);
                 return signature;

diff --git a/packages/wallets/saifu/src/adapter.ts b/packages/wallets/saifu/src/adapter.ts
@@ -1,4 +1,4 @@
-import type { EventEmitter, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
+import type { ConnectionContext, EventEmitter, SendTransactionOptions, WalletName } from '@solana/wallet-adapter-base';
 import {
     BaseMessageSignerWalletAdapter,
     scopePollingDetectionStrategy,
@@ -15,7 +15,7 @@ import {
     WalletSignMessageError,
     WalletSignTransactionError,
 } from '@solana/wallet-adapter-base';
-import type { Connection, SendOptions, Transaction, TransactionSignature } from '@solana/web3.js';
+import type { SendOptions, Transaction, TransactionSignature } from '@solana/web3.js';
 import { PublicKey } from '@solana/web3.js';
 
 interface SaifuWalletEvents {
@@ -158,7 +158,7 @@ export class SaifuWalletAdapter extends BaseMessageSignerWalletAdapter {
 
     async sendTransaction(
         transaction: Transaction,
-        connection: Connection,
+        connectionContext: ConnectionContext,
         options: SendTransactionOptions = {}
     ): Promise<TransactionSignature> {
         try {
@@ -169,11 +169,11 @@ export class SaifuWalletAdapter extends BaseMessageSignerWalletAdapter {
                 try {
                     const { signers, ...sendOptions } = options;
 
-                    transaction = await this.prepareTransaction(transaction, connection, sendOptions);
+                    transaction = await this.prepareTransaction(transaction, connectionContext, sendOptions);
 
                     signers?.length && transaction.partialSign(...signers);
 
-                    sendOptions.preflightCommitment = sendOptions.preflightCommitment || connection.commitment;
+                    sendOptions.preflightCommitment = sendOptions.preflightCommitment || connectionContext.commitment;
 
                     const { signature } = await wallet.signAndSendTransaction(transaction, sendOptions);
                     return signature;
@@ -187,7 +187,7 @@ export class SaifuWalletAdapter extends BaseMessageSignerWalletAdapter {
             throw error;
         }
 
-        return await super.sendTransaction(transaction, connection, options);
+        return await super.sendTransaction(transaction, connectionContext, options);
     }
 
     async signTransaction<T extends Transaction>(transaction: T): Promise<T> {