starknet 3.7.0 → 3.10.0

package/__tests__/utils/ellipticalCurve.test.ts

@@ -1,7 +1,15 @@
+import { StarknetChainId } from '../../src/constants';
 import { ec, getKeyPair, getStarkKey, sign, verify } from '../../src/utils/ellipticCurve';
 import { removeHexPrefix } from '../../src/utils/encode';
-import { computeHashOnElements, hashMulticall, pedersen } from '../../src/utils/hash';
+import {
+  calculcateTransactionHash,
+  computeHashOnElements,
+  getSelectorFromName,
+  pedersen,
+  transactionVersion,
+} from '../../src/utils/hash';
 import { toBN, toHex } from '../../src/utils/number';
+import { fromCallsToExecuteCalldataWithNonce } from '../../src/utils/transaction';
 
 test('getKeyPair()', () => {
   const privateKey = '0x019800ea6a9a73f94aee6a3d2edf018fc770443e90c7ba121e8303ec6b349279';
@@ -42,17 +50,27 @@ test('hashMessage()', () => {
   ];
   const nonce = '3';
   const maxFee = '0';
-  const hashMsg = hashMulticall(account, transactions, nonce, maxFee);
-  expect(hashMsg).toBe(
-    toHex(toBN('1608351043472325350463069815257733118091727529101532499046754244230898025592'))
+  const calldata = fromCallsToExecuteCalldataWithNonce(transactions, nonce);
+
+  const hashMsg = calculcateTransactionHash(
+    account,
+    transactionVersion,
+    getSelectorFromName('__execute__'),
+    calldata,
+    maxFee,
+    StarknetChainId.TESTNET
+  );
+
+  expect(hashMsg).toMatchInlineSnapshot(
+    `"0x4c337c6bf32b2cf2b8ae54064e4b982c214660e8d0423b431a3fde10b9b9c02"`
   );
   const keyPair = getKeyPair(privateKey);
   const [r, s] = sign(keyPair, removeHexPrefix(hashMsg));
-  expect(r.toString()).toStrictEqual(
-    toBN('1079537730825246752292590270213864261175133133352510235773017189606850691611').toString()
+  expect(r.toString()).toMatchInlineSnapshot(
+    `"1944132633844378384908742523072599391732300777648030785844673145513474741467"`
   );
-  expect(s.toString()).toStrictEqual(
-    toBN('2904560423220491364719171767721067837294296476624248675613584621502231297000').toString()
+  expect(s.toString()).toMatchInlineSnapshot(
+    `"1067771353159635307522498807851959257107695451405842425488451092336556917559"`
   );
 });
 

package/__tests__/utils/transactionHash.test.ts

@@ -0,0 +1,17 @@
+import { StarknetChainId, TransactionHashPrefix } from '../../src/constants';
+import { calculateTransactionHashCommon } from '../../src/utils/hash';
+
+describe('calculateTransactionHashCommon()', () => {
+  test('should match most simple python output', () => {
+    const result = calculateTransactionHashCommon(
+      TransactionHashPrefix.INVOKE,
+      '0x0',
+      '0x2a',
+      '0x64',
+      [],
+      '0x0',
+      StarknetChainId.TESTNET
+    );
+    expect(result).toBe('0x7d260744de9d8c55e7675a34512d1951a7b262c79e685d26599edd2948de959');
+  });
+});

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,5 @@
 import { Provider } from '../provider';
+import { BlockIdentifier } from '../provider/utils';
 import { SignerInterface } from '../signer';
 import {
   Abi,
@@ -18,7 +19,16 @@ export declare class Account extends Provider implements AccountInterface {
   private signer;
   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

@@ -197,11 +197,13 @@ var __importDefault =
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.Account = void 0;
 var minimalistic_assert_1 = __importDefault(require('minimalistic-assert'));
+var constants_1 = require('../constants');
 var provider_1 = require('../provider');
 var signer_1 = require('../signer');
 var ellipticCurve_1 = require('../utils/ellipticCurve');
 var hash_1 = require('../utils/hash');
 var number_1 = require('../utils/number');
+var shortString_1 = require('../utils/shortString');
 var stark_1 = require('../utils/stark');
 var transaction_1 = require('../utils/transaction');
 var typedData_1 = require('../utils/typedData');
@@ -234,41 +236,52 @@ 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'),
+              maxFee: constants_1.ZERO,
+              version: version,
+              chainId: this.chainId,
             };
             return [4 /*yield*/, this.signer.signTransaction(transactions, signerDetails)];
-          case 2:
-            signature = _a.sent();
-            calldata = __spreadArray(
-              __spreadArray(
-                [],
-                __read((0, transaction_1.fromCallsToExecuteCalldata)(transactions)),
-                false
-              ),
-              [signerDetails.nonce.toString()],
-              false
-            );
+          case 4:
+            signature = _e.sent();
+            calldata = (0, transaction_1.fromCallsToExecuteCalldataWithNonce)(transactions, nonce);
             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),
+                }
+              ),
             ];
         }
       });
