starknet 3.18.0 → 3.19.0

package/utils/typedData/index.d.ts

@@ -10,11 +10,7 @@ export * from './types';
  * @param {string[]} [dependencies]
  * @return {string[]}
  */
-export declare const getDependencies: (
-  typedData: TypedData,
-  type: string,
-  dependencies?: string[]
-) => string[];
+export declare const getDependencies: (typedData: TypedData, type: string, dependencies?: string[]) => string[];
 /**
  * Encode a type to a string. All dependant types are alphabetically sorted.
  *
@@ -39,11 +35,7 @@ export declare const getTypeHash: (typedData: TypedData, type: string) => string
  * @param {string} type
  * @param {Record<string, any>} data
  */
-export declare const encodeData: <T extends TypedData>(
-  typedData: T,
-  type: string,
-  data: T['message']
-) => string[][];
+export declare const encodeData: <T extends TypedData>(typedData: T, type: string, data: T["message"]) => string[][];
 /**
  * Get encoded data as a hash. The data should be a key -> value object with all the required values. All dependant
  * types are automatically encoded.
@@ -53,11 +45,7 @@ export declare const encodeData: <T extends TypedData>(
  * @param {Record<string, any>} data
  * @return {Buffer}
  */
-export declare const getStructHash: <T extends TypedData>(
-  typedData: T,
-  type: string,
-  data: T['message']
-) => string;
+export declare const getStructHash: <T extends TypedData>(typedData: T, type: string, data: T["message"]) => string;
 /**
  * Get the EIP-191 encoded message to sign, from the typedData object. If `hash` is enabled, the message will be hashed
  * with Keccak256.

package/utils/typedData/index.js

@@ -1,87 +1,60 @@
-'use strict';
-var __createBinding =
-  (this && this.__createBinding) ||
-  (Object.create
-    ? function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        var desc = Object.getOwnPropertyDescriptor(m, k);
-        if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-          desc = {
-            enumerable: true,
-            get: function () {
-              return m[k];
-            },
-          };
-        }
-        Object.defineProperty(o, k2, desc);
-      }
-    : function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        o[k2] = m[k];
-      });
-var __exportStar =
-  (this && this.__exportStar) ||
-  function (m, exports) {
-    for (var p in m)
-      if (p !== 'default' && !Object.prototype.hasOwnProperty.call(exports, p))
-        __createBinding(exports, m, p);
-  };
-var __read =
-  (this && this.__read) ||
-  function (o, n) {
-    var m = typeof Symbol === 'function' && o[Symbol.iterator];
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+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;
+    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;
-      }
+        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++) {
+};
+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];
+            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.getMessageHash =
-  exports.getStructHash =
-  exports.encodeData =
-  exports.getTypeHash =
-  exports.encodeType =
-  exports.getDependencies =
-    void 0;
-var hash_1 = require('../hash');
-var number_1 = require('../number');
-var shortString_1 = require('../shortString');
-var utils_1 = require('./utils');
-__exportStar(require('./types'), exports);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMessageHash = exports.getStructHash = exports.encodeData = exports.getTypeHash = exports.encodeType = exports.getDependencies = void 0;
+var hash_1 = require("../hash");
+var number_1 = require("../number");
+var shortString_1 = require("../shortString");
+var utils_1 = require("./utils");
+__exportStar(require("./types"), exports);
 function getHex(value) {
-  try {
-    return (0, number_1.toHex)((0, number_1.toBN)(value));
-  } catch (e) {
-    if (typeof value === 'string') {
-      return (0, number_1.toHex)((0, number_1.toBN)((0, shortString_1.encodeShortString)(value)));
+    try {
+        return (0, number_1.toHex)((0, number_1.toBN)(value));
+    }
+    catch (e) {
+        if (typeof value === 'string') {
+            return (0, number_1.toHex)((0, number_1.toBN)((0, shortString_1.encodeShortString)(value)));
+        }
+        throw new Error("Invalid BigNumberish: ".concat(value));
     }
-    throw new Error('Invalid BigNumberish: '.concat(value));
-  }
 }
 /**
  * Get the dependencies of a struct type. If a struct has the same dependency multiple times, it's only included once
@@ -93,36 +66,25 @@ function getHex(value) {
  * @return {string[]}
  */
 var getDependencies = function (typedData, type, dependencies) {
-  if (dependencies === void 0) {
-    dependencies = [];
-  }
-  // `getDependencies` is called by most other functions, so we validate the JSON schema here
-  if (!(0, utils_1.validateTypedData)(typedData)) {
-    throw new Error('Typed data does not match JSON schema');
-  }
-  if (dependencies.includes(type)) {
-    return dependencies;
-  }
-  if (!typedData.types[type]) {
-    return dependencies;
-  }
-  return __spreadArray(
-    [type],
-    __read(
-      typedData.types[type].reduce(function (previous, t) {
-        return __spreadArray(
-          __spreadArray([], __read(previous), false),
-          __read(
-            (0, exports.getDependencies)(typedData, t.type, previous).filter(function (dependency) {
-              return !previous.includes(dependency);
-            })
-          ),
-          false
-        );
-      }, [])
-    ),
-    false
-  );
+    if (dependencies === void 0) { dependencies = []; }
+    // `getDependencies` is called by most other functions, so we validate the JSON schema here
+    if (!(0, utils_1.validateTypedData)(typedData)) {
+        throw new Error('Typed data does not match JSON schema');
+    }
+    // Include pointers (struct arrays)
+    if (type[type.length - 1] === '*') {
+        // eslint-disable-next-line no-param-reassign
+        type = type.slice(0, -1);
+    }
+    if (dependencies.includes(type)) {
+        return dependencies;
+    }
+    if (!typedData.types[type]) {
+        return dependencies;
+    }
+    return __spreadArray([
+        type
+    ], __read(typedData.types[type].reduce(function (previous, t) { return __spreadArray(__spreadArray([], __read(previous), false), __read((0, exports.getDependencies)(typedData, t.type, previous).filter(function (dependency) { return !previous.includes(dependency); })), false); }, [])), false);
 };
 exports.getDependencies = getDependencies;
 /**
@@ -133,20 +95,13 @@ exports.getDependencies = getDependencies;
  * @return {string}
  */
 var encodeType = function (typedData, type) {
-  var _a = __read((0, exports.getDependencies)(typedData, type)),
-    primary = _a[0],
-    dependencies = _a.slice(1);
-  var types = __spreadArray([primary], __read(dependencies.sort()), false);
-  return types
-    .map(function (dependency) {
-      return ''.concat(dependency, '(').concat(
-        typedData.types[dependency].map(function (t) {
-          return ''.concat(t.name, ':').concat(t.type);
-        }),
-        ')'
-      );
+    var _a = __read((0, exports.getDependencies)(typedData, type)), primary = _a[0], dependencies = _a.slice(1);
+    var types = __spreadArray([primary], __read(dependencies.sort()), false);
+    return types
+        .map(function (dependency) {
+        return "".concat(dependency, "(").concat(typedData.types[dependency].map(function (t) { return "".concat(t.name, ":").concat(t.type); }), ")");
     })
-    .join('');
+        .join('');
 };
 exports.encodeType = encodeType;
 /**
@@ -157,7 +112,7 @@ exports.encodeType = encodeType;
  * @return {string}
  */
 var getTypeHash = function (typedData, type) {
-  return (0, hash_1.getSelectorFromName)((0, exports.encodeType)(typedData, type));
+    return (0, hash_1.getSelectorFromName)((0, exports.encodeType)(typedData, type));
 };
 exports.getTypeHash = getTypeHash;
 /**
@@ -170,14 +125,23 @@ exports.getTypeHash = getTypeHash;
  * @returns {[string, string]}
  */
 var encodeValue = function (typedData, type, data) {
-  if (typedData.types[type]) {
-    // eslint-disable-next-line @typescript-eslint/no-use-before-define
-    return [type, (0, exports.getStructHash)(typedData, type, data)];
-  }
-  if (type === 'felt*') {
-    return ['felt*', (0, hash_1.computeHashOnElements)(data)];
-  }
-  return [type, getHex(data)];
+    if (typedData.types[type]) {
+        // eslint-disable-next-line @typescript-eslint/no-use-before-define
+        return [type, (0, exports.getStructHash)(typedData, type, data)];
+    }
+    if (Object.keys(typedData.types)
+        .map(function (x) { return "".concat(x, "*"); })
+        .includes(type)) {
+        var structHashes = data.map(function (struct) {
+            // eslint-disable-next-line @typescript-eslint/no-use-before-define
+            return (0, exports.getStructHash)(typedData, type.slice(0, -1), struct);
+        });
+        return [type, (0, hash_1.computeHashOnElements)(structHashes)];
+    }
+    if (type === 'felt*') {
+        return ['felt*', (0, hash_1.computeHashOnElements)(data)];
+    }
+    return [type, getHex(data)];
 };
 /**
  * Encode the data to an ABI encoded Buffer. The data should be a key -> value object with all the required values. All
@@ -188,31 +152,19 @@ var encodeValue = function (typedData, type, data) {
  * @param {Record<string, any>} data
  */
 var encodeData = function (typedData, type, data) {
-  var _a = __read(
-      typedData.types[type].reduce(
-        function (_a, field) {
-          var _b = __read(_a, 2),
-            ts = _b[0],
-            vs = _b[1];
-          if (data[field.name] === undefined || data[field.name] === null) {
+    var _a = __read(typedData.types[type].reduce(function (_a, field) {
+        var _b = __read(_a, 2), ts = _b[0], vs = _b[1];
+        if (data[field.name] === undefined || data[field.name] === null) {
             throw new Error("Cannot encode data: missing data for '".concat(field.name, "'"));
-          }
-          var value = data[field.name];
-          var _c = __read(encodeValue(typedData, field.type, value), 2),
-            t = _c[0],
-            encodedValue = _c[1];
-          return [
+        }
+        var value = data[field.name];
+        var _c = __read(encodeValue(typedData, field.type, value), 2), t = _c[0], encodedValue = _c[1];
+        return [
             __spreadArray(__spreadArray([], __read(ts), false), [t], false),
             __spreadArray(__spreadArray([], __read(vs), false), [encodedValue], false),
-          ];
-        },
-        [['felt'], [(0, exports.getTypeHash)(typedData, type)]]
-      ),
-      2
-    ),
-    types = _a[0],
-    values = _a[1];
-  return [types, values];
+        ];
+    }, [['felt'], [(0, exports.getTypeHash)(typedData, type)]]), 2), types = _a[0], values = _a[1];
+    return [types, values];
 };
 exports.encodeData = encodeData;
 /**
@@ -225,7 +177,7 @@ exports.encodeData = encodeData;
  * @return {Buffer}
  */
 var getStructHash = function (typedData, type, data) {
-  return (0, hash_1.computeHashOnElements)((0, exports.encodeData)(typedData, type, data)[1]);
+    return (0, hash_1.computeHashOnElements)((0, exports.encodeData)(typedData, type, data)[1]);
 };
 exports.getStructHash = getStructHash;
 /**
@@ -237,12 +189,12 @@ exports.getStructHash = getStructHash;
  * @return {string}
  */
 var getMessageHash = function (typedData, account) {
-  var message = [
-    (0, shortString_1.encodeShortString)('StarkNet Message'),
-    (0, exports.getStructHash)(typedData, 'StarkNetDomain', typedData.domain),
-    account,
-    (0, exports.getStructHash)(typedData, typedData.primaryType, typedData.message),
-  ];
-  return (0, hash_1.computeHashOnElements)(message);
+    var message = [
+        (0, shortString_1.encodeShortString)('StarkNet Message'),
+        (0, exports.getStructHash)(typedData, 'StarkNetDomain', typedData.domain),
+        account,
+        (0, exports.getStructHash)(typedData, typedData.primaryType, typedData.message),
+    ];
+    return (0, hash_1.computeHashOnElements)(message);
 };
 exports.getMessageHash = getMessageHash;

package/utils/typedData/types.d.ts

@@ -5,23 +5,23 @@
  * standard.
  */
 export interface StarkNetType {
-  name: string;
-  type: 'felt' | 'felt*' | string;
+    name: string;
+    type: 'felt' | 'felt*' | string;
 }
 /**
  * The EIP712 domain struct. Any of these fields are optional, but it must contain at least one field.
  */
 export interface StarkNetDomain extends Record<string, unknown> {
-  name?: string;
-  version?: string;
-  chainId?: string | number;
+    name?: string;
+    version?: string;
+    chainId?: string | number;
 }
 /**
  * The complete typed data, with all the structs, domain data, primary type of the message, and the message itself.
  */
 export interface TypedData {
-  types: Record<string, StarkNetType[]>;
-  primaryType: string;
-  domain: StarkNetDomain;
-  message: Record<string, unknown>;
+    types: Record<string, StarkNetType[]>;
+    primaryType: string;
+    domain: StarkNetDomain;
+    message: Record<string, unknown>;
 }

package/utils/typedData/types.js

@@ -1,2 +1,2 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/utils/typedData/utils.js

@@ -1,5 +1,5 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateTypedData = void 0;
 /**
  * Validates that `data` matches the EIP-712 JSON schema.
@@ -8,9 +8,9 @@ exports.validateTypedData = void 0;
  * @return {boolean}
  */
 var validateTypedData = function (data) {
-  var typedData = data;
-  // Validate that the data matches the EIP-712 JSON schema
-  var valid = Boolean(typedData.types && typedData.primaryType && typedData.message);
-  return valid;
+    var typedData = data;
+    // Validate that the data matches the EIP-712 JSON schema
+    var valid = Boolean(typedData.types && typedData.primaryType && typedData.message);
+    return valid;
 };
 exports.validateTypedData = validateTypedData;

package/utils/uint256.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="bn.js" />
 import { BigNumberish } from './number';
 export interface Uint256 {
-  low: BigNumberish;
-  high: BigNumberish;
+    low: BigNumberish;
+    high: BigNumberish;
 }
-export declare function uint256ToBN(uint256: Uint256): import('bn.js');
-export declare const UINT_128_MAX: import('bn.js');
-export declare const UINT_256_MAX: import('bn.js');
+export declare function uint256ToBN(uint256: Uint256): import("bn.js");
+export declare const UINT_128_MAX: import("bn.js");
+export declare const UINT_256_MAX: import("bn.js");
 export declare function isUint256(bn: BigNumberish): boolean;
 export declare function bnToUint256(bignumber: BigNumberish): Uint256;

package/utils/uint256.js

@@ -1,38 +1,28 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.bnToUint256 =
-  exports.isUint256 =
-  exports.UINT_256_MAX =
-  exports.UINT_128_MAX =
-  exports.uint256ToBN =
-    void 0;
-var encode_1 = require('./encode');
-var number_1 = require('./number');
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bnToUint256 = exports.isUint256 = exports.UINT_256_MAX = exports.UINT_128_MAX = exports.uint256ToBN = void 0;
+var encode_1 = require("./encode");
+var number_1 = require("./number");
 // function to convert Uint256 to BN
 function uint256ToBN(uint256) {
-  return (0, number_1.toBN)(uint256.high)
-    .shln(128)
-    .add((0, number_1.toBN)(uint256.low));
+    return (0, number_1.toBN)(uint256.high).shln(128).add((0, number_1.toBN)(uint256.low));
 }
 exports.uint256ToBN = uint256ToBN;
-exports.UINT_128_MAX = (0, number_1.toBN)(1)
-  .shln(128)
-  .sub((0, number_1.toBN)(1));
-exports.UINT_256_MAX = (0, number_1.toBN)(1)
-  .shln(256)
-  .sub((0, number_1.toBN)(1));
+exports.UINT_128_MAX = (0, number_1.toBN)(1).shln(128).sub((0, number_1.toBN)(1));
+exports.UINT_256_MAX = (0, number_1.toBN)(1).shln(256).sub((0, number_1.toBN)(1));
 // function to check if BN is smaller or equal 2**256-1
 function isUint256(bn) {
-  return (0, number_1.toBN)(bn).lte(exports.UINT_256_MAX);
+    return (0, number_1.toBN)(bn).lte(exports.UINT_256_MAX);
 }
 exports.isUint256 = isUint256;
 // function to convert BN to Uint256
 function bnToUint256(bignumber) {
-  var bn = (0, number_1.toBN)(bignumber);
-  if (!isUint256(bn)) throw new Error('Number is too large');
-  return {
-    low: (0, encode_1.addHexPrefix)(bn.maskn(128).toString(16)),
-    high: (0, encode_1.addHexPrefix)(bn.shrn(128).toString(16)),
-  };
+    var bn = (0, number_1.toBN)(bignumber);
+    if (!isUint256(bn))
+        throw new Error('Number is too large');
+    return {
+        low: (0, encode_1.addHexPrefix)(bn.maskn(128).toString(16)),
+        high: (0, encode_1.addHexPrefix)(bn.shrn(128).toString(16)),
+    };
 }
 exports.bnToUint256 = bnToUint256;

package/www/docs/API/account.md

@@ -43,8 +43,9 @@ The _options_ object may include any of:
 
 ```
 {
-  amount: number;
-  unit: string;
+  overall_fee: BN;
+  gas_consumed?: BN;
+  gas_price?: BN;
 }
 ```
 
@@ -64,9 +65,7 @@ The _transactionsDetail_ object may include any of:
 
 ```
 {
-  code: 'TRANSACTION_RECEIVED';
   transaction_hash: string;
-  address?: string;
 };
 ```
 

package/www/docs/API/contract.md

@@ -22,9 +22,9 @@ contract.**address** => _string_
 
 The address the contract was constructed/connected with
 
-contract.**providerOrAcount** => _Provider | Account_
+contract.**providerOrAcount** => ProviderInterface | AccountInterface_
 
-Provider or Account that are used to interact with the network
+Provider or account that are used to interact with the network
 
 contract.**deployTransactionHash** => _string | null_
 

package/www/docs/API/contractFactory.md

@@ -26,9 +26,9 @@ contractFactory.**compiledContract** => _CompiledContract_;
 
 The compiled contract the contractFactory was constructed with
 
-contractFactory.**providerOrAccount** => _Provider | Account_;
+contractFactory.**providerOrAccount** => _ProviderInterface | AccountInterface_;
 
-Provider or Account that are used to interact with the network
+Provider or account that are used to interact with the network
 
 ## Methods