fix: provider rpc 0.5-0.6 getTransactionReceipt response standardization

starknet-io · Dec 12, 2023 · 76b6ab4 · 76b6ab4
1 parent ab50471
commit 76b6ab4
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 233 deletions.
diff --git a/__tests__/account.test.ts b/__tests__/account.test.ts
@@ -96,7 +96,9 @@ describe('deploy and test Wallet', () => {
     });
 
     expect(result).toMatchSchemaRef('EstimateFee');
-    expect(innerInvokeEstFeeSpy.mock.calls[0][1].version).toBe(constants.TRANSACTION_VERSION.F1);
+    expect([constants.TRANSACTION_VERSION.F1, constants.TRANSACTION_VERSION.F3]).toContain(
+      innerInvokeEstFeeSpy.mock.calls[0][1].version
+    );
     innerInvokeEstFeeSpy.mockClear();
   });
 

diff --git a/__tests__/schemas/provider.json b/__tests__/schemas/provider.json
@@ -203,7 +203,16 @@
           ]
         },
         "actual_fee": {
-          "type": "string"
+          "type": "object",
+          "properties": {
+            "amount": {
+              "type": "string"
+            },
+            "unit": {
+              "type": "string",
+              "enum": ["WEI", "FRI"]
+            }
+          }
         },
         "status_data": {
           "type": "string"

diff --git a/src/provider/rpc.ts b/src/provider/rpc.ts
@@ -127,7 +127,9 @@ export class RpcProvider implements ProviderInterface {
   }
 
   public async getTransactionReceipt(txHash: BigNumberish) {
-    return this.channel.getTransactionReceipt(txHash);
+    return this.channel
+      .getTransactionReceipt(txHash)
+      .then(this.responseParser.parseTransactionReceipt);
   }
 
   public async getTransactionTrace(txHash: BigNumberish) {

diff --git a/src/types/api/rpcspec_0_6/nonspec.ts b/src/types/api/rpcspec_0_6/nonspec.ts
@@ -15,13 +15,15 @@ import {
   EVENTS_CHUNK,
   EVENT_FILTER,
   FEE_ESTIMATE,
+  FEE_PAYMENT,
   FELT,
   MSG_FROM_L1,
   NONCE_UPDATE,
   PENDING_BLOCK_WITH_TXS,
   PENDING_BLOCK_WITH_TX_HASHES,
   PENDING_STATE_UPDATE,
   PENDING_TXN_RECEIPT,
+  PRICE_UNIT,
   REPLACED_CLASS,
   RESOURCE_BOUNDS_MAPPING,
   RESULT_PAGE_REQUEST,
@@ -88,6 +90,8 @@ export type TransactionStatus = {
   execution_status?: TXN_EXECUTION_STATUS;
 };
 export type ResourceBounds = RESOURCE_BOUNDS_MAPPING;
+export type FeePayment = FEE_PAYMENT;
+export type PriceUnit = PRICE_UNIT;
 
 // Diff Than Seq
 export type StorageDiffs = Array<CONTRACT_STORAGE_DIFF_ITEM>;

diff --git a/src/types/provider/configuration.ts b/src/types/provider/configuration.ts
@@ -12,20 +12,3 @@ export type RpcProviderOptions = {
   default?: boolean;
   waitMode?: boolean;
 };
-
-export type SequencerHttpMethod = 'POST' | 'GET';
-
-export type SequencerProviderOptions = {
-  headers?: Record<string, string>;
-  blockIdentifier?: BlockIdentifier;
-  chainId?: StarknetChainId;
-} & (
-  | {
-      network: NetworkName | StarknetChainId;
-    }
-  | {
-      baseUrl: string;
-      feederGatewayUrl?: string;
-      gatewayUrl?: string;
-    }
-);
diff --git a/src/types/provider/response.ts b/src/types/provider/response.ts
@@ -112,7 +112,7 @@ export interface InvokeTransactionReceiptResponse {
   execution_status: TransactionExecutionStatus;
   finality_status: TransactionFinalityStatus;
   status?: `${TransactionStatus}`; // SEQ only
-  actual_fee: string | RPC.SPEC.FEE_ESTIMATE;
+  actual_fee: RPC.FeePayment;
   block_hash: RPC.BlockHash;
   block_number: BlockNumber;
   transaction_hash: string;
@@ -127,7 +127,7 @@ export type DeclareTransactionReceiptResponse = {
   execution_status: TransactionExecutionStatus;
   finality_status: TransactionFinalityStatus;
   status?: `${TransactionStatus}`; // SEQ only
-  actual_fee: string;
+  actual_fee: RPC.FeePayment;
   block_hash: RPC.BlockHash;
   block_number: BlockNumber;
   transaction_hash: string;
@@ -157,7 +157,7 @@ export type RevertedTransactionReceiptResponse = {
   execution_status: TransactionExecutionStatus.REVERTED | any; // any due to RPC Spec issue
   finality_status: TransactionFinalityStatus | any;
   status?: TransactionStatus; // SEQ only
-  actual_fee: string | RPC.SPEC.FEE_PAYMENT;
+  actual_fee: RPC.FeePayment;
   block_hash?: string; // ?~ optional due to RPC spec issue
   block_number?: BlockNumber; // ?~ optional due to RCP spec issue
   transaction_hash: string;

diff --git a/src/utils/responseParser/rpc.ts b/src/utils/responseParser/rpc.ts
@@ -9,7 +9,9 @@ import {
   EstimateFeeResponse,
   EstimateFeeResponseBulk,
   GetBlockResponse,
+  GetTransactionReceiptResponse,
   GetTransactionResponse,
+  RPC,
   SimulateTransactionResponse,
 } from '../../types';
 import {
@@ -45,6 +47,21 @@ export class RPCResponseParser
     };
   }
 
+  public parseTransactionReceipt(res: RPC.TransactionReceipt): GetTransactionReceiptResponse {
+    if (typeof res.actual_fee === 'string') {
+      // This case is RPC 0.5. It can be only v2 thx with FRI units
+      return {
+        ...res,
+        actual_fee: {
+          amount: res.actual_fee,
+          unit: 'FRI' as RPC.PriceUnit,
+        },
+      };
+    }
+
+    return res;
+  }
+
   public parseGetTransactionResponse(res: TransactionWithHash): GetTransactionResponse {
     return {
       calldata: 'calldata' in res ? res.calldata : [],

diff --git a/src/utils/responseParser/sequencer.ts b/src/utils/responseParser/sequencer.ts