starknet 3.8.0 → 3.9.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [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

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.js

@@ -240,7 +240,7 @@ var Account = /** @class */ (function (_super) {
       _c = _b.blockIdentifier,
       blockIdentifier = _c === void 0 ? 'pending' : _c;
     return __awaiter(this, void 0, void 0, function () {
-      var transactions, nonce, _d, signerDetails, signature, calldata;
+      var transactions, nonce, _d, version, signerDetails, signature, calldata;
       return __generator(this, function (_e) {
         switch (_e.label) {
           case 0:
@@ -255,10 +255,12 @@ var Account = /** @class */ (function (_super) {
             _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 4:
@@ -281,6 +283,7 @@ var Account = /** @class */ (function (_super) {
                   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),
                 }
               ),
@@ -298,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;
     }
@@ -306,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, { 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.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)];
       });
     });
   };

package/dist/account/default.js

@@ -117,7 +117,7 @@ var Account = /** @class */ (function (_super) {
     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, _d, signerDetails, signature, calldata;
+            var transactions, nonce, _d, version, signerDetails, signature, calldata;
             return __generator(this, function (_e) {
                 switch (_e.label) {
                     case 0:
@@ -131,10 +131,12 @@ var Account = /** @class */ (function (_super) {
                         _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 4:
@@ -144,6 +146,7 @@ var Account = /** @class */ (function (_super) {
                                 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),
                             })];
                 }
@@ -159,42 +162,44 @@ 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; }
         if (transactionsDetail === void 0) { 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, { 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([], __read((0, transaction_1.fromCallsToExecuteCalldata)(transactions)), false), [signerDetails.nonce.toString()], false);
                         return [2 /*return*/, this.fetchEndpoint('add_transaction', undefined, {
                                 type: 'INVOKE_FUNCTION',

package/dist/contract/default.js

@@ -116,8 +116,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)];
             });
         });
     };

package/dist/signer/default.js

@@ -58,7 +58,7 @@ var Signer = /** @class */ (function () {
                 if (abis && abis.length !== transactions.length) {
                     throw new Error('ABI must be provided for each transaction or no transaction');
                 }
-                msgHash = (0, hash_1.hashMulticall)(transactionsDetail.walletAddress, transactions, transactionsDetail.nonce.toString(), transactionsDetail.maxFee.toString());
+                msgHash = (0, hash_1.hashMulticall)(transactionsDetail.walletAddress, transactions, transactionsDetail.nonce.toString(), transactionsDetail.maxFee.toString(), transactionsDetail.version.toString());
                 return [2 /*return*/, (0, ellipticCurve_1.sign)(this.keyPair, msgHash)];
             });
         });

package/dist/types/api.d.ts

