starknet 3.0.0 → 3.3.0

package/dist/types/lib.d.ts

@@ -1,7 +1,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;
@@ -14,11 +14,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' | 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
 export declare type TransactionStatus = 'TRANSACTION_RECEIVED';
 export declare type Type = 'DEPLOY' | 'INVOKE_FUNCTION';

package/dist/utils/ellipticCurve.js

@@ -93,7 +93,7 @@ function sign(keyPair, msgHash) {
     (0, number_1.assertInRange)(r, constants_1.ONE, (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.MAX_ECDSA_VAL)), 'r');
     (0, number_1.assertInRange)(s, constants_1.ONE, (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.EC_ORDER)), 's');
     (0, number_1.assertInRange)(w, constants_1.ONE, (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/dist/utils/hash.d.ts

@@ -1,5 +1,8 @@
 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
  *
@@ -8,7 +11,14 @@ 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(account: string, to: string, selector: string, calldata: string[], nonce: string): string;
+export declare function hashMulticall(account: string, transactions: Call[], nonce: string, maxFee: string): string;

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/number.d.ts

@@ -4,5 +4,6 @@ export declare function isHex(hex: string): boolean;
 export declare function toBN(number: BigNumberish, base?: number | 'hex'): BN;
 export declare function toHex(number: BN): string;
 export declare function hexToDecimalString(hex: string): string;
+export declare function toFelt(num: BigNumberish): string;
 export declare function assertInRange(input: BigNumberish, lowerBound: BigNumberish, upperBound: BigNumberish, inputName?: string): void;
 export declare function bigNumberishArrayToDecimalStringArray(rawCalldata: BigNumberish[]): string[];

package/dist/utils/number.js

@@ -1,10 +1,29 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bigNumberishArrayToDecimalStringArray = exports.assertInRange = exports.hexToDecimalString = exports.toHex = exports.toBN = exports.isHex = void 0;
-var bn_js_1 = __importDefault(require("bn.js"));
+exports.bigNumberishArrayToDecimalStringArray = exports.assertInRange = exports.toFelt = exports.hexToDecimalString = exports.toHex = exports.toBN = exports.isHex = void 0;
+var bn_js_1 = __importStar(require("bn.js"));
 var minimalistic_assert_1 = __importDefault(require("minimalistic-assert"));
 var encode_1 = require("./encode");
 function isHex(hex) {
@@ -25,6 +44,13 @@ function hexToDecimalString(hex) {
     return toBN("0x" + hex.replace(/^0x/, '')).toString();
 }
 exports.hexToDecimalString = hexToDecimalString;
+function toFelt(num) {
+    if ((0, bn_js_1.isBN)(num)) {
+        return num.toString();
+    }
+    return toBN(num).toString();
+}
+exports.toFelt = toFelt;
 /*
  Asserts input is equal to or greater then lowerBound and lower then upperBound.
  Assert message specifies inputName.

package/dist/utils/stark.d.ts

@@ -1,4 +1,4 @@
-import { CompressedProgram, Program, Signature } from '../types';
+import { Calldata, CompressedProgram, Program, RawArgs, Signature } from '../types';
 /**
  * Function to compress compiled cairo program
  *
@@ -7,14 +7,7 @@ import { CompressedProgram, Program, Signature } from '../types';
  * @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[];
+export declare function compileCalldata(args: RawArgs): Calldata;

package/dist/utils/stark.js

@@ -1,10 +1,34 @@
 "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.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");
 /**
@@ -20,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);
@@ -52,3 +64,21 @@ function formatSignature(sig) {
     }
 }
 exports.formatSignature = formatSignature;
+function compileCalldata(args) {
+    return Object.values(args).flatMap(function (value) {
+        if (Array.isArray(value))
+            return __spreadArray([(0, number_1.toBN)(value.length).toString()], __read(value.map(function (x) { return (0, number_1.toBN)(x).toString(); })), false);
+        if (typeof value === 'object' && 'type' in value)
+            return Object.entries(value)
+                .filter(function (_a) {
+                var _b = __read(_a, 1), k = _b[0];
+                return k !== 'type';
+            })
+                .map(function (_a) {
+                var _b = __read(_a, 2), v = _b[1];
+                return (0, number_1.toBN)(v).toString();
+            });
+        return (0, number_1.toBN)(value).toString();
+    });
+}
+exports.compileCalldata = compileCalldata;

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.0.0",
+  "version": "3.3.0",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,7 +23,7 @@
     "zk",
     "rollup"
   ],
-  "repository": "github:seanjameshan/starknet.js",
+  "repository": "github:0xs34n/starknet.js",
   "author": "Sean Han",
   "license": "MIT",
   "devDependencies": {

package/provider/default.d.ts

@@ -11,6 +11,7 @@ import {
   GetTransactionResponse,
   GetTransactionStatusResponse,
   Invocation,
+  Signature,
   TransactionReceipt,
 } from '../types';
 import { BigNumberish } from '../utils/number';
@@ -146,6 +147,15 @@ export declare class Provider implements ProviderInterface {
    * @returns a confirmation of sending a transaction on the starknet contract
    */
   deployContract(payload: DeployContractPayload, _abi?: Abi): Promise<AddTransactionResponse>;
+  /**
+   * Invokes a function on starknet
+   * @deprecated This method wont be supported as soon as fees are mandatory
+   *
+   * @param invocation
+   * @param _abi - (optional) signature to send along
+   * @returns response from addTransaction
+   */
+  invokeFunction(invocation: Invocation, _abi?: Abi): Promise<AddTransactionResponse>;
   /**
    * Invokes a function on starknet
    * @deprecated This method wont be supported as soon as fees are mandatory
@@ -156,7 +166,16 @@ export declare class Provider implements ProviderInterface {
    * @param signature - (optional) signature to send along
    * @returns response from addTransaction
    */
-  invokeFunction(invocation: Invocation, _abi?: Abi): Promise<AddTransactionResponse>;
+  LEGACY_invokeFunction(
+    contractAddress: string,
+    entrypointSelector: string,
+    calldata?: string[],
+    signature?: Signature
+  ): Promise<AddTransactionResponse>;
+  waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+  /**
+   * @deprecated use `waitForTransaction` instead
+   */
   waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }
 export {};