@@ -283,7 +296,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;
     }
@@ -291,51 +304,46 @@ 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))
+            nonce = _b.apply(void 0, [_c]);
+            maxFee = '0';
+            if (!(transactionsDetail.maxFee || transactionsDetail.maxFee === 0))
               return [3 /*break*/, 4];
-            _e = _b;
+            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),
+              chainId: this.chainId,
             };
             return [4 /*yield*/, this.signer.signTransaction(transactions, signerDetails, abis)];
           case 7:
-            signature = _f.sent();
-            calldata = __spreadArray(
-              __spreadArray(
-                [],
-                __read((0, transaction_1.fromCallsToExecuteCalldata)(transactions)),
-                false
-              ),
-              [signerDetails.nonce.toString()],
-              false
-            );
+            signature = _d.sent();
+            calldata = (0, transaction_1.fromCallsToExecuteCalldataWithNonce)(transactions, nonce);
             return [
               2 /*return*/,
               this.fetchEndpoint('add_transaction', undefined, {
@@ -372,7 +380,7 @@ var Account = /** @class */ (function (_super) {
           .map(number_1.bigNumberishArrayToDecimalStringArray)
           .map(hash_1.computeHashOnElements);
         return (0,
-        hash_1.computeHashOnElements)([hash_1.transactionPrefix, account, (0, hash_1.computeHashOnElements)(hashArray), nonce, maxFee, hash_1.transactionVersion]);
+        hash_1.computeHashOnElements)([(0, shortString_1.encodeShortString)('StarkNet Transaction'), account, (0, hash_1.computeHashOnElements)(hashArray), nonce, maxFee, hash_1.transactionVersion]);
       }
       var nonceBn,
         result,

package/constants.d.ts

@@ -5,6 +5,15 @@ export declare const ONE: import('bn.js');
 export declare const TWO: import('bn.js');
 export declare const MASK_250: import('bn.js');
 export declare const MASK_251: import('bn.js');
+export declare enum StarknetChainId {
+  MAINNET = '0x534e5f4d41494e',
+  TESTNET = '0x534e5f474f45524c49',
+}
+export declare enum TransactionHashPrefix {
+  DEPLOY = '0x6465706c6f79',
+  INVOKE = '0x696e766f6b65',
+  L1_HANDLER = '0x6c315f68616e646c6572',
+}
 /**
  * The following is taken from https://github.com/starkware-libs/starkex-resources/blob/master/crypto/starkware/crypto/signature/pedersen_params.json but converted to hex, because JS is very bad handling big integers by default
  * Please do not edit until the JSON changes.

package/constants.js

@@ -8,6 +8,8 @@ exports.CONSTANT_POINTS =
   exports.FIELD_SIZE =
   exports.FIELD_GEN =
   exports.FIELD_PRIME =
+  exports.TransactionHashPrefix =
+  exports.StarknetChainId =
   exports.MASK_251 =
   exports.MASK_250 =
   exports.TWO =
@@ -28,6 +30,17 @@ exports.ONE = (0, number_1.toBN)(1);
 exports.TWO = (0, number_1.toBN)(2);
 exports.MASK_250 = exports.TWO.pow((0, number_1.toBN)(250)).sub(exports.ONE); // 2 ** 250 - 1
 exports.MASK_251 = exports.TWO.pow((0, number_1.toBN)(251));
+var StarknetChainId;
+(function (StarknetChainId) {
+  StarknetChainId['MAINNET'] = '0x534e5f4d41494e';
+  StarknetChainId['TESTNET'] = '0x534e5f474f45524c49';
+})((StarknetChainId = exports.StarknetChainId || (exports.StarknetChainId = {})));
+var TransactionHashPrefix;
+(function (TransactionHashPrefix) {
+  TransactionHashPrefix['DEPLOY'] = '0x6465706c6f79';
+  TransactionHashPrefix['INVOKE'] = '0x696e766f6b65';
+  TransactionHashPrefix['L1_HANDLER'] = '0x6c315f68616e646c6572';
+})((TransactionHashPrefix = exports.TransactionHashPrefix || (exports.TransactionHashPrefix = {})));
 /**
  * The following is taken from https://github.com/starkware-libs/starkex-resources/blob/master/crypto/starkware/crypto/signature/pedersen_params.json but converted to hex, because JS is very bad handling big integers by default
  * Please do not edit until the JSON changes.

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,5 @@
 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';
@@ -9,7 +10,10 @@ export declare class Account extends Provider implements AccountInterface {
     private signer;
     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
      *