@stacks/rendezvous 0.7.0 → 0.7.2

package/dist/citizen.js

@@ -12,10 +12,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTestContractSource = exports.buildRendezvousData = exports.getContractSource = exports.groupContractsByEpochFromSimnetPlan = exports.issueFirstClassCitizenship = void 0;
+exports.getSbtcBalancesFromSimnet = exports.getTestContractSource = exports.buildRendezvousData = exports.getContractSource = exports.deployContracts = exports.groupContractsByEpochFromDeploymentPlan = exports.issueFirstClassCitizenship = void 0;
 exports.scheduleRendezvous = scheduleRendezvous;
 const fs_1 = require("fs");
 const path_1 = require("path");
+const toml_1 = __importDefault(require("toml"));
 const yaml_1 = __importDefault(require("yaml"));
 const clarinet_sdk_1 = require("@hirosystems/clarinet-sdk");
 const transactions_1 = require("@stacks/transactions");
@@ -35,31 +36,21 @@ const transactions_1 = require("@stacks/transactions");
  * the test contract treated as a first-class citizen of the target contract.
  */
 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.
+    var _a;
+    // Initialize the simnet, to generate the deployment plan and instance. The
+    // empty session will be set up, and contracts will be deployed in the
+    // correct order based on the deployment plan a few lines below.
     const simnet = yield (0, clarinet_sdk_1.initSimnet)(manifestPath);
