Merge pull request #136 from 0xs34n/refactor/rename

refactor(provider): rename `waitForTx` to `waitForTransaction`
starknet-io · Mar 8, 2022 · 570d1c2 · 570d1c2
2 parents b130516 + af4ef14
commit 570d1c2
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 12 deletions.
diff --git a/__tests__/account.test.ts b/__tests__/account.test.ts
@@ -47,7 +47,7 @@ describe('deploy and test Wallet', () => {
     });
     dapp = new Contract(compiledTestDapp.abi, dappResponse.address);
     expect(dappResponse.code).toBe('TRANSACTION_RECEIVED');
-    await defaultProvider.waitForTx(dappResponse.transaction_hash);
+    await defaultProvider.waitForTransaction(dappResponse.transaction_hash);
   });
 
   test('same wallet address', () => {
@@ -80,7 +80,7 @@ describe('deploy and test Wallet', () => {
     });
 
     expect(code).toBe('TRANSACTION_RECEIVED');
-    await defaultProvider.waitForTx(transaction_hash);
+    await defaultProvider.waitForTransaction(transaction_hash);
   });
 
   test('read balance of wallet after transfer', async () => {
@@ -108,7 +108,7 @@ describe('deploy and test Wallet', () => {
     );
 
     expect(code).toBe('TRANSACTION_RECEIVED');
-    await defaultProvider.waitForTx(transaction_hash);
+    await defaultProvider.waitForTransaction(transaction_hash);
   });
 
   test('execute multiple transactions', async () => {
@@ -126,7 +126,7 @@ describe('deploy and test Wallet', () => {
     ]);
 
     expect(code).toBe('TRANSACTION_RECEIVED');
-    await defaultProvider.waitForTx(transaction_hash);
+    await defaultProvider.waitForTransaction(transaction_hash);
 
     const response = await dapp.call('get_number', { user: account.address });
     expect(toBN(response.number as string).toString()).toStrictEqual('57');

diff --git a/__tests__/accountContract.test.ts b/__tests__/accountContract.test.ts
@@ -56,7 +56,7 @@ describe('deploy and test Wallet', () => {
       amount: '1000',
     });
     expect(mintResponse.code).toBe('TRANSACTION_RECEIVED');
-    await defaultProvider.waitForTx(mintResponse.transaction_hash);
+    await defaultProvider.waitForTransaction(mintResponse.transaction_hash);
   });
 
   test('read nonce', async () => {
@@ -96,7 +96,7 @@ describe('deploy and test Wallet', () => {
 
     expect(code).toBe('TRANSACTION_RECEIVED');
 
-    await defaultProvider.waitForTx(transaction_hash);
+    await defaultProvider.waitForTransaction(transaction_hash);
   });
 
   test('read balance of wallet after transfer', async () => {

diff --git a/__tests__/contract.test.ts b/__tests__/contract.test.ts
@@ -19,7 +19,7 @@ describe('class Contract {}', () => {
       });
       erc20 = new Contract(compiledErc20.abi, address, defaultProvider);
       expect(code).toBe('TRANSACTION_RECEIVED');
-      await defaultProvider.waitForTx(transaction_hash);
+      await defaultProvider.waitForTransaction(transaction_hash);
 
       // Deploy Multicall
 
@@ -35,7 +35,7 @@ describe('class Contract {}', () => {
 
       expect(m_code).toBe('TRANSACTION_RECEIVED');
 
-      await defaultProvider.waitForTx(m_transaction_hash);
+      await defaultProvider.waitForTransaction(m_transaction_hash);
     });
 
     test('read initial balance of that account', async () => {
@@ -52,7 +52,7 @@ describe('class Contract {}', () => {
       });
       expect(response.code).toBe('TRANSACTION_RECEIVED');
 
-      await defaultProvider.waitForTx(response.transaction_hash);
+      await defaultProvider.waitForTransaction(response.transaction_hash);
     });
 
     test('read balance after mint of that account', async () => {
@@ -93,7 +93,7 @@ describe('class Contract {}', () => {
       });
       contract = new Contract(compiledTypeTransformation.abi, address, defaultProvider);
       expect(code).toBe('TRANSACTION_RECEIVED');
-      await defaultProvider.waitForTx(transaction_hash);
+      await defaultProvider.waitForTransaction(transaction_hash);
     });
 
     describe('Request Type Transformation', () => {

diff --git a/src/provider/default.ts b/src/provider/default.ts
@@ -333,7 +333,7 @@ export class Provider implements ProviderInterface {
     });
   }
 
-  public async waitForTx(txHash: BigNumberish, retryInterval: number = 8000) {
+  public async waitForTransaction(txHash: BigNumberish, retryInterval: number = 8000) {
     let onchain = false;
     await wait(retryInterval);
 
@@ -355,4 +355,11 @@ export class Provider implements ProviderInterface {
       }
     }
   }
+
+  /**
+   * @deprecated use `waitForTransaction` instead
+   */
+  public async waitForTx(txHash: BigNumberish, retryInterval: number = 8000) {
+    return this.waitForTransaction(txHash, retryInterval);
+  }
 }
diff --git a/src/provider/interface.ts b/src/provider/interface.ts
@@ -137,5 +137,10 @@ export abstract class ProviderInterface {
    */
   public abstract invokeFunction(invocation: Invocation): Promise<AddTransactionResponse>;
 
-  public abstract waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+  public abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+
+  /**
+   * @deprecated use `waitForTransaction` instead
+   */
+  public abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }