starknet 3.1.0 → 3.4.0

package/dist/utils/hash.js

@@ -28,13 +28,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hashMessage = exports.hashCalldata = exports.computeHashOnElements = exports.pedersen = exports.starknetKeccak = void 0;
+exports.hashMulticall = exports.computeHashOnElements = exports.pedersen = exports.getSelectorFromName = exports.starknetKeccak = 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");
 var ellipticCurve_1 = require("./ellipticCurve");
 var encode_1 = require("./encode");
 var number_1 = require("./number");
+var shortString_1 = require("./shortString");
+exports.transactionPrefix = (0, shortString_1.encodeShortString)('StarkNet Transaction');
+exports.transactionVersion = 0;
 function keccakHex(value) {
     return (0, encode_1.addHexPrefix)((0, encode_1.buf2hex)((0, keccak_1.keccak256)((0, encode_1.utf8ToArray)(value))));
 }
@@ -49,6 +52,18 @@ function starknetKeccak(value) {
     return (0, number_1.toBN)(keccakHex(value)).and(constants_1.MASK_250);
 }
 exports.starknetKeccak = starknetKeccak;
+/**
+ * Function to get the hex selector from a given function name
+ *
+ * [Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/public/abi.py#L25-L26)
+ * @param funcName - selectors abi function name
+ * @returns hex selector of given abi function name
+ */
+function getSelectorFromName(funcName) {
+    // sometimes BigInteger pads the hex string with zeros, which isnt allowed in the starknet api
+    return (0, number_1.toHex)(starknetKeccak(funcName));
+}
+exports.getSelectorFromName = getSelectorFromName;
 var constantPoints = constants_1.CONSTANT_POINTS.map(function (coords) {
     return ellipticCurve_1.ec.curve.point(coords[0], coords[1]);
 });
