cashscript 0.13.0-next.0 → 0.13.0-next.1

package/dist/debugging.js

@@ -45,16 +45,32 @@ const debugSingleScenario = (template, artifact, unlockingScriptId, scenarioId)
     // https://libauth.org/types/AuthenticationVirtualMachine.html#__type.debug
     const lockingScriptDebugResult = fullDebugSteps.slice(findLastIndex(fullDebugSteps, (state) => state.ip === 0));
     // The controlStack determines whether the current debug step is in the executed branch
+    // It also tracks loop / function usage, but for the purpose of determining whether a step was executed,
+    // we only need to check that there are no 'false' items in the control stack.
     // https://libauth.org/types/AuthenticationProgramStateControlStack.html
+    // https://github.com/bitjson/bch-loops#control-stack
     const executedDebugSteps = lockingScriptDebugResult
-        .filter((debugStep) => debugStep.controlStack.every(item => item === true));
+        .filter((debugStep) => debugStep.controlStack.every(item => item !== false));
     // P2PKH inputs do not have an artifact, so we skip the console.log handling
     if (artifact) {
-        const executedLogs = (artifact.debug?.logs ?? [])
-            .filter((log) => executedDebugSteps.some((debugStep) => log.ip === debugStep.ip));
-        for (const log of executedLogs) {
+        // Try to match each executed debug step to a log entry if it exists. Note that inside loops,
+        // the same log statement may be executed multiple times in different debug steps
+        // Also note that multiple log statements may exist for the same ip, so we need to handle all of them
+        const executedLogs = executedDebugSteps
+            .flatMap((debugStep, index) => {
+            const logEntries = artifact.debug?.logs?.filter((log) => log.ip === debugStep.ip);
+            if (!logEntries || logEntries.length === 0)
+                return [];
+            const reversedPriorDebugSteps = executedDebugSteps.slice(0, index + 1).reverse();
+            return logEntries.map((logEntry) => {
+                const decodedLogData = logEntry.data
+                    .map((dataEntry) => decodeLogDataEntry(dataEntry, reversedPriorDebugSteps, vm));
+                return { logEntry, decodedLogData };
+            });
+        });
+        for (const { logEntry, decodedLogData } of executedLogs) {
             const inputIndex = extractInputIndexFromScenario(scenarioId);
-            logConsoleLogStatement(log, executedDebugSteps, artifact, inputIndex, vm);
+            logConsoleLogStatement(logEntry, decodedLogData, artifact.contractName, inputIndex);
         }
     }
     const lastExecutedDebugStep = executedDebugSteps[executedDebugSteps.length - 1];
@@ -147,16 +163,18 @@ const createProgram = (template, unlockingScriptId, scenarioId) => {
     }
     return { vm, program: scenarioGeneration.scenario.program };
 };
-const logConsoleLogStatement = (log, debugSteps, artifact, inputIndex, vm) => {
-    let line = `${artifact.contractName}.cash:${log.line}`;
-    const decodedData = log.data.map((element) => {
-        if (typeof element === 'string')
-            return element;
-        const debugStep = debugSteps.find((step) => step.ip === element.ip);
-        const transformedDebugStep = applyStackItemTransformations(element, debugStep, vm);
-        return decodeStackItem(element, transformedDebugStep.stack);
-    });
-    console.log(`[Input #${inputIndex}] ${line} ${decodedData.join(' ')}`);
+const logConsoleLogStatement = (log, decodedLogData, contractName, inputIndex) => {
+    console.log(`[Input #${inputIndex}] ${contractName}.cash:${log.line} ${decodedLogData.join(' ')}`);
+};
+const decodeLogDataEntry = (dataEntry, reversedPriorDebugSteps, vm) => {
+    if (typeof dataEntry === 'string')
+        return dataEntry;
+    const dataEntryDebugStep = reversedPriorDebugSteps.find((step) => step.ip === dataEntry.ip);
+    if (!dataEntryDebugStep) {
+        throw new Error(`Should not happen: corresponding data entry debug step not found for entry at ip ${dataEntry.ip}`);
+    }
+    const transformedDebugStep = applyStackItemTransformations(dataEntry, dataEntryDebugStep, vm);
+    return decodeStackItem(dataEntry, transformedDebugStep.stack);
 };
 const applyStackItemTransformations = (element, debugStep, vm) => {
     if (!element.transformations)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cashscript",
-  "version": "0.13.0-next.0",
+  "version": "0.13.0-next.1",
   "description": "Easily write and interact with Bitcoin Cash contracts",
   "keywords": [
     "bitcoin cash",
@@ -46,7 +46,7 @@
   },
   "dependencies": {
     "@bitauth/libauth": "^3.1.0-next.8",
-    "@cashscript/utils": "^0.13.0-next.0",
+    "@cashscript/utils": "^0.13.0-next.1",
     "@electrum-cash/network": "^4.1.3",
     "@mr-zwets/bchn-api-wrapper": "^1.0.1",
     "pako": "^2.1.0",
@@ -61,5 +61,5 @@
     "jest": "^29.7.0",
     "typescript": "^5.9.2"
   },
-  "gitHead": "1514d30e3d5de5bb2024d6198ed93a7ae8ae4e30"
+  "gitHead": "f3d3fd75400c93f4457276b56ce094b11c0986d7"
 }