@cashscript/utils 0.13.1 → 0.14.0-next.0

package/dist/bitauth-script.js

@@ -48,6 +48,11 @@ const PROLOGUE_KINDS = [
     SourceTagKind.LOCKTIME_GUARD,
     SourceTagKind.PARAMETER_VALIDATION,
 ];
+// Compiler-injected epilogue checks: emitted after the function/loop body
+const EPILOGUE_KINDS = [
+    SourceTagKind.SCOPE_CLEANUP,
+    SourceTagKind.LOOP_CONDITION,
+];
 function buildInsertions(locationData, sourceLines, sourceTags) {
     const tags = (sourceTags ? parseSourceTags(sourceTags) : []);
     return tags.map((tag) => {
@@ -70,6 +75,14 @@ function deriveAnchor(tag, tags, locationData, sourceLines) {
             indent: lineIndent(sourceLines, firstBodyLine),
         };
     }
+    // Scope cleanup and loop-back condition tags always get inserted right before the scope's closing brace.
+    if (EPILOGUE_KINDS.includes(tag.kind)) {
+        const braceLine = getDisplayLine(locationData[tag.startIndex]);
+        return {
+            insertAfterLine: braceLine - 1,
+            indent: deriveIndent(locationData[tag.startIndex].location.start.line, sourceLines),
+        };
+    }
     return {
         insertAfterLine: getDisplayLine(locationData[Math.max(tag.startIndex - 1, 0)]),
         indent: deriveIndent(getDisplayLine(locationData[tag.startIndex]), sourceLines),
@@ -113,6 +126,10 @@ function tagDescription(tag, locationData, sourceLines) {
             const parameter = deriveSourceText(tag, locationData, sourceLines);
             return `>>> parameter type check${parameter ? ` (${parameter})` : ''}`;
         }
+        case SourceTagKind.SCOPE_CLEANUP:
+            return '>>> scope cleanup';
+        case SourceTagKind.LOOP_CONDITION:
+            return '>>> loop condition check';
         case SourceTagKind.FOR_UPDATE:
         default:
             return `>>> for-loop update (${deriveSourceText(tag, locationData, sourceLines)})`;

package/dist/script.js

@@ -1,7 +1,8 @@
 import { encodeDataPush, hexToBin, disassembleBytecodeBch, flattenBinArray, encodeAuthenticationInstructions, decodeAuthenticationInstructions, OpcodesBch, } from '@bitauth/libauth';
 import OptimisationsEquivFile from './cashproof-optimisations.js';
 import { optimisationReplacements } from './optimisations.js';
-import { PositionHint } from './types.js';
+import { range } from './data.js';
+import { PositionHint, SourceTagKind } from './types.js';
 export const Op = OpcodesBch;
 export function scriptToAsm(script) {
     return bytecodeToAsm(scriptToBytecode(script));
@@ -120,7 +121,24 @@ export function optimiseBytecode(script, locationData, logs, requires, sourceTag
         requires = newRequires;
         sourceTags = newSourceTags;
     }
-    return { script, locationData, logs, requires, sourceTags };
+    return { script, locationData, logs, requires, sourceTags: reconcileScopeCleanupTags(script, sourceTags) };
+}
+const SCOPE_CLEANUP_OPCODES = [Op.OP_DROP, Op.OP_NIP, Op.OP_2DROP];
+// Make sure that scope cleanup tags are only displayed if they did not merge with other tags or drift
+// due to compiler optimisations.
+function reconcileScopeCleanupTags(script, sourceTags) {
+    const otherTags = sourceTags.filter((tag) => tag.kind !== SourceTagKind.SCOPE_CLEANUP);
+    return sourceTags.filter((tag) => {
+        if (tag.kind !== SourceTagKind.SCOPE_CLEANUP)
+            return true;
+        const isOnlyCleanupOpcodes = range(tag.startIndex, tag.endIndex)
+            .every((index) => SCOPE_CLEANUP_OPCODES.includes(script[index]));
+        if (!isOnlyCleanupOpcodes)
+            return false;
+        const overlapsOtherTag = otherTags
+            .some((other) => tag.startIndex <= other.endIndex && other.startIndex <= tag.endIndex);
+        return !overlapsOtherTag;
+    });
 }
 export function optimiseBytecodeOld(script, runs = 1000) {
     const optimisations = OptimisationsEquivFile

package/dist/types.d.ts

@@ -24,7 +24,8 @@ export declare enum PrimitiveType {
     PUBKEY = "pubkey",
     SIG = "sig",
     DATASIG = "datasig",
-    ANY = "any"
+    ANY = "any",
+    VOID = "void"
 }
 export declare function explicitlyCastable(from?: Type, to?: Type): boolean;
 export declare function implicitlyCastable(actual?: Type, expected?: Type): boolean;
@@ -54,7 +55,9 @@ export declare enum PositionHint {
 export declare enum SourceTagKind {
     FOR_UPDATE = "fu",
     LOCKTIME_GUARD = "lg",
-    PARAMETER_VALIDATION = "pv"
+    PARAMETER_VALIDATION = "pv",
+    SCOPE_CLEANUP = "sc",
+    LOOP_CONDITION = "lc"
 }
 export interface SourceTagEntry {
     startIndex: number;

package/dist/types.js

@@ -38,6 +38,7 @@ export var PrimitiveType;
     PrimitiveType["SIG"] = "sig";
     PrimitiveType["DATASIG"] = "datasig";
     PrimitiveType["ANY"] = "any";
+    PrimitiveType["VOID"] = "void";
 })(PrimitiveType || (PrimitiveType = {}));
 const ExplicitlyCastableTo = {
     [PrimitiveType.INT]: [PrimitiveType.INT, PrimitiveType.BOOL],
@@ -47,10 +48,14 @@ const ExplicitlyCastableTo = {
     [PrimitiveType.SIG]: [PrimitiveType.SIG],
     [PrimitiveType.DATASIG]: [PrimitiveType.DATASIG],
     [PrimitiveType.ANY]: [],
+    [PrimitiveType.VOID]: [],
 };
 export function explicitlyCastable(from, to) {
     if (!from || !to)
         return false;
+    // `void` is not a real value type, so it can never participate in a cast
+    if (from === PrimitiveType.VOID || to === PrimitiveType.VOID)
+        return false;
     // Tuples can't be cast
     if (from instanceof TupleType || to instanceof TupleType)
         return false;
@@ -104,6 +109,9 @@ export function explicitlyCastable(from, to) {
 export function implicitlyCastable(actual, expected) {
     if (!actual || !expected)
         return false;
+    // `void` is not a real value type, so it can never be assigned to or from (not even to `any`)
+    if (actual === PrimitiveType.VOID || expected === PrimitiveType.VOID)
+        return false;
     if (actual instanceof TupleType && expected instanceof TupleType) {
         const leftIsCompatible = implicitlyCastable(actual.leftType, expected.leftType);
         const rightIsCompatible = implicitlyCastable(actual.rightType, expected.rightType);
@@ -197,5 +205,7 @@ export var SourceTagKind;
     SourceTagKind["FOR_UPDATE"] = "fu";
     SourceTagKind["LOCKTIME_GUARD"] = "lg";
     SourceTagKind["PARAMETER_VALIDATION"] = "pv";
+    SourceTagKind["SCOPE_CLEANUP"] = "sc";
+    SourceTagKind["LOOP_CONDITION"] = "lc";
 })(SourceTagKind || (SourceTagKind = {}));
 //# sourceMappingURL=types.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cashscript/utils",
-  "version": "0.13.1",
+  "version": "0.14.0-next.0",
   "description": "CashScript utilities and types",
   "keywords": [
     "bitcoin cash",
@@ -48,5 +48,5 @@
     "typescript": "^5.9.2",
     "vitest": "^4.0.15"
   },
-  "gitHead": "b5248b51a2ef93d750dcf916743eac9b79f62b5b"
+  "gitHead": "790d4a2c608ef492a9a1f886b1489d2e4ffe95e2"
 }