starknet 3.2.0 → 3.3.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [3.3.0](https://github.com/seanjameshan/starknet.js/compare/v3.2.0...v3.3.0) (2022-03-08)
+
+### Features
+
+- **provider:** add back legacy `invokeFunction` ([dbd00ff](https://github.com/seanjameshan/starknet.js/commit/dbd00ff822456f05df5ba1967d5cd0040b012fc0))
+
 # [3.2.0](https://github.com/seanjameshan/starknet.js/compare/v3.1.0...v3.2.0) (2022-03-04)
 
 ### Features

package/__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');

package/__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 () => {

package/__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', () => {

package/dist/provider/default.d.ts

@@ -1,4 +1,4 @@
-import { Abi, AddTransactionResponse, Call, CallContractResponse, DeployContractPayload, Endpoints, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, Invocation, TransactionReceipt } from '../types';
+import { Abi, AddTransactionResponse, Call, CallContractResponse, DeployContractPayload, Endpoints, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, Invocation, Signature, TransactionReceipt } from '../types';
 import { BigNumberish } from '../utils/number';
 import { ProviderInterface } from './interface';
 import { BlockIdentifier } from './utils';
@@ -109,6 +109,15 @@ export declare class Provider implements ProviderInterface {
      * @returns a confirmation of sending a transaction on the starknet contract
      */
     deployContract(payload: DeployContractPayload, _abi?: Abi): Promise<AddTransactionResponse>;
+    /**
+     * Invokes a function on starknet
+     * @deprecated This method wont be supported as soon as fees are mandatory
+     *
+     * @param invocation
+     * @param _abi - (optional) signature to send along
+     * @returns response from addTransaction
+     */
+    invokeFunction(invocation: Invocation, _abi?: Abi): Promise<AddTransactionResponse>;
     /**
      * Invokes a function on starknet
      * @deprecated This method wont be supported as soon as fees are mandatory
@@ -119,7 +128,11 @@ export declare class Provider implements ProviderInterface {
      * @param signature - (optional) signature to send along
      * @returns response from addTransaction
      */
-    invokeFunction(invocation: Invocation, _abi?: Abi): Promise<AddTransactionResponse>;
+    LEGACY_invokeFunction(contractAddress: string, entrypointSelector: string, calldata?: string[], signature?: Signature): Promise<AddTransactionResponse>;
+    waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+    /**
+     * @deprecated use `waitForTransaction` instead
+     */
     waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }
 export {};

package/dist/provider/default.js

@@ -371,10 +371,8 @@ var Provider = /** @class */ (function () {
      * Invokes a function on starknet
      * @deprecated This method wont be supported as soon as fees are mandatory
      *
-     * @param contractAddress - target contract address for invoke
-     * @param entrypointSelector - target entrypoint selector for
-     * @param calldata - (optional, default []) calldata
-     * @param signature - (optional) signature to send along
+     * @param invocation
+     * @param _abi - (optional) signature to send along
      * @returns response from addTransaction
      */
     Provider.prototype.invokeFunction = function (invocation, _abi) {
@@ -387,7 +385,26 @@ var Provider = /** @class */ (function () {
             signature: (0, number_1.bigNumberishArrayToDecimalStringArray)((_b = invocation.signature) !== null && _b !== void 0 ? _b : []),
         });
     };
-    Provider.prototype.waitForTx = function (txHash, retryInterval) {
+    /**
+     * Invokes a function on starknet
+     * @deprecated This method wont be supported as soon as fees are mandatory
+     *
+     * @param contractAddress - target contract address for invoke
+     * @param entrypointSelector - target entrypoint selector for
+     * @param calldata - (optional, default []) calldata
+     * @param signature - (optional) signature to send along
+     * @returns response from addTransaction
+     */
+    Provider.prototype.LEGACY_invokeFunction = function (contractAddress, entrypointSelector, calldata, signature) {
+        return this.fetchEndpoint('add_transaction', undefined, {
+            type: 'INVOKE_FUNCTION',
+            contract_address: contractAddress,
+            entry_point_selector: entrypointSelector,
+            calldata: (0, number_1.bigNumberishArrayToDecimalStringArray)(calldata !== null && calldata !== void 0 ? calldata : []),
+            signature: (0, number_1.bigNumberishArrayToDecimalStringArray)(signature !== null && signature !== void 0 ? signature : []),
+        });
+    };
+    Provider.prototype.waitForTransaction = function (txHash, retryInterval) {
         if (retryInterval === void 0) { retryInterval = 8000; }
         return __awaiter(this, void 0, void 0, function () {
             var onchain, res, message, error;
@@ -426,6 +443,17 @@ var Provider = /** @class */ (function () {
             });
         });
     };
+    /**
+     * @deprecated use `waitForTransaction` instead
+     */
+    Provider.prototype.waitForTx = function (txHash, retryInterval) {
+        if (retryInterval === void 0) { retryInterval = 8000; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.waitForTransaction(txHash, retryInterval)];
+            });
+        });
+    };
     return Provider;
 }());
 exports.Provider = Provider;

package/dist/provider/interface.d.ts

@@ -97,5 +97,9 @@ export declare abstract class ProviderInterface {
      * @returns response from addTransaction
      */
     abstract invokeFunction(invocation: Invocation): Promise<AddTransactionResponse>;
-    abstract waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+    abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+    /**
+     * @deprecated use `waitForTransaction` instead
+     */
+    abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/provider/default.d.ts

@@ -11,6 +11,7 @@ import {
   GetTransactionResponse,
   GetTransactionStatusResponse,
   Invocation,
+  Signature,
   TransactionReceipt,
 } from '../types';
 import { BigNumberish } from '../utils/number';
@@ -146,6 +147,15 @@ export declare class Provider implements ProviderInterface {
    * @returns a confirmation of sending a transaction on the starknet contract
    */
   deployContract(payload: DeployContractPayload, _abi?: Abi): Promise<AddTransactionResponse>;
+  /**
+   * Invokes a function on starknet
+   * @deprecated This method wont be supported as soon as fees are mandatory
+   *
+   * @param invocation
+   * @param _abi - (optional) signature to send along
+   * @returns response from addTransaction
+   */
+  invokeFunction(invocation: Invocation, _abi?: Abi): Promise<AddTransactionResponse>;
   /**
    * Invokes a function on starknet
    * @deprecated This method wont be supported as soon as fees are mandatory
@@ -156,7 +166,16 @@ export declare class Provider implements ProviderInterface {
    * @param signature - (optional) signature to send along
    * @returns response from addTransaction
    */
-  invokeFunction(invocation: Invocation, _abi?: Abi): Promise<AddTransactionResponse>;
+  LEGACY_invokeFunction(
+    contractAddress: string,
+    entrypointSelector: string,
+    calldata?: string[],
+    signature?: Signature
+  ): Promise<AddTransactionResponse>;
+  waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+  /**
+   * @deprecated use `waitForTransaction` instead
+   */
   waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }
 export {};

package/provider/default.js

@@ -550,10 +550,8 @@ var Provider = /** @class */ (function () {
    * Invokes a function on starknet
    * @deprecated This method wont be supported as soon as fees are mandatory
    *
-   * @param contractAddress - target contract address for invoke
-   * @param entrypointSelector - target entrypoint selector for
-   * @param calldata - (optional, default []) calldata
-   * @param signature - (optional) signature to send along
+   * @param invocation
+   * @param _abi - (optional) signature to send along
    * @returns response from addTransaction
    */
   Provider.prototype.invokeFunction = function (invocation, _abi) {
@@ -570,7 +568,35 @@ var Provider = /** @class */ (function () {
       ),
     });
   };
-  Provider.prototype.waitForTx = function (txHash, retryInterval) {
+  /**
+   * Invokes a function on starknet
+   * @deprecated This method wont be supported as soon as fees are mandatory
+   *
+   * @param contractAddress - target contract address for invoke
+   * @param entrypointSelector - target entrypoint selector for
+   * @param calldata - (optional, default []) calldata
+   * @param signature - (optional) signature to send along
+   * @returns response from addTransaction
+   */
+  Provider.prototype.LEGACY_invokeFunction = function (
+    contractAddress,
+    entrypointSelector,
+    calldata,
+    signature
+  ) {
+    return this.fetchEndpoint('add_transaction', undefined, {
+      type: 'INVOKE_FUNCTION',
+      contract_address: contractAddress,
+      entry_point_selector: entrypointSelector,
+      calldata: (0, number_1.bigNumberishArrayToDecimalStringArray)(
+        calldata !== null && calldata !== void 0 ? calldata : []
+      ),
+      signature: (0, number_1.bigNumberishArrayToDecimalStringArray)(
+        signature !== null && signature !== void 0 ? signature : []
+      ),
+    });
+  };
+  Provider.prototype.waitForTransaction = function (txHash, retryInterval) {
     if (retryInterval === void 0) {
       retryInterval = 8000;
     }
@@ -615,6 +641,19 @@ var Provider = /** @class */ (function () {
       });
     });
   };
+  /**
+   * @deprecated use `waitForTransaction` instead
+   */
+  Provider.prototype.waitForTx = function (txHash, retryInterval) {
+    if (retryInterval === void 0) {
+      retryInterval = 8000;
+    }
+    return __awaiter(this, void 0, void 0, function () {
+      return __generator(this, function (_a) {
+        return [2 /*return*/, this.waitForTransaction(txHash, retryInterval)];
+      });
+    });
+  };
   return Provider;
 })();
 exports.Provider = Provider;

