@stacks/rendezvous 0.4.1 → 0.6.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

@@ -29,11 +29,12 @@ const transactions_1 = require("@stacks/transactions");
  *
  * @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.
@@ -43,13 +44,25 @@ const issueFirstClassCitizenship = (manifestDir, manifestPath, sutContractName)
     }));
     const sortedContractsByEpoch = (0, exports.groupContractsByEpochFromSimnetPlan)(simnetPlan);
     const simnetAddresses = [...simnet.getAccounts().values()];
-    const balancesMap = new Map(Array.from(simnetAddresses, (address) => {
+    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))];
     }));
-    yield simnet.initEmptySession();
+    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];
+        }
+    }));
+    yield simnet.initEmptySession(remoteDataSettings);
     simnetAddresses.forEach((address) => {
-        simnet.mintSTX(address, balancesMap.get(address));
+        simnet.mintSTX(address, stxBalancesMap.get(address));
     });
     // Combine the target contract with its tests into a single contract. The
     // resulting contract will replace the target contract in the simnet.
@@ -62,6 +75,14 @@ const issueFirstClassCitizenship = (manifestDir, manifestPath, sutContractName)
     ]));
     // Deploy the contracts to the simnet in the correct order.
     yield deployContracts(simnet, sortedContractsByEpoch, (name, props) => (0, exports.getContractSource)([sutContractName], rendezvousSources, name, 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
+    // had sBTC balances previously, restore them. If no test wallet previously
+    // owned sBTC, skip this step.
+    if ([...sbtcBalancesToRestore.keys()].length > 0) {
+        restoreSbtcBalances(simnet, sbtcBalancesToRestore);
+    }
     return simnet;
 });
 exports.issueFirstClassCitizenship = issueFirstClassCitizenship;
@@ -239,3 +260,85 @@ function scheduleRendezvous(targetContractSource, tests) {
     (ok (map-set context function-name {called: called})))`;
     return `${targetContractSource}\n\n${context}\n\n${tests}`;
 }
+/**
+ * Utility function that restores the test wallets' initial sBTC balances in
+ * the re-initialized first-class citizenship simnet.
+ *
+ * @param simnet The simnet instance.
+ * @param sbtcBalancesMap A map containing the test wallets' balances to be
+ * restored.
+ */
+const restoreSbtcBalances = (simnet, sbtcBalancesMap) => {
+    // For each address present in the balances map, restore the balance.
+    [...sbtcBalancesMap.entries()]
+        // Re-assure the map does not contain nil balances.
+        .filter(([_, balance]) => balance !== 0)
+        .forEach(([address, balance]) => {
+        // To deposit sBTC, one needs a txId and a sweep txId. A deposit transaction
+        // must have a unique txId and sweep txId.
+        const txId = getUniqueHex();
+        const sweepTxId = getUniqueHex();
+        mintSbtc(simnet, balance, address, txId, sweepTxId);
+    });
+};
+/**
+ * Utility function to deposit an amount of sBTC to a Stacks address.
+ *
+ * @param simnet The simnet instance.
+ * @param amountSats The amount to mint in sats.
+ * @param recipient The Stacks address to mint sBTC to.
+ * @param txId A unique hex to use for the deposit.
+ * @param sweepTxId A unique hex to use for the deposit.
+ */
+const mintSbtc = (simnet, amountSats, recipient, txId, sweepTxId) => {
+    // Calling `get-burn-header` only works for past block heights. We mine one
+    // empty Stacks block if the initial height is 0.
+    if (simnet.blockHeight === 0) {
+        simnet.mineEmptyBlock();
+    }
+    const previousStacksHeight = simnet.blockHeight - 1;
+    const burnHash = simnet.callReadOnlyFn("SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-deposit", "get-burn-header", [
+        // (height uint)
+        transactions_1.Cl.uint(previousStacksHeight),
+    ], simnet.deployer).result;
+    if (burnHash === null || burnHash.type === transactions_1.ClarityType.OptionalNone) {
+        throw new Error("Something went wrong trying to retrieve the burn header.");
+    }
+    const completeDepositTx = (0, transactions_1.cvToJSON)(simnet.callPublicFn("SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-deposit", "complete-deposit-wrapper", [
+        // (txid (buff 32))
+        transactions_1.Cl.bufferFromHex(txId),
+        // (vout-index uint)
+        transactions_1.Cl.uint(1),
+        // (amount uint)
+        transactions_1.Cl.uint(amountSats),
+        // (recipient principal)
+        transactions_1.Cl.principal(recipient),
+        // (burn-hash (buff 32))
+        burnHash.value,
+        // (burn-height uint)
+        transactions_1.Cl.uint(previousStacksHeight),
+        // (sweep-txid (buff 32))
+        transactions_1.Cl.bufferFromHex(sweepTxId),
+    ], "SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4").result);
+    // If the deposit transaction fails, an unexpected outcome can happen. Throw
+    // an error if the transaction is not successful.
+    if (!completeDepositTx.success) {
+        throw new Error("Something went wrong trying to restore sBTC balances.");
+    }
+};
+/**
+ * Utility function that generates a random, unique hex to be used as txId in
+ * `mintSbtc`.
+ *
+ * @returns A random hex string.
+ */
+const getUniqueHex = () => {
+    let hex;
+    // Generate a 32-byte (64 character) random hex string.
+    const bytes = new Uint8Array(32);
+    crypto.getRandomValues(bytes);
+    hex = Array.from(bytes)
+        .map((byte) => byte.toString(16).padStart(2, "0"))
+        .join("");
+    return hex;
+};

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stacks/rendezvous",
-    "version": "0.4.1",
+    "version": "0.6.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.15.2",
         "@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.15.2",
         "@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.4.1",
+  "version": "0.6.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.15.2",
     "@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.15.2",
     "@types/jest": "^29.5.12",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",