Refactor transaction-confirmation to use new transaction lifetimes (#…

…2485) * add lastValidBlockHeight to transaction blockhash lifetime * add nonceAccountAddress to Transaction durable nonce lifetime * refactor transaction-confirmation to use new lifetimes
solana-labs · Apr 18, 2024 · 1344fa7 · 1344fa7
1 parent 028bdcc
commit 1344fa7
Show file tree

Hide file tree

Showing 17 changed files with 218 additions and 135 deletions.
diff --git a/packages/library/src/__tests__/send-transaction-internal-test.ts b/packages/library/src/__tests__/send-transaction-internal-test.ts
@@ -3,12 +3,10 @@ import type { Rpc, SendTransactionApi } from '@solana/rpc';
 import type { Commitment } from '@solana/rpc-types';
 import {
     Base64EncodedWireTransaction,
-    BaseTransaction,
-    getBase64EncodedWireTransaction,
-    IDurableNonceTransaction,
-    IFullySignedTransaction,
-    ITransactionWithBlockhashLifetime,
-    ITransactionWithFeePayer,
+    FullySignedTransaction,
+    newGetBase64EncodedWireTransaction,
+    TransactionBlockhashLifetime,
+    TransactionDurableNonceLifetime,
 } from '@solana/transactions';
 
 import {
@@ -23,10 +21,9 @@ const FOREVER_PROMISE = new Promise(() => {
 });
 
 describe('sendAndConfirmTransaction', () => {
-    const MOCK_TRANSACTION = {} as unknown as BaseTransaction &
-        IFullySignedTransaction &
-        ITransactionWithBlockhashLifetime &
-        ITransactionWithFeePayer;
+    const MOCK_TRANSACTION = {} as unknown as FullySignedTransaction & {
+        lifetimeConstraint: TransactionBlockhashLifetime;
+    };
     let confirmRecentTransaction: jest.Mock;
     let createPendingRequest: jest.Mock;
     let rpc: Rpc<SendTransactionApi>;
@@ -39,7 +36,7 @@ describe('sendAndConfirmTransaction', () => {
         rpc = {
             sendTransaction: createPendingRequest,
         };
-        jest.mocked(getBase64EncodedWireTransaction).mockReturnValue(
+        jest.mocked(newGetBase64EncodedWireTransaction).mockReturnValue(
             'MOCK_WIRE_TRANSACTION' as Base64EncodedWireTransaction,
         );
     });
@@ -51,7 +48,7 @@ describe('sendAndConfirmTransaction', () => {
             rpc,
             transaction: MOCK_TRANSACTION,
         });
-        expect(getBase64EncodedWireTransaction).toHaveBeenCalledWith(MOCK_TRANSACTION);
+        expect(newGetBase64EncodedWireTransaction).toHaveBeenCalledWith(MOCK_TRANSACTION);
         expect(createPendingRequest).toHaveBeenCalledWith('MOCK_WIRE_TRANSACTION', expect.anything());
     });
     it('calls `sendTransaction` with the expected inputs', () => {
@@ -69,7 +66,7 @@ describe('sendAndConfirmTransaction', () => {
             rpc,
             transaction: MOCK_TRANSACTION,
         });
-        expect(getBase64EncodedWireTransaction).toHaveBeenCalledWith(MOCK_TRANSACTION);
+        expect(newGetBase64EncodedWireTransaction).toHaveBeenCalledWith(MOCK_TRANSACTION);
         expect(createPendingRequest).toHaveBeenCalledWith('MOCK_WIRE_TRANSACTION', {
             ...sendTransactionConfig,
             encoding: 'base64',
@@ -180,10 +177,9 @@ describe('sendAndConfirmTransaction', () => {
 });
 
 describe('sendAndConfirmDurableNonceTransaction', () => {
-    const MOCK_DURABLE_NONCE_TRANSACTION = {} as unknown as BaseTransaction &
-        IDurableNonceTransaction &
-        IFullySignedTransaction &
-        ITransactionWithFeePayer;
+    const MOCK_DURABLE_NONCE_TRANSACTION = {} as unknown as FullySignedTransaction & {
+        lifetimeConstraint: TransactionDurableNonceLifetime;
+    };
     let confirmDurableNonceTransaction: jest.Mock;
     let createPendingRequest: jest.Mock;
     let rpc: Rpc<SendTransactionApi>;
@@ -196,7 +192,7 @@ describe('sendAndConfirmDurableNonceTransaction', () => {
         rpc = {
             sendTransaction: createPendingRequest,
         };
-        jest.mocked(getBase64EncodedWireTransaction).mockReturnValue(
+        jest.mocked(newGetBase64EncodedWireTransaction).mockReturnValue(
             'MOCK_WIRE_TRANSACTION' as Base64EncodedWireTransaction,
         );
     });
@@ -208,7 +204,7 @@ describe('sendAndConfirmDurableNonceTransaction', () => {
             rpc,
             transaction: MOCK_DURABLE_NONCE_TRANSACTION,
         });
-        expect(getBase64EncodedWireTransaction).toHaveBeenCalledWith(MOCK_DURABLE_NONCE_TRANSACTION);
+        expect(newGetBase64EncodedWireTransaction).toHaveBeenCalledWith(MOCK_DURABLE_NONCE_TRANSACTION);
         expect(createPendingRequest).toHaveBeenCalledWith('MOCK_WIRE_TRANSACTION', expect.anything());
     });
     it('calls `sendTransaction` with the expected inputs', () => {
@@ -226,7 +222,7 @@ describe('sendAndConfirmDurableNonceTransaction', () => {
             rpc,
             transaction: MOCK_DURABLE_NONCE_TRANSACTION,
         });
-        expect(getBase64EncodedWireTransaction).toHaveBeenCalledWith(MOCK_DURABLE_NONCE_TRANSACTION);
+        expect(newGetBase64EncodedWireTransaction).toHaveBeenCalledWith(MOCK_DURABLE_NONCE_TRANSACTION);
         expect(createPendingRequest).toHaveBeenCalledWith('MOCK_WIRE_TRANSACTION', {
             ...sendTransactionConfig,
             encoding: 'base64',

diff --git a/packages/library/src/send-transaction-internal.ts b/packages/library/src/send-transaction-internal.ts
@@ -7,12 +7,17 @@ import {
 } from '@solana/transaction-confirmation';
 import {
     BaseTransaction,
-    getBase64EncodedWireTransaction,
+    FullySignedTransaction,
     IDurableNonceTransaction,
     IFullySignedTransaction,
     ITransactionWithBlockhashLifetime,
     ITransactionWithFeePayer,
+    newGetBase64EncodedWireTransaction,
 } from '@solana/transactions';
+import {
+    TransactionBlockhashLifetime,
+    TransactionDurableNonceLifetime,
+} from '@solana/transactions/dist/types/lifetime';
 
 interface SendAndConfirmDurableNonceTransactionConfig
     extends SendTransactionBaseConfig,
@@ -23,7 +28,7 @@ interface SendAndConfirmDurableNonceTransactionConfig
             'getNonceInvalidationPromise' | 'getRecentSignatureConfirmationPromise'
         >,
     ) => Promise<void>;
-    transaction: IDurableNonceTransaction & SendableTransaction;
+    transaction: FullySignedTransaction & { lifetimeConstraint: TransactionDurableNonceLifetime };
 }
 
 interface SendAndConfirmTransactionWithBlockhashLifetimeConfig
@@ -35,14 +40,14 @@ interface SendAndConfirmTransactionWithBlockhashLifetimeConfig
             'getBlockHeightExceedencePromise' | 'getRecentSignatureConfirmationPromise'
         >,
     ) => Promise<void>;
-    transaction: ITransactionWithBlockhashLifetime & SendableTransaction;
+    transaction: FullySignedTransaction & { lifetimeConstraint: TransactionBlockhashLifetime };
 }
 
 interface SendTransactionBaseConfig extends SendTransactionConfigWithoutEncoding {
     abortSignal?: AbortSignal;
     commitment: Commitment;
     rpc: Rpc<SendTransactionApi>;
-    transaction: SendableTransaction;
+    transaction: FullySignedTransaction;
 }
 
 interface SendTransactionConfigWithoutEncoding
@@ -84,7 +89,7 @@ export async function sendTransaction_INTERNAL_ONLY_DO_NOT_EXPORT({
     transaction,
     ...sendTransactionConfig
 }: SendTransactionBaseConfig): Promise<Signature> {
-    const base64EncodedWireTransaction = getBase64EncodedWireTransaction(transaction);
+    const base64EncodedWireTransaction = newGetBase64EncodedWireTransaction(transaction);
     return await rpc
         .sendTransaction(base64EncodedWireTransaction, {
             ...getSendTransactionConfigWithAdjustedPreflightCommitment(commitment, sendTransactionConfig),

diff --git a/packages/library/src/send-transaction.ts b/packages/library/src/send-transaction.ts
@@ -13,15 +13,12 @@ import {
     waitForRecentTransactionConfirmation,
 } from '@solana/transaction-confirmation';
 import {
-    BaseTransaction,
-    IDurableNonceTransaction,
-    IFullySignedTransaction,
-    ITransactionWithBlockhashLifetime,
-    ITransactionWithFeePayer,
+    FullySignedTransaction,
+    TransactionBlockhashLifetime,
+    TransactionDurableNonceLifetime,
 } from '@solana/transactions';
 
 import {
-    SendableTransaction,
     sendAndConfirmDurableNonceTransaction_INTERNAL_ONLY_DO_NOT_EXPORT,
     sendAndConfirmTransactionWithBlockhashLifetime_INTERNAL_ONLY_DO_NOT_EXPORT,
     sendTransaction_INTERNAL_ONLY_DO_NOT_EXPORT,
@@ -42,23 +39,23 @@ interface SendTransactionWithoutConfirmingFactoryConfig {
 }
 
 type SendAndConfirmTransactionWithBlockhashLifetimeFunction = (
-    transaction: ITransactionWithBlockhashLifetime & SendableTransaction,
+    transaction: FullySignedTransaction & { lifetimeConstraint: TransactionBlockhashLifetime },
     config: Omit<
         Parameters<typeof sendAndConfirmTransactionWithBlockhashLifetime_INTERNAL_ONLY_DO_NOT_EXPORT>[0],
         'confirmRecentTransaction' | 'rpc' | 'transaction'
     >,
 ) => Promise<void>;
 
 type SendAndConfirmDurableNonceTransactionFunction = (
-    transaction: BaseTransaction & IDurableNonceTransaction & IFullySignedTransaction & ITransactionWithFeePayer,
+    transaction: FullySignedTransaction & { lifetimeConstraint: TransactionDurableNonceLifetime },
     config: Omit<
         Parameters<typeof sendAndConfirmDurableNonceTransaction_INTERNAL_ONLY_DO_NOT_EXPORT>[0],
         'confirmDurableNonceTransaction' | 'rpc' | 'transaction'
     >,
 ) => Promise<void>;
 
 type SendTransactionWithoutConfirmingFunction = (
-    transaction: SendableTransaction,
+    transaction: FullySignedTransaction,
     config: Omit<Parameters<typeof sendTransaction_INTERNAL_ONLY_DO_NOT_EXPORT>[0], 'rpc' | 'transaction'>,
 ) => Promise<void>;