Merge pull request #463 from 0xs34n/v5/refactor-1

V5/refactor 1
starknet-io · Feb 10, 2023 · e17ff17 · e17ff17
2 parents 558b20e + 9339212
commit e17ff17
Show file tree

Hide file tree

Showing 21 changed files with 160 additions and 113 deletions.
diff --git a/__tests__/account.test.ts b/__tests__/account.test.ts
@@ -1,5 +1,5 @@
 import typedDataExample from '../__mocks__/typedDataExample.json';
-import { Account, Contract, Provider, ec, number, stark } from '../src';
+import { Account, Contract, Provider, TransactionStatus, ec, number, stark } from '../src';
 import { parseUDCEvent } from '../src/utils/events';
 import { calculateContractAddressFromHash, feeTransactionVersion } from '../src/utils/hash';
 import { cleanHex, hexToDecimalString, toBigInt, toHex } from '../src/utils/number';
@@ -123,7 +123,9 @@ describe('deploy and test Wallet', () => {
       calldata: [erc20.address, '10', '0'],
     });
 
-    await provider.waitForTransaction(transaction_hash, undefined, ['ACCEPTED_ON_L2']);
+    await provider.waitForTransaction(transaction_hash, {
+      successStates: [TransactionStatus.ACCEPTED_ON_L2],
+    });
   });
 
   test('read balance of wallet after transfer', async () => {
@@ -162,7 +164,9 @@ describe('deploy and test Wallet', () => {
       },
     ]);
 
-    await provider.waitForTransaction(transaction_hash, undefined, ['ACCEPTED_ON_L2']);
+    await provider.waitForTransaction(transaction_hash, {
+      successStates: [TransactionStatus.ACCEPTED_ON_L2],
+    });
 
     const response = await dapp.get_number(account.address);
     expect(toBigInt(response.number as string).toString()).toStrictEqual('57');

diff --git a/__tests__/fixtures.ts b/__tests__/fixtures.ts
@@ -2,7 +2,7 @@ import fs from 'fs';
 import path from 'path';
 
 import { Account, ProviderInterface, RpcProvider, SequencerProvider, json } from '../src';
-import { CompiledContract } from '../src/types';
+import { CompiledContract, waitForTransactionOptions } from '../src/types';
 import { toHex } from '../src/utils/number';
 
 const readContract = (name: string): CompiledContract =>
@@ -51,8 +51,11 @@ export const getTestProvider = (): ProviderInterface => {
   if (IS_LOCALHOST_DEVNET) {
     // accelerate the tests when running locally
     const originalWaitForTransaction = provider.waitForTransaction.bind(provider);
-    provider.waitForTransaction = (txHash: string, retryInterval?: number) => {
-      return originalWaitForTransaction(txHash, retryInterval || 1000);
+    provider.waitForTransaction = (
+      txHash: string,
+      { retryInterval }: waitForTransactionOptions = {}
+    ) => {
+      return originalWaitForTransaction(txHash, { retryInterval: retryInterval || 1000 });
     };
   }
 

diff --git a/__tests__/utils/ellipticalCurve.test.ts b/__tests__/utils/ellipticalCurve.test.ts
@@ -56,7 +56,7 @@ test('hashMessage()', () => {
     transactionVersion,
     calldata,
     maxFee,
-    StarknetChainId.TESTNET,
+    StarknetChainId.SN_GOERLI,
     nonce
   );
 

diff --git a/__tests__/utils/starknetId.test.ts b/__tests__/utils/starknetId.test.ts
@@ -36,15 +36,15 @@ describe('Should tets StarknetId utils', () => {
   });
 
   test('Should test getStarknetIdContract', () => {
-    expect(getStarknetIdContract(StarknetChainId.TESTNET)).toBe(
+    expect(getStarknetIdContract(StarknetChainId.SN_GOERLI)).toBe(
       '0x05cf267a0af6101667013fc6bd3f6c11116a14cda9b8c4b1198520d59f900b17'
     );
 
     expect(() => {
-      getStarknetIdContract(StarknetChainId.TESTNET2);
+      getStarknetIdContract(StarknetChainId.SN_GOERLI2);
     }).toThrow();
 
-    expect(getStarknetIdContract(StarknetChainId.MAINNET)).toBe(
+    expect(getStarknetIdContract(StarknetChainId.SN_MAIN)).toBe(
       '0x6ac597f8116f886fa1c97a23fa4e08299975ecaf6b598873ca6792b9bbfb678'
     );
   });

diff --git a/__tests__/utils/transactionHash.test.ts b/__tests__/utils/transactionHash.test.ts
@@ -10,7 +10,7 @@ describe('calculateTransactionHashCommon()', () => {
       '0x64',
       [],
       '0x0',
-      StarknetChainId.TESTNET
+      StarknetChainId.SN_GOERLI
     );
     expect(result).toBe('0x7d260744de9d8c55e7675a34512d1951a7b262c79e685d26599edd2948de959');
   });

diff --git a/package-lock.json b/package-lock.json
diff --git a/src/account/default.ts b/src/account/default.ts
@@ -26,6 +26,8 @@ import {
   MultiDeployContractResponse,
   Signature,
   TransactionBulk,
+  TransactionStatus,
+  TransactionType,
   UniversalDeployerContractPayload,
 } from '../types';
 import { EstimateFeeBulk, TransactionSimulation } from '../types/account';
@@ -111,13 +113,6 @@ export class Account extends Provider implements AccountInterface {
     }
   }
 
-  public async estimateFee(
-    calls: AllowArray<Call>,
-    estimateFeeDetails?: EstimateFeeDetails | undefined
-  ): Promise<EstimateFee> {
-    return this.estimateInvokeFee(calls, estimateFeeDetails);
-  }
-
   public async estimateInvokeFee(
     calls: AllowArray<Call>,
     { nonce: providedNonce, blockIdentifier }: EstimateFeeDetails = {}
@@ -315,7 +310,10 @@ export class Account extends Provider implements AccountInterface {
     const nonce = toBigInt(transactionsDetail.nonce ?? (await this.getNonce()));
     const maxFee =
       transactionsDetail.maxFee ??
-      (await this.getSuggestedMaxFee({ type: 'INVOKE', payload: calls }, transactionsDetail));
+      (await this.getSuggestedMaxFee(
+        { type: TransactionType.INVOKE, payload: calls },
+        transactionsDetail
+      ));
     const version = toBigInt(transactionVersion);
     const chainId = await this.getChainId();
 
@@ -352,7 +350,7 @@ export class Account extends Provider implements AccountInterface {
     const maxFee =
       transactionsDetail.maxFee ??
       (await this.getSuggestedMaxFee(
-        { type: 'DECLARE', payload: { classHash, contract } }, // Provide the classHash to avoid re-computing it
+        { type: TransactionType.DECLARE, payload: { classHash, contract } }, // Provide the classHash to avoid re-computing it
         transactionsDetail
       ));
 
@@ -431,9 +429,9 @@ export class Account extends Provider implements AccountInterface {
     details?: InvocationsDetails | undefined
   ): Promise<DeployContractUDCResponse> {
     const deployTx = await this.deploy(payload, details);
-    const txReceipt = await this.waitForTransaction(deployTx.transaction_hash, undefined, [
-      'ACCEPTED_ON_L2',
-    ]);
+    const txReceipt = await this.waitForTransaction(deployTx.transaction_hash, {
+      successStates: [TransactionStatus.ACCEPTED_ON_L2],
+    });
     return parseUDCEvent(txReceipt);
   }
 
@@ -443,7 +441,9 @@ export class Account extends Provider implements AccountInterface {
   ): Promise<DeclareDeployUDCResponse> {
     const { contract, constructorCalldata, salt, unique } = payload;
     const { transaction_hash, class_hash } = await this.declare({ contract }, details);
-    const declare = await this.waitForTransaction(transaction_hash, undefined, ['ACCEPTED_ON_L2']);
+    const declare = await this.waitForTransaction(transaction_hash, {
+      successStates: [TransactionStatus.ACCEPTED_ON_L2],
+    });
     const deploy = await this.deployContract(
       { classHash: class_hash, salt, unique, constructorCalldata },
       details
@@ -472,7 +472,7 @@ export class Account extends Provider implements AccountInterface {
       transactionsDetail.maxFee ??
       (await this.getSuggestedMaxFee(
         {
-          type: 'DEPLOY_ACCOUNT',
+          type: TransactionType.DEPLOY_ACCOUNT,
           payload: { classHash, constructorCalldata, addressSalt, contractAddress },
         },
         transactionsDetail
@@ -535,19 +535,19 @@ export class Account extends Provider implements AccountInterface {
     let feeEstimate: EstimateFee;
 
     switch (type) {
-      case 'INVOKE':
+      case TransactionType.INVOKE:
         feeEstimate = await this.estimateInvokeFee(payload, details);
         break;
 
-      case 'DECLARE':
+      case TransactionType.DECLARE:
         feeEstimate = await this.estimateDeclareFee(payload, details);
         break;
 
-      case 'DEPLOY_ACCOUNT':
+      case TransactionType.DEPLOY_ACCOUNT:
         feeEstimate = await this.estimateAccountDeployFee(payload, details);
         break;
 
-      case 'DEPLOY':
+      case TransactionType.DEPLOY:
         feeEstimate = await this.estimateDeployFee(payload, details);
         break;
 

diff --git a/src/account/interface.ts b/src/account/interface.ts
@@ -32,22 +32,6 @@ export abstract class AccountInterface extends ProviderInterface {
 
   public abstract signer: SignerInterface;
 
-  /**
-   * @deprecated Use estimateInvokeFee or estimateDeclareFee instead
-   * Estimate Fee for executing an INVOKE transaction on starknet
-   *
-   * @param calls the invocation object containing:
-   * - contractAddress - the address of the contract
-   * - entrypoint - the entrypoint of the contract
-   * - calldata - (defaults to []) the calldata
-   *
-   * @returns response from estimate_fee
-   */
-  public abstract estimateFee(
-    calls: AllowArray<Call>,
-    estimateFeeDetails?: EstimateFeeDetails
-  ): Promise<EstimateFeeResponse>;
-
   /**
    * Estimate Fee for executing an INVOKE transaction on starknet
    *

diff --git a/src/constants.ts b/src/constants.ts
@@ -5,11 +5,24 @@ export const MASK_250 = 2n ** 250n - 1n; // 2 ** 250 - 1
 export const MASK_251 = 2n ** 251n;
 export const API_VERSION = ZERO;
 
+export enum BaseUrl {
+  SN_MAIN = 'https://alpha-mainnet.starknet.io',
+  SN_GOERLI = 'https://alpha4.starknet.io',
+  SN_GOERLI2 = 'https://alpha4-2.starknet.io',
+}
+
+export enum NetworkName {
+  SN_MAIN = 'SN_MAIN',
+  SN_GOERLI = 'SN_GOERLI',
+  SN_GOERLI2 = 'SN_GOERLI2',
+}
+
 export enum StarknetChainId {
-  MAINNET = '0x534e5f4d41494e', // encodeShortString('SN_MAIN'),
-  TESTNET = '0x534e5f474f45524c49', // encodeShortString('SN_GOERLI'),
-  TESTNET2 = '0x534e5f474f45524c4932',
+  SN_MAIN = '0x534e5f4d41494e', // encodeShortString('SN_MAIN'),
+  SN_GOERLI = '0x534e5f474f45524c49', // encodeShortString('SN_GOERLI'),
+  SN_GOERLI2 = '0x534e5f474f45524c4932', // encodeShortString('SN_GOERLI2'),
 }
+
 export enum TransactionHashPrefix {
   DECLARE = '0x6465636c617265', // encodeShortString('declare'),
   DEPLOY = '0x6465706c6f79', // encodeShortString('deploy'),

diff --git a/src/provider/default.ts b/src/provider/default.ts
@@ -17,8 +17,8 @@ import {
   InvocationBulk,
   InvocationsDetailsWithNonce,
   InvokeFunctionResponse,
-  Status,
   TransactionSimulationResponse,
+  waitForTransactionOptions,
 } from '../types';
 import { BigNumberish } from '../utils/number';
 import { ProviderInterface } from './interface';
@@ -185,10 +185,9 @@ export class Provider implements ProviderInterface {
 
   public async waitForTransaction(
     txHash: BigNumberish,
-    retryInterval?: number,
-    successStates?: Array<Status>
+    options: waitForTransactionOptions
   ): Promise<GetTransactionReceiptResponse> {
-    return this.provider.waitForTransaction(txHash, retryInterval, successStates);
+    return this.provider.waitForTransaction(txHash, options);
   }
 
   public async getSimulateTransaction(

diff --git a/src/provider/interface.ts b/src/provider/interface.ts
@@ -18,8 +18,8 @@ import type {
   InvocationBulk,
   InvocationsDetailsWithNonce,
   InvokeFunctionResponse,
-  Status,
   TransactionSimulationResponse,
+  waitForTransactionOptions,
 } from '../types';
 import type { BigNumberish } from '../utils/number';
 import { BlockIdentifier } from './utils';
@@ -293,8 +293,7 @@ export abstract class ProviderInterface {
    */
   public abstract waitForTransaction(
     txHash: BigNumberish,
-    retryInterval?: number,
-    successStates?: Array<Status>
+    options?: waitForTransactionOptions
   ): Promise<GetTransactionReceiptResponse>;
 
   /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,7 +10,7 @@ describe('calculateTransactionHashCommon()', () => { @@
           '0x64',
           [],
           '0x0',
-          StarknetChainId.TESTNET
+          StarknetChainId.SN_GOERLI
         );
         expect(result).toBe('0x7d260744de9d8c55e7675a34512d1951a7b262c79e685d26599edd2948de959');
       });
@@ Expand Down @@