starknet 4.11.0 → 4.13.0

package/utils/typedData/index.d.ts

@@ -1,72 +0,0 @@
-import { BigNumberish } from '../number';
-import { StarkNetMerkleType, StarkNetType, TypedData } from './types';
-export * from './types';
-export declare function prepareSelector(selector: string): string;
-export declare function isMerkleTreeType(type: StarkNetType): type is StarkNetMerkleType;
-interface Context {
-    parent?: string;
-    key?: string;
-}
-/**
- * Get the dependencies of a struct type. If a struct has the same dependency multiple times, it's only included once
- * in the resulting array.
- *
- * @param {TypedData} typedData
- * @param {string} type
- * @param {string[]} [dependencies]
- * @return {string[]}
- */
-export declare const getDependencies: (types: TypedData['types'], type: string, dependencies?: string[]) => string[];
-/**
- * Encode a type to a string. All dependant types are alphabetically sorted.
- *
- * @param {TypedData} typedData
- * @param {string} type
- * @return {string}
- */
-export declare const encodeType: (types: TypedData['types'], type: string) => string;
-/**
- * Get a type string as hash.
- *
- * @param {TypedData} typedData
- * @param {string} type
- * @return {string}
- */
-export declare const getTypeHash: (types: TypedData['types'], type: string) => string;
-/**
- * Encodes a single value to an ABI serialisable string, number or Buffer. Returns the data as tuple, which consists of
- * an array of ABI compatible types, and an array of corresponding values.
- *
- * @param {TypedData} typedData
- * @param {string} type
- * @param {any} data
- * @returns {[string, string]}
- */
-export declare const encodeValue: (types: TypedData['types'], type: string, data: unknown, ctx?: Context) => [string, string];
-/**
- * Encode the data to an ABI encoded Buffer. The data should be a key -> value object with all the required values. All
- * dependant types are automatically encoded.
- *
- * @param {TypedData} typedData
- * @param {string} type
- * @param {Record<string, any>} data
- */
-export declare const encodeData: <T extends TypedData>(types: T["types"], 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.
- *
- * @param {TypedData} typedData
- * @param {string} type
- * @param {Record<string, any>} data
- * @return {Buffer}
- */
-export declare const getStructHash: <T extends TypedData>(types: T["types"], type: string, data: T["message"]) => string;
-/**
- * Get the EIP-191 encoded message to sign, from the typedData object.
- *
- * @param {TypedData} typedData
- * @param {BigNumberish} account
- * @return {string}
- */
-export declare const getMessageHash: (typedData: TypedData, account: BigNumberish) => string;

package/utils/typedData/index.js

@@ -1,239 +0,0 @@
-"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;
-    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.getMessageHash = exports.getStructHash = exports.encodeData = exports.encodeValue = exports.getTypeHash = exports.encodeType = exports.getDependencies = exports.isMerkleTreeType = exports.prepareSelector = void 0;
-var hash_1 = require("../hash");
-var merkle_1 = require("../merkle");
-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)));
-        }
-        throw new Error("Invalid BigNumberish: ".concat(value));
-    }
-}
-function prepareSelector(selector) {
-    return (0, number_1.isHex)(selector) ? selector : (0, hash_1.getSelectorFromName)(selector);
-}
-exports.prepareSelector = prepareSelector;
-function isMerkleTreeType(type) {
-    return type.type === 'merkletree';
-}
-exports.isMerkleTreeType = isMerkleTreeType;
-/**
- * Get the dependencies of a struct type. If a struct has the same dependency multiple times, it's only included once
- * in the resulting array.
- *
- * @param {TypedData} typedData
- * @param {string} type
- * @param {string[]} [dependencies]
- * @return {string[]}
- */
-var getDependencies = function (types, type, dependencies) {
-    if (dependencies === void 0) { dependencies = []; }
-    // 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 (!types[type]) {
-        return dependencies;
-    }
-    return __spreadArray([
-        type
-    ], __read(types[type].reduce(function (previous, t) { return __spreadArray(__spreadArray([], __read(previous), false), __read((0, exports.getDependencies)(types, t.type, previous).filter(function (dependency) { return !previous.includes(dependency); })), false); }, [])), false);
-};
-exports.getDependencies = getDependencies;
-function getMerkleTreeType(types, ctx) {
-    if (ctx.parent && ctx.key) {
-        var parentType = types[ctx.parent];
-        var merkleType = parentType.find(function (t) { return t.name === ctx.key; });
-        var isMerkleTree = isMerkleTreeType(merkleType);
-        if (!isMerkleTree) {
-            throw new Error("".concat(ctx.key, " is not a merkle tree"));
-        }
-        if (merkleType.contains.endsWith('*')) {
-            throw new Error("Merkle tree contain property must not be an array but was given ".concat(ctx.key));
-        }
-        return merkleType.contains;
-    }
-    return 'raw';
-}
-/**
- * Encode a type to a string. All dependant types are alphabetically sorted.
- *
- * @param {TypedData} typedData
- * @param {string} type
- * @return {string}
- */
-var encodeType = function (types, type) {
-    var _a = __read((0, exports.getDependencies)(types, type)), primary = _a[0], dependencies = _a.slice(1);
-    var newTypes = !primary ? [] : __spreadArray([primary], __read(dependencies.sort()), false);
-    return newTypes
-        .map(function (dependency) {
-        return "".concat(dependency, "(").concat(types[dependency].map(function (t) { return "".concat(t.name, ":").concat(t.type); }), ")");
-    })
-        .join('');
-};
-exports.encodeType = encodeType;
-/**
- * Get a type string as hash.
- *
- * @param {TypedData} typedData
- * @param {string} type
- * @return {string}
- */
-var getTypeHash = function (types, type) {
-    return (0, hash_1.getSelectorFromName)((0, exports.encodeType)(types, type));
-};
-exports.getTypeHash = getTypeHash;
-/**
- * Encodes a single value to an ABI serialisable string, number or Buffer. Returns the data as tuple, which consists of
- * an array of ABI compatible types, and an array of corresponding values.
- *
- * @param {TypedData} typedData
- * @param {string} type
- * @param {any} data
- * @returns {[string, string]}
- */
-var encodeValue = function (types, type, data, ctx) {
-    if (ctx === void 0) { ctx = {}; }
-    if (types[type]) {
-        // eslint-disable-next-line @typescript-eslint/no-use-before-define
-        return [type, (0, exports.getStructHash)(types, type, data)];
-    }
-    if (Object.keys(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)(types, type.slice(0, -1), struct);
-        });
-        return [type, (0, hash_1.computeHashOnElements)(structHashes)];
-    }
-    if (type === 'merkletree') {
-        var merkleTreeType_1 = getMerkleTreeType(types, ctx);
-        var structHashes = data.map(function (struct) {
-            // eslint-disable-next-line @typescript-eslint/no-use-before-define
-            return (0, exports.encodeValue)(types, merkleTreeType_1, struct)[1];
-        });
-        var root = new merkle_1.MerkleTree(structHashes).root;
-        return ['felt', root];
-    }
-    if (type === 'felt*') {
-        return ['felt*', (0, hash_1.computeHashOnElements)(data)];
-    }
-    if (type === 'selector') {
-        return ['felt', prepareSelector(data)];
-    }
-    return [type, getHex(data)];
-};
-exports.encodeValue = encodeValue;
-/**
- * Encode the data to an ABI encoded Buffer. The data should be a key -> value object with all the required values. All
- * dependant types are automatically encoded.
- *
- * @param {TypedData} typedData
- * @param {string} type
- * @param {Record<string, any>} data
- */
-var encodeData = function (types, type, data) {
-    var _a = __read(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((0, exports.encodeValue)(types, field.type, value, {
-            parent: type,
-            key: field.name,
-        }), 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)(types, type)]]), 2), returnTypes = _a[0], values = _a[1];
-    return [returnTypes, values];
-};
-exports.encodeData = encodeData;
-/**
- * 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.
- *
- * @param {TypedData} typedData
- * @param {string} type
- * @param {Record<string, any>} data
- * @return {Buffer}
- */
-var getStructHash = function (types, type, data) {
-    return (0, hash_1.computeHashOnElements)((0, exports.encodeData)(types, type, data)[1]);
-};
-exports.getStructHash = getStructHash;
-/**
- * Get the EIP-191 encoded message to sign, from the typedData object.
- *
- * @param {TypedData} typedData
- * @param {BigNumberish} account
- * @return {string}
- */
-var getMessageHash = function (typedData, account) {
-    if (!(0, utils_1.validateTypedData)(typedData)) {
-        throw new Error('Typed data does not match JSON schema');
-    }
-    var message = [
-        (0, shortString_1.encodeShortString)('StarkNet Message'),
-        (0, exports.getStructHash)(typedData.types, 'StarkNetDomain', typedData.domain),
-        account,
-        (0, exports.getStructHash)(typedData.types, typedData.primaryType, typedData.message),
-    ];
-    return (0, hash_1.computeHashOnElements)(message);
-};
-exports.getMessageHash = getMessageHash;

