@stacks/rendezvous 0.4.0 → 0.5.0

package/dist/app.js

@@ -9,11 +9,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getManifestFileName = void 0;
+exports.tryParseRemoteDataSettings = exports.getManifestFileName = exports.invalidRemoteDataErrorMessage = exports.noRemoteData = void 0;
 exports.main = main;
 const path_1 = require("path");
 const events_1 = require("events");
+const toml_1 = __importDefault(require("toml"));
 const property_1 = require("./property");
 const invariant_1 = require("./invariant");
 const shared_1 = require("./shared");
@@ -25,6 +29,16 @@ const dialer_1 = require("./dialer");
 const logger = (log, logLevel = "log") => {
     console[logLevel](log);
 };
+/**
+ * The object used to initialize an empty simnet session with, when no remote
+ * data is enabled in the `Clarinet.toml` file.
+ */
+exports.noRemoteData = {
+    enabled: false,
+    api_url: "",
+    initial_height: 1,
+};
+exports.invalidRemoteDataErrorMessage = `Remote data settings not properly setup in Clarinet.toml! To use remote data, please provide the "api_url", "initial_height", and "enabled" fields under the "repl.remote_data" section in the Clarinet.toml file.`;
 /**
  * Gets the manifest file name for a Clarinet project.
  * If a custom manifest exists (`Clarinet-<contract-name>.toml`), it is used.
@@ -41,6 +55,22 @@ const getManifestFileName = (manifestDir, targetContractName) => {
     return "Clarinet.toml";
 };
 exports.getManifestFileName = getManifestFileName;
+const tryParseRemoteDataSettings = (manifestPath, radio) => {
+    var _a, _b;
+    const clarinetToml = toml_1.default.parse((0, fs_1.readFileSync)((0, path_1.resolve)(manifestPath), "utf-8"));
+    const remoteDataUserSettings = (_b = (_a = clarinetToml.repl) === null || _a === void 0 ? void 0 : _a["remote_data"]) !== null && _b !== void 0 ? _b : undefined;
+    if (remoteDataUserSettings !== undefined &&
+        (!(remoteDataUserSettings === null || remoteDataUserSettings === void 0 ? void 0 : remoteDataUserSettings["api_url"]) ||
+            !(remoteDataUserSettings === null || remoteDataUserSettings === void 0 ? void 0 : remoteDataUserSettings["enabled"]) ||
+            !(remoteDataUserSettings === null || remoteDataUserSettings === void 0 ? void 0 : remoteDataUserSettings["initial_height"]))) {
+        throw new Error(exports.invalidRemoteDataErrorMessage);
+    }
+    if (remoteDataUserSettings) {
+        radio.emit("logMessage", (0, ansicolor_1.yellow)("\nUsing remote data. Setting up the environment can take up to a minute..."));
+    }
+    return remoteDataUserSettings || exports.noRemoteData;
+};
+exports.tryParseRemoteDataSettings = tryParseRemoteDataSettings;
 const helpMessage = `
   rv v${package_json_1.version}
   
@@ -130,7 +160,8 @@ function main() {
         if (dialerRegistry !== undefined) {
             dialerRegistry.registerDialers();
         }
-        const simnet = yield (0, citizen_1.issueFirstClassCitizenship)(manifestDir, manifestPath, sutContractName);
+        const remoteDataSettings = (0, exports.tryParseRemoteDataSettings)(manifestPath, radio);
+        const simnet = yield (0, citizen_1.issueFirstClassCitizenship)(manifestDir, manifestPath, remoteDataSettings, sutContractName);
         /**
          * The list of contract IDs for the SUT contract names, as per the simnet.
          */

package/dist/app.types.js

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

package/dist/citizen.js

@@ -18,6 +18,7 @@ const fs_1 = require("fs");
 const path_1 = require("path");
 const yaml_1 = __importDefault(require("yaml"));
 const clarinet_sdk_1 = require("@hirosystems/clarinet-sdk");
+const transactions_1 = require("@stacks/transactions");
 /**
  * Prepares the simnet instance and assures the target contract's corresponding
  * test contract is treated as a first-class citizen, relying on their
@@ -28,11 +29,12 @@ const clarinet_sdk_1 = require("@hirosystems/clarinet-sdk");
  *
  * @param manifestDir The relative path to the manifest directory.
  * @param manifestPath The absolute path to the manifest file.
+ * @param remoteDataSettings The remote data settings.
  * @param sutContractName The target contract name.
  * @returns The initialized simnet instance with all contracts deployed, with
  * the test contract treated as a first-class citizen of the target contract.
  */
