@cashscript/utils 0.10.0-next.2 → 0.10.0-next.4

package/dist/artifact.d.ts

@@ -9,14 +9,22 @@ export interface AbiFunction {
     covenant?: boolean;
     inputs: AbiInput[];
 }
+export interface DebugInformation {
+    bytecode: string;
+    sourceMap: string;
+    logs: LogEntry[];
+    requireMessages: RequireMessage[];
+}
 export interface LogEntry {
     ip: number;
     line: number;
-    data: Array<{
-        stackIndex: number;
-        type: string;
-    } | string>;
+    data: Array<LogData>;
 }
+export interface StackItem {
+    type: string;
+    stackIndex: number;
+}
+export declare type LogData = StackItem | string;
 export interface RequireMessage {
     ip: number;
     line: number;
@@ -28,12 +36,7 @@ export interface Artifact {
     abi: AbiFunction[];
     bytecode: string;
     source: string;
-    debug?: {
-        bytecode: string;
-        sourceMap: string;
-        logs: LogEntry[];
-        requireMessages: RequireMessage[];
-    };
+    debug?: DebugInformation;
     compiler: {
         name: string;
         version: string;

package/dist/bitauth-script.d.ts

@@ -1,6 +1,6 @@
 import { Script } from './script.js';
 export declare type LineToOpcodesMap = Record<string, Script>;
 export declare type LineToAsmMap = Record<string, string>;
-export declare function buildLineToOpcodesMap(bytecode: Script, souceMap: string): LineToOpcodesMap;
-export declare function buildLineToAsmMap(bytecode: Script, souceMap: string): LineToAsmMap;
-export declare function formatBitAuthScript(bytecode: Script, souceMap: string, sourceCode: string): string;
+export declare function buildLineToOpcodesMap(bytecode: Script, sourceMap: string): LineToOpcodesMap;
+export declare function buildLineToAsmMap(bytecode: Script, sourceMap: string): LineToAsmMap;
+export declare function formatBitAuthScript(bytecode: Script, sourceMap: string, sourceCode: string): string;

package/dist/bitauth-script.js

@@ -1,23 +1,25 @@
 import { scriptToBitAuthAsm } from './script.js';
 import { sourceMapToLocationData } from './source-map.js';
-export function buildLineToOpcodesMap(bytecode, souceMap) {
-    const locationData = sourceMapToLocationData(souceMap);
-    return locationData.reduce((lineToOpcodeMap, [location, positionHint], index) => {
+import { PositionHint } from './types.js';
+export function buildLineToOpcodesMap(bytecode, sourceMap) {
+    const locationData = sourceMapToLocationData(sourceMap);
+    return locationData.reduce((lineToOpcodeMap, { location, positionHint }, index) => {
         const opcode = bytecode[index];
-        const line = positionHint ? location?.end.line : location?.start.line;
+        const line = positionHint === PositionHint.END ? location?.end.line : location?.start.line;
         return {
             ...lineToOpcodeMap,
             [line]: [...(lineToOpcodeMap[line] || []), opcode],
         };
     }, {});
 }
-export function buildLineToAsmMap(bytecode, souceMap) {
-    const lineToOpcodesMap = buildLineToOpcodesMap(bytecode, souceMap);
+export function buildLineToAsmMap(bytecode, sourceMap) {
+    const lineToOpcodesMap = buildLineToOpcodesMap(bytecode, sourceMap);
     return Object.fromEntries(Object.entries(lineToOpcodesMap).map(([lineNumber, opcodeList]) => [lineNumber, scriptToBitAuthAsm(opcodeList)]));
 }
-export function formatBitAuthScript(bytecode, souceMap, sourceCode) {
-    const lineToAsmMap = buildLineToAsmMap(bytecode, souceMap);
-    const sourceCodeLines = sourceCode.split('\n');
+export function formatBitAuthScript(bytecode, sourceMap, sourceCode) {
+    const lineToAsmMap = buildLineToAsmMap(bytecode, sourceMap);
+    const escapedSourceCode = sourceCode.replaceAll('/*', '\\/*').replaceAll('*/', '*\\/');
+    const sourceCodeLines = escapedSourceCode.split('\n');
     const sourceCodeLineLengths = sourceCodeLines.map((line) => line.length);
     const bytecodeLineLengths = Object.values(lineToAsmMap).map((line) => line.length);
     const maxSourceCodeLength = Math.max(...sourceCodeLineLengths);

package/dist/source-map.d.ts

@@ -1,13 +1,3 @@
-export interface LocationI {
-    start: {
-        line: number;
-        column: number;
-    };
-    end: {
-        line: number;
-        column: number;
-    };
-}
-export declare type LocationData = Array<[location: LocationI, positionHint?: number]>;
-export declare function generateSourceMap(locationData: LocationData): string;
-export declare const sourceMapToLocationData: (sourceMap: string) => LocationData;
+import { FullLocationData } from './types.js';
+export declare function generateSourceMap(locationData: FullLocationData): string;
+export declare const sourceMapToLocationData: (sourceMap: string) => FullLocationData;

package/dist/source-map.js

@@ -1,3 +1,4 @@
+import { PositionHint } from './types.js';
 /*
  * The source mappings for the bytecode use the following notation (similar to Solidity):
  *
@@ -28,17 +29,17 @@ export function generateSourceMap(locationData) {
     let prevStartColumn = 0;
     let prevEndLine = 0;
     let prevEndColumn = 0;
-    let prevHint = 0;
-    return locationData.map((row) => {
-        const prevStartLineString = prevStartLine === row[0].start.line ? '' : String(row[0].start.line);
-        prevStartLine = row[0].start.line;
-        const prevStartColumnString = prevStartColumn === row[0].start.column ? '' : String(row[0].start.column);
-        prevStartColumn = row[0].start.column;
-        const prevEndLineString = prevEndLine === row[0].end.line ? '' : String(row[0].end.line);
-        prevEndLine = row[0].end.line;
-        const prevEndColumnString = prevEndColumn === row[0].end.column ? '' : String(row[0].end.column);
-        prevEndColumn = row[0].end.column;
-        const hint = row[1] ?? 0;
+    let prevHint = PositionHint.START;
+    return locationData.map(({ location, positionHint }) => {
+        const prevStartLineString = prevStartLine === location.start.line ? '' : String(location.start.line);
+        prevStartLine = location.start.line;
+        const prevStartColumnString = prevStartColumn === location.start.column ? '' : String(location.start.column);
+        prevStartColumn = location.start.column;
+        const prevEndLineString = prevEndLine === location.end.line ? '' : String(location.end.line);
+        prevEndLine = location.end.line;
+        const prevEndColumnString = prevEndColumn === location.end.column ? '' : String(location.end.column);
+        prevEndColumn = location.end.column;
+        const hint = positionHint ?? PositionHint.START;
         const prevHintString = prevHint === hint ? '' : String(hint);
         prevHint = hint;
         let result = '';
@@ -72,24 +73,31 @@ export const sourceMapToLocationData = (sourceMap) => {
     let prevEndColumn = 0;
     let prevHint;
     return sourceMap.split(';').map((entry) => {
-        const val = entry.split(':');
-        const startLine = val[0] ? Number(val[0]) : prevStartLine;
+        const [startLineStr, startColumnStr, endLineStr, endColumnStr, positionHintStr] = entry.split(':');
+        const startLine = startLineStr ? Number(startLineStr) : prevStartLine;
         prevStartLine = startLine;
-        const startColumn = val[1] ? Number(val[1]) : prevStartColumn;
+        const startColumn = startColumnStr ? Number(startColumnStr) : prevStartColumn;
         prevStartColumn = startColumn;
-        const endLine = val[2] ? Number(val[2]) : prevEndLine;
+        const endLine = endLineStr ? Number(endLineStr) : prevEndLine;
         prevEndLine = endLine;
-        const endColumn = val[3] ? Number(val[3]) : prevEndColumn;
+        const endColumn = endColumnStr ? Number(endColumnStr) : prevEndColumn;
         prevEndColumn = endColumn;
-        const hint = val[4] ? Number(val[4]) : prevHint;
+        const hint = parsePositionHint(positionHintStr) ?? prevHint;
         prevHint = hint;
-        return [
-            {
+        return {
+            location: {
                 start: { line: startLine, column: startColumn },
                 end: { line: endLine, column: endColumn },
             },
-            ...(hint ? [hint] : []),
-        ];
+            ...(hint ? { positionHint: hint } : {}),
+        };
     });
 };
+const parsePositionHint = (hint) => {
+    if (hint === '1')
+        return PositionHint.END;
+    if (hint === '0')
+        return PositionHint.START;
+    return undefined;
+};
 //# sourceMappingURL=source-map.js.map

package/dist/types.d.ts

@@ -32,3 +32,22 @@ export declare function arrayType(types: Type[]): Type | undefined;
 export declare function implicitlyCastableSignature(actual: Type[], expected: Type[]): boolean;
 export declare function parseType(str: string): Type;
 export declare function isPrimitive(type: Type): type is PrimitiveType;
+export interface LocationI {
+    start: {
+        line: number;
+        column: number;
+    };
+    end: {
+        line: number;
+        column: number;
+    };
+}
+export declare type SingleLocationData = {
+    location: LocationI;
+    positionHint?: PositionHint;
+};
+export declare type FullLocationData = Array<SingleLocationData>;
+export declare enum PositionHint {
+    START = 0,
+    END = 1
+}

package/dist/types.js

@@ -172,4 +172,10 @@ export function parseType(str) {
 export function isPrimitive(type) {
     return !!PrimitiveType[type.toString().toUpperCase()];
 }
+// Denotes whether an opcode belongs to the "start" or "end" of the statement it's in (defaults to "start")
+export var PositionHint;
+(function (PositionHint) {
+    PositionHint[PositionHint["START"] = 0] = "START";
+    PositionHint[PositionHint["END"] = 1] = "END";
+})(PositionHint || (PositionHint = {}));
 //# sourceMappingURL=types.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cashscript/utils",
-  "version": "0.10.0-next.2",
+  "version": "0.10.0-next.4",
   "description": "CashScript utilities and types",
   "keywords": [
     "bitcoin cash",
@@ -40,7 +40,7 @@
     "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest"
   },
   "dependencies": {
-    "@bitauth/libauth": "^2.0.0-alpha.8",
+    "@bitauth/libauth": "^2.0.0",
     "hash.js": "^1.1.7"
   },
   "devDependencies": {
@@ -49,5 +49,5 @@
     "jest": "^29.4.1",
     "typescript": "^4.1.5"
   },
-  "gitHead": "23f2f6fc78f6a911dfe559404be7741aa824e791"
+  "gitHead": "9105dbcd300aa6a96f8f5297147572a9a79af6c4"
 }