feat: improve transaction summary (FuelLabs#1200)

pay1t · Aug 23, 2023 · ff8c4df · ff8c4df
1 parent a8234c3
commit ff8c4df
Show file tree

Hide file tree

Showing 21 changed files with 257 additions and 151 deletions.
diff --git a/.changeset/great-lamps-beg.md b/.changeset/great-lamps-beg.md
@@ -0,0 +1,5 @@
+---
+"@fuel-ts/providers": minor
+---
+
+improvements to transaction summary functions
diff --git a/packages/fuel-gauge/src/transaction-summary.test.ts b/packages/fuel-gauge/src/transaction-summary.test.ts
@@ -15,7 +15,7 @@ import {
   BaseAssetId,
   Provider,
   ScriptTransactionRequest,
-  TransactionTypeNameEnum,
+  TransactionTypeName,
   Wallet,
 } from 'fuels';
 
@@ -37,7 +37,7 @@ describe('TransactionSummary', () => {
     expect(transaction.fee).toStrictEqual(expect.any(BN));
     expect(transaction.gasUsed).toStrictEqual(expect.any(BN));
     expect(transaction.operations).toStrictEqual(expect.any(Array<Operation>));
-    expect(transaction.type).toEqual(TransactionTypeNameEnum.Script);
+    expect(transaction.type).toEqual(TransactionTypeName.Script);
     expect(transaction.receipts).toStrictEqual(expect.any(Array<TransactionResultReceipt>));
     expect(transaction.isTypeMint).toBe(false);
     expect(transaction.isTypeCreate).toBe(false);
@@ -76,7 +76,10 @@ describe('TransactionSummary', () => {
 
     const transactionResponse = await tx.waitForResult();
 
-    const transactionSummary = await getTransactionSummary(tx.id, provider);
+    const transactionSummary = await getTransactionSummary({
+      id: tx.id,
+      provider,
+    });
 
     verifyTransactionSummary({
       transaction: transactionSummary,
@@ -99,9 +102,12 @@ describe('TransactionSummary', () => {
     const tx2 = await sender.transfer(destination.address, amountToTransfer);
     const transactionResponse2 = await tx2.waitForResult();
 
-    const { transactions } = await getTransactionsSummaries(provider, {
-      first: 2,
-      owner: sender.address.toB256(),
+    const { transactions } = await getTransactionsSummaries({
+      provider,
+      filters: {
+        first: 2,
+        owner: sender.address.toB256(),
+      },
     });
 
     expect(transactions.length).toBe(2);
@@ -132,7 +138,10 @@ describe('TransactionSummary', () => {
 
     const transactionRequest = await wallet.populateTransactionWitnessesSignature(request);
 
-    const transactionSummary = await getTransactionSummaryFromRequest(transactionRequest, provider);
+    const transactionSummary = await getTransactionSummaryFromRequest({
+      provider,
+      transactionRequest,
+    });
     verifyTransactionSummary({
       transaction: transactionSummary,
       isRequest: true,

diff --git a/packages/providers/src/operations.graphql b/packages/providers/src/operations.graphql
@@ -36,19 +36,18 @@ fragment transactionFragment on Transaction {
   }
 }
 
-fragment contractFragment on Contract {
-  id
-  bytecode
-}
-
 fragment receiptFragment on Receipt {
   contract {
-    ...contractFragment
+    id
+    bytecode
+    salt
   }
   pc
   is
   to {
-    ...contractFragment
+    id
+    bytecode
+    salt
   }
   toAddress
   amount
@@ -246,12 +245,6 @@ query getTransactionWithReceipts($transactionId: TransactionId!) {
       ...receiptFragment
     }
   }
-  chain {
-    consensusParameters {
-      gasPerByte
-      gasPriceFactor
-    }
-  }
 }
 
 query getTransactions(

diff --git a/packages/providers/src/transaction-response/transaction-response.ts b/packages/providers/src/transaction-response/transaction-response.ts
@@ -27,6 +27,7 @@ import type {
   TransactionSummary,
   FailureStatus,
   GqlTransaction,
+  AbiMap,
 } from '../transaction-summary/types';
 import { sleep } from '../utils';
 
@@ -136,13 +137,10 @@ export class TransactionResponse {
    *
    * @returns The completed transaction result
    */
-  async waitForResult<TTransactionType = void>(): Promise<TransactionResult<TTransactionType>> {
-    const {
-      transaction: gqlTransaction,
-      chain: {
-        consensusParameters: { gasPerByte, gasPriceFactor },
-      },
-    } = await this.fetch();
+  async waitForResult<TTransactionType = void>(
+    contractsAbiMap?: AbiMap
+  ): Promise<TransactionResult<TTransactionType>> {
+    const { transaction: gqlTransaction } = await this.fetch();
 
     const nullResponse = !gqlTransaction?.status?.type;
     const isStatusSubmitted = gqlTransaction?.status?.type === 'SubmittedStatus';
@@ -158,7 +156,7 @@ export class TransactionResponse {
       await sleep(
         Math.min(STATUS_POLLING_INTERVAL_MIN_MS * this.attempts, STATUS_POLLING_INTERVAL_MAX_MS)
       );
-      return this.waitForResult();
+      return this.waitForResult(contractsAbiMap);
     }
 
     const decodedTransaction = this.decodeTransaction<TTransactionType>(
@@ -167,15 +165,19 @@ export class TransactionResponse {
 
     const receipts = gqlTransaction.receipts?.map(processGqlReceipt) || [];
 
+    const {
+      consensusParameters: { gasPerByte, gasPriceFactor },
+    } = await this.provider.getChain();
+
     const transactionSummary = assembleTransactionSummary<TTransactionType>({
       id: this.id,
-      gasPrice: bn(gqlTransaction.gasPrice),
       receipts,
       transaction: decodedTransaction,
       transactionBytes: arrayify(gqlTransaction.rawPayload),
       gqlTransactionStatus: gqlTransaction.status,
       gasPerByte: bn(gasPerByte),
       gasPriceFactor: bn(gasPriceFactor),
+      abiMap: contractsAbiMap,
     });
 
     const transactionResult: TransactionResult<TTransactionType> = {
@@ -191,8 +193,10 @@ export class TransactionResponse {
    *
    * @returns The completed transaction.
    */
-  async wait<TTransactionType = void>(): Promise<TransactionResult<TTransactionType>> {
-    const result = await this.waitForResult<TTransactionType>();
+  async wait<TTransactionType = void>(
+    contractsAbiMap?: AbiMap
+  ): Promise<TransactionResult<TTransactionType>> {
+    const result = await this.waitForResult<TTransactionType>(contractsAbiMap);
 
     if (result.isStatusFailure) {
       throw new Error(

diff --git a/packages/providers/src/transaction-summary/assemble-transaction-summary.test.ts b/packages/providers/src/transaction-summary/assemble-transaction-summary.test.ts
@@ -22,7 +22,6 @@ import { type Operation } from './types';
 
 describe('TransactionSummary', () => {
   const id = '0x2bfbebca58da94ba3ee258698c9be5884e2874688bdffa29cb535cf05d665215';
-  const gasPrice = bn(1);
   const gasPerByte = bn(2);
   const gasPriceFactor = bn(3);
   const transaction = MOCK_TRANSACTION;
@@ -38,7 +37,6 @@ describe('TransactionSummary', () => {
   const runTest = (status: GraphqlTransactionStatus, expected: Record<string, unknown>) => {
     const transactionSummary = assembleTransactionSummary({
       id,
-      gasPrice,
       gasPerByte,
       gasPriceFactor,
       transaction,

diff --git a/packages/providers/src/transaction-summary/assemble-transaction-summary.ts b/packages/providers/src/transaction-summary/assemble-transaction-summary.ts
@@ -1,5 +1,5 @@
 import { hexlify } from '@ethersproject/bytes';
-import type { BN } from '@fuel-ts/math';
+import { bn, type BN } from '@fuel-ts/math';
 import { type Transaction } from '@fuel-ts/transactions';
 
 import type { TransactionResultReceipt } from '../transaction-response';
@@ -14,44 +14,44 @@ import {
 } from './operations';
 import { extractBurnedAssetsFromReceipts, extractMintedAssetsFromReceipts } from './receipt';
 import { processGraphqlStatus } from './status';
-import type { AbiParam, GraphqlTransactionStatus, TransactionSummary } from './types';
+import type { AbiMap, GraphqlTransactionStatus, TransactionSummary } from './types';
 
-interface IAssembleTransactionSummaryParams {
+export interface AssembleTransactionSummaryParams {
   id?: string;
-  gasPrice: BN;
   gasPerByte?: BN;
   gasPriceFactor?: BN;
   transaction: Transaction;
   transactionBytes: Uint8Array;
   gqlTransactionStatus?: GraphqlTransactionStatus;
   receipts: TransactionResultReceipt[];
-  abiParam?: AbiParam;
+  abiMap?: AbiMap;
 }
 
 /** @hidden */
 export function assembleTransactionSummary<TTransactionType = void>(
-  params: IAssembleTransactionSummaryParams
+  params: AssembleTransactionSummaryParams
 ) {
   const {
     receipts,
     gasPerByte,
-    gasPrice,
     gasPriceFactor,
     transaction,
     transactionBytes,
     id,
     gqlTransactionStatus,
-    abiParam,
+    abiMap = {},
   } = params;
 
-  const { fee, gasUsed } = calculateTransactionFee({
+  const gasPrice = bn(transaction.gasPrice);
+
+  const { gasUsed, fee } = calculateTransactionFee({
+    receipts,
     gasPrice,
     transactionBytes,
     transactionWitnesses: transaction?.witnesses || [],
     gasPerByte,
     gasPriceFactor,
     transactionType: transaction.type,
-    receipts,
   });
 
   const operations = getOperations({
@@ -60,7 +60,7 @@ export function assembleTransactionSummary<TTransactionType = void>(
     outputs: transaction.outputs || [],
     receipts,
     rawPayload: hexlify(transactionBytes),
-    abiMap: abiParam?.abiMap,
+    abiMap,
   });
 
   const typeName = getTransactionTypeName(transaction.type);