@ledgerhq/hw-app-eth/lib/modules/EIP712/EIP712.utils.js

"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
var __generator = (this && this.__generator) || function (thisArg, body) {
    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
    function verb(n) { return function (v) { return step([n, v]); }; }
    function step(op) {
        if (f) throw new TypeError("Generator is already executing.");
        while (_) try {
            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
            if (y = 0, t) op = [op[0] & 2, t.value];
            switch (op[0]) {
                case 0: case 1: t = op; break;
                case 4: _.label++; return { value: op[1], done: false };
                case 5: _.label++; y = op[1]; op = [0]; continue;
                case 7: op = _.ops.pop(); _.trys.pop(); continue;
                default:
                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
                    if (t[2]) _.ops.pop();
                    _.trys.pop(); continue;
            }
            op = body.call(thisArg, _);
        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
    }
};
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));
};
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
exports.__esModule = true;
exports.getFiltersForMessage = exports.getSchemaHashForMessage = exports.sortObjectAlphabetically = exports.isEIP712Message = exports.makeTypeEntryStructBuffer = exports.constructTypeDescByteString = exports.destructTypeFromString = exports.EIP712_TYPE_ENCODERS = exports.EIP712_TYPE_PROPERTIES = void 0;
var axios_1 = __importDefault(require("axios"));
var sha224_1 = __importDefault(require("crypto-js/sha224"));
var utils_1 = require("../../utils");
var eip712_1 = __importDefault(require("@ledgerhq/cryptoassets/data/eip712"));
var bignumber_js_1 = __importDefault(require("bignumber.js"));
var NULL_ADDRESS = "0x0000000000000000000000000000000000000000";
/**
 * @ignore for the README
 *
 * A Map of helpers to get the wanted binary value for
 * each type of array possible in a type definition
 */
var EIP712_ARRAY_TYPE_VALUE;
(function (EIP712_ARRAY_TYPE_VALUE) {
    EIP712_ARRAY_TYPE_VALUE[EIP712_ARRAY_TYPE_VALUE["DYNAMIC"] = 0] = "DYNAMIC";
    EIP712_ARRAY_TYPE_VALUE[EIP712_ARRAY_TYPE_VALUE["FIXED"] = 1] = "FIXED";
})(EIP712_ARRAY_TYPE_VALUE || (EIP712_ARRAY_TYPE_VALUE = {}));
/**
 * @ignore for the README
 *
 * A Map of helpers to get the id and size to return for each
 * type that can be used in EIP712
 */
exports.EIP712_TYPE_PROPERTIES = {
    CUSTOM: {
        key: function () { return 0; },
        sizeInBits: function () { return null; }
    },
    INT: {
        key: function () { return 1; },
        sizeInBits: function (size) { return Number(size) / 8; }
    },
    UINT: {
        key: function () { return 2; },
        sizeInBits: function (size) { return Number(size) / 8; }
    },
    ADDRESS: {
        key: function () { return 3; },
        sizeInBits: function () { return null; }
    },
    BOOL: {
        key: function () { return 4; },
        sizeInBits: function () { return null; }
    },
    STRING: {
        key: function () { return 5; },
        sizeInBits: function () { return null; }
    },
    BYTES: {
        key: function (size) { return (typeof size !== "undefined" ? 6 : 7); },
        sizeInBits: function (size) { return (typeof size !== "undefined" ? Number(size) : null); }
    }
};
/**
 * @ignore for the README
 *
 * A Map of encoders to transform a value to formatted buffer
 */
exports.EIP712_TYPE_ENCODERS = {
    INT: function (value, sizeInBits) {
        if (sizeInBits === void 0) { sizeInBits = 256; }
        var failSafeValue = value !== null && value !== void 0 ? value : "0";
        if (typeof failSafeValue === "string" && (failSafeValue === null || failSafeValue === void 0 ? void 0 : failSafeValue.startsWith("0x"))) {
            return (0, utils_1.hexBuffer)(failSafeValue);
        }
        var valueAsBN = new bignumber_js_1["default"](failSafeValue);
        // If negative we'll use `two's complement` method to
        // "reversibly convert a positive binary number into a negative binary number with equivalent (but negative) value".
        // thx wikipedia
        if (valueAsBN.lt(0)) {
            var sizeInBytes = sizeInBits / 8;
            // Creates BN from a buffer serving as a mask filled by maximum value 0xff
            var maskAsBN = new bignumber_js_1["default"]("0x".concat(Buffer.alloc(sizeInBytes, 0xff).toString("hex")));
            // two's complement version of value
            valueAsBN = maskAsBN.plus(valueAsBN).plus(1);
        }
        var paddedHexString = valueAsBN.toString(16).length % 2
            ? "0" + valueAsBN.toString(16)
            : valueAsBN.toString(16);
        return Buffer.from(paddedHexString, "hex");
    },
    UINT: function (value) {
        return this.INT(value);
    },
    BOOL: function (value) {
        return this.INT(typeof value === "boolean" ? Number(value).toString() : value);
    },
    ADDRESS: function (value) {
        // Only sending the first 10 bytes (why ?)
        return (0, utils_1.hexBuffer)(value !== null && value !== void 0 ? value : "").slice(0, 20);
    },
    STRING: function (value) {
        return Buffer.from(value !== null && value !== void 0 ? value : "", "utf-8");
    },
    BYTES: function (value, sizeInBits) {
        var failSafeValue = value !== null && value !== void 0 ? value : "";
        // Why slice again ?
        return (0, utils_1.hexBuffer)(failSafeValue).slice(0, sizeInBits !== null && sizeInBits !== void 0 ? sizeInBits : ((failSafeValue === null || failSafeValue === void 0 ? void 0 : failSafeValue.length) - 2) / 2);
    }
};
/**
 * @ignore for the README
 *
 * Helper parsing an EIP712 Type name to return its type and size(s)
 * if it's an array or nested arrays
 *
 * @see EIP712MessageTypes
 *
 * @example "uint8[2][][4]" => [{name: "uint", bits: 8}, [2, null, 4]]
 * @example "bool" => [{name: "bool", bits: null}, []]
 *
 * @param {String} typeName
 * @returns {[{ name: string; bits: Number | null }, Array<Number | null | undefined>]}
 */
