starknet 3.6.0 → 3.9.0

package/CHANGELOG.md

@@ -1,3 +1,38 @@
+# [3.9.0](https://github.com/seanjameshan/starknet.js/compare/v3.8.0...v3.9.0) (2022-04-08)
+
+### Bug Fixes
+
+- **account:** adding overhead on estimateFee for maxFee ([ec52f61](https://github.com/seanjameshan/starknet.js/commit/ec52f61aed9a8755491a4b7de73517b075785479))
+- **contract:** override object when invoking a function ([c605151](https://github.com/seanjameshan/starknet.js/commit/c605151c03b544bf62ff9ab2e314e49de3cd562a))
+- estimatedFeeToMaxFee with integers only ([71d19a7](https://github.com/seanjameshan/starknet.js/commit/71d19a7db01630ca0dba55011ff440243d7db992))
+- rename txVersion to version ([2ae36b2](https://github.com/seanjameshan/starknet.js/commit/2ae36b2c075dbee4710abe47770af35478ceba4e))
+- **utils:** remove check for the BN ([50a7951](https://github.com/seanjameshan/starknet.js/commit/50a79514343e303c397358efdba978fec5f93f48))
+
+### Features
+
+- **account:** adding new transaction version for fee estimation ([2f7cb3f](https://github.com/seanjameshan/starknet.js/commit/2f7cb3fe85c973bcff3e39db333a9ed969c550b1))
+
+# [3.8.0](https://github.com/seanjameshan/starknet.js/compare/v3.7.0...v3.8.0) (2022-04-04)
+
+### Bug Fixes
+
+- getBlock should not default to pending block ([7a641b5](https://github.com/seanjameshan/starknet.js/commit/7a641b55c3c762dada70814bf509b147f0cd315e))
+
+### Features
+
+- complete interface ([39d2f05](https://github.com/seanjameshan/starknet.js/commit/39d2f0574691e4b37a6050831b4e548b07a8e3e3))
+- default estimateFee to pending block ([719dda5](https://github.com/seanjameshan/starknet.js/commit/719dda5f33a2bed353bd1bf311a2baf3110d1654))
+- default to pending block ([d3c1bdc](https://github.com/seanjameshan/starknet.js/commit/d3c1bdcdca996bce273673cf9c8220156e965863))
+- pending as success ([9e79288](https://github.com/seanjameshan/starknet.js/commit/9e7928845cc1e7088ba9a8dc9ba8fb9311970440))
+
+# [3.7.0](https://github.com/seanjameshan/starknet.js/compare/v3.6.0...v3.7.0) (2022-03-24)
+
+### Features
+
+- **Account:** account constructor should take a KeyPair or a Signer as parameter ([ea6ae40](https://github.com/seanjameshan/starknet.js/commit/ea6ae40225d33e293b9d2de7c8509e87fb7a651e))
+- add BigInt support within BigNumberish ([e42427a](https://github.com/seanjameshan/starknet.js/commit/e42427afa9a57673576da68cfbbee1356ffb5c0d))
+- using typeguard to narrow variable's type in Account's constructor ([ed048f3](https://github.com/seanjameshan/starknet.js/commit/ed048f355bee815cc9b2ccc984db900059fa2303))
+
 # [3.6.0](https://github.com/seanjameshan/starknet.js/compare/v3.5.1...v3.6.0) (2022-03-24)
 
 ### Bug Fixes

package/README.md

@@ -40,62 +40,19 @@ Install starknet with `npm`
 
 ```bash
 $ npm install starknet
-# or
+# or for pre-release features:
 $ npm install starknet@next
 ```
 
-Import `starknet` and use the [API](https://www.starknetjs.com/modules.html)
-
-The following code is used to build a [simple AMM example](https://starkfin.netlify.app/) from the [cairo docs](https://www.cairo-lang.org/docs/hello_starknet/amm.html)
-
-```javascript
-import { defaultProvider, stark } from 'starknet';
-const { getSelectorFromName } = stark;
-
-const CONTRACT_ADDRESS =
-  "0x03e19baa6cb2078631bcdb34844f3f7879449a544c9ce722681a54af08cff4b9";
-
-/**
- * invokeFunction() example
-**/
-
-/** Reset the liquidity pool **/
-const addTokenResponse = await defaultProvider.invokeFunction(
-  {
-    contractAddress: CONTRACT_ADDRESS,
-    entrypoint: "init_pool",
-    calldata: ["1000000", "1000000"],
-  },
-  abi // for displaying purposes only (default implementation has no display/ui)
-);
-console.log(addTokenResponse);
-
-/**
- * callContract() example
-**/
-
-/** Get the balance of the liquidity pool of token A **/
-const poolBalanceTokenA = await defaultProvider.callContract({
-  contractAddress: CONTRACT_ADDRESS,
-  entrypoint: "get_pool_token_balance",
-  calldata: ["1"],
-});
-const balanceA = poolBalanceTokenA.result[0];
-console.log('token a liquidity pool balance: ', parseInt(balanceA, 16));
-
-/** Get the balance of the liquidity pool of token B **/
-const poolBalanceTokenB = await defaultProvider.callContract({
-  contractAddress: CONTRACT_ADDRESS,
-  entrypoint: "get_pool_token_balance",
-  calldata: ["2"],
-});
-const balanceB = poolBalanceTokenB.result[0];
-console.log('token b liquidity pool balance: ', parseInt(balanceB, 16));
-```
+Import `starknet` and use the [API](https://www.starknetjs.com/docs/API/)
+
+Please refer to the following code example [here](https://github.com/0xs34n/starknet.js-workshop/blob/main/index.js)
+
+Guides can be found [here](https://www.starknetjs.com/guides/intro)
 
 ## 🌐 API
 
-[Click Here](https://www.starknetjs.com/modules.html)
+[Click Here](https://www.starknetjs.com/docs/API/)
 
 ## 🚀 Powered by Starknet.js
 
@@ -105,11 +62,19 @@ console.log('token b liquidity pool balance: ', parseInt(balanceB, 16));
 
 ## ✏️ Contributing
 
-If you consider to contribute to this project please read [CONTRIBUTING.md](https://github.com/seanjameshan/starknet.js/blob/main/CONTRIBUTING.md) first.
+If you consider to contribute to this project please read [CONTRIBUTING.md](https://github.com/0xs34n/starknet.js/blob/main/CONTRIBUTING.md) first.
 
 ## ❤️ Special Thanks
 
-Special thanks to all the [contributors](https://github.com/seanjameshan/starknet.js/graphs/contributors), especially to Janek ([@janek26](https://github.com/janek26)) from [Argent](https://github.com/argentlabs) for driving the development of Starknet.js.
+Special thanks to all the [contributors](https://github.com/0xs34n/starknet.js/graphs/contributors), especially to:
+
+Janek ([@janek26](https://github.com/janek26)) and Axel ([@delaaxe](https://github.com/delaaxe)) from [Argent](https://github.com/argentlabs)
+
+Miljan ([@MilGard91](https://github.com/MilGard91)) from [Shard Labs](https://shardlabs.io/)
+
+Dhruv ([@dhruvkelawala](https://github.com/dhruvkelawala)) from [Jedi Swap](https://twitter.com/jediswap)
+
+and of course the [StarkWare](https://starkware.co/) team for their dedicated support!
 
 This library would not be possible without these rockstars.
 
@@ -117,4 +82,4 @@ This library would not be possible without these rockstars.
 
 Copyright (c) 2022 0xs34n
 
-Licensed under the [MIT license](https://github.com/seanjameshan/starknet.js/blob/main/LICENSE).
+Licensed under the [MIT license](https://github.com/0xs34n/starknet.js/blob/main/LICENSE).

package/__tests__/utils/utils.test.ts

@@ -77,3 +77,13 @@ describe('computeHashOnElements()', () => {
     );
   });
 });
+describe('estimatedFeeToMaxFee()', () => {
+  test('should return maxFee for 0', () => {
+    const res = stark.estimatedFeeToMaxFee(0, 0.15).toNumber();
+    expect(res).toBe(0);
+  });
+  test('should return maxFee for 10_000', () => {
+    const res = stark.estimatedFeeToMaxFee(10_000, 0.15).toNumber();
+    expect(res).toBe(11_500);
+  });
+});

package/account/default.d.ts

@@ -1,4 +1,6 @@
 import { Provider } from '../provider';
+import { BlockIdentifier } from '../provider/utils';
+import { SignerInterface } from '../signer';
 import {
   Abi,
   AddTransactionResponse,
@@ -15,9 +17,18 @@ import { AccountInterface } from './interface';
 export declare class Account extends Provider implements AccountInterface {
   address: string;
   private signer;
-  constructor(provider: Provider, address: string, keyPair: KeyPair);
+  constructor(provider: Provider, address: string, keyPairOrSigner: KeyPair | SignerInterface);
   getNonce(): Promise<string>;
-  estimateFee(calls: Call | Call[]): Promise<EstimateFeeResponse>;
+  estimateFee(
+    calls: Call | Call[],
+    {
+      nonce: providedNonce,
+      blockIdentifier,
+    }?: {
+      nonce?: BigNumberish;
+      blockIdentifier?: BlockIdentifier;
+    }
+  ): Promise<EstimateFeeResponse>;
   /**
    * Invoke execute function in account contract
    *

package/account/default.js

@@ -207,9 +207,10 @@ var transaction_1 = require('../utils/transaction');
 var typedData_1 = require('../utils/typedData');
 var Account = /** @class */ (function (_super) {
   __extends(Account, _super);
-  function Account(provider, address, keyPair) {
+  function Account(provider, address, keyPairOrSigner) {
     var _this = _super.call(this, provider) || this;
-    _this.signer = new signer_1.Signer(keyPair);
+    _this.signer =
+      'getPubKey' in keyPairOrSigner ? keyPairOrSigner : new signer_1.Signer(keyPairOrSigner);
     _this.address = address;
     return _this;
   }
@@ -233,24 +234,37 @@ var Account = /** @class */ (function (_super) {
       });
     });
   };
-  Account.prototype.estimateFee = function (calls) {
+  Account.prototype.estimateFee = function (calls, _a) {
+    var _b = _a === void 0 ? {} : _a,
+      providedNonce = _b.nonce,
+      _c = _b.blockIdentifier,
+      blockIdentifier = _c === void 0 ? 'pending' : _c;
     return __awaiter(this, void 0, void 0, function () {
-      var transactions, nonce, signerDetails, signature, calldata;
-      return __generator(this, function (_a) {
-        switch (_a.label) {
+      var transactions, nonce, _d, version, signerDetails, signature, calldata;
+      return __generator(this, function (_e) {
+        switch (_e.label) {
           case 0:
             transactions = Array.isArray(calls) ? calls : [calls];
-            return [4 /*yield*/, this.getNonce()];
+            if (!(providedNonce !== null && providedNonce !== void 0)) return [3 /*break*/, 1];
+            _d = providedNonce;
+            return [3 /*break*/, 3];
           case 1:
-            nonce = _a.sent();
+            return [4 /*yield*/, this.getNonce()];
+          case 2:
+            _d = _e.sent();
+            _e.label = 3;
+          case 3:
+            nonce = _d;
+            version = (0, number_1.toBN)(hash_1.feeTransactionVersion);
             signerDetails = {
               walletAddress: this.address,
               nonce: (0, number_1.toBN)(nonce),
               maxFee: (0, number_1.toBN)('0'),
+              version: version,
             };
             return [4 /*yield*/, this.signer.signTransaction(transactions, signerDetails)];
-          case 2:
-            signature = _a.sent();
+          case 4:
+            signature = _e.sent();
             calldata = __spreadArray(
               __spreadArray(
                 [],
@@ -262,12 +276,17 @@ var Account = /** @class */ (function (_super) {
             );
             return [
               2 /*return*/,
-              this.fetchEndpoint('estimate_fee', undefined, {
-                contract_address: this.address,
-                entry_point_selector: (0, hash_1.getSelectorFromName)('__execute__'),
-                calldata: calldata,
-                signature: (0, number_1.bigNumberishArrayToDecimalStringArray)(signature),
-              }),
+              this.fetchEndpoint(
+                'estimate_fee',
+                { blockIdentifier: blockIdentifier },
+                {
+                  contract_address: this.address,
+                  entry_point_selector: (0, hash_1.getSelectorFromName)('__execute__'),
+                  calldata: calldata,
+                  version: (0, number_1.toHex)(version),
+                  signature: (0, number_1.bigNumberishArrayToDecimalStringArray)(signature),
+                }
+              ),
             ];
         }
       });
@@ -282,7 +301,7 @@ var Account = /** @class */ (function (_super) {
    * @returns a confirmation of invoking a function on the starknet contract
    */
   Account.prototype.execute = function (calls, abis, transactionsDetail) {
-    var _a, _b;
+    var _a;
     if (abis === void 0) {
       abis = undefined;
     }
@@ -290,42 +309,43 @@ var Account = /** @class */ (function (_super) {
       transactionsDetail = {};
     }
     return __awaiter(this, void 0, void 0, function () {
-      var transactions, nonce, _c, _d, maxFee, _e, signerDetails, signature, calldata;
-      return __generator(this, function (_f) {
-        switch (_f.label) {
+      var transactions, nonce, _b, _c, maxFee, estimatedFee, signerDetails, signature, calldata;
+      return __generator(this, function (_d) {
+        switch (_d.label) {
           case 0:
             transactions = Array.isArray(calls) ? calls : [calls];
-            _c = number_1.toBN;
+            _b = number_1.toBN;
             if (!((_a = transactionsDetail.nonce) !== null && _a !== void 0))
               return [3 /*break*/, 1];
-            _d = _a;
+            _c = _a;
             return [3 /*break*/, 3];
           case 1:
             return [4 /*yield*/, this.getNonce()];
           case 2:
-            _d = _f.sent();
-            _f.label = 3;
+            _c = _d.sent();
+            _d.label = 3;
           case 3:
-            nonce = _c.apply(void 0, [_d]);
-            if (!((_b = transactionsDetail.maxFee) !== null && _b !== void 0))
-              return [3 /*break*/, 4];
-            _e = _b;
+            nonce = _b.apply(void 0, [_c]);
+            maxFee = '0';
+            if (!transactionsDetail.maxFee) return [3 /*break*/, 4];
+            maxFee = transactionsDetail.maxFee;
             return [3 /*break*/, 6];
           case 4:
-            return [4 /*yield*/, this.estimateFee(transactions)];
+            return [4 /*yield*/, this.estimateFee(transactions, { nonce: nonce })];
           case 5:
-            _e = _f.sent().amount;
-            _f.label = 6;
+            estimatedFee = _d.sent().amount;
+            maxFee = (0, stark_1.estimatedFeeToMaxFee)(estimatedFee).toString();
+            _d.label = 6;
           case 6:
-            maxFee = _e;
             signerDetails = {
               walletAddress: this.address,
               nonce: nonce,
               maxFee: maxFee,
+              version: (0, number_1.toBN)(hash_1.transactionVersion),
             };
             return [4 /*yield*/, this.signer.signTransaction(transactions, signerDetails, abis)];
           case 7:
-            signature = _f.sent();
+            signature = _d.sent();
             calldata = __spreadArray(
               __spreadArray(
                 [],

package/contract/default.d.ts

@@ -1,5 +1,6 @@
 import { AccountInterface } from '../account';
 import { ProviderInterface } from '../provider';
+import { BlockIdentifier } from '../provider/utils';
 import {
   Abi,
   AbiEntry,
@@ -9,6 +10,7 @@ import {
   Calldata,
   ContractFunction,
   Invocation,
+  Overrides,
   ParsedStruct,
   Result,
   StructAbi,
@@ -136,8 +138,16 @@ export declare class Contract implements ContractInterface {
    * @return - parsed response corresponding to the abi
    */
   protected parseResponse(method: string, response: string[]): Result;
-  invoke(method: string, args?: Array<any>): Promise<AddTransactionResponse>;
-  call(method: string, args?: Array<any>): Promise<Result>;
+  invoke(method: string, args?: Array<any>, options?: Overrides): Promise<AddTransactionResponse>;
+  call(
+    method: string,
+    args?: Array<any>,
+    {
+      blockIdentifier,
+    }?: {
+      blockIdentifier?: BlockIdentifier;
+    }
+  ): Promise<Result>;
   estimate(method: string, args?: Array<any>): Promise<import('../types').EstimateFeeResponse>;
   populate(method: string, args?: Array<any>): Invocation;
 }

package/contract/default.js

@@ -224,8 +224,20 @@ function buildInvoke(contract, functionAbi) {
       args[_i] = arguments[_i];
     }
     return __awaiter(this, void 0, void 0, function () {
+      var inputs, inputsLength, options;
       return __generator(this, function (_a) {
-        return [2 /*return*/, contract.invoke(functionAbi.name, args)];
+        inputs = functionAbi.inputs;
+        inputsLength = inputs.reduce(function (acc, input) {
+          if (!/_len$/.test(input.name)) {
+            return acc + 1;
+          }
+          return acc;
+        }, 0);
+        options = {};
+        if (inputsLength + 1 === args.length && typeof args[args.length - 1] === 'object') {
+          Object.assign(options, args.pop());
+        }
+        return [2 /*return*/, contract.invoke(functionAbi.name, args, options)];
       });
     });
   };
@@ -705,10 +717,13 @@ var Contract = /** @class */ (function () {
       return acc;
     }, []);
   };
-  Contract.prototype.invoke = function (method, args) {
+  Contract.prototype.invoke = function (method, args, options) {
     if (args === void 0) {
       args = [];
     }
+    if (options === void 0) {
+      options = {};
+    }
     // ensure contract is connected
     (0, minimalistic_assert_1.default)(
       this.address !== null,
@@ -725,10 +740,6 @@ var Contract = /** @class */ (function () {
       }
       return acc;
     }, 0);
-    var overrides = {};
-    if (args.length === inputsLength + 1 && Array.isArray(args[args.length - 1])) {
-      Object.assign(overrides, args.pop());
-    }
     if (args.length !== inputsLength) {
       throw Error(
         'Invalid number of arguments, expected ' +
@@ -746,22 +757,25 @@ var Contract = /** @class */ (function () {
     };
     if ('execute' in this.providerOrAccount) {
       return this.providerOrAccount.execute(invocation, undefined, {
-        maxFee: overrides.maxFee,
-        nonce: overrides.nonce,
+        maxFee: options.maxFee,
+        nonce: options.nonce,
       });
     }
     return this.providerOrAccount.invokeFunction(
-      __assign(__assign({}, invocation), { signature: overrides.signature || [] })
+      __assign(__assign({}, invocation), { signature: options.signature || [] })
     );
   };
-  Contract.prototype.call = function (method, args) {
+  Contract.prototype.call = function (method, args, _a) {
     if (args === void 0) {
       args = [];
     }
+    var _b = _a === void 0 ? {} : _a,
+      _c = _b.blockIdentifier,
+      blockIdentifier = _c === void 0 ? 'pending' : _c;
     return __awaiter(this, void 0, void 0, function () {
-      var inputs, inputsLength, options, calldata;
+      var inputs, calldata;
       var _this = this;
-      return __generator(this, function (_a) {
+      return __generator(this, function (_d) {
         // ensure contract is connected
         (0,
         minimalistic_assert_1.default)(this.address !== null, 'contract isnt connected to an address');
@@ -770,13 +784,6 @@ var Contract = /** @class */ (function () {
         inputs = this.abi.find(function (abi) {
           return abi.name === method;
         }).inputs;
-        inputsLength = inputs.length;
-        options = {
-          blockIdentifier: null,
-        };
-        if (args.length === inputsLength + 1 && typeof args[args.length - 1] === 'object') {
-          Object.assign(options, args.pop());
-        }
         calldata = this.compileCalldata(args, inputs);
         return [
           2 /*return*/,
@@ -787,7 +794,7 @@ var Contract = /** @class */ (function () {
                 calldata: calldata,
                 entrypoint: method,
               },
-              options
+              { blockIdentifier: blockIdentifier }
             )
             .then(function (x) {
               return _this.parseResponse(method, x.result);

package/contract/interface.d.ts

@@ -1,11 +1,13 @@
 import { AccountInterface } from '../account';
 import { ProviderInterface } from '../provider';
+import { BlockIdentifier } from '../provider/utils';
 import {
   Abi,
   AddTransactionResponse,
   AsyncContractFunction,
   ContractFunction,
   Invocation,
+  Overrides,
   Result,
 } from '../types';
 export declare abstract class ContractInterface {
@@ -52,7 +54,13 @@ export declare abstract class ContractInterface {
    * @param args Array of the arguments for the call
    * @returns Result of the call as an array with key value pars
    */
-  abstract call(method: string, args?: Array<any>): Promise<Result>;
+  abstract call(
+    method: string,
+    args?: Array<any>,
+    options?: {
+      blockIdentifier?: BlockIdentifier;
+    }
+  ): Promise<Result>;
   /**
    * Invokes a method on a contract
    *
@@ -60,14 +68,24 @@ export declare abstract class ContractInterface {
    * @param args Array of the arguments for the invoke
    * @returns Add Transaction Response
    */
-  abstract invoke(method: string, args?: Array<any>): Promise<AddTransactionResponse>;
+  abstract invoke(
+    method: string,
+    args?: Array<any>,
+    options?: Overrides
+  ): Promise<AddTransactionResponse>;
   /**
    * Calls a method on a contract
    *
    * @param method name of the method
    * @param args Array of the arguments for the call
    */
-  abstract estimate(method: string, args?: Array<any>): Promise<any>;
+  abstract estimate(
+    method: string,
+    args?: Array<any>,
+    options?: {
+      blockIdentifier?: BlockIdentifier;
+    }
+  ): Promise<any>;
   /**
    * Calls a method on a contract
    *

package/dist/account/default.d.ts

@@ -1,4 +1,6 @@
 import { Provider } from '../provider';
+import { BlockIdentifier } from '../provider/utils';
+import { SignerInterface } from '../signer';
 import { Abi, AddTransactionResponse, Call, EstimateFeeResponse, InvocationsDetails, KeyPair, Signature, Transaction } from '../types';
 import { BigNumberish } from '../utils/number';
 import { TypedData } from '../utils/typedData';
@@ -6,9 +8,12 @@ import { AccountInterface } from './interface';
 export declare class Account extends Provider implements AccountInterface {
     address: string;
     private signer;
-    constructor(provider: Provider, address: string, keyPair: KeyPair);
+    constructor(provider: Provider, address: string, keyPairOrSigner: KeyPair | SignerInterface);
     getNonce(): Promise<string>;
-    estimateFee(calls: Call | Call[]): Promise<EstimateFeeResponse>;
+    estimateFee(calls: Call | Call[], { nonce: providedNonce, blockIdentifier, }?: {
+        nonce?: BigNumberish;
+        blockIdentifier?: BlockIdentifier;
+    }): Promise<EstimateFeeResponse>;
     /**
      * Invoke execute function in account contract
      *