@@ -73,12 +88,25 @@ 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 hashCalldata(calldata) {
-    return computeHashOnElements(calldata);
-}
-exports.hashCalldata = hashCalldata;
-function hashMessage(account, to, selector, calldata, nonce) {
-    var calldataHash = hashCalldata(calldata);
-    return computeHashOnElements([account, to, selector, calldataHash, nonce]);
+function hashMulticall(account, transactions, nonce, maxFee) {
+    var hashArray = transactions
+        .map(function (_a) {
+        var contractAddress = _a.contractAddress, entrypoint = _a.entrypoint, calldata = _a.calldata;
+        return [
+            contractAddress,
+            getSelectorFromName(entrypoint),
+            computeHashOnElements(calldata || []),
+        ];
+    })
+        .map(number_1.bigNumberishArrayToDecimalStringArray)
+        .map(computeHashOnElements);
+    return computeHashOnElements([
+        exports.transactionPrefix,
+        account,
+        computeHashOnElements(hashArray),
+        nonce,
+        maxFee,
+        exports.transactionVersion,
+    ]);
 }
-exports.hashMessage = hashMessage;
+exports.hashMulticall = hashMulticall;

package/dist/utils/stark.d.ts

@@ -7,14 +7,6 @@ import { Calldata, CompressedProgram, Program, RawArgs, Signature } from '../typ
  * @returns Compressed cairo program
  */
 export declare function compressProgram(jsonProgram: Program | string): CompressedProgram;
-/**
- * Function to get the hex selector from a given function name
- *
- * [Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/public/abi.py#L25-L26)
- * @param funcName - selectors abi function name
- * @returns hex selector of given abi function name
- */
-export declare function getSelectorFromName(funcName: string): string;
 export declare function randomAddress(): string;
 export declare function makeAddress(input: string): string;
 export declare function formatSignature(sig?: Signature): string[];

package/dist/utils/stark.js

@@ -25,11 +25,10 @@ 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.getSelectorFromName = exports.compressProgram = void 0;
+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");
-var hash_1 = require("./hash");
 var json_1 = require("./json");
 var number_1 = require("./number");
 /**
@@ -45,18 +44,6 @@ function compressProgram(jsonProgram) {
     return (0, encode_1.btoaUniversal)(compressedProgram);
 }
 exports.compressProgram = compressProgram;
-/**
- * Function to get the hex selector from a given function name
- *
- * [Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/public/abi.py#L25-L26)
- * @param funcName - selectors abi function name
- * @returns hex selector of given abi function name
- */
-function getSelectorFromName(funcName) {
-    // sometimes BigInteger pads the hex string with zeros, which isnt allowed in the starknet api
-    return (0, number_1.toHex)((0, hash_1.starknetKeccak)(funcName));
-}
-exports.getSelectorFromName = getSelectorFromName;
 function randomAddress() {
     var randomKeyPair = (0, ellipticCurve_1.genKeyPair)();
     return (0, ellipticCurve_1.getStarkKey)(randomKeyPair);

package/dist/utils/transaction.d.ts

@@ -0,0 +1,19 @@
+import { ParsedStruct } from '../contract';
+import { Call } from '../types';
+/**
+ * Transforms a list of Calls, each with their own calldata, into
+ * two arrays: one with the entrypoints, and one with the concatenated calldata.
+ * @param calls
+ * @returns
+ */
+export declare const transformCallsToMulticallArrays: (calls: Call[]) => {
+    callArray: ParsedStruct[];
+    calldata: string[];
+};
+/**
+ * Transforms a list of calls in the full flattened calldata expected
+ * by the __execute__ protocol.
+ * @param calls
+ * @returns
+ */
+export declare const fromCallsToExecuteCalldata: (calls: Call[]) => string[];

package/dist/utils/transaction.js

@@ -0,0 +1,75 @@
+"use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fromCallsToExecuteCalldata = exports.transformCallsToMulticallArrays = void 0;
+var hash_1 = require("./hash");
+var number_1 = require("./number");
+/**
+ * Transforms a list of Calls, each with their own calldata, into
+ * two arrays: one with the entrypoints, and one with the concatenated calldata.
+ * @param calls
+ * @returns
+ */
+var transformCallsToMulticallArrays = function (calls) {
+    var callArray = [];
+    var calldata = [];
+    calls.forEach(function (call) {
+        var data = call.calldata || [];
+        callArray.push({
+            to: (0, number_1.toBN)(call.contractAddress).toString(10),
+            selector: (0, number_1.toBN)((0, hash_1.getSelectorFromName)(call.entrypoint)).toString(10),
+            data_offset: calldata.length.toString(),
+            data_len: data.length.toString(),
+        });
+        calldata.push.apply(calldata, __spreadArray([], __read(data), false));
+    });
+    return {
+        callArray: callArray,
+        calldata: (0, number_1.bigNumberishArrayToDecimalStringArray)(calldata),
+    };
+};
+exports.transformCallsToMulticallArrays = transformCallsToMulticallArrays;
+/**
+ * Transforms a list of calls in the full flattened calldata expected
+ * by the __execute__ protocol.
+ * @param calls
+ * @returns
+ */
+var fromCallsToExecuteCalldata = function (calls) {
+    var _a = (0, exports.transformCallsToMulticallArrays)(calls), callArray = _a.callArray, calldata = _a.calldata;
+    return __spreadArray(__spreadArray(__spreadArray([
+        callArray.length.toString()
+    ], __read(callArray
+        .map(function (_a) {
+        var to = _a.to, selector = _a.selector, data_offset = _a.data_offset, data_len = _a.data_len;
+        return [to, selector, data_offset, data_len];
+    })
+        .flat()), false), [
+        calldata.length.toString()
+    ], false), __read(calldata), false);
+};
+exports.fromCallsToExecuteCalldata = fromCallsToExecuteCalldata;

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

@@ -85,7 +85,7 @@ export declare const getStructHash: <T extends {
  * with Keccak256.
  *
  * @param {TypedData} typedData
- * @param {boolean} hash
+ * @param {BigNumberish} account
  * @return {string}
  */
 export declare const getMessageHash: (typedData: TypedData, account: BigNumberish) => string;

package/dist/utils/typedData/index.js

@@ -39,7 +39,6 @@ exports.getMessageHash = exports.getStructHash = exports.encodeData = exports.ge
 var hash_1 = require("../hash");
 var number_1 = require("../number");
 var shortString_1 = require("../shortString");
-var stark_1 = require("../stark");
 var utils_1 = require("./utils");
 __exportStar(require("./types"), exports);
 function getHex(value) {
@@ -104,7 +103,7 @@ exports.encodeType = encodeType;
  * @return {string}
  */
 var getTypeHash = function (typedData, type) {
-    return (0, stark_1.getSelectorFromName)((0, exports.encodeType)(typedData, type));
+    return (0, hash_1.getSelectorFromName)((0, exports.encodeType)(typedData, type));
 };
 exports.getTypeHash = getTypeHash;
 /**
@@ -168,7 +167,7 @@ exports.getStructHash = getStructHash;
  * with Keccak256.
  *
  * @param {TypedData} typedData
- * @param {boolean} hash
+ * @param {BigNumberish} account
  * @return {string}
  */
 var getMessageHash = function (typedData, account) {

package/index.d.ts

@@ -5,6 +5,7 @@ export * from './types';
 export * from './contract';
 export * from './provider';
 export * from './account';
+export * from './signer';
 /**
  * Utils
  */

package/index.js

@@ -62,6 +62,7 @@ __exportStar(require('./types'), exports);
 __exportStar(require('./contract'), exports);
 __exportStar(require('./provider'), exports);
 __exportStar(require('./account'), exports);
+__exportStar(require('./signer'), exports);
 /**
  * Utils
  */

package/package.json

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

package/provider/default.d.ts

@@ -150,13 +150,15 @@ export declare 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
    */
   invokeFunction(invocation: Invocation, _abi?: Abi): 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

@@ -175,6 +175,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 exports.Provider = void 0;
 var axios_1 = __importDefault(require('axios'));
 var url_join_1 = __importDefault(require('url-join'));
+var hash_1 = require('../utils/hash');
 var json_1 = require('../utils/json');
 var number_1 = require('../utils/number');
 var stark_1 = require('../utils/stark');
@@ -260,8 +261,9 @@ var Provider = /** @class */ (function () {
   };
   // typesafe fetch
   Provider.prototype.fetchEndpoint = function (endpoint) {
+    var _a;
     // typescript type magiuc to create a nice fitting function interface
-    var _a = []; // when both query and request are needed, we cant omit anything
+    var _b = []; // when both query and request are needed, we cant omit anything
     for (
       // typescript type magiuc to create a nice fitting function interface
       var _i = 1; // when both query and request are needed, we cant omit anything
@@ -271,21 +273,24 @@ var Provider = /** @class */ (function () {
       _i++ // when both query and request are needed, we cant omit anything
     ) {
       // typescript type magiuc to create a nice fitting function interface
-      _a[_i - 1] = arguments[_i]; // when both query and request are needed, we cant omit anything
+      _b[_i - 1] = arguments[_i]; // when both query and request are needed, we cant omit anything
     }
     // typescript type magiuc to create a nice fitting function interface
-    var _b = __read(_a, 2),
-      query = _b[0],
-      request = _b[1]; // when both query and request are needed, we cant omit anything
+    var _c = __read(_b, 2),
+      query = _c[0],
+      request = _c[1]; // when both query and request are needed, we cant omit anything
     return __awaiter(this, void 0, void 0, function () {
-      var baseUrl, method, queryString, headers, data;
-      return __generator(this, function (_c) {
-        switch (_c.label) {
+      var baseUrl, method, queryString, headers, data, error_1, data;
+      return __generator(this, function (_d) {
+        switch (_d.label) {
           case 0:
             baseUrl = this.getFetchUrl(endpoint);
             method = this.getFetchMethod(endpoint);
             queryString = this.getQueryString(query);
             headers = this.getHeaders(method);
+            _d.label = 1;
+          case 1:
+            _d.trys.push([1, 3, , 4]);
             return [
               4 /*yield*/,
               axios_1.default.request({
@@ -295,9 +300,22 @@ var Provider = /** @class */ (function () {
                 headers: headers,
               }),
             ];
-          case 1:
-            data = _c.sent().data;
+          case 2:
+            data = _d.sent().data;
             return [2 /*return*/, data];
+          case 3:
+            error_1 = _d.sent();
+            data =
+              (_a = error_1 === null || error_1 === void 0 ? void 0 : error_1.response) === null ||
+              _a === void 0
+                ? void 0
+                : _a.data;
+            if (data === null || data === void 0 ? void 0 : data.message) {
+              throw new Error(data.code + ': ' + data.message);
+            }
+            throw error_1;
+          case 4:
+            return [2 /*return*/];
         }
       });
     });
@@ -345,7 +363,7 @@ var Provider = /** @class */ (function () {
             {
               signature: [],
               contract_address: contractAddress,
-              entry_point_selector: (0, stark_1.getSelectorFromName)(entrypoint),
+              entry_point_selector: (0, hash_1.getSelectorFromName)(entrypoint),
               calldata: calldata,
             }
           ),
@@ -532,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) {
@@ -543,7 +559,7 @@ var Provider = /** @class */ (function () {
     return this.fetchEndpoint('add_transaction', undefined, {
       type: 'INVOKE_FUNCTION',
       contract_address: invocation.contractAddress,
-      entry_point_selector: (0, stark_1.getSelectorFromName)(invocation.entrypoint),
+      entry_point_selector: (0, hash_1.getSelectorFromName)(invocation.entrypoint),
       calldata: (0, number_1.bigNumberishArrayToDecimalStringArray)(
         (_a = invocation.calldata) !== null && _a !== void 0 ? _a : []
       ),
@@ -552,12 +568,12 @@ var Provider = /** @class */ (function () {
       ),
     });
   };
-  Provider.prototype.waitForTx = function (txHash, retryInterval) {
+  Provider.prototype.waitForTransaction = function (txHash, retryInterval) {
     if (retryInterval === void 0) {
       retryInterval = 8000;
     }
     return __awaiter(this, void 0, void 0, function () {
-      var onchain, res, error;
+      var onchain, res, message, error;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -579,7 +595,14 @@ var Provider = /** @class */ (function () {
             if (res.tx_status === 'ACCEPTED_ON_L1' || res.tx_status === 'ACCEPTED_ON_L2') {
               onchain = true;
             } else if (res.tx_status === 'REJECTED' || res.tx_status === 'NOT_RECEIVED') {
-              error = Error(res.tx_status);
+              message = res.tx_failure_reason
+                ? res.tx_status +
+                  ': ' +
+                  res.tx_failure_reason.code +
+                  '\n' +
+                  res.tx_failure_reason.error_message
+                : res.tx_status;
+              error = new Error(message);
               error.response = res;
               throw error;
             }
@@ -590,6 +613,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/signer/default.d.ts

@@ -10,5 +10,5 @@ export declare class Signer implements SignerInterface {
     transactionsDetail: InvocationsSignerDetails,
     abis?: Abi[]
   ): Promise<Signature>;
-  signMessage(typedData: TypedData, walletAddress: string): Promise<Signature>;
+  signMessage(typedData: TypedData, accountAddress: string): Promise<Signature>;
 }

package/signer/default.js

@@ -133,10 +133,7 @@ var __generator =
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.Signer = void 0;
 var ellipticCurve_1 = require('../utils/ellipticCurve');
-var encode_1 = require('../utils/encode');
 var hash_1 = require('../utils/hash');
-var number_1 = require('../utils/number');
-var stark_1 = require('../utils/stark');
 var typedData_1 = require('../utils/typedData');
 var Signer = /** @class */ (function () {
   function Signer(keyPair) {
@@ -150,58 +147,27 @@ var Signer = /** @class */ (function () {
     });
   };
   Signer.prototype.signTransaction = function (transactions, transactionsDetail, abis) {
-    if (abis === void 0) {
-      abis = [];
-    }
     return __awaiter(this, void 0, void 0, function () {
-      var _a,
-        contractAddress,
-        entrypoint,
-        _b,
-        calldata,
-        nonce,
-        walletAddress,
-        nonceBn,
-        entrypointSelector,
-        calldataDecimal,
-        msgHash;
-      return __generator(this, function (_c) {
-        if (transactions.length !== 1) {
-          throw new Error('Only one transaction at a time is currently supported by this signer');
-        }
-        if (
-          (abis === null || abis === void 0 ? void 0 : abis.length) !== 0 &&
-          abis.length !== transactions.length
-        ) {
+      var msgHash;
+      return __generator(this, function (_a) {
+        if (abis && abis.length !== transactions.length) {
           throw new Error('ABI must be provided for each transaction or no transaction');
         }
-        (_a = transactions[0]),
-          (contractAddress = _a.contractAddress),
-          (entrypoint = _a.entrypoint),
-          (_b = _a.calldata),
-          (calldata = _b === void 0 ? [] : _b);
-        (nonce = transactionsDetail.nonce), (walletAddress = transactionsDetail.walletAddress);
-        nonceBn = (0, number_1.toBN)(nonce);
-        entrypointSelector = (0, stark_1.getSelectorFromName)(entrypoint);
-        calldataDecimal = (0, number_1.bigNumberishArrayToDecimalStringArray)(calldata);
-        msgHash = (0, encode_1.addHexPrefix)(
-          (0, hash_1.hashMessage)(
-            walletAddress,
-            contractAddress,
-            entrypointSelector,
-            calldataDecimal,
-            nonceBn.toString()
-          )
+        msgHash = (0, hash_1.hashMulticall)(
+          transactionsDetail.walletAddress,
+          transactions,
+          transactionsDetail.nonce.toString(),
+          transactionsDetail.maxFee.toString()
         );
         return [2 /*return*/, (0, ellipticCurve_1.sign)(this.keyPair, msgHash)];
       });
     });
   };
-  Signer.prototype.signMessage = function (typedData, walletAddress) {
+  Signer.prototype.signMessage = function (typedData, accountAddress) {
     return __awaiter(this, void 0, void 0, function () {
       var msgHash;
       return __generator(this, function (_a) {
-        msgHash = (0, typedData_1.getMessageHash)(typedData, walletAddress);
+        msgHash = (0, typedData_1.getMessageHash)(typedData, accountAddress);
         return [2 /*return*/, (0, ellipticCurve_1.sign)(this.keyPair, msgHash)];
       });
     });

package/signer/interface.d.ts

@@ -11,11 +11,12 @@ export declare abstract class SignerInterface {
    * Sign an JSON object for off-chain usage with the starknet private key and return the signature
    * This adds a message prefix so it cant be interchanged with transactions
    *
-   * @param json - JSON object to be signed
+   * @param typedData - JSON object to be signed
+   * @param accountAddress - account
    * @returns the signature of the JSON object
    * @throws {Error} if the JSON object is not a valid JSON
    */
-  abstract signMessage(typedData: TypedData, walletAddress: string): Promise<Signature>;
+  abstract signMessage(typedData: TypedData, accountAddress: string): Promise<Signature>;
   /**
    * Signs a transaction with the starknet private key and returns the signature
    *