chore: types of tx response and the network calls involved (#3568)

* chore: tests for tx response network calls * chore: changeset
FuelLabs · Jan 9, 2025 · a5bb56f · a5bb56f
1 parent f2407dc
commit a5bb56f
Show file tree

Hide file tree

Showing 2 changed files with 103 additions and 0 deletions.
diff --git a/.changeset/sweet-geese-count.md b/.changeset/sweet-geese-count.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/packages/fuel-gauge/src/transaction-response.test.ts b/packages/fuel-gauge/src/transaction-response.test.ts
@@ -71,6 +71,107 @@ function getSubscriptionStreamFromFetch(streamHolder: { stream: ReadableStream<U
  * @group browser
  */
 describe('TransactionResponse', () => {
+  beforeEach(() => {
+    vi.resetAllMocks();
+  });
+
+  it('builds tx response from active sendAndAwaitStatus subscription', async () => {
+    using launched = await launchTestNode();
+
+    const {
+      provider,
+      wallets: [adminWallet],
+    } = launched;
+
+    const submitAndAwaitStatusSpy = vi.spyOn(provider.operations, 'submitAndAwaitStatus');
+    const statusChangeSpy = vi.spyOn(provider.operations, 'statusChange');
+    const getTransactionWithReceiptsSpy = vi.spyOn(
+      provider.operations,
+      'getTransactionWithReceipts'
+    );
+
+    const transferTx = await adminWallet.transfer(
+      Wallet.generate().address,
+      100,
+      await provider.getBaseAssetId()
+    );
+    const result = await transferTx.waitForResult();
+
+    expect(transferTx.id).toEqual(result.id);
+    expect(result.receipts.length).toBe(2);
+
+    expect(submitAndAwaitStatusSpy).toHaveBeenCalledTimes(1); // sends tx and gets result
+    expect(statusChangeSpy).toHaveBeenCalledTimes(0); // we already have the status
+    expect(getTransactionWithReceiptsSpy).toHaveBeenCalledTimes(0); // we already have the raw tx
+  });
+
+  it('builds tx response from transaction ID', async () => {
+    using launched = await launchTestNode();
+
+    const {
+      provider,
+      wallets: [adminWallet],
+    } = launched;
+
+    const submitAndAwaitStatusSpy = vi.spyOn(provider.operations, 'submitAndAwaitStatus');
+    const statusChangeSpy = vi.spyOn(provider.operations, 'statusChange');
+    const getTransactionWithReceiptsSpy = vi.spyOn(
+      provider.operations,
+      'getTransactionWithReceipts'
+    );
+
+    const transferTx = await adminWallet.transfer(
+      Wallet.generate().address,
+      100,
+      await provider.getBaseAssetId()
+    );
+    const response = new TransactionResponse(transferTx.id, provider, await provider.getChainId());
+    const result = await response.waitForResult();
+
+    expect(transferTx.id).toEqual(result.id);
+    expect(result.receipts.length).toBe(2);
+
+    expect(submitAndAwaitStatusSpy).toHaveBeenCalledTimes(1); // sends tx
+    expect(statusChangeSpy).toHaveBeenCalledTimes(1); // awaits result (can get receipts)
+    expect(getTransactionWithReceiptsSpy).toHaveBeenCalledTimes(1); // gets raw transaction and receipts
+  });
+
+  it('builds tx response from transaction request instance', async () => {
+    using launched = await launchTestNode();
+
+    const {
+      provider,
+      wallets: [adminWallet],
+    } = launched;
+
+    const submitAndAwaitStatusSpy = vi.spyOn(provider.operations, 'submitAndAwaitStatus');
+    const statusChangeSpy = vi.spyOn(provider.operations, 'statusChange');
+    const getTransactionWithReceiptsSpy = vi.spyOn(
+      provider.operations,
+      'getTransactionWithReceipts'
+    );
+
+    const transferTxRequest = await adminWallet.createTransfer(
+      Wallet.generate().address,
+      100,
+      await provider.getBaseAssetId()
+    );
+    const transferTx = await adminWallet.sendTransaction(transferTxRequest);
+    const response = new TransactionResponse(
+      transferTxRequest,
+      provider,
+      await provider.getChainId()
+    );
+    const result = await response.waitForResult();
+
+    expect(transferTx.id).toEqual(result.id);
+    expect(result.receipts.length).toBe(2);
+
+    expect(submitAndAwaitStatusSpy).toHaveBeenCalledTimes(1); // sends tx
+    expect(statusChangeSpy).toHaveBeenCalledTimes(1); // awaits result and gets receipts
+    expect(getTransactionWithReceiptsSpy).toHaveBeenCalledTimes(0); // we already have raw tx
+  });
+
   it('should ensure create method waits till a transaction response is given', async () => {
     using launched = await launchTestNode();