var destructTypeFromString = function (typeName) {
    // Will split "any[][1][10]" in "any", "[][1][10]"
    var splitNameAndArraysRegex = new RegExp(/^([^[\]]*)(\[.*\])*/g);
    // Will match all numbers (or null) inside each array. [0][10][] => [0,10,null]
    var splitArraysRegex = new RegExp(/\[(\d*)\]/g);
    // Will separate the the name from the potential bits allocation. uint8 => [uint,8]
    var splitNameAndNumberRegex = new RegExp(/(\D*)(\d*)/);
    var _a = __read(splitNameAndArraysRegex.exec(typeName || "") || [], 3), type = _a[1], maybeArrays = _a[2];
    var _b = __read(splitNameAndNumberRegex.exec(type || "") || [], 3), name = _b[1], bits = _b[2];
    var typeDescription = name
        ? { name: name, bits: bits ? Number(bits) : undefined }
        : null;
    var arrays = maybeArrays ? __spreadArray([], __read(maybeArrays.matchAll(splitArraysRegex)), false) : [];
    // Parse each size to either a Number or null
    var arraySizes = arrays.map(function (_a) {
        var _b = __read(_a, 2), size = _b[1];
        return (size ? Number(size) : null);
    });
    return [typeDescription, arraySizes];
};
exports.destructTypeFromString = destructTypeFromString;
/**
 * @ignore for the README
 *
 * Helper to construct the hexadecimal ByteString for the description
 * of a field in an EIP712 Message
 *
 * @param isArray
 * @param typeSize
 * @param typeValue
 * @returns {String} HexByteString
 */
var constructTypeDescByteString = function (isArray, typeSize, typeValue) {
    if (typeValue >= 16) {
        throw new Error("Eth utils - constructTypeDescByteString - Cannot accept a typeValue >= 16 because the typeValue can only be 4 bits in binary" +
            { isArray: isArray, typeSize: typeSize, typeValue: typeValue });
    }
    // 1 is array, 0 is not array
    var isArrayBit = isArray ? "1" : "0";
    // 1 has type size, 0 has no type size
    var hasTypeSize = typeof typeSize === "number" ? "1" : "0";
    // 2 unused bits
    var unusedBits = "00";
    // type key as 4 bits
    var typeValueBits = typeValue.toString(2).padStart(4, "0");
    return (0, utils_1.intAsHexBytes)(parseInt(isArrayBit + hasTypeSize + unusedBits + typeValueBits, 2), 1);
};
exports.constructTypeDescByteString = constructTypeDescByteString;
/**
 * @ignore for the README
 *
 * Helper to create the buffer to describe an EIP712 types' entry structure
 *
 * @param {EIP712MessageTypesEntry} entry
 * @returns {Buffer}
 */
var makeTypeEntryStructBuffer = function (_a) {
    var _b, _c, _d, _e;
    var name = _a.name, type = _a.type;
    var _f = __read((0, exports.destructTypeFromString)(type), 2), typeDescription = _f[0], arrSizes = _f[1];
    var isTypeAnArray = Boolean(arrSizes.length);
    var typeProperties = exports.EIP712_TYPE_PROPERTIES[((_b = typeDescription === null || typeDescription === void 0 ? void 0 : typeDescription.name) === null || _b === void 0 ? void 0 : _b.toUpperCase()) || ""] ||
        exports.EIP712_TYPE_PROPERTIES.CUSTOM;
    var typeKey = typeProperties.key(typeDescription === null || typeDescription === void 0 ? void 0 : typeDescription.bits);
    var typeSizeInBits = typeProperties.sizeInBits(typeDescription === null || typeDescription === void 0 ? void 0 : typeDescription.bits);
    var typeDescData = (0, exports.constructTypeDescByteString)(isTypeAnArray, typeSizeInBits, typeKey);
    var bufferArray = [Buffer.from(typeDescData, "hex")];
    if (typeProperties === exports.EIP712_TYPE_PROPERTIES.CUSTOM) {
        bufferArray.push(Buffer.from((0, utils_1.intAsHexBytes)((_d = (_c = typeDescription === null || typeDescription === void 0 ? void 0 : typeDescription.name) === null || _c === void 0 ? void 0 : _c.length) !== null && _d !== void 0 ? _d : 0, 1), "hex"));
        bufferArray.push(Buffer.from((_e = typeDescription === null || typeDescription === void 0 ? void 0 : typeDescription.name) !== null && _e !== void 0 ? _e : "", "utf-8"));
    }
    if (typeof typeSizeInBits === "number") {
        bufferArray.push(Buffer.from((0, utils_1.intAsHexBytes)(typeSizeInBits, 1), "hex"));
    }
    if (isTypeAnArray) {
        bufferArray.push(Buffer.from((0, utils_1.intAsHexBytes)(arrSizes.length, 1), "hex"));
        arrSizes.forEach(function (size) {
            if (typeof size === "number") {
                bufferArray.push(Buffer.from((0, utils_1.intAsHexBytes)(EIP712_ARRAY_TYPE_VALUE.FIXED, 1), "hex"), Buffer.from((0, utils_1.intAsHexBytes)(size, 1), "hex"));
            }
            else {
                bufferArray.push(Buffer.from((0, utils_1.intAsHexBytes)(EIP712_ARRAY_TYPE_VALUE.DYNAMIC, 1), "hex"));
            }
        });
    }
    bufferArray.push(Buffer.from((0, utils_1.intAsHexBytes)(name.length, 1), "hex"), Buffer.from(name, "utf-8"));
    return Buffer.concat(bufferArray);
};
exports.makeTypeEntryStructBuffer = makeTypeEntryStructBuffer;
// As defined in [spec](https://eips.ethereum.org/EIPS/eip-712), the properties below are all required.
function isEIP712Message(message) {
    return (typeof message === "object" &&
        "types" in message &&
        "primaryType" in message &&
        "domain" in message &&
        "message" in message);
}
exports.isEIP712Message = isEIP712Message;
var sortObjectAlphabetically = function (obj) {
    var keys = Object.keys(obj).sort();
    return keys.reduce(function (acc, curr) {
        var value = (function () {
            if (Array.isArray(obj[curr])) {
                return obj[curr].map(function (field) {
                    return (0, exports.sortObjectAlphabetically)(field);
                });
            }
            return obj[curr];
        })();
        acc[curr] = value;
        return acc;
    }, {});
};
exports.sortObjectAlphabetically = sortObjectAlphabetically;
var getSchemaHashForMessage = function (message) {
    var types = message.types;
    var sortedTypes = (0, exports.sortObjectAlphabetically)(types);
    return (0, sha224_1["default"])(JSON.stringify(sortedTypes).replace(" ", "")).toString();
};
exports.getSchemaHashForMessage = getSchemaHashForMessage;
/**
 * @ignore for the README
 *
 * Tries to find the proper filters for a given EIP712 message
 * in the CAL
 *
 * @param {EIP712Message} message
 * @returns {MessageFilters | undefined}
 */
var getFiltersForMessage = function (message, remoteCryptoAssetsListURI) { return __awaiter(void 0, void 0, void 0, function () {
    var schemaHash, messageId, dynamicCAL, e_1;
    var _a, _b, _c, _d;
    return __generator(this, function (_e) {
        switch (_e.label) {
            case 0:
                schemaHash = (0, exports.getSchemaHashForMessage)(message);
                messageId = "".concat((_b = (_a = message.domain) === null || _a === void 0 ? void 0 : _a.chainId) !== null && _b !== void 0 ? _b : 0, ":").concat((_d = (_c = message.domain) === null || _c === void 0 ? void 0 : _c.verifyingContract) !== null && _d !== void 0 ? _d : NULL_ADDRESS, ":").concat(schemaHash);
                _e.label = 1;
            case 1:
                _e.trys.push([1, 4, , 5]);
                if (!remoteCryptoAssetsListURI) return [3 /*break*/, 3];
                return [4 /*yield*/, axios_1["default"].get("".concat(remoteCryptoAssetsListURI, "/eip712.json"))];
            case 2:
                dynamicCAL = (_e.sent()).data;
                return [2 /*return*/, dynamicCAL[messageId] || eip712_1["default"][messageId]];
            case 3: throw new Error();
            case 4:
                e_1 = _e.sent();
                return [2 /*return*/, eip712_1["default"][messageId]];
            case 5: return [2 /*return*/];
        }
    });
}); };
exports.getFiltersForMessage = getFiltersForMessage;
//# sourceMappingURL=EIP712.utils.js.map