@@ -92,6 +92,7 @@ export declare type InvokeFunctionTransaction = {
     calldata?: RawCalldata;
     nonce?: BigNumberish;
     max_fee?: BigNumberish;
+    version?: BigNumberish;
 };
 export declare type InvokeFunctionTrace = {
     caller_address: string;

package/dist/types/lib.d.ts

@@ -18,6 +18,7 @@ export declare type Call = Omit<Invocation, 'signature'>;
 export declare type InvocationsDetails = {
     nonce?: BigNumberish;
     maxFee?: BigNumberish;
+    version?: BigNumberish;
 };
 export declare type Status = 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
 export declare type TransactionStatus = 'TRANSACTION_RECEIVED';

package/dist/utils/hash.d.ts

@@ -3,6 +3,7 @@ import { Call } from '../types';
 import { BigNumberish } from './number';
 export declare const transactionPrefix: string;
 export declare const transactionVersion = 0;
+export declare const feeTransactionVersion: BN;
 /**
  * Function to get the starknet keccak hash from a string
  *
@@ -21,4 +22,4 @@ export declare function starknetKeccak(value: string): BN;
 export declare function getSelectorFromName(funcName: string): string;
 export declare function pedersen(input: [BigNumberish, BigNumberish]): string;
 export declare function computeHashOnElements(data: BigNumberish[]): string;
-export declare function hashMulticall(account: string, transactions: Call[], nonce: string, maxFee: string): string;
+export declare function hashMulticall(account: string, transactions: Call[], nonce: string, maxFee: string, version?: string | number): string;

package/dist/utils/hash.js

@@ -28,7 +28,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hashMulticall = exports.computeHashOnElements = exports.pedersen = exports.getSelectorFromName = exports.starknetKeccak = exports.transactionVersion = exports.transactionPrefix = void 0;
+exports.hashMulticall = exports.computeHashOnElements = exports.pedersen = exports.getSelectorFromName = exports.starknetKeccak = exports.feeTransactionVersion = exports.transactionVersion = exports.transactionPrefix = void 0;
 var keccak_1 = require("ethereum-cryptography/keccak");
 var minimalistic_assert_1 = __importDefault(require("minimalistic-assert"));
 var constants_1 = require("../constants");
@@ -38,6 +38,7 @@ var number_1 = require("./number");
 var shortString_1 = require("./shortString");
 exports.transactionPrefix = (0, shortString_1.encodeShortString)('StarkNet Transaction');
 exports.transactionVersion = 0;
+exports.feeTransactionVersion = (0, number_1.toBN)(2).pow((0, number_1.toBN)(128)).add((0, number_1.toBN)(exports.transactionVersion));
 function keccakHex(value) {
     return (0, encode_1.addHexPrefix)((0, encode_1.buf2hex)((0, keccak_1.keccak256)((0, encode_1.utf8ToArray)(value))));
 }
@@ -88,7 +89,8 @@ function computeHashOnElements(data) {
     return __spreadArray(__spreadArray([], __read(data), false), [data.length], false).reduce(function (x, y) { return pedersen([x, y]); }, 0).toString();
 }
 exports.computeHashOnElements = computeHashOnElements;
-function hashMulticall(account, transactions, nonce, maxFee) {
+function hashMulticall(account, transactions, nonce, maxFee, version) {
+    if (version === void 0) { version = exports.transactionVersion; }
     var hashArray = transactions
         .map(function (_a) {
         var contractAddress = _a.contractAddress, entrypoint = _a.entrypoint, calldata = _a.calldata;
@@ -106,7 +108,7 @@ function hashMulticall(account, transactions, nonce, maxFee) {
         computeHashOnElements(hashArray),
         nonce,
         maxFee,
-        exports.transactionVersion,
+        version,
     ]);
 }
 exports.hashMulticall = hashMulticall;

package/dist/utils/stark.d.ts

@@ -1,4 +1,6 @@
+import BN from 'bn.js';
 import { Calldata, CompressedProgram, Program, RawArgs, Signature } from '../types';
+import { BigNumberish } from './number';
 /**
  * Function to compress compiled cairo program
  *
@@ -11,3 +13,4 @@ export declare function randomAddress(): string;
 export declare function makeAddress(input: string): string;
 export declare function formatSignature(sig?: Signature): string[];
 export declare function compileCalldata(args: RawArgs): Calldata;
+export declare function estimatedFeeToMaxFee(estimatedFee: BigNumberish, overhead?: number): BN;

package/dist/utils/stark.js

@@ -25,7 +25,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compileCalldata = exports.formatSignature = exports.makeAddress = exports.randomAddress = exports.compressProgram = void 0;
+exports.estimatedFeeToMaxFee = exports.compileCalldata = exports.formatSignature = exports.makeAddress = exports.randomAddress = exports.compressProgram = void 0;
 var pako_1 = require("pako");
 var ellipticCurve_1 = require("./ellipticCurve");
 var encode_1 = require("./encode");
@@ -82,3 +82,10 @@ function compileCalldata(args) {
     });
 }
 exports.compileCalldata = compileCalldata;
+function estimatedFeeToMaxFee(estimatedFee, overhead) {
+    if (overhead === void 0) { overhead = 0.15; }
+    // BN can only handle Integers, so we need to do all calulations with integers
+    var overHeadPercent = Math.round((1 + overhead) * 100);
+    return (0, number_1.toBN)(estimatedFee).mul((0, number_1.toBN)(overHeadPercent)).div((0, number_1.toBN)(100));
+}
+exports.estimatedFeeToMaxFee = estimatedFeeToMaxFee;

package/dist/utils/typedData/index.d.ts

@@ -47,8 +47,8 @@ export declare const encodeData: <T extends {
     }[]>;
     primaryType: string;
     domain: {
-        name?: string | undefined;
         version?: string | undefined;
+        name?: string | undefined;
         chainId?: string | number | undefined;
     };
     message: Record<string, unknown>;
@@ -74,8 +74,8 @@ export declare const getStructHash: <T extends {
     }[]>;
     primaryType: string;
     domain: {
-        name?: string | undefined;
         version?: string | undefined;
+        name?: string | undefined;
         chainId?: string | number | undefined;
     };
     message: Record<string, unknown>;

package/dist/utils/typedData/types.d.ts

@@ -25,8 +25,8 @@ export declare const STARKNET_TYPE: import("superstruct").Struct<{
  */
 export declare type StarkNetType = Infer<typeof STARKNET_TYPE>;
 export declare const STARKNET_DOMAIN_TYPE: import("superstruct").Struct<{
-    name?: string | undefined;
     version?: string | undefined;
+    name?: string | undefined;
     chainId?: string | number | undefined;
 }, {
     name: import("superstruct").Struct<string | undefined, null>;
@@ -49,8 +49,8 @@ export declare const STARKNET_TYPED_DATA_TYPE: import("superstruct").Struct<{
     }[]>;
     primaryType: string;
     domain: {
-        name?: string | undefined;
         version?: string | undefined;
+        name?: string | undefined;
         chainId?: string | number | undefined;
     };
     message: Record<string, unknown>;
@@ -66,8 +66,8 @@ export declare const STARKNET_TYPED_DATA_TYPE: import("superstruct").Struct<{
     }[]>, null>;
     primaryType: import("superstruct").Struct<string, null>;
     domain: import("superstruct").Struct<{
-        name?: string | undefined;
         version?: string | undefined;
+        name?: string | undefined;
         chainId?: string | number | undefined;
     }, {
         name: import("superstruct").Struct<string | undefined, null>;

package/dist/utils/typedData/utils.d.ts

@@ -16,8 +16,8 @@ export declare const validateTypedData: (data: unknown) => data is {
     }[]>;
     primaryType: string;
     domain: {
-        name?: string | undefined;
         version?: string | undefined;
+        name?: string | undefined;
         chainId?: string | number | undefined;
     };
     message: Record<string, unknown>;

package/package.json

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

package/signer/default.js

@@ -157,7 +157,8 @@ var Signer = /** @class */ (function () {
           transactionsDetail.walletAddress,
           transactions,
           transactionsDetail.nonce.toString(),
-          transactionsDetail.maxFee.toString()
+          transactionsDetail.maxFee.toString(),
+          transactionsDetail.version.toString()
         );
         return [2 /*return*/, (0, ellipticCurve_1.sign)(this.keyPair, msgHash)];
       });

package/src/account/default.ts

@@ -17,12 +17,13 @@ import {
 import { sign } from '../utils/ellipticCurve';
 import {
   computeHashOnElements,
+  feeTransactionVersion,
   getSelectorFromName,
   transactionPrefix,
   transactionVersion,
 } from '../utils/hash';
 import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN, toHex } from '../utils/number';
-import { compileCalldata } from '../utils/stark';
+import { compileCalldata, estimatedFeeToMaxFee } from '../utils/stark';
 import { fromCallsToExecuteCalldata } from '../utils/transaction';
 import { TypedData, getMessageHash } from '../utils/typedData';
 import { AccountInterface } from './interface';
@@ -56,10 +57,12 @@ export class Account extends Provider implements AccountInterface {
   ): Promise<EstimateFeeResponse> {
     const transactions = Array.isArray(calls) ? calls : [calls];
     const nonce = providedNonce ?? (await this.getNonce());
+    const version = toBN(feeTransactionVersion);
     const signerDetails = {
       walletAddress: this.address,
       nonce: toBN(nonce),
       maxFee: toBN('0'),
+      version,
     };
     const signature = await this.signer.signTransaction(transactions, signerDetails);
 
@@ -71,6 +74,7 @@ export class Account extends Provider implements AccountInterface {
         contract_address: this.address,
         entry_point_selector: getSelectorFromName('__execute__'),
         calldata,
+        version: toHex(version),
         signature: bigNumberishArrayToDecimalStringArray(signature),
       }
     );
@@ -91,12 +95,18 @@ export class Account extends Provider implements AccountInterface {
   ): Promise<AddTransactionResponse> {
     const transactions = Array.isArray(calls) ? calls : [calls];
     const nonce = toBN(transactionsDetail.nonce ?? (await this.getNonce()));
-    const maxFee =
-      transactionsDetail.maxFee ?? (await this.estimateFee(transactions, { nonce })).amount;
+    let maxFee: BigNumberish = '0';
+    if (transactionsDetail.maxFee) {
+      maxFee = transactionsDetail.maxFee;
+    } else {
+      const estimatedFee = (await this.estimateFee(transactions, { nonce })).amount;
+      maxFee = estimatedFeeToMaxFee(estimatedFee).toString();
+    }
     const signerDetails = {
       walletAddress: this.address,
       nonce,
       maxFee,
+      version: toBN(transactionVersion),
     };
 
     const signature = await this.signer.signTransaction(transactions, signerDetails, abis);

package/src/contract/default.ts

@@ -46,7 +46,18 @@ function buildCall(contract: Contract, functionAbi: FunctionAbi): AsyncContractF
  */
 function buildInvoke(contract: Contract, functionAbi: FunctionAbi): AsyncContractFunction {
   return async function (...args: Array<any>): Promise<any> {
-    return contract.invoke(functionAbi.name, args);
+    const { inputs } = functionAbi;
+    const inputsLength = inputs.reduce((acc, input) => {
+      if (!/_len$/.test(input.name)) {
+        return acc + 1;
+      }
+      return acc;
+    }, 0);
+    const options = {};
+    if (inputsLength + 1 === args.length && typeof args[args.length - 1] === 'object') {
+      Object.assign(options, args.pop());
+    }
+    return contract.invoke(functionAbi.name, args, options);
   };
 }
 

package/src/signer/default.ts

@@ -29,7 +29,8 @@ export class Signer implements SignerInterface {
       transactionsDetail.walletAddress,
       transactions,
       transactionsDetail.nonce.toString(),
-      transactionsDetail.maxFee.toString()
+      transactionsDetail.maxFee.toString(),
+      transactionsDetail.version.toString()
     );
 
     return sign(this.keyPair, msgHash);

package/src/types/api.ts

@@ -105,6 +105,7 @@ export type InvokeFunctionTransaction = {
   calldata?: RawCalldata;
   nonce?: BigNumberish;
   max_fee?: BigNumberish;
+  version?: BigNumberish;
 };
 
 export type InvokeFunctionTrace = {

package/src/types/lib.ts

@@ -24,6 +24,7 @@ export type Call = Omit<Invocation, 'signature'>;
 export type InvocationsDetails = {
   nonce?: BigNumberish;
   maxFee?: BigNumberish;
+  version?: BigNumberish;
 };
 
 export type Status =

package/src/utils/hash.ts

@@ -11,6 +11,7 @@ import { encodeShortString } from './shortString';
 
 export const transactionPrefix = encodeShortString('StarkNet Transaction');
 export const transactionVersion = 0;
+export const feeTransactionVersion = toBN(2).pow(toBN(128)).add(toBN(transactionVersion));
 
 function keccakHex(value: string): string {
   return addHexPrefix(buf2hex(keccak256(utf8ToArray(value))));
@@ -68,7 +69,8 @@ export function hashMulticall(
   account: string,
   transactions: Call[],
   nonce: string,
-  maxFee: string
+  maxFee: string,
+  version: string | number = transactionVersion
 ) {
   const hashArray = transactions
     .map(({ contractAddress, entrypoint, calldata }) => [
@@ -85,6 +87,6 @@ export function hashMulticall(
     computeHashOnElements(hashArray),
     nonce,
     maxFee,
-    transactionVersion,
+    version,
   ]);
 }

package/src/utils/stark.ts

@@ -1,10 +1,11 @@
+import BN from 'bn.js';
 import { gzip } from 'pako';
 
 import { Calldata, CompressedProgram, Program, RawArgs, Signature } from '../types';
 import { genKeyPair, getStarkKey } from './ellipticCurve';
 import { addHexPrefix, btoaUniversal } from './encode';
 import { stringify } from './json';
-import { toBN } from './number';
+import { BigNumberish, toBN } from './number';
 
 /**
  * Function to compress compiled cairo program
@@ -48,3 +49,9 @@ export function compileCalldata(args: RawArgs): Calldata {
     return toBN(value).toString();
   });
 }
+
+export function estimatedFeeToMaxFee(estimatedFee: BigNumberish, overhead: number = 0.15): BN {
+  // BN can only handle Integers, so we need to do all calulations with integers
+  const overHeadPercent = Math.round((1 + overhead) * 100);
+  return toBN(estimatedFee).mul(toBN(overHeadPercent)).div(toBN(100));
+}

package/types/api.d.ts

@@ -101,6 +101,7 @@ export declare type InvokeFunctionTransaction = {
   calldata?: RawCalldata;
   nonce?: BigNumberish;
   max_fee?: BigNumberish;
+  version?: BigNumberish;
 };
 export declare type InvokeFunctionTrace = {
   caller_address: string;

package/types/lib.d.ts

@@ -19,6 +19,7 @@ export declare type Call = Omit<Invocation, 'signature'>;
 export declare type InvocationsDetails = {
   nonce?: BigNumberish;
   maxFee?: BigNumberish;
+  version?: BigNumberish;
 };
 export declare type Status =
   | 'NOT_RECEIVED'

package/utils/hash.d.ts

@@ -4,6 +4,7 @@ import { Call } from '../types';
 import { BigNumberish } from './number';
 export declare const transactionPrefix: string;
 export declare const transactionVersion = 0;
+export declare const feeTransactionVersion: BN;
 /**
  * Function to get the starknet keccak hash from a string
  *
@@ -26,5 +27,6 @@ export declare function hashMulticall(
   account: string,
   transactions: Call[],
   nonce: string,
-  maxFee: string
+  maxFee: string,
+  version?: string | number
 ): string;

package/utils/hash.js

@@ -44,6 +44,7 @@ exports.hashMulticall =
   exports.pedersen =
   exports.getSelectorFromName =
   exports.starknetKeccak =
+  exports.feeTransactionVersion =
   exports.transactionVersion =
   exports.transactionPrefix =
     void 0;
@@ -56,6 +57,9 @@ var number_1 = require('./number');
 var shortString_1 = require('./shortString');
 exports.transactionPrefix = (0, shortString_1.encodeShortString)('StarkNet Transaction');
 exports.transactionVersion = 0;
+exports.feeTransactionVersion = (0, number_1.toBN)(2)
+  .pow((0, number_1.toBN)(128))
+  .add((0, number_1.toBN)(exports.transactionVersion));
 function keccakHex(value) {
   return (0, encode_1.addHexPrefix)(
     (0, encode_1.buf2hex)((0, keccak_1.keccak256)((0, encode_1.utf8ToArray)(value)))
@@ -116,7 +120,10 @@ function computeHashOnElements(data) {
     .toString();
 }
 exports.computeHashOnElements = computeHashOnElements;
-function hashMulticall(account, transactions, nonce, maxFee) {
+function hashMulticall(account, transactions, nonce, maxFee, version) {
+  if (version === void 0) {
+    version = exports.transactionVersion;
+  }
   var hashArray = transactions
     .map(function (_a) {
       var contractAddress = _a.contractAddress,
@@ -136,7 +143,7 @@ function hashMulticall(account, transactions, nonce, maxFee) {
     computeHashOnElements(hashArray),
     nonce,
     maxFee,
-    exports.transactionVersion,
+    version,
   ]);
 }
 exports.hashMulticall = hashMulticall;

package/utils/stark.d.ts

@@ -1,4 +1,7 @@
+import BN from 'bn.js';
+
 import { Calldata, CompressedProgram, Program, RawArgs, Signature } from '../types';
+import { BigNumberish } from './number';
 /**
  * Function to compress compiled cairo program
  *
@@ -11,3 +14,4 @@ export declare function randomAddress(): string;
 export declare function makeAddress(input: string): string;
 export declare function formatSignature(sig?: Signature): string[];
 export declare function compileCalldata(args: RawArgs): Calldata;
+export declare function estimatedFeeToMaxFee(estimatedFee: BigNumberish, overhead?: number): BN;

package/utils/stark.js

@@ -34,7 +34,8 @@ var __spreadArray =
     return to.concat(ar || Array.prototype.slice.call(from));
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.compileCalldata =
+exports.estimatedFeeToMaxFee =
+  exports.compileCalldata =
   exports.formatSignature =
   exports.makeAddress =
   exports.randomAddress =
@@ -111,3 +112,14 @@ function compileCalldata(args) {
   });
 }
 exports.compileCalldata = compileCalldata;
+function estimatedFeeToMaxFee(estimatedFee, overhead) {
+  if (overhead === void 0) {
+    overhead = 0.15;
+  }
+  // BN can only handle Integers, so we need to do all calulations with integers
+  var overHeadPercent = Math.round((1 + overhead) * 100);
+  return (0, number_1.toBN)(estimatedFee)
+    .mul((0, number_1.toBN)(overHeadPercent))
+    .div((0, number_1.toBN)(100));
+}
+exports.estimatedFeeToMaxFee = estimatedFeeToMaxFee;

package/utils/typedData/index.d.ts

@@ -55,8 +55,8 @@ export declare const encodeData: <
     >;
     primaryType: string;
     domain: {
-      name?: string | undefined;
       version?: string | undefined;
+      name?: string | undefined;
       chainId?: string | number | undefined;
     };
     message: Record<string, unknown>;
@@ -91,8 +91,8 @@ export declare const getStructHash: <
     >;
     primaryType: string;
     domain: {
-      name?: string | undefined;
       version?: string | undefined;
+      name?: string | undefined;
       chainId?: string | number | undefined;
     };
     message: Record<string, unknown>;

package/utils/typedData/types.d.ts

@@ -29,8 +29,8 @@ export declare const STARKNET_TYPE: import('superstruct').Struct<
 export declare type StarkNetType = Infer<typeof STARKNET_TYPE>;
 export declare const STARKNET_DOMAIN_TYPE: import('superstruct').Struct<
   {
-    name?: string | undefined;
     version?: string | undefined;
+    name?: string | undefined;
     chainId?: string | number | undefined;
   },
   {
@@ -59,8 +59,8 @@ export declare const STARKNET_TYPED_DATA_TYPE: import('superstruct').Struct<
     >;
     primaryType: string;
     domain: {
-      name?: string | undefined;
       version?: string | undefined;
+      name?: string | undefined;
       chainId?: string | number | undefined;
     };
     message: Record<string, unknown>;
@@ -84,8 +84,8 @@ export declare const STARKNET_TYPED_DATA_TYPE: import('superstruct').Struct<
     primaryType: import('superstruct').Struct<string, null>;
     domain: import('superstruct').Struct<
       {
-        name?: string | undefined;
         version?: string | undefined;
+        name?: string | undefined;
         chainId?: string | number | undefined;
       },
       {

package/utils/typedData/utils.d.ts

@@ -19,8 +19,8 @@ export declare const validateTypedData: (data: unknown) => data is {
   >;
   primaryType: string;
   domain: {
-    name?: string | undefined;
     version?: string | undefined;
+    name?: string | undefined;
     chainId?: string | number | undefined;
   };
   message: Record<string, unknown>;