starknet 3.1.0 → 3.4.0

package/types/lib.d.ts

@@ -2,7 +2,7 @@ import type { ec as EC } from 'elliptic';
 
 import type { BigNumberish } from '../utils/number';
 export declare type KeyPair = EC.KeyPair;
-export declare type Signature = BigNumberish[];
+export declare type Signature = string[];
 export declare type RawCalldata = BigNumberish[];
 export declare type DeployContractPayload = {
   contract: CompiledContract | string;
@@ -15,11 +15,11 @@ export declare type Invocation = {
   calldata?: RawCalldata;
   signature?: Signature;
 };
-export declare type ExecuteInvocation = Omit<Invocation, 'signature'>;
+export declare type Call = Omit<Invocation, 'signature'>;
 export declare type InvocationsDetails = {
   nonce?: BigNumberish;
+  maxFee?: BigNumberish;
 };
-export declare type Call = Omit<Invocation, 'signature' | 'nonce'>;
 export declare type Status =
   | 'NOT_RECEIVED'
   | 'RECEIVED'

package/utils/ellipticCurve.js

@@ -136,7 +136,7 @@ function sign(keyPair, msgHash) {
     (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.MAX_ECDSA_VAL)),
     'w'
   );
-  return [r, s];
+  return [r.toString(), s.toString()];
 }
 exports.sign = sign;
 function chunkArray(arr, n) {

package/utils/hash.d.ts

@@ -1,6 +1,9 @@
 import BN from 'bn.js';
 
+import { Call } from '../types';
 import { BigNumberish } from './number';
+export declare const transactionPrefix: string;
+export declare const transactionVersion = 0;
 /**
  * Function to get the starknet keccak hash from a string
  *
@@ -9,13 +12,19 @@ import { BigNumberish } from './number';
  * @returns starknet keccak hash as BigNumber
  */
 export declare function starknetKeccak(value: string): BN;
+/**
+ * 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 pedersen(input: [BigNumberish, BigNumberish]): string;
 export declare function computeHashOnElements(data: BigNumberish[]): string;
-export declare function hashCalldata(calldata: string[]): string;
-export declare function hashMessage(
+export declare function hashMulticall(
   account: string,
-  to: string,
-  selector: string,
-  calldata: string[],
-  nonce: string
+  transactions: Call[],
+  nonce: string,
+  maxFee: string
 ): string;

package/utils/hash.js

@@ -39,11 +39,13 @@ var __importDefault =
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.hashMessage =
-  exports.hashCalldata =
+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'));
@@ -51,6 +53,9 @@ 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)))
@@ -67,6 +72,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]);
 });
@@ -99,12 +116,27 @@ function computeHashOnElements(data) {
     .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/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/utils/stark.js

@@ -38,13 +38,11 @@ exports.compileCalldata =
   exports.formatSignature =
   exports.makeAddress =
   exports.randomAddress =
-  exports.getSelectorFromName =
   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');
 /**
@@ -61,18 +59,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/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/utils/transaction.js

@@ -0,0 +1,99 @@
+'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/utils/typedData/index.d.ts

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

package/utils/typedData/index.js

@@ -67,7 +67,6 @@ exports.getMessageHash =
 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) {
@@ -156,7 +155,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;
 /**
@@ -232,7 +231,7 @@ exports.getStructHash = getStructHash;
  * with Keccak256.
  *
  * @param {TypedData} typedData
- * @param {boolean} hash
+ * @param {BigNumberish} account
  * @return {string}
  */
 var getMessageHash = function (typedData, account) {