package/provider/interface.d.ts

@@ -122,5 +122,9 @@ export declare abstract class ProviderInterface {
    * @returns response from addTransaction
    */
   abstract invokeFunction(invocation: Invocation): Promise<AddTransactionResponse>;
-  abstract waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+  abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+  /**
+   * @deprecated use `waitForTransaction` instead
+   */
+  abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }

package/src/provider/default.ts

@@ -15,6 +15,7 @@ import {
   GetTransactionResponse,
   GetTransactionStatusResponse,
   Invocation,
+  Signature,
   TransactionReceipt,
 } from '../types';
 import { getSelectorFromName } from '../utils/hash';
@@ -317,10 +318,8 @@ export class Provider implements ProviderInterface {
    * Invokes a function on starknet
    * @deprecated This method wont be supported as soon as fees are mandatory
    *
-   * @param contractAddress - target contract address for invoke
-   * @param entrypointSelector - target entrypoint selector for
-   * @param calldata - (optional, default []) calldata
-   * @param signature - (optional) signature to send along
+   * @param invocation
+   * @param _abi - (optional) signature to send along
    * @returns response from addTransaction
    */
   public invokeFunction(invocation: Invocation, _abi?: Abi): Promise<AddTransactionResponse> {
@@ -333,7 +332,32 @@ export class Provider implements ProviderInterface {
     });
   }
 