package/utils/typedData/types.d.ts

@@ -1,32 +0,0 @@
-export declare type StarkNetMerkleType = {
-    name: string;
-    type: 'merkletree';
-    contains: string;
-};
-/**
- * A single type, as part of a struct. The `type` field can be any of the EIP-712 supported types.
- *
- * Note that the `uint` and `int` aliases like in Solidity, and fixed point numbers are not supported by the EIP-712
- * standard.
- */
-export declare type StarkNetType = {
-    name: string;
-    type: string;
-} | StarkNetMerkleType;
-/**
- * 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;
-}
-/**
- * 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>;
-}

package/utils/typedData/types.js

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

package/utils/typedData/utils.d.ts

@@ -1,8 +0,0 @@
-import { TypedData } from './types';
-/**
- * Validates that `data` matches the EIP-712 JSON schema.
- *
- * @param {any} data
- * @return {boolean}
- */
-export declare const validateTypedData: (data: unknown) => data is TypedData;

package/utils/typedData/utils.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateTypedData = void 0;
-/**
- * Validates that `data` matches the EIP-712 JSON schema.
- *
- * @param {any} data
- * @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;
-};
-exports.validateTypedData = validateTypedData;

package/utils/uint256.d.ts

@@ -1,11 +0,0 @@
-/// <reference types="bn.js" />
-import { BigNumberish } from './number';
-export interface Uint256 {
-    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 isUint256(bn: BigNumberish): boolean;
-export declare function bnToUint256(bignumber: BigNumberish): Uint256;

package/utils/uint256.js

@@ -1,28 +0,0 @@
-"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));
-}
-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));
-// 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);
-}
-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)),
-    };
-}
-exports.bnToUint256 = bnToUint256;

package/utils/url.d.ts

@@ -1,7 +0,0 @@
-/**
- * Loosely validate a URL `string`.
- * @param {String} s
- * @return {Boolean}
- */
-export declare function isUrl(s?: string): boolean;
-export declare function buildUrl(baseUrl: string, defaultPath: string, urlOrPath?: string): string;

