@cashscript/utils 0.9.1 → 0.10.0-next.0

package/dist/artifact.d.ts

@@ -9,12 +9,31 @@ export interface AbiFunction {
     covenant?: boolean;
     inputs: AbiInput[];
 }
+export interface LogEntry {
+    ip: number;
+    line: number;
+    data: Array<{
+        stackIndex: number;
+        type: string;
+    } | string>;
+}
+export interface RequireMessage {
+    ip: number;
+    line: number;
+    message: string;
+}
 export interface Artifact {
     contractName: string;
     constructorInputs: AbiInput[];
     abi: AbiFunction[];
     bytecode: string;
     source: string;
+    debug?: {
+        bytecode: string;
+        sourceMap: string;
+        logs: LogEntry[];
+        requireMessages: RequireMessage[];
+    };
     compiler: {
         name: string;
         version: string;

package/dist/index.d.ts

@@ -3,3 +3,5 @@ export * from './data.js';
 export * from './hash.js';
 export * from './script.js';
 export * from './types.js';
+export * from './sourceMap.js';
+export * from './libauth.js';

package/dist/index.js

@@ -3,4 +3,6 @@ export * from './data.js';
 export * from './hash.js';
 export * from './script.js';
 export * from './types.js';
+export * from './sourceMap.js';
+export * from './libauth.js';
 //# sourceMappingURL=index.js.map

package/dist/libauth.d.ts

@@ -0,0 +1,5 @@
+import { Script } from './script.js';
+export declare function buildOpCodeMap(bytecode: Script, souceMap: string): {
+    [key: string]: string;
+};
+export declare function formatLibauthScript(bytecode: Script, souceMap: string, sourceCode: string): string;

package/dist/libauth.js

@@ -0,0 +1,50 @@
+import { binToHex } from '@bitauth/libauth';
+import { Op } from './script.js';
+import { sourceMapToLocationData } from './sourceMap.js';
+function buildLineMap(bytecode, souceMap) {
+    const lineMap = {};
+    const locationData = sourceMapToLocationData(souceMap);
+    const map = locationData.map(([location, positionHint], index) => {
+        const op = bytecode[index];
+        return [
+            op,
+            Object.keys(Op)[Object.values(Op).indexOf(op)],
+            positionHint ? location?.end.line : location?.start.line,
+        ];
+    });
+    map.forEach(([op, , line]) => {
+        if (!lineMap[line]) {
+            lineMap[line] = [];
+        }
+        lineMap[line].push(op);
+    });
+    return lineMap;
+}
+export function buildOpCodeMap(bytecode, souceMap) {
+    const lineMap = buildLineMap(bytecode, souceMap);
+    const opCodeMap = {};
+    for (const [key, value] of Object.entries(lineMap)) {
+        opCodeMap[key] = value.map((asmElement) => {
+            if (asmElement instanceof Uint8Array) {
+                if (asmElement.length === 0) {
+                    return 'OP_0';
+                }
+                return `<0x${binToHex(asmElement)}>`;
+            }
+            return Object.keys(Op)[Object.values(Op).indexOf(asmElement)];
+        }).join(' ');
+    }
+    return opCodeMap;
+}
+export function formatLibauthScript(bytecode, souceMap, sourceCode) {
+    const opCodeMap = buildOpCodeMap(bytecode, souceMap);
+    const split = sourceCode.split('\n');
+    const maxCodeLength = Math.max(...split.map((val) => val.length));
+    const maxBytecodeLength = Math.max(...Object.values(opCodeMap).map((val) => val.length));
+    const result = split.map((line, index) => {
+        const opCodes = opCodeMap[index + 1];
+        return `${(opCodes || '').padEnd(maxBytecodeLength)} /* ${line.padEnd(maxCodeLength)} */`;
+    }).join('\n');
+    return result;
+}
+//# sourceMappingURL=libauth.js.map

package/dist/sourceMap.d.ts

@@ -0,0 +1,13 @@
+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;

package/dist/sourceMap.js

@@ -0,0 +1,95 @@
+/*
+ * The source mappings for the bytecode use the following notation (similar to Solidity):
+ *
+ * `sl:sc:el:ec:h`
+ *
+ * Where `sl` is the start line, `sc` - start column, `el` - end line, and `ec` - end column
+ * of the range in the source file.
+ * `h` is the position hint denoting where to place the instruction - at the beginning of the parent AST block
+ * or at the end.
+ * `h` is used with AST blocks, instructions of which surround children blocks, like function declarations and
+ * if-then-else blocks.
+ *
+ * Mappings are a list of `sl:sc:el:ec:h` separated by `;`. Each of these elements corresponds to an instruction.
+ *
+ * In order to compress these source mappings, the following rules are used:
+ *
+ * If a field is empty, the value of the preceding element is used.
+ * If a `:` is missing, all the following fields are considered empty.
+ * This means the following source mappings represent the same information:
+ *
+ * 14:20:14:29;14:20:14:29;14:12:14:30;14:34:14:43;14:34:14:43
+ *
+ * 14:20:14:29;;:12::30;:34::43;
+ *
+ */
+export function generateSourceMap(locationData) {
+    let prevStartLine = 0;
+    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;
+        const prevHintString = prevHint === hint ? '' : String(hint);
+        prevHint = hint;
+        let result = '';
+        if (prevStartLineString) {
+            result += prevStartLineString;
+        }
+        result += ':';
+        if (prevStartColumnString) {
+            result += prevStartColumnString;
+        }
+        result += ':';
+        if (prevEndLineString) {
+            result += prevEndLineString;
+        }
+        result += ':';
+        if (prevEndColumnString) {
+            result += prevEndColumnString;
+        }
+        result += ':';
+        if (prevHintString) {
+            result += prevHintString;
+        }
+        result = result.replace(/:*$/, '');
+        return result;
+    }).join(';');
+}
+export const sourceMapToLocationData = (sourceMap) => {
+    let prevStartLine = 0;
+    let prevStartColumn = 0;
+    let prevEndLine = 0;
+    let prevEndColumn = 0;
+    let prevHint;
+    return sourceMap.split(';').map((entry) => {
+        const val = entry.split(':');
+        const startLine = val[0] ? Number(val[0]) : prevStartLine;
+        prevStartLine = startLine;
+        const startColumn = val[1] ? Number(val[1]) : prevStartColumn;
+        prevStartColumn = startColumn;
+        const endLine = val[2] ? Number(val[2]) : prevEndLine;
+        prevEndLine = endLine;
+        const endColumn = val[3] ? Number(val[3]) : prevEndColumn;
+        prevEndColumn = endColumn;
+        const hint = val[4] ? Number(val[4]) : prevHint;
+        prevHint = hint;
+        return [
+            {
+                start: { line: startLine, column: startColumn },
+                end: { line: endLine, column: endColumn },
+            },
+            ...(hint ? [hint] : []),
+        ];
+    });
+};
+//# sourceMappingURL=sourceMap.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cashscript/utils",
-  "version": "0.9.1",
+  "version": "0.10.0-next.0",
   "description": "CashScript utilities and types",
   "keywords": [
     "bitcoin cash",
@@ -35,7 +35,7 @@
     "compile:test": "tsc -p tsconfig.test.json",
     "lint": "eslint . --ext .ts --ignore-path ../../.eslintignore",
     "prepare": "yarn build",
-    "prepublishOnly": "yarn test && yarn lint",
+    "prepublishOnly": "yarn test",
     "pretest": "yarn build:test",
     "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest"
   },
@@ -45,9 +45,9 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.4.1",
-    "eslint": "^7.20.0",
+    "eslint": "^8.54.0",
     "jest": "^29.4.1",
     "typescript": "^4.1.5"
   },
-  "gitHead": "0043ea317d554436cf2c8927e82a8a8a04bee615"
+  "gitHead": "3514c438fa3c8069c36f45cc80730293ac85dbdf"
 }