-    const simnetPlan = yaml_1.default.parse((0, fs_1.readFileSync)((0, path_1.join)(manifestDir, "deployments", "default.simnet-plan.yaml"), {
+    const deploymentPlan = yaml_1.default.parse((0, fs_1.readFileSync)((0, path_1.join)(manifestDir, "deployments", "default.simnet-plan.yaml"), {
         encoding: "utf-8",
     }));
-    const sortedContractsByEpoch = (0, exports.groupContractsByEpochFromSimnetPlan)(simnetPlan);
+    const sortedContractsByEpoch = (0, exports.groupContractsByEpochFromDeploymentPlan)(deploymentPlan);
     const simnetAddresses = [...simnet.getAccounts().values()];
     const stxBalancesMap = new Map(simnetAddresses.map((address) => {
         const balanceHex = simnet.runSnippet(`(stx-get-balance '${address})`);
         return [address, (0, transactions_1.cvToValue)((0, transactions_1.hexToCV)(balanceHex))];
     }));
-    const sbtcBalancesMap = new Map(simnetAddresses.map((address) => {
-        try {
-            const { result: getBalanceResult } = simnet.callReadOnlyFn("SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token", "get-balance", [transactions_1.Cl.principal(address)], address);
-            // If the previous read-only call works, the user is working with
-            // sBTC. This means we can proceed with restoring sBTC balances.
-            const sbtcBalance = (0, transactions_1.cvToJSON)(getBalanceResult).value.value;
-            return [address, sbtcBalance];
-        }
-        catch (e) {
-            return [address, 0];
-        }
-    }));
+    const sbtcBalancesMap = (0, exports.getSbtcBalancesFromSimnet)(simnet);
     yield simnet.initEmptySession(remoteDataSettings);
     simnetAddresses.forEach((address) => {
         simnet.mintSTX(address, stxBalancesMap.get(address));
@@ -68,13 +59,19 @@ const issueFirstClassCitizenship = (manifestDir, manifestPath, remoteDataSetting
     // resulting contract will replace the target contract in the simnet.
     /** The contract names mapped to the concatenated source code. */
     const rendezvousSources = new Map([sutContractName]
-        .map((contractName) => (0, exports.buildRendezvousData)(simnetPlan, contractName, manifestDir))
+        // For each target contract name, execute the processing steps to get the
+        // concatenated contract source code and the contract ID.
+        .map((contractName) => (0, exports.buildRendezvousData)(deploymentPlan, contractName, manifestDir))
+        // Use the contract ID as a key, mapping to the concatenated contract
+        // source code.
         .map((rendezvousContractData) => [
-        rendezvousContractData.rendezvousContractName,
-        rendezvousContractData.rendezvousSource,
+        rendezvousContractData.rendezvousContractId,
+        rendezvousContractData.rendezvousSourceCode,
     ]));
-    // Deploy the contracts to the simnet in the correct order.
-    yield deployContracts(simnet, sortedContractsByEpoch, (name, props) => (0, exports.getContractSource)([sutContractName], rendezvousSources, name, props, manifestDir));
+    const clarinetToml = toml_1.default.parse((0, fs_1.readFileSync)(manifestPath, { encoding: "utf-8" }));
+    const cacheDir = ((_a = clarinetToml.project) === null || _a === void 0 ? void 0 : _a.cache_dir) || "./.cache";
+    // Deploy the contracts to the empty simnet session in the correct order.
+    yield (0, exports.deployContracts)(simnet, sortedContractsByEpoch, manifestDir, cacheDir, (name, sender, props) => (0, exports.getContractSource)([sutContractName], rendezvousSources, name, sender, props, manifestDir));
     // Filter out addresses with zero balance. They do not need to be restored.
     const sbtcBalancesToRestore = new Map([...sbtcBalancesMap.entries()].filter(([_, balance]) => balance !== 0));
     // After all the contracts and requirements are deployed, if the test wallets
@@ -87,15 +84,15 @@ const issueFirstClassCitizenship = (manifestDir, manifestPath, remoteDataSetting
 });
 exports.issueFirstClassCitizenship = issueFirstClassCitizenship;
 /**
- * Groups contracts by epoch from the simnet plan.
- * @param simnetPlan The simnet plan.
+ * Groups contracts by epoch from the deployment plan.
+ * @param deploymentPlan The parsed deployment plan.
  * @returns A record of contracts grouped by epoch. The record key is the epoch
  * string, and the value is an array of contracts. Each contract is represented
  * as a record with the contract name as the key and a record containing the
  * contract path and clarity version as the value.
  */
-const groupContractsByEpochFromSimnetPlan = (simnetPlan) => {
-    return simnetPlan.plan.batches.reduce((acc, batch) => {
+const groupContractsByEpochFromDeploymentPlan = (deploymentPlan) => {
+    return deploymentPlan.plan.batches.reduce((acc, batch) => {
         const epoch = batch.epoch;
         const contracts = batch.transactions
             .filter((tx) => tx["emulated-contract-publish"])
@@ -114,44 +111,56 @@ const groupContractsByEpochFromSimnetPlan = (simnetPlan) => {
         return acc;
     }, {});
 };
-exports.groupContractsByEpochFromSimnetPlan = groupContractsByEpochFromSimnetPlan;
+exports.groupContractsByEpochFromDeploymentPlan = groupContractsByEpochFromDeploymentPlan;
 /**
  * Deploys the contracts to the simnet in the correct order.
  * @param simnet The simnet instance.
  * @param contractsByEpoch The record of contracts by epoch.
  * @param getContractSourceFn The function to retrieve the contract source.
  */
-const deployContracts = (simnet, contractsByEpoch, getContractSourceFn) => __awaiter(void 0, void 0, void 0, function* () {
+const deployContracts = (simnet, contractsByEpoch, manifestDir, cacheDir, getContractSourceFn) => __awaiter(void 0, void 0, void 0, function* () {
     for (const [epoch, contracts] of Object.entries(contractsByEpoch)) {
         // Move to the next epoch and deploy the contracts in the correct order.
         simnet.setEpoch(epoch);
         for (const contract of contracts.flatMap(Object.entries)) {
             const [name, props] = contract;
-            const source = getContractSourceFn(name, props);
-            // For requirement contracts, use the original sender. The sender address
-            // is included in the path:
-            // "./.cache/requirements/<address>.contract-name.clar".
-            const sender = props.path.includes(".cache")
-                ? props.path.split("requirements")[1].slice(1).split(".")[0]
+            // Resolve paths to absolute for proper comparison.
+            const absoluteContractPath = (0, path_1.resolve)(manifestDir, props.path);
+            const absoluteRequirementsPath = (0, path_1.resolve)(manifestDir, cacheDir, "requirements");
+            // Check if contract is in requirements directory.
+            const isRequirement = absoluteContractPath.startsWith(absoluteRequirementsPath);
+            const sender = isRequirement
+                ? (0, path_1.basename)(props.path).split(".")[0]
                 : simnet.deployer;
+            const source = getContractSourceFn(name, sender, props);
             simnet.deployContract(name, source, { clarityVersion: props.clarity_version }, sender);
         }
     }
 });
+exports.deployContracts = deployContracts;
 /**
  * Conditionally retrieves the contract source based on whether the contract is
  * a SUT contract or not.
  * @param targetContractNames The list of target contract names.
- * @param rendezvousSourcesMap The contract names mapped to the concatenated
- * source code.
+ * @param rendezvousSourcesMap The target contract IDs mapped to the resulting
+ * concatenated source code.
  * @param contractName The contract name.
+ * @param contractSender The emulated sender of the contract according to the
+ * deployment plan.
  * @param contractProps The contract deployment properties.
  * @param manifestDir The relative path to the manifest directory.
  * @returns The contract source code.
  */
-const getContractSource = (targetContractNames, rendezvousSourcesMap, contractName, contractProps, manifestDir) => {
-    if (targetContractNames.includes(contractName)) {
-        const contractSource = rendezvousSourcesMap.get(contractName);
+const getContractSource = (targetContractNames, rendezvousSourcesMap, contractName, contractSender, contractProps, manifestDir) => {
+    const contractId = `${contractSender}.${contractName}`;
+    // Checking if a contract is a SUT one just by using the name is not enough.
+    // There can be multiple contracts with the same name, but different senders
+    // in the deployment plan. The contract ID is the unique identifier used to
+    // store the concatenated Rendezvous source codes in the
+    // `rendezvousSourcesMap`.
+    if (targetContractNames.includes(contractName) &&
+        rendezvousSourcesMap.has(contractId)) {
+        const contractSource = rendezvousSourcesMap.get(contractId);
         if (!contractSource) {
             throw new Error(`Contract source not found for ${contractName}`);
         }
@@ -166,20 +175,24 @@ const getContractSource = (targetContractNames, rendezvousSourcesMap, contractNa
 exports.getContractSource = getContractSource;
 /**
  * Builds the Rendezvous data.
- * @param simnetPlan The parsed simnet plan.
+ * @param deploymentPlan The parsed deployment plan.
  * @param contractName The contract name.
  * @param manifestDir The relative path to the manifest directory.
  * @returns The Rendezvous data representing a record. The returned record
- * contains the Rendezvous source code and the Rendezvous contract name.
+ * contains the Rendezvous source code and the unique Rendezvous contract ID.
  */
-const buildRendezvousData = (simnetPlan, contractName, manifestDir) => {
+const buildRendezvousData = (deploymentPlan, contractName, manifestDir) => {
     try {
-        const sutContractSource = getSimnetPlanContractSource(simnetPlan, manifestDir, contractName);
-        const testContractSource = (0, exports.getTestContractSource)(simnetPlan, contractName, manifestDir);
+        const sutContractSource = getDeploymentPlanContractSource(deploymentPlan, contractName, manifestDir);
+        const testContractSource = (0, exports.getTestContractSource)(deploymentPlan, contractName, manifestDir);
         const rendezvousSource = scheduleRendezvous(sutContractSource, testContractSource);
+        const rendezvousContractEmulatedSender = getSutContractDeploymentPlanEmulatedPublish(deploymentPlan, contractName)["emulated-sender"];
+        // Use the contract ID as a unique identifier of the contract within the
+        // deployment plan.
+        const rendezvousContractId = `${rendezvousContractEmulatedSender}.${contractName}`;
         return {
-            rendezvousSource: rendezvousSource,
-            rendezvousContractName: contractName,
+            rendezvousContractId: rendezvousContractId,
+            rendezvousSourceCode: rendezvousSource,
         };
     }
     catch (error) {
@@ -188,47 +201,45 @@ const buildRendezvousData = (simnetPlan, contractName, manifestDir) => {
 };
 exports.buildRendezvousData = buildRendezvousData;
 /**
- * Retrieves the contract source code using the simnet plan.
- * @param simnetPlan The parsed simnet plan.
- * @param manifestDir The relative path to the manifest directory.
+ * Retrieves the contract source code using the deployment plan.
+ * @param deploymentPlan The parsed deployment plan.
  * @param sutContractName The target contract name.
+ * @param manifestDir The relative path to the manifest directory.
  * @returns The contract source code.
  */
-const getSimnetPlanContractSource = (simnetPlan, manifestDir, sutContractName) => {
-    var _a;
-    // Filter for transactions that contain "emulated-contract-publish".
-    const contractInfo = (_a = simnetPlan.plan.batches
-        .flatMap((batch) => batch.transactions)
-        .find((transaction) => transaction["emulated-contract-publish"] &&
-        transaction["emulated-contract-publish"]["contract-name"] ===
-            sutContractName)) === null || _a === void 0 ? void 0 : _a["emulated-contract-publish"];
-    if (contractInfo == undefined) {
-        throw new Error(`"${sutContractName}" contract not found in Clarinet.toml.`);
-    }
-    return (0, fs_1.readFileSync)((0, path_1.join)(manifestDir, contractInfo.path), {
+const getDeploymentPlanContractSource = (deploymentPlan, sutContractName, manifestDir) => {
+    const sutContractPath = getSutContractDeploymentPlanEmulatedPublish(deploymentPlan, sutContractName).path;
+    return (0, fs_1.readFileSync)((0, path_1.join)(manifestDir, sutContractPath), {
         encoding: "utf-8",
     }).toString();
 };
 /**
  * Retrieves the test contract source code.
- * @param simnetPlan The parsed simnet plan.
+ * @param deploymentPlan The parsed deployment plan.
  * @param sutContractName The target contract name.
  * @param manifestDir The relative path to the manifest directory.
  * @returns The test contract source code.
  */
-const getTestContractSource = (simnetPlan, sutContractName, manifestDir) => {
-    var _a;
-    const contractInfo = (_a = simnetPlan.plan.batches
-        .flatMap((batch) => batch.transactions)
-        .find((transaction) => transaction["emulated-contract-publish"] &&
-        transaction["emulated-contract-publish"]["contract-name"] ===
-            sutContractName)) === null || _a === void 0 ? void 0 : _a["emulated-contract-publish"];
-    const sutContractPath = contractInfo.path;
-    const extension = ".clar";
-    if (!sutContractPath.endsWith(extension)) {
+const getTestContractSource = (deploymentPlan, sutContractName, manifestDir) => {
+    const sutContractPath = getSutContractDeploymentPlanEmulatedPublish(deploymentPlan, sutContractName).path;
+    const clarityExtension = ".clar";
+    if (!sutContractPath.endsWith(clarityExtension)) {
         throw new Error(`Invalid contract extension for the "${sutContractName}" contract.`);
     }
-    const testContractPath = sutContractPath.replace(extension, `.tests${extension}`);
+    // If the sutContractPath is located under .cache/requirements/ path, search
+    // for the test contract in the classic `contracts` directory.
+    if (sutContractPath.includes(".cache")) {
+        const relativePath = sutContractPath.split(".cache/requirements/")[1];
+        const relativePathTestContract = relativePath.replace(clarityExtension, `.tests${clarityExtension}`);
+        return (0, fs_1.readFileSync)((0, path_1.join)(manifestDir, "contracts", relativePathTestContract), {
+            encoding: "utf-8",
+        }).toString();
+    }
+    // If the contract is not under the `.cache/requirements/` path, we assume it
+    // is located in a regular path specified in the manifest file. Just search
+    // for the test contract near the SUT one, following the naming
+    // convention: `<contract-name>.tests.clar`.
+    const testContractPath = sutContractPath.replace(clarityExtension, `.tests${clarityExtension}`);
     try {
         return (0, fs_1.readFileSync)((0, path_1.join)(manifestDir, testContractPath), {
             encoding: "utf-8",
@@ -239,6 +250,58 @@ const getTestContractSource = (simnetPlan, sutContractName, manifestDir) => {
     }
 };
 exports.getTestContractSource = getTestContractSource;
+/**
+ * Retrieves the emulated contract publish data of the target contract from the
+ * deployment plan. If multiple contracts share the same name in the deployment
+ * plan, this utility will prioritize the one defined in `Clarinet.toml` as a
+ * project contract over a requirement. The prioritization is made comparing
+ * the deployment plan emulated sender with the deployer of the Clarinet project.
+ * @param deploymentPlan The parsed deployment plan.
+ * @param sutContractName The target contract name.
+ * @returns The emulated contract publish data of the SUT contract as present
+ * in the deployment plan.
+ */
+const getSutContractDeploymentPlanEmulatedPublish = (deploymentPlan, sutContractName) => {
+    var _a, _b;
+    // Filter all emulated contract publish transactions matching the target
+    // contract name from the deployment plan.
+    const contractPublishMatchesByName = deploymentPlan.plan.batches
+        .flatMap((batch) => batch.transactions)
+        .filter((transaction) => transaction["emulated-contract-publish"] &&
+        transaction["emulated-contract-publish"]["contract-name"] ===
+            sutContractName);
+    // If no matches are found, something went wrong.
+    if (contractPublishMatchesByName.length === 0) {
+        throw new Error(`"${sutContractName}" contract not found in Clarinet.toml.`);
+    }
+    // If multiple matches are found, search for the one deployed by the deployer
+    // defined in the `Devnet.toml` file and present in the deployment plan. This
+    // is the project contract.
+    if (contractPublishMatchesByName.length > 1) {
+        const deployer = (_a = deploymentPlan.genesis.wallets.find((wallet) => wallet.name === "deployer")) === null || _a === void 0 ? void 0 : _a.address;
+        if (!deployer) {
+            throw new Error(`Something went wrong. Deployer not found in the deployment plan.`);
+        }
+        // From the list of filtered emulated contract publish transactions with
+        // having the same name, select the one deployed by the deployer.
+        const targetContractDeploymentData = (_b = contractPublishMatchesByName.find((transaction) => transaction["emulated-contract-publish"]["emulated-sender"] ===
+            deployer)) === null || _b === void 0 ? void 0 : _b["emulated-contract-publish"];
+        // This is an edge case that can happen in practice. If the project has two
+        // requirements that share the same contract name, Rendezvous will not be
+        // able to select the one to be fuzzed. The recommendation for users would
+        // be to include the target contract in the Clarinet project.
+        if (!targetContractDeploymentData) {
+            throw new Error(`Multiple contracts named "${sutContractName}" found in the deployment plan, no one deployed by the deployer.`);
+        }
+        return targetContractDeploymentData;
+    }
+    // Only one match was found, return the path to the contract.
+    const contractNameMatch = contractPublishMatchesByName[0]["emulated-contract-publish"];
+    if (!contractNameMatch) {
+        throw new Error(`Could not locate "${sutContractName}" contract.`);
+    }
+    return contractNameMatch;
+};
 /**
  * Schedules a Rendezvous between the System Under Test (`SUT`) and the test
  * contract.
@@ -260,6 +323,31 @@ function scheduleRendezvous(targetContractSource, tests) {
     (ok (map-set context function-name {called: called})))`;
     return `${targetContractSource}\n\n${context}\n\n${tests}`;
 }
+/**
+ * Maps the simnet accounts to their sBTC balances. The function tries to call
+ * the `get-balance` function of the `sbtc-token` contract for each address. If
+ * the call fails, it returns a balance of 0 for that address. The call fails
+ * if the user is not working with sBTC.
+ * @param simnet The simnet instance.
+ * @returns A map of addresses to their sBTC balances.
+ */
+const getSbtcBalancesFromSimnet = (simnet) => new Map([...simnet.getAccounts().values()].map((address) => {
+    try {
+        const { result: getBalanceResult } = simnet.callReadOnlyFn("SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token", "get-balance", [transactions_1.Cl.principal(address)], address);
+        // If the previous read-only call works, the user is working with
+        // sBTC. This means we can proceed with restoring sBTC balances.
+        const sbtcBalanceJSON = (0, transactions_1.cvToJSON)(getBalanceResult);
+        // The `get-balance` function returns a response containing the uint
+        // balance of the address. In the JSON representation, the balance is
+        // represented as a string. We need to parse it to an integer.
+        const sbtcBalance = parseInt(sbtcBalanceJSON.value.value, 10);
+        return [address, sbtcBalance];
+    }
+    catch (e) {
+        return [address, 0];
+    }
+}));
+exports.getSbtcBalancesFromSimnet = getSbtcBalancesFromSimnet;
 /**
  * Utility function that restores the test wallets' initial sBTC balances in
  * the re-initialized first-class citizenship simnet.

package/dist/package.json

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

package/package.json

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