-const issueFirstClassCitizenship = (manifestDir, manifestPath, sutContractName) => __awaiter(void 0, void 0, void 0, function* () {
+const issueFirstClassCitizenship = (manifestDir, manifestPath, remoteDataSettings, sutContractName) => __awaiter(void 0, void 0, void 0, function* () {
     // Initialize the simnet, to generate the simnet plan and instance. The empty
     // session will be set up, and contracts will be deployed in the correct
     // order based on the simnet plan a few lines below.
@@ -41,7 +43,15 @@ const issueFirstClassCitizenship = (manifestDir, manifestPath, sutContractName)
         encoding: "utf-8",
     }));
     const sortedContractsByEpoch = (0, exports.groupContractsByEpochFromSimnetPlan)(simnetPlan);
-    yield simnet.initEmptySession();
+    const simnetAddresses = [...simnet.getAccounts().values()];
+    const balancesMap = new Map(Array.from(simnetAddresses, (address) => {
+        const balanceHex = simnet.runSnippet(`(stx-get-balance '${address})`);
+        return [address, (0, transactions_1.cvToValue)((0, transactions_1.hexToCV)(balanceHex))];
+    }));
+    yield simnet.initEmptySession(remoteDataSettings);
+    simnetAddresses.forEach((address) => {
+        simnet.mintSTX(address, balancesMap.get(address));
+    });
     // Combine the target contract with its tests into a single contract. The
     // resulting contract will replace the target contract in the simnet.
     /** The contract names mapped to the concatenated source code. */

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stacks/rendezvous",
-    "version": "0.4.0",
+    "version": "0.5.0",
     "description": "Meet your contract's vulnerabilities head-on.",
     "main": "app.js",
     "bin": {
@@ -30,14 +30,15 @@
         "url": "https://github.com/stacks-network/rendezvous.git"
     },
     "dependencies": {
-        "@hirosystems/clarinet-sdk": "2.12.0",
+        "@hirosystems/clarinet-sdk": "2.14.0",
         "@stacks/transactions": "^6.16.1",
         "ansicolor": "^2.0.3",
         "fast-check": "^3.20.0",
+        "toml": "^3.0.0",
         "yaml": "^2.6.1"
     },
     "devDependencies": {
-        "@hirosystems/clarinet-sdk-wasm": "2.12.0",
+        "@hirosystems/clarinet-sdk-wasm": "2.14.0",
         "@types/jest": "^29.5.12",
         "jest": "^29.7.0",
         "ts-jest": "^29.2.5",

package/dist/property.js

@@ -171,10 +171,21 @@ const checkProperties = (simnet, targetContractName, rendezvousList, rendezvousA
                     }
                 }
                 else {
-                    throw new Error(`Test failed for ${targetContractName} contract: "${r.selectedTestFunction.name}" returned ${testFunctionCallResultJson.value.value}`);
+                    // The function call did not result in (ok true) or (ok false).
+                    // Either the test failed or the test function returned an
+                    // unexpected value i.e. `(ok 1)`.
+                    const displayedError = (0, transactions_1.cvToString)(testFunctionCallResult);
+                    throw new PropertyTestError(`Test failed for ${targetContractName} contract: "${r.selectedTestFunction.name}" returned ${displayedError}`, displayedError);
                 }
             }
             catch (error) {
+                const displayedError = error instanceof PropertyTestError
+                    ? error.clarityError
+                    : error &&
+                        typeof error === "string" &&
+                        error.toLowerCase().includes("runtime")
+                        ? "(runtime)"
+                        : "(unknown)";
                 // Capture the error and log the test failure.
                 radio.emit("logMessage", (0, ansicolor_1.red)(`₿ ${simnet.burnBlockHeight.toString().padStart(8)} ` +
                     `Ӿ ${simnet.blockHeight.toString().padStart(8)}   ` +
@@ -182,7 +193,8 @@ const checkProperties = (simnet, targetContractName, rendezvousList, rendezvousA
                     `[FAIL] ` +
                     `${targetContractName} ` +
                     `${(0, ansicolor_1.underline)(r.selectedTestFunction.name)} ` +
-                    printedTestFunctionArgs));
+                    `${printedTestFunctionArgs} ` +
+                    displayedError));
                 // Re-throw the error for fast-check to catch and process.
                 throw error;
             }
@@ -269,3 +281,9 @@ exports.isParamsMatch = isParamsMatch;
  */
 const isReturnTypeBoolean = (discardFunctionInterface) => discardFunctionInterface.outputs.type === "bool";
 exports.isReturnTypeBoolean = isReturnTypeBoolean;
+class PropertyTestError extends Error {
+    constructor(message, clarityError) {
+        super(message);
+        this.clarityError = clarityError;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/rendezvous",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Meet your contract's vulnerabilities head-on.",
   "main": "app.js",
   "bin": {
@@ -30,14 +30,15 @@
     "url": "https://github.com/stacks-network/rendezvous.git"
   },
   "dependencies": {
-    "@hirosystems/clarinet-sdk": "2.12.0",
+    "@hirosystems/clarinet-sdk": "2.14.0",
     "@stacks/transactions": "^6.16.1",
     "ansicolor": "^2.0.3",
     "fast-check": "^3.20.0",
+    "toml": "^3.0.0",
     "yaml": "^2.6.1"
   },
   "devDependencies": {
-    "@hirosystems/clarinet-sdk-wasm": "2.12.0",
+    "@hirosystems/clarinet-sdk-wasm": "2.14.0",
     "@types/jest": "^29.5.12",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",