@theqrl/hypc 0.0.2 → 0.3.1

package/linker.js

@@ -5,6 +5,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 const assert_1 = __importDefault(require("assert"));
 const js_sha3_1 = require("js-sha3");
 const helpers_1 = require("./common/helpers");
+const ADDRESS_HEX_LENGTH = 128;
+const ADDRESS_PREFIX = 'Q';
+const PREFIXED_ADDRESS_LENGTH = ADDRESS_HEX_LENGTH + ADDRESS_PREFIX.length;
+const PLACEHOLDER_MARKER_LENGTH = 4;
+const HASH_PLACEHOLDER_MARKER_LENGTH = 6;
+const PLACEHOLDER_BODY_LENGTH = ADDRESS_HEX_LENGTH - PLACEHOLDER_MARKER_LENGTH;
+const HASH_PLACEHOLDER_BODY_LENGTH = ADDRESS_HEX_LENGTH - HASH_PLACEHOLDER_MARKER_LENGTH;
 /**
  * Generates a new-style library placeholder from a fully-qualified library name.
  *
@@ -13,8 +20,32 @@ const helpers_1 = require("./common/helpers");
  *
  * @param fullyQualifiedLibraryName Fully qualified library name.
  */
+function libraryHash(fullyQualifiedLibraryName, length) {
+    let hash = (0, js_sha3_1.keccak256)(fullyQualifiedLibraryName);
+    while (hash.length < length) {
+        hash += (0, js_sha3_1.keccak256)(hash);
+    }
+    return hash.slice(0, length);
+}
 function libraryHashPlaceholder(fullyQualifiedLibraryName) {
-    return `$${(0, js_sha3_1.keccak256)(fullyQualifiedLibraryName).slice(0, 34)}$`;
+    return `$${libraryHash(fullyQualifiedLibraryName, HASH_PLACEHOLDER_BODY_LENGTH)}$`;
+}
+/**
+ * Applies the compiler's address checksum to a hex address body: a letter is upper case when
+ * the matching nibble of SHAKE-256 (64 bytes) of the lower-case body is 8 or more.
+ * Mirrors `checksummedAddressBody` in hyperion's libhyputil/CommonData.cpp.
+ */
+function checksummedAddressBody(body) {
+    const lower = body.toLowerCase();
+    const hash = (0, js_sha3_1.shake256)(lower, ADDRESS_HEX_LENGTH * 4);
+    return [...lower].map((c, i) => (c >= 'a' && c <= 'f' && parseInt(hash[i], 16) >= 8 ? c.toUpperCase() : c)).join('');
+}
+/**
+ * Accepts an all-lower-case or all-upper-case body, or a mixed-case body with a valid checksum,
+ * as the compiler does for `settings.libraries`.
+ */
+function passesAddressChecksum(body) {
+    return body === body.toLowerCase() || body === body.toUpperCase() || body === checksummedAddressBody(body);
 }
 /**
  * Finds all placeholders corresponding to the specified library label and replaces them
@@ -30,9 +61,8 @@ function libraryHashPlaceholder(fullyQualifiedLibraryName) {
  *     It will **not** be padded with zeros if too short.
  */
 function replacePlaceholder(bytecode, label, address) {
-    // truncate to 36 characters
-    const truncatedName = label.slice(0, 36);
-    const libLabel = `__${truncatedName.padEnd(36, '_')}__`;
+    const truncatedName = label.slice(0, PLACEHOLDER_BODY_LENGTH);
+    const libLabel = `__${truncatedName.padEnd(PLACEHOLDER_BODY_LENGTH, '_')}__`;
     while (bytecode.indexOf(libLabel) >= 0) {
         bytecode = bytecode.replace(libLabel, address);
     }
@@ -44,14 +74,14 @@ function replacePlaceholder(bytecode, label, address) {
  * See [Library Linking](https://docs.soliditylang.org/en/latest/using-the-compiler.html#library-linking)
  * for a full explanation of the linking process.
  *
- * Example of a legacy placeholder: `__lib.hyp:L_____________________________`
- * Example of a new-style placeholder: `__$7484607a72fb0587588e5a1e608f0b16de$__`
+ * Example of an old-style placeholder: `__lib.hyp:L...__` padded to 64 bytes.
+ * Example of a new-style placeholder: `__$<122 hex characters>$__`
  *
- * @param bytecode Hex-encoded bytecode string. All 40-byte substrings starting and ending with
+ * @param bytecode Hex-encoded bytecode string. All 64-byte substrings starting and ending with
  *     `__` will be interpreted as placeholders.
  *
  * @param libraries Mapping between fully qualified library names and the hex-encoded
- *     addresses they should be replaced with. Addresses shorter than 40 characters are automatically padded with zeros.
+ *     addresses they should be replaced with.
  *
  * @returns bytecode Hex-encoded bytecode string with placeholders replaced with addresses.
  *    Note that some placeholders may remain in the bytecode if `libraries` does not provide addresses for all of them.
@@ -66,7 +96,7 @@ function linkBytecode(bytecode, libraries) {
             throw new Error(`No address provided for library ${fullyQualifiedLibraryName}`);
         }
         // API compatible with the standard JSON i/o
-        // {"lib.hyp": {"L": "Z..."}}
+        // {"lib.hyp": {"L": "Q..."}}
         if ((0, helpers_1.isObject)(libraryObjectOrAddress)) {
             for (const [unqualifiedLibraryName, address] of Object.entries(libraryObjectOrAddress)) {
                 librariesComplete[unqualifiedLibraryName] = address;
@@ -85,11 +115,16 @@ function linkBytecode(bytecode, libraries) {
     }
     for (const libraryName in librariesComplete) {
         let hexAddress = librariesComplete[libraryName];
-        if (!hexAddress.startsWith('Z') || hexAddress.length > 41) {
+        if (!hexAddress.startsWith(ADDRESS_PREFIX) ||
+            hexAddress.length !== PREFIXED_ADDRESS_LENGTH ||
+            !/^[0-9a-fA-F]+$/.test(hexAddress.slice(ADDRESS_PREFIX.length))) {
             throw new Error(`Invalid address specified for ${libraryName}`);
         }
-        // remove 0x prefix
-        hexAddress = hexAddress.slice(1).padStart(40, '0');
+        // remove address prefix
+        hexAddress = hexAddress.slice(ADDRESS_PREFIX.length);
+        if (!passesAddressChecksum(hexAddress)) {
+            throw new Error(`Invalid address checksum specified for ${libraryName}`);
+        }
         bytecode = replacePlaceholder(bytecode, libraryName, hexAddress);
         bytecode = replacePlaceholder(bytecode, libraryHashPlaceholder(libraryName), hexAddress);
     }
@@ -97,17 +132,17 @@ function linkBytecode(bytecode, libraries) {
 }
 /**
  * Finds locations of all library address placeholders in the hex-encoded bytecode.
- * Returns information in a format matching `zvm.bytecode.linkReferences` output
+ * Returns information in a format matching `qrvm.bytecode.linkReferences` output
  * in Standard JSON.
  *
  * See [Library Linking](https://docs.soliditylang.org/en/latest/using-the-compiler.html#library-linking)
  * for a full explanation of library placeholders and linking process.
  *
- * WARNING: The output matches `zvm.bytecode.linkReferences` exactly only in
+ * WARNING: The output matches `qrvm.bytecode.linkReferences` exactly only in
  * case of old-style placeholders created from fully qualified library names
  * of no more than 36 characters, and even then only if the name does not start
  * or end with an underscore. This is different from
- * `zvm.bytecode.linkReferences`, which uses fully qualified library names.
+ * `qrvm.bytecode.linkReferences`, which uses fully qualified library names.
  * This is a limitation of the placeholder format - the fully qualified names
  * are not preserved in the compiled bytecode and cannot be reconstructed
  * without external information.
@@ -116,37 +151,33 @@ function linkBytecode(bytecode, libraries) {
  *
  * @returns linkReferences A mapping between library labels and their locations
  * in the bytecode. In case of old-style placeholders the label is a fully
- * qualified library name truncated to 36 characters. For new-style placeholders
- * it's the first 34 characters of the hex-encoded hash of the fully qualified
- * library name, with a leading and trailing $ character added. Note that the
+ * qualified library name truncated to 124 characters. For new-style placeholders
+ * it's the address-width hash label of the fully qualified library name, with a leading
+ * and trailing $ character added. Note that the
  * offsets and lengths refer to the *binary* (not hex-encoded) bytecode, just
- * like in `zvm.bytecode.linkReferences`.
+ * like in `qrvm.bytecode.linkReferences`.
  */
 function findLinkReferences(bytecode) {
     (0, assert_1.default)(typeof bytecode === 'string');
-    // find 40 bytes in the pattern of __...<36 digits>...__
-    // e.g. __Lib.hyp:L_____________________________
+    // find 64-byte placeholders in the pattern of __...__
+    // e.g. __Lib.hyp:L_____________________________ or __$<122 hex digits>$__
     const linkReferences = {};
-    let offset = 0;
-    while (true) {
-        const found = bytecode.match(/__(.{36})__/);
-        if (!found) {
-            break;
-        }
+    const placeholderPattern = /__(.{124})__/g;
+    let found;
+    while ((found = placeholderPattern.exec(bytecode)) !== null) {
         const start = found.index;
+        const placeholder = found[1];
         // trim trailing underscores
         // NOTE: this has no way of knowing if the trailing underscore was part of the name
-        const libraryName = found[1].replace(/_+$/gm, '');
+        const libraryName = placeholder.replace(/_+$/gm, '');
         if (!linkReferences[libraryName]) {
             linkReferences[libraryName] = [];
         }
         // offsets are in bytes in binary representation (and not hex)
         linkReferences[libraryName].push({
-            start: (offset + start) / 2,
-            length: 20
+            start: start / 2,
+            length: ADDRESS_HEX_LENGTH / 2
         });
-        offset += start + 20;
-        bytecode = bytecode.slice(start + 20);
     }
     return linkReferences;
 }

package/package.json

@@ -1,33 +1,37 @@
 {
     "name": "@theqrl/hypc",
-    "version": "0.0.2",
+    "version": "0.3.1",
     "description": "Hyperion compiler",
     "main": "index.js",
     "bin": {
         "hypcjs": "hypc.js"
     },
+    "files": [
+        "*.js",
+        "bindings/*.js",
+        "common/*.js"
+    ],
     "scripts": {
         "build": "tsc",
         "postbuild": "node build/postbuild.js && cp README.md LICENSE dist/",
-        "lint": "eslint --ext .js,.ts .",
-        "lint:fix": "eslint --fix --ext .js,.ts .",
+        "lint": "eslint .",
+        "lint:fix": "eslint --fix .",
         "updateBinary": "node build/clean.js && ts-node ./downloadCurrentVersion.ts && ts-node ./verifyVersion.ts",
         "prepack": "node build/pack-publish-block.js",
         "build:tarball": "npm run updateBinary && npm run build && BYPASS_SAFETY_CHECK=true npm pack ./dist",
         "publish:tarball": "tarball=$(npm run --silent tarballName) && ls \"$tarball\" && BYPASS_SAFETY_CHECK=true npm publish --access public \"$tarball\"",
-        "tarballName": "jq --raw-output '.name + \"-\" + .version + \".tgz\"' package.json",
+        "tarballName": "jq --raw-output '(.name | sub(\"@\"; \"\") | gsub(\"/\"; \"-\")) + \"-\" + .version + \".tgz\"' package.json",
         "copyTestFiles": "cp -r ./test/resources ./dist/test/",
         "pretest": "npm run lint && npm run build && npm run copyTestFiles",
-        "test": "cd dist && tape ./test/index.js",
-        "coverage": "nyc npm run test",
-        "coveralls": "npm run coverage && coveralls <coverage/lcov.info"
+        "test": "cd dist && tape ./test/index.js --no-remote-versions",
+        "coverage": "nyc npm run test"
     },
     "repository": {
         "type": "git",
         "url": "git+https://github.com/theQRL/hypc-js.git"
     },
     "keywords": [
-        "zond",
+        "qrl",
         "hyperion",
         "compiler"
     ],
@@ -37,33 +41,29 @@
         "url": "https://github.com/theQRL/hypc-js/issues"
     },
     "homepage": "https://github.com/theQRL/hypc-js#readme",
+    "engines": {
+        "node": ">=22.12.0"
+    },
     "dependencies": {
         "command-exists": "^1.2.8",
-        "commander": "^8.1.0",
-        "follow-redirects": "^1.12.1",
-        "js-sha3": "0.8.0",
-        "memorystream": "^0.3.1",
-        "semver": "^5.5.0",
-        "tmp": "0.0.33"
+        "commander": "^15.0.0",
+        "follow-redirects": "^1.16.2",
+        "js-sha3": "0.13.0",
+        "semver": "^7.8.5",
+        "tmp": "0.2.7"
     },
     "devDependencies": {
-        "@types/node": "^16.11.7",
-        "@types/semver": "^7.3.9",
-        "@types/tape": "^4.13.2",
+        "@types/node": "^22.12.0",
+        "@types/semver": "^7.8.0",
+        "@types/tape": "^5.8.1",
         "@types/tmp": "^0.2.3",
-        "@typescript-eslint/eslint-plugin": "^5.8.0",
-        "@typescript-eslint/parser": "^5.8.0",
-        "coveralls": "^3.0.0",
-        "eslint": "^7.32.0",
-        "eslint-config-standard": "^16.0.3",
-        "eslint-plugin-import": "^2.25.3",
-        "eslint-plugin-node": "^11.1.0",
-        "eslint-plugin-promise": "^5.1.1",
-        "nyc": "^15.1.0",
-        "tape": "^4.11.0",
+        "eslint": "^10.13.0",
+        "neostandard": "^0.14.1",
+        "nyc": "^18.0.0",
+        "tape": "^5.10.3",
         "tape-spawn": "^1.4.2",
         "ts-node": "^10.4.0",
-        "typescript": "^4.5.4"
+        "typescript": "~6.0.2"
     },
     "nyc": {
         "exclude": [

package/smtchecker.js

@@ -1,4 +1,5 @@
 "use strict";
+const helpers_1 = require("./common/helpers");
 // This function checks the standard JSON output for auxiliaryInputRequested,
 // where smtlib2queries represent the queries created by the SMTChecker.
 // The function runs an SMT solver on each query and adjusts the input for
@@ -29,7 +30,8 @@ function smtCallback(solverFunction, solver) {
             return { contents: result };
         }
         catch (err) {
-            return { error: err };
+            // The compiler takes the error as a string, like the contents.
+            return { error: (0, helpers_1.describeException)(err) };
         }
     };
 }

package/smtsolver.js

@@ -15,34 +15,51 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 const command_exists_1 = require("command-exists");
 const child_process_1 = require("child_process");
 const fs = __importStar(require("fs"));
 const tmp = __importStar(require("tmp"));
 // Timeout in ms.
 const timeout = 10000;
+// Solver answers are short; this only bounds a runaway solver.
+const maxBuffer = 64 * 1024 * 1024;
 const potentialSolvers = [
     {
         name: 'z3',
         command: 'z3',
-        params: '-smt2 rlimit=20000000 rewriter.pull_cheap_ite=true fp.spacer.q3.use_qgen=true fp.spacer.mbqi=false fp.spacer.ground_pobs=false'
+        params: ['-smt2', 'rlimit=20000000', 'rewriter.pull_cheap_ite=true', 'fp.spacer.q3.use_qgen=true', 'fp.spacer.mbqi=false', 'fp.spacer.ground_pobs=false']
     },
     {
         name: 'Eldarica',
         command: 'eld',
-        params: '-horn -t:' + (timeout / 1000) // Eldarica takes timeout in seconds.
+        params: ['-horn', '-t:' + (timeout / 1000)] // Eldarica takes timeout in seconds.
+    },
+    {
+        name: 'cvc5',
+        command: 'cvc5',
+        params: ['--lang=smt2', '--tlimit=' + timeout]
     },
     {
         name: 'cvc4',
         command: 'cvc4',
-        params: '--lang=smt2 --tlimit=' + timeout
+        params: ['--lang=smt2', '--tlimit=' + timeout]
     }
 ];
 const solvers = potentialSolvers.filter(solver => (0, command_exists_1.sync)(solver.command));
@@ -59,18 +76,26 @@ function solve(query, solver) {
     fs.writeFileSync(tmpFile.name, query);
     let solverOutput;
     try {
-        solverOutput = (0, child_process_1.execSync)(solver.command + ' ' + solver.params + ' ' + tmpFile.name, {
+        // No shell: the solver gets its arguments as an array. A caller's solver configuration may
+        // still give params as one string, as before; it is split on whitespace.
+        const params = typeof solver.params === 'string' ? solver.params.split(/\s+/).filter(Boolean) : solver.params;
+        solverOutput = (0, child_process_1.execFileSync)(solver.command, [...params, tmpFile.name], {
             encoding: 'utf8',
-            maxBuffer: 1024 * 1024 * 1024,
+            maxBuffer,
             stdio: 'pipe',
-            timeout: timeout // Enforce timeout on the process, since solvers can sometimes go around it.
+            timeout, // Enforce timeout on the process, since solvers can sometimes go around it.
+            killSignal: 'SIGKILL' // A solver can ignore SIGTERM.
         }).toString();
     }
     catch (e) {
-        // execSync throws if the process times out or returns != 0.
+        // The output was cut off at maxBuffer, so even an answer at its start cannot be trusted.
+        if (e.code === 'ENOBUFS') {
+            throw new Error(`Failed to solve SMT query. The solver wrote more than ${maxBuffer} bytes.`);
+        }
+        // execFileSync throws if the process times out or returns != 0.
         // The latter might happen with z3 if the query asks for a model
         // for an UNSAT formula. We can still use stdout.
-        solverOutput = e.stdout.toString();
+        solverOutput = (e.stdout || '').toString();
         if (!solverOutput.startsWith('sat') &&
             !solverOutput.startsWith('unsat') &&
             !solverOutput.startsWith('unknown') &&
@@ -79,8 +104,10 @@ function solve(query, solver) {
             throw new Error('Failed to solve SMT query. ' + e.toString());
         }
     }
-    // Trigger early manual cleanup
-    tmpFile.removeCallback();
+    finally {
+        // Trigger early manual cleanup
+        tmpFile.removeCallback();
+    }
     return solverOutput;
 }
 module.exports = {

package/translate.js

@@ -7,8 +7,8 @@ const linker_1 = __importDefault(require("./linker"));
 /// Old style: 0.3.6-3fc68da5/Release-Emscripten/clang
 ///            0.3.5-371690f0/Release-Emscripten/clang/Interpreter
 ///            0.3.5-0/Release-Emscripten/clang/Interpreter
-///            0.2.0-e7098958/.-Emscripten/clang/int linked to libzond-1.1.1-bbb80ab0/.-Emscripten/clang/int
-///            0.1.3-0/.-/clang/int linked to libzond-0.9.92-0/.-/clang/int
+///            0.2.0-e7098958/.-Emscripten/clang/int linked to libqrl-1.1.1-bbb80ab0/.-Emscripten/clang/int
+///            0.1.3-0/.-/clang/int linked to libqrl-0.9.92-0/.-/clang/int
 ///            0.1.2-5c3bfd4b*/.-/clang/int
 ///            0.1.1-6ff4cd6b/RelWithDebInfo-Emscripten/clang/int
 /// New style: 0.4.5+commit.b318366e.Emscripten.clang
@@ -42,7 +42,7 @@ function translateErrors(ret, errors) {
             type = 'Error';
         }
         ret.push({
-            type: type,
+            type,
             component: 'general',
             severity: (type === 'Warning') ? 'warning' : 'error',
             message: errors[error],
@@ -106,7 +106,7 @@ function translateJsonCompilerOutput(output, libraries) {
         const contractOutput = {
             abi: JSON.parse(contractInput.interface),
             metadata: contractInput.metadata,
-            zvm: {
+            qrvm: {
                 legacyAssembly: contractInput.assembly,
                 bytecode: {
                     object: contractInput.bytecode && linker_1.default.linkBytecode(contractInput.bytecode, libraries || {}),

package/verifyVersion.js

@@ -16,13 +16,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };