Merge pull request #187 from 0xs34n/bugfix/handle-bignumber-fetch-response

Author: janek26

__tests__/account.test.ts

@@ -1,3 +1,5 @@
+import { isBN } from 'bn.js';
+
 import typedDataExample from '../__mocks__/typedDataExample.json';
 import { Account, Contract, defaultProvider, ec, number, stark } from '../src';
 import { toBN } from '../src/utils/number';
@@ -50,7 +52,7 @@ describe('deploy and test Wallet', () => {
       entrypoint: 'transfer',
       calldata: [erc20.address, '10'],
     });
-    expect(typeof amount).toBe('number');
+    expect(isBN(amount)).toBe(true);
     expect(typeof unit).toBe('string');
   });
 

__tests__/provider.test.ts

@@ -76,9 +76,9 @@ describe('defaultProvider', () => {
 
     test('getTransactionReceipt', async () => {
       return expect(
-        defaultProvider.getTransactionReceipt({
-          txHash: '0x37013e1cb9c133e6fe51b4b371b76b317a480f56d80576730754c1662582348',
-        })
+        defaultProvider.getTransactionReceipt(
+          '0x37013e1cb9c133e6fe51b4b371b76b317a480f56d80576730754c1662582348'
+        )
       ).resolves.not.toThrow();
     });
 

src/provider/default.ts

@@ -10,21 +10,22 @@ import {
   CompiledContract,
   DeployContractPayload,
   Endpoints,
+  EstimateFeeResponse,
   GetBlockResponse,
   GetCodeResponse,
   GetContractAddressesResponse,
   GetTransactionResponse,
   GetTransactionStatusResponse,
   GetTransactionTraceResponse,
   Invocation,
-  TransactionReceipt,
+  TransactionReceiptResponse,
 } from '../types';
 import { getSelectorFromName } from '../utils/hash';
 import { parse, stringify } from '../utils/json';
 import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN, toHex } from '../utils/number';
 import { compressProgram, randomAddress } from '../utils/stark';
 import { ProviderInterface } from './interface';
-import { BlockIdentifier, getFormattedBlockIdentifier, txIdentifier } from './utils';
+import { BlockIdentifier, getFormattedBlockIdentifier } from './utils';
 
 type NetworkName = 'mainnet-alpha' | 'goerli-alpha';
 
@@ -153,6 +154,17 @@ export class Provider implements ProviderInterface {
     try {
       const { data } = await axios.request<Endpoints[T]['RESPONSE']>({
         method,
+        transformResponse:
+          endpoint === 'estimate_fee'
+            ? (res): EstimateFeeResponse => {
+                return parse(res, (_, v) => {
+                  if (v && typeof v === 'bigint') {
+                    return toBN(v.toString());
+                  }
+                  return v;
+                });
+              }
+            : axios.defaults.transformResponse,
         url: urljoin(baseUrl, endpoint, queryString),
         data: stringify(request),
         headers,
@@ -272,22 +284,12 @@ export class Provider implements ProviderInterface {
    * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
    *
    * @param txHash
-   * @param txId
    * @returns the transaction receipt object
    */
 
-  public async getTransactionReceipt({
-    txHash,
-    txId,
-  }: {
-    txHash?: BigNumberish;
-    txId?: BigNumberish;
-  }): Promise<TransactionReceipt> {
-    const { data } = await axios.get<TransactionReceipt>(
-      urljoin(this.feederGatewayUrl, 'get_transaction_receipt', `?${txIdentifier(txHash, txId)}`)
-    );
-
-    return data;
+  public async getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse> {
+    const txHashHex = toHex(toBN(txHash));
+    return this.fetchEndpoint('get_transaction_receipt', { transactionHash: txHashHex });
   }
 
   /**

src/provider/interface.ts

@@ -10,7 +10,7 @@ import type {
   GetTransactionResponse,
   GetTransactionStatusResponse,
   Invocation,
-  TransactionReceipt,
+  TransactionReceiptResponse,
 } from '../types';
 import type { BigNumberish } from '../utils/number';
 import { BlockIdentifier } from './utils';
@@ -109,13 +109,7 @@ export abstract class ProviderInterface {
    */
   public abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
 
-  public abstract getTransactionReceipt({
-    txHash,
-    txId,
-  }: {
-    txHash?: BigNumberish;
-    txId?: BigNumberish;
-  }): Promise<TransactionReceipt>;
+  public abstract getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse>;
 
   /**
    * Deploys a given compiled contract (json) to starknet

src/types/api.ts

@@ -1,3 +1,5 @@
+import BN from 'bn.js';
+
 import { BlockIdentifier } from '../provider/utils';
 import { BigNumberish } from '../utils/number';
 import {
@@ -43,6 +45,13 @@ export type Endpoints = {
     REQUEST: never;
     RESPONSE: GetTransactionTraceResponse;
   };
+  get_transaction_receipt: {
+    QUERY: {
+      transactionHash: string;
+    };
+    REQUEST: never;
+    RESPONSE: TransactionReceiptResponse;
+  };
   get_storage_at: {
     QUERY: {
       contractAddress: string;
@@ -217,7 +226,7 @@ export type AddTransactionResponse = {
   address?: string;
 };
 
-export type TransactionReceipt = {
+export type TransactionReceiptResponse = {
   status: Status;
   transaction_hash: string;
   transaction_index: number;
@@ -228,7 +237,7 @@ export type TransactionReceipt = {
 };
 
 export type EstimateFeeResponse = {
-  amount: number;
+  amount: BN;
   unit: string;
 };