-  public async waitForTx(txHash: BigNumberish, retryInterval: number = 8000) {
+  /**
+   * Invokes a function on starknet
+   * @deprecated This method wont be supported as soon as fees are mandatory
+   *
+   * @param contractAddress - target contract address for invoke
+   * @param entrypointSelector - target entrypoint selector for
+   * @param calldata - (optional, default []) calldata
+   * @param signature - (optional) signature to send along
+   * @returns response from addTransaction
+   */
+  public LEGACY_invokeFunction(
+    contractAddress: string,
+    entrypointSelector: string,
+    calldata?: string[],
+    signature?: Signature
+  ): Promise<AddTransactionResponse> {
+    return this.fetchEndpoint('add_transaction', undefined, {
+      type: 'INVOKE_FUNCTION',
+      contract_address: contractAddress,
+      entry_point_selector: entrypointSelector,
+      calldata: bigNumberishArrayToDecimalStringArray(calldata ?? []),
+      signature: bigNumberishArrayToDecimalStringArray(signature ?? []),
+    });
+  }
+
+  public async waitForTransaction(txHash: BigNumberish, retryInterval: number = 8000) {
     let onchain = false;
     await wait(retryInterval);
 
@@ -355,4 +379,11 @@ export class Provider implements ProviderInterface {
       }
     }
   }
+
+  /**
+   * @deprecated use `waitForTransaction` instead
+   */
+  public async waitForTx(txHash: BigNumberish, retryInterval: number = 8000) {
+    return this.waitForTransaction(txHash, retryInterval);
+  }
 }

package/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>;
 }