@stacks/rendezvous 0.9.0 → 0.10.0

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.invalidRemoteDataWarningMessage = exports.noRemoteData = void 0;
+exports.tryParseRemoteDataSettings = exports.getManifestFileName = exports.noRemoteData = void 0;
 exports.main = main;
 const path_1 = require("path");
 const events_1 = require("events");
@@ -35,16 +35,7 @@ const logger = (log, logLevel = "log") => {
  */
 exports.noRemoteData = {
     enabled: false,
-    api_url: "",
-    initial_height: 1,
 };
-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.
@@ -64,17 +55,14 @@ 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;
-    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));
-    }
-    else if (remoteDataUserSettings) {
+    const remoteDataUserSettings = (_b = (_a = clarinetToml.repl) === null || _a === void 0 ? void 0 : _a.remote_data) !== null && _b !== void 0 ? _b : undefined;
+    if (remoteDataUserSettings && (remoteDataUserSettings === null || remoteDataUserSettings === void 0 ? void 0 : remoteDataUserSettings.enabled) === true) {
         radio.emit("logMessage", (0, ansicolor_1.yellow)("\nUsing remote data. Setting up the environment can take up to a minute..."));
     }
-    if (!remoteDataUserSettings || invalidRemoteDataSetup) {
+    // If no remote data settings are provided, we still need to return an object
+    // with the `enabled` property set to `false`. That is what simnet expects
+    // at least in order to initialize an empty simnet session.
+    if (!remoteDataUserSettings) {
         return exports.noRemoteData;
     }
     return remoteDataUserSettings;

package/dist/citizen.js

@@ -50,7 +50,9 @@ const issueFirstClassCitizenship = (manifestDir, manifestPath, remoteDataSetting
         const balanceHex = simnet.runSnippet(`(stx-get-balance '${address})`);
         return [address, (0, transactions_1.cvToValue)((0, transactions_1.hexToCV)(balanceHex))];
     }));
-    const sbtcBalancesMap = (0, exports.getSbtcBalancesFromSimnet)(simnet);
+    // If the sbtc-token contract is included in the deployment plan, we need to
+    // restore the sBTC balances. Otherwise, use an empty map.
+    const sbtcBalancesMap = (0, exports.getSbtcBalancesFromSimnet)(simnet, deploymentPlan, remoteDataSettings);
     yield simnet.initEmptySession(remoteDataSettings);
     simnetAddresses.forEach((address) => {
         simnet.mintSTX(address, stxBalancesMap.get(address));
@@ -323,30 +325,59 @@ function scheduleRendezvous(targetContractSource, tests) {
     (ok (map-set context function-name {called: called})))`;
     return `${targetContractSource}\n\n${context}\n\n${tests}`;
 }
+/**
+ * Checks if a contract can be found in the deployment plan.
+ * @param deploymentPlan The parsed deployment plan.
+ * @param contractAddress The address of the contract.
+ * @param contractName The name of the contract.
+ * @returns True if the contract can be found in the deployment plan, false
+ * otherwise.
+ */
+const isContractInDeploymentPlan = (deploymentPlan, contractAddress, contractName) => {
+    return deploymentPlan.plan.batches.some((batch) => batch.transactions.some((transaction) => {
+        var _a, _b;
+        return ((_a = transaction["emulated-contract-publish"]) === null || _a === void 0 ? void 0 : _a["contract-name"]) ===
+            contractName &&
+            ((_b = transaction["emulated-contract-publish"]) === null || _b === void 0 ? void 0 : _b["emulated-sender"]) ===
+                contractAddress;
+    }));
+};
 /**
  * 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.
+ * @param deploymentPlan The parsed deployment plan.
+ * @param remoteDataSettings The remote data settings.
  * @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];
+const getSbtcBalancesFromSimnet = (simnet, deploymentPlan, remoteDataSettings) => {
+    // If the user is not using remote data and the deployment plan does not
+    // contain the `sbtc-token` contract, return a map with 0 balances for all
+    // addresses. When remote data is enabled, the sbtc-token contract will not
+    // necessarily be present in the deployment plan.
+    if (!remoteDataSettings.enabled &&
+        !isContractInDeploymentPlan(deploymentPlan, "SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4", "sbtc-token")) {
+        return new Map([...simnet.getAccounts().values()].map((address) => [address, 0]));
     }
-}));
+    return 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

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stacks/rendezvous",
-    "version": "0.9.0",
+    "version": "0.10.0",
     "description": "Meet your contract's vulnerabilities head-on.",
     "main": "app.js",
     "bin": {
@@ -8,7 +8,7 @@
     },
     "scripts": {
         "build": "npx -p typescript tsc --project tsconfig.json && node -e \"if (process.platform !== 'win32') require('fs').chmodSync('./dist/app.js', 0o755);\"",
-        "test": "npx jest",
+        "test": "npx jest --testTimeout=15000",
         "test:coverage": "npx tsc --project tsconfig.json && npx jest --coverage"
     },
     "keywords": [
@@ -30,15 +30,15 @@
         "url": "https://github.com/stacks-network/rendezvous.git"
     },
     "dependencies": {
-        "@hirosystems/clarinet-sdk": "^3.0.1",
-        "@stacks/transactions": "^7.0.6",
+        "@hirosystems/clarinet-sdk": "^3.7.0",
+        "@stacks/transactions": "^7.2.0",
         "ansicolor": "^2.0.3",
         "fast-check": "^3.20.0",
         "toml": "^3.0.0",
         "yaml": "^2.6.1"
     },
     "devDependencies": {
-        "@hirosystems/clarinet-sdk-wasm": "^3.0.1",
+        "@hirosystems/clarinet-sdk-wasm": "^3.7.0",
         "@types/jest": "^29.5.12",
         "jest": "^29.7.0",
         "ts-jest": "^29.2.5",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/rendezvous",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Meet your contract's vulnerabilities head-on.",
   "main": "app.js",
   "bin": {
@@ -8,7 +8,7 @@
   },
   "scripts": {
     "build": "npx -p typescript tsc --project tsconfig.json && node -e \"if (process.platform !== 'win32') require('fs').chmodSync('./dist/app.js', 0o755);\"",
-    "test": "npx jest",
+    "test": "npx jest --testTimeout=15000",
     "test:coverage": "npx tsc --project tsconfig.json && npx jest --coverage"
   },
   "keywords": [
@@ -30,15 +30,15 @@
     "url": "https://github.com/stacks-network/rendezvous.git"
   },
   "dependencies": {
-    "@hirosystems/clarinet-sdk": "^3.0.1",
-    "@stacks/transactions": "^7.0.6",
+    "@hirosystems/clarinet-sdk": "^3.7.0",
+    "@stacks/transactions": "^7.2.0",
     "ansicolor": "^2.0.3",
     "fast-check": "^3.20.0",
     "toml": "^3.0.0",
     "yaml": "^2.6.1"
   },
   "devDependencies": {
-    "@hirosystems/clarinet-sdk-wasm": "^3.0.1",
+    "@hirosystems/clarinet-sdk-wasm": "^3.7.0",
     "@types/jest": "^29.5.12",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",