package/utils/url.js

@@ -1,49 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildUrl = exports.isUrl = void 0;
-var url_join_1 = __importDefault(require("url-join"));
-/**
- * Inspired from https://github.com/segmentio/is-url
- */
-/**
- * RegExps.
- * A URL must match #1 and then at least one of #2/#3.
- * Use two levels of REs to avoid REDOS.
- */
-var protocolAndDomainRE = /^(?:\w+:)?\/\/(\S+)$/;
-var localhostDomainRE = /^localhost[:?\d]*(?:[^:?\d]\S*)?$/;
-var nonLocalhostDomainRE = /^[^\s.]+\.\S{2,}$/;
-/**
- * Loosely validate a URL `string`.
- * @param {String} s
- * @return {Boolean}
- */
-function isUrl(s) {
-    if (!s) {
-        return false;
-    }
-    if (typeof s !== 'string') {
-        return false;
-    }
-    var match = s.match(protocolAndDomainRE);
-    if (!match) {
-        return false;
-    }
-    var everythingAfterProtocol = match[1];
-    if (!everythingAfterProtocol) {
-        return false;
-    }
-    if (localhostDomainRE.test(everythingAfterProtocol) ||
-        nonLocalhostDomainRE.test(everythingAfterProtocol)) {
-        return true;
-    }
-    return false;
-}
-exports.isUrl = isUrl;
-function buildUrl(baseUrl, defaultPath, urlOrPath) {
-    return isUrl(urlOrPath) ? urlOrPath : (0, url_join_1.default)(baseUrl, urlOrPath !== null && urlOrPath !== void 0 ? urlOrPath : defaultPath);
-}
-exports.buildUrl = buildUrl;