Skip functions with trait reference parameters from selection

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        node: [22, 20, 18]
+        node: [23, 22, 20, 18]
 
     steps:
       - name: Checkout code
@@ -40,7 +40,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        node: [22, 20, 18]
+        node: [23, 22, 20, 18]
 
     steps:
       - name: Checkout code

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 deployments
 dist
+coverage

app.tests.ts

@@ -1,3 +1,4 @@
+import { red } from "ansicolor";
 import { main } from "./app";
 import { version } from "./package.json";
 
@@ -20,8 +21,12 @@ describe("Command-line arguments handling", () => {
     --runs - The runs to use for iterating over the tests. Default: 100.
     --help - Show the help message.
   `;
-  const noManifestMessage = `\nNo path to Clarinet project provided. Supply it immediately or face the relentless scrutiny of your contract's vulnerabilities.`;
-  const noContractNameMessage = `\nNo target contract name provided. Please provide the contract name to be fuzzed.`;
+  const noManifestMessage = red(
+    `\nNo path to Clarinet project provided. Supply it immediately or face the relentless scrutiny of your contract's vulnerabilities.`
+  );
+  const noContractNameMessage = red(
+    `\nNo target contract name provided. Please provide the contract name to be fuzzed.`
+  );
 
   it.each([
     ["manifest path", ["node", "app.js"]],
@@ -96,56 +101,60 @@ describe("Command-line arguments handling", () => {
     [
       ["no command-line arguments"],
       ["node", "app.js"],
-      [
-        `\nNo path to Clarinet project provided. Supply it immediately or face the relentless scrutiny of your contract's vulnerabilities.`,
-        helpMessage,
-      ],
+      [noManifestMessage, helpMessage],
     ],
     [
       ["manifest path"],
       ["node", "app.js", "example"],
-      [
-        `\nNo target contract name provided. Please provide the contract name to be fuzzed.`,
-        helpMessage,
-      ],
+      [noContractNameMessage, helpMessage],
     ],
     [
       ["manifest path", "contract name"],
       ["node", "app.js", "example", "counter"],
       [
-        `\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant.`,
+        red(
+          `\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant.`
+        ),
         helpMessage,
       ],
     ],
     [
       ["manifest path", "contract name", "seed"],
       ["node", "app.js", "example", "counter", "--seed=123"],
       [
-        `\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant.`,
+        red(
+          `\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant.`
+        ),
         helpMessage,
       ],
     ],
     [
       ["manifest path", "contract name", "seed", "path"],
       ["node", "app.js", "example", "counter", "--seed=123", "--path=84:0"],
       [
-        `\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant.`,
+        red(
+          `\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant.`
+        ),
         helpMessage,
       ],
     ],
     [
       ["manifest path", "contract name", "runs"],
       ["node", "app.js", "example", "counter", "--runs=10"],
       [
-        `\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant.`,
+        red(
+          `\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant.`
+        ),
         helpMessage,
       ],
     ],
     [
       ["manifest path", "contract name", "path"],
       ["node", "app.js", "example", "counter", "--path=84:0"],
       [
-        `\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant.`,
+        red(
+          `\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant.`
+        ),
         helpMessage,
       ],
     ],
@@ -161,7 +170,9 @@ describe("Command-line arguments handling", () => {
         "--runs=10",
       ],
       [
-        `\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant.`,
+        red(
+          `\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant.`
+        ),
         helpMessage,
       ],
     ],

app.ts

@@ -4,11 +4,13 @@ import { EventEmitter } from "events";
 import { checkProperties } from "./property";
 import { checkInvariants } from "./invariant";
 import {
+  getContractNameFromContractId,
   getFunctionsFromContractInterfaces,
   getSimnetDeployerContractsInterfaces,
 } from "./shared";
 import { issueFirstClassCitizenship } from "./citizen";
 import { version } from "./package.json";
+import { red } from "ansicolor";
 
 const logger = (log: string, logLevel: "log" | "error" | "info" = "log") => {
   console[logLevel](log);
@@ -42,7 +44,7 @@ const parseOptionalArgument = (argName: string) => {
 export async function main() {
   const radio = new EventEmitter();
   radio.on("logMessage", (log) => logger(log));
-  radio.on("logFailure", (log) => logger(log, "error"));
+  radio.on("logFailure", (log) => logger(red(log), "error"));
 
   const args = process.argv;
   if (args.includes("--help")) {
@@ -55,7 +57,9 @@ export async function main() {
   if (!manifestDir || manifestDir.startsWith("--")) {
     radio.emit(
       "logMessage",
-      "\nNo path to Clarinet project provided. Supply it immediately or face the relentless scrutiny of your contract's vulnerabilities."
+      red(
+        "\nNo path to Clarinet project provided. Supply it immediately or face the relentless scrutiny of your contract's vulnerabilities."
+      )
     );
     radio.emit("logMessage", helpMessage);
     return;
@@ -66,7 +70,9 @@ export async function main() {
   if (!sutContractName || sutContractName.startsWith("--")) {
     radio.emit(
       "logMessage",
-      "\nNo target contract name provided. Please provide the contract name to be fuzzed."
+      red(
+        "\nNo target contract name provided. Please provide the contract name to be fuzzed."
+      )
     );
     radio.emit("logMessage", helpMessage);
     return;
@@ -76,7 +82,9 @@ export async function main() {
   if (!type || type.startsWith("--") || !["test", "invariant"].includes(type)) {
     radio.emit(
       "logMessage",
-      "\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant."
+      red(
+        "\nInvalid type provided. Please provide the type of test to be executed. Possible values: test, invariant."
+      )
     );
     radio.emit("logMessage", helpMessage);
     return;
@@ -110,7 +118,7 @@ export async function main() {
   const rendezvousList = Array.from(
     getSimnetDeployerContractsInterfaces(simnet).keys()
   ).filter((deployedContract) =>
-    [sutContractName].includes(deployedContract.split(".")[1])
+    [sutContractName].includes(getContractNameFromContractId(deployedContract))
   );
 
   const rendezvousAllFunctions = getFunctionsFromContractInterfaces(

heatstroke.tests.ts

@@ -1,9 +1,9 @@
 import fc from "fast-check";
 import { reporter } from "./heatstroke";
-import { getContractNameFromRendezvousId } from "./invariant";
 import { EventEmitter } from "events";
 import { resolve } from "path";
 import { initSimnet } from "@hirosystems/clarinet-sdk";
+import { getContractNameFromContractId } from "./shared";
 
 describe("Custom reporter logging", () => {
   it("handles cases with missing path on failure for invariant testing type", async () => {
@@ -105,7 +105,7 @@ describe("Custom reporter logging", () => {
             `\nError: Property failed after ${r.numRuns} tests.`,
             `Seed : ${r.seed}`,
             `\nCounterexample:`,
-            `- Contract : ${getContractNameFromRendezvousId(
+            `- Contract : ${getContractNameFromContractId(
               rendezvousContractId
             )}`,
             `- Function : ${r.selectedFunction.name} (${r.selectedFunction.access})`,
@@ -235,7 +235,7 @@ describe("Custom reporter logging", () => {
             `Seed : ${r.seed}`,
             `Path : ${r.path}`,
             `\nCounterexample:`,
-            `- Contract : ${getContractNameFromRendezvousId(
+            `- Contract : ${getContractNameFromContractId(
               rendezvousContractId
             )}`,
             `- Function : ${r.selectedFunction.name} (${r.selectedFunction.access})`,
@@ -444,7 +444,9 @@ describe("Custom reporter logging", () => {
             `\nError: Property failed after ${r.numRuns} tests.`,
             `Seed : ${r.seed}`,
             `\nCounterexample:`,
-            `- Test Contract : ${testContractId.split(".")[1]}`,
+            `- Test Contract : ${getContractNameFromContractId(
+              testContractId
+            )}`,
             `- Test Function : ${r.selectedTestFunction.name} (${r.selectedTestFunction.access})`,
             `- Arguments     : ${JSON.stringify(r.functionArgsArb)}`,
             `- Caller        : ${r.testCaller[0]}`,
@@ -547,7 +549,9 @@ describe("Custom reporter logging", () => {
             `Seed : ${r.seed}`,
             `Path : ${r.path}`,
             `\nCounterexample:`,
-            `- Test Contract : ${testContractId.split(".")[1]}`,
+            `- Test Contract : ${getContractNameFromContractId(
+              testContractId
+            )}`,
             `- Test Function : ${r.selectedTestFunction.name} (${r.selectedTestFunction.access})`,
             `- Arguments     : ${JSON.stringify(r.functionArgsArb)}`,
             `- Caller        : ${r.testCaller[0]}`,

heatstroke.ts

@@ -23,9 +23,9 @@
  * @property runDetails.error - The error thrown during the test.
  */
 
-import { EventEmitter } from "events";
-import { getContractNameFromRendezvousId } from "./invariant";
 import { green } from "ansicolor";
+import { EventEmitter } from "events";
+import { getContractNameFromContractId } from "./shared";
 
 export function reporter(
   //@ts-ignore
@@ -51,7 +51,7 @@ export function reporter(
         radio.emit("logFailure", `\nCounterexample:`);
         radio.emit(
           "logFailure",
-          `- Contract : ${getContractNameFromRendezvousId(
+          `- Contract : ${getContractNameFromContractId(
             r.rendezvousContractId
           )}`
         );
@@ -101,7 +101,7 @@ export function reporter(
         radio.emit("logFailure", `\nCounterexample:`);
         radio.emit(
           "logFailure",
-          `- Test Contract : ${r.testContractId.split(".")[1]}`
+          `- Test Contract : ${getContractNameFromContractId(r.testContractId)}`
         );
         radio.emit(
           "logFailure",
@@ -138,9 +138,11 @@ export function reporter(
   } else {
     radio.emit(
       "logMessage",
+      green(
         `\nOK, ${
           type === "invariant" ? "invariants" : "properties"
         } passed after ${runDetails.numRuns} runs.\n`
+      )
     );
   }
 }

invariant.tests.ts

@@ -1,17 +1,13 @@
 import { initSimnet } from "@hirosystems/clarinet-sdk";
+import { initializeClarityContext, initializeLocalContext } from "./invariant";
 import {
-  getContractNameFromRendezvousId,
-  initializeClarityContext,
-  initializeLocalContext,
-} from "./invariant";
-import {
+  getContractNameFromContractId,
   getFunctionsFromContractInterfaces,
   getSimnetDeployerContractsInterfaces,
 } from "./shared";
 import { join } from "path";
 import { issueFirstClassCitizenship } from "./citizen";
 import { Cl } from "@stacks/transactions";
-import fc from "fast-check";
 
 describe("Simnet contracts operations", () => {
   it("correctly initializes the local context for a given functions map", async () => {
@@ -48,7 +44,7 @@ describe("Simnet contracts operations", () => {
     const rendezvousList = Array.from(
       getSimnetDeployerContractsInterfaces(simnet).keys()
     ).filter((deployedContract) =>
-      ["counter"].includes(deployedContract.split(".")[1])
+      ["counter"].includes(getContractNameFromContractId(deployedContract))
     );
 
     const rendezvousAllFunctions = getFunctionsFromContractInterfaces(
@@ -97,27 +93,3 @@ describe("Simnet contracts operations", () => {
     expect(actualContext).toEqual(expectedContext);
   });
 });
-
-describe("Rendezvous contract name", () => {
-  it("gets contract name from Rendezvous contract name", () => {
-    const addressCharset = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
-    const contractNameCharset =
-      "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_";
-    fc.assert(
-      // Arrange
-      fc.property(
-        fc.stringOf(fc.constantFrom(...addressCharset)),
-        fc.stringOf(fc.constantFrom(...contractNameCharset)),
-        (address, contractName) => {
-          const rendezvousId = `${address}.${contractName}_rendezvous`;
-
-          // Act
-          const actual = getContractNameFromRendezvousId(rendezvousId);
-
-          // Assert
-          expect(actual).toBe(contractName);
-        }
-      )
-    );
-  });
-});