@stacks/rendezvous 0.6.0 → 0.6.2

package/README.md

@@ -106,4 +106,10 @@ rv example counter invariant
 
 ---
 
+### Documentation
+
+For full documentation, see the official [Rendezvous Book](https://stacks-network.github.io/rendezvous/).
+
+---
+
 [^1]: Hughes, J. (2004). _Testing the Hard Stuff and Staying Sane_. In Proceedings of the ACM SIGPLAN Workshop on Haskell (Haskell '04).

package/dist/app.js

@@ -13,7 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tryParseRemoteDataSettings = exports.getManifestFileName = exports.invalidRemoteDataErrorMessage = exports.noRemoteData = void 0;
+exports.tryParseRemoteDataSettings = exports.getManifestFileName = exports.invalidRemoteDataWarningMessage = exports.noRemoteData = void 0;
 exports.main = main;
 const path_1 = require("path");
 const events_1 = require("events");
@@ -38,7 +38,13 @@ exports.noRemoteData = {
     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.`;
+exports.invalidRemoteDataWarningMessage = `\nRemote data settings existing in Clarinet.toml, but remote data feature will not be used! To use remote data, please make sure the following fields are set:
+
+- enabled = true
+- api_url = <stacks-api-url>
+- initial_height = <stacks-block-height-to-fork-from>
+
+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.
@@ -59,16 +65,19 @@ 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);
+    const invalidRemoteDataSetup = !(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"]);
+    if (remoteDataUserSettings !== undefined && invalidRemoteDataSetup) {
+        radio.emit("logMessage", (0, ansicolor_1.yellow)(exports.invalidRemoteDataWarningMessage));
     }
-    if (remoteDataUserSettings) {
+    else 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;
+    if (!remoteDataUserSettings || invalidRemoteDataSetup) {
+        return exports.noRemoteData;
+    }
+    return remoteDataUserSettings;
 };
 exports.tryParseRemoteDataSettings = tryParseRemoteDataSettings;
 const helpMessage = `

package/dist/invariant.js

@@ -169,18 +169,26 @@ const checkInvariants = (simnet, targetContractName, rendezvousList, rendezvousA
             try {
                 const functionCall = simnet.callPublicFn(r.rendezvousContractId, selectedFunction.name, selectedFunctionsArgsCV[index], sutCallerAddress);
                 const functionCallResultJson = (0, transactions_1.cvToJSON)(functionCall.result);
+                // Reaching this point means the function call went through, but it
+                // may still have returned an error result. Get the result, convert
+                // it to Clarity string format, and report it to improve the user
+                // experiance by providing important information about the function
+                // call during the run.
+                const selectedFunctionClarityResult = (0, transactions_1.cvToString)(functionCall.result);
                 if (functionCallResultJson.success) {
                     localContext[r.rendezvousContractId][selectedFunction.name]++;
                     simnet.callPublicFn(r.rendezvousContractId, "update-context", [
                         transactions_1.Cl.stringAscii(selectedFunction.name),
                         transactions_1.Cl.uint(localContext[r.rendezvousContractId][selectedFunction.name]),
                     ], simnet.deployer);
+                    // Function call passed.
                     radio.emit("logMessage", `₿ ${simnet.burnBlockHeight.toString().padStart(8)} ` +
                         `Ӿ ${simnet.blockHeight.toString().padStart(8)}   ` +
                         (0, ansicolor_1.dim)(`${sutCallerWallet}        `) +
                         `${targetContractName} ` +
                         `${(0, ansicolor_1.underline)(selectedFunction.name)} ` +
-                        printedFunctionArgs);
+                        `${printedFunctionArgs} ` +
+                        (0, ansicolor_1.green)(selectedFunctionClarityResult));
                     try {
                         if (dialerRegistry !== undefined) {
                             yield dialerRegistry.executePostDialers({
@@ -195,12 +203,14 @@ const checkInvariants = (simnet, targetContractName, rendezvousList, rendezvousA
                     }
                 }
                 else {
+                    // Function call failed.
                     radio.emit("logMessage", (0, ansicolor_1.dim)(`₿ ${simnet.burnBlockHeight.toString().padStart(8)} ` +
                         `Ӿ ${simnet.blockHeight.toString().padStart(8)}   ` +
                         `${sutCallerWallet}        ` +
                         `${targetContractName} ` +
                         `${(0, ansicolor_1.underline)(selectedFunction.name)} ` +
-                        printedFunctionArgs));
+                        `${printedFunctionArgs} ` +
+                        (0, ansicolor_1.red)(selectedFunctionClarityResult)));
                 }
             }
             catch (error) {
@@ -209,15 +219,21 @@ const checkInvariants = (simnet, targetContractName, rendezvousList, rendezvousA
                     throw error;
                 }
                 else {
+                    const displayedError = error &&
+                        typeof error === "string" &&
+                        error.toLowerCase().includes("runtime")
+                        ? "(runtime)"
+                        : "(unknown)";
                     // If the function call fails with a runtime error, log a dimmed
-                    // message. Since the public function result is ignored, there's
-                    // no need to throw an error.
+                    // message. Since the public function result is only logged and
+                    // does not affect the run, there's no need to throw an error.
                     radio.emit("logMessage", (0, ansicolor_1.dim)(`₿ ${simnet.burnBlockHeight.toString().padStart(8)} ` +
                         `Ӿ ${simnet.blockHeight.toString().padStart(8)}   ` +
                         `${sutCallerWallet}        ` +
                         `${targetContractName} ` +
                         `${(0, ansicolor_1.underline)(selectedFunction.name)} ` +
-                        printedFunctionArgs));
+                        `${printedFunctionArgs} ` +
+                        (0, ansicolor_1.red)(displayedError)));
                 }
             }
         }
@@ -237,6 +253,7 @@ const checkInvariants = (simnet, targetContractName, rendezvousList, rendezvousA
         try {
             const { result: invariantCallResult } = simnet.callReadOnlyFn(r.rendezvousContractId, r.selectedInvariant.name, selectedInvariantArgsCV, invariantCallerAddress);
             const invariantCallResultJson = (0, transactions_1.cvToJSON)(invariantCallResult);
+            const invariantCallClarityResult = (0, transactions_1.cvToString)(invariantCallResult);
             if (invariantCallResultJson.value === true) {
                 radio.emit("logMessage", `₿ ${simnet.burnBlockHeight.toString().padStart(8)} ` +
                     `Ӿ ${simnet.blockHeight.toString().padStart(8)}   ` +
@@ -244,23 +261,36 @@ const checkInvariants = (simnet, targetContractName, rendezvousList, rendezvousA
                     `${(0, ansicolor_1.green)("[PASS]")} ` +
                     `${targetContractName} ` +
                     `${(0, ansicolor_1.underline)(r.selectedInvariant.name)} ` +
-                    printedInvariantArgs);
+                    `${printedInvariantArgs} ` +
+                    (0, ansicolor_1.green)(invariantCallClarityResult));
             }
-            if (!invariantCallResultJson.value) {
-                throw new Error(`Invariant failed for ${targetContractName} contract: "${r.selectedInvariant.name}" returned ${invariantCallResultJson.value}`);
+            else {
+                radio.emit("logMessage", (0, ansicolor_1.red)(`₿ ${simnet.burnBlockHeight.toString().padStart(8)} ` +
+                    `Ӿ ${simnet.blockHeight.toString().padStart(8)}   ` +
+                    `${invariantCallerWallet} ` +
+                    `[FAIL] ` +
+                    `${targetContractName} ` +
+                    `${(0, ansicolor_1.underline)(r.selectedInvariant.name)} ` +
+                    `${printedInvariantArgs} ` +
+                    (0, ansicolor_1.red)(invariantCallClarityResult)));
+                // Invariant call went through, but returned something other than
+                // `true`. Create a custom error to distinguish this case from
+                // runtime errors.
+                throw new FalsifiedInvariantError(`Invariant failed for ${targetContractName} contract: "${r.selectedInvariant.name}" returned ${invariantCallClarityResult}`);
             }
         }
         catch (error) {
-            // Handle both negative results from the invariant function and
-            // general runtime failures. Focus is on capturing the invariant
-            // function's result, including any runtime errors it caused.
-            radio.emit("logMessage", (0, ansicolor_1.red)(`₿ ${simnet.burnBlockHeight.toString().padStart(8)} ` +
-                `Ӿ ${simnet.blockHeight.toString().padStart(8)}   ` +
-                `${invariantCallerWallet} ` +
-                `[FAIL] ` +
-                `${targetContractName} ` +
-                `${(0, ansicolor_1.underline)(r.selectedInvariant.name)} ` +
-                printedInvariantArgs));
+            // Log errors that aren't already handled as falsified invariants.
+            // This prevents duplicate error messages for the same failure.
+            if (!(error instanceof FalsifiedInvariantError)) {
+                radio.emit("logMessage", (0, ansicolor_1.red)(`₿ ${simnet.burnBlockHeight.toString().padStart(8)} ` +
+                    `Ӿ ${simnet.blockHeight.toString().padStart(8)}   ` +
+                    `${invariantCallerWallet} ` +
+                    `[FAIL] ` +
+                    `${targetContractName} ` +
+                    `${(0, ansicolor_1.underline)(r.selectedInvariant.name)} ` +
+                    printedInvariantArgs));
+            }
             // Re-throw the error for fast-check to catch and process.
             throw error;
         }
@@ -318,3 +348,8 @@ const filterInvariantFunctions = (allFunctionsMap) => new Map(Array.from(allFunc
     contractId,
     functions.filter((f) => f.access === "read_only" && f.name.startsWith("invariant-")),
 ]));
+class FalsifiedInvariantError extends Error {
+    constructor(message) {
+        super(message);
+    }
+}

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stacks/rendezvous",
-    "version": "0.6.0",
+    "version": "0.6.2",
     "description": "Meet your contract's vulnerabilities head-on.",
     "main": "app.js",
     "bin": {

package/dist/property.js

@@ -147,6 +147,7 @@ const checkProperties = (simnet, targetContractName, rendezvousList, rendezvousA
                 const { result: testFunctionCallResult } = simnet.callPublicFn(r.testContractId, r.selectedTestFunction.name, selectedTestFunctionArgs, testCallerAddress);
                 const testFunctionCallResultJson = (0, transactions_1.cvToJSON)(testFunctionCallResult);
                 const discardedInPlace = (0, exports.isTestDiscardedInPlace)(testFunctionCallResultJson);
+                const testFunctionCallClarityResult = (0, transactions_1.cvToString)(testFunctionCallResult);
                 if (discardedInPlace) {
                     radio.emit("logMessage", `₿ ${simnet.burnBlockHeight.toString().padStart(8)} ` +
                         `Ӿ ${simnet.blockHeight.toString().padStart(8)}   ` +
@@ -154,7 +155,8 @@ const checkProperties = (simnet, targetContractName, rendezvousList, rendezvousA
                         `${(0, ansicolor_1.yellow)("[WARN]")} ` +
                         `${targetContractName} ` +
                         `${(0, ansicolor_1.underline)(r.selectedTestFunction.name)} ` +
-                        (0, ansicolor_1.dim)(printedTestFunctionArgs));
+                        `${(0, ansicolor_1.dim)(printedTestFunctionArgs)} ` +
+                        (0, ansicolor_1.yellow)(testFunctionCallClarityResult));
                 }
                 else if (!discardedInPlace &&
                     testFunctionCallResultJson.success &&
@@ -165,7 +167,8 @@ const checkProperties = (simnet, targetContractName, rendezvousList, rendezvousA
                         `${(0, ansicolor_1.green)("[PASS]")} ` +
                         `${targetContractName} ` +
                         `${(0, ansicolor_1.underline)(r.selectedTestFunction.name)} ` +
-                        printedTestFunctionArgs);
+                        `${printedTestFunctionArgs} ` +
+                        (0, ansicolor_1.green)(testFunctionCallClarityResult));
                     if (r.canMineBlocks) {
                         simnet.mineEmptyBurnBlocks(r.burnBlocks);
                     }
@@ -174,8 +177,7 @@ const checkProperties = (simnet, targetContractName, rendezvousList, rendezvousA
                     // 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);
+                    throw new PropertyTestError(`Test failed for ${targetContractName} contract: "${r.selectedTestFunction.name}" returned ${testFunctionCallClarityResult}`, testFunctionCallClarityResult);
                 }
             }
             catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/rendezvous",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "Meet your contract's vulnerabilities head-on.",
   "main": "app.js",
   "bin": {