@cashscript/utils 0.10.0-next.5 → 0.10.0

package/README.md

@@ -1,9 +1,9 @@
 # @cashscript/utils
 
-[![Build Status](https://travis-ci.org/Bitcoin-com/cashscript.svg)](https://travis-ci.org/Bitcoin-com/cashscript)
-[![Coverage Status](https://img.shields.io/codecov/c/github/Bitcoin-com/cashscript.svg)](https://codecov.io/gh/Bitcoin-com/cashscript)
+[![Build Status](https://travis-ci.org/CashScript/cashscript.svg)](https://travis-ci.org/CashScript/cashscript)
+[![Coverage Status](https://img.shields.io/codecov/c/github/CashScript/cashscript.svg)](https://codecov.io/gh/CashScript/cashscript)
 [![NPM Version](https://img.shields.io/npm/v/@cashscript/utils.svg)](https://www.npmjs.com/package/@cashscript/utils)
 [![NPM Monthly Downloads](https://img.shields.io/npm/dm/@cashscript/utils.svg)](hhttps://www.npmjs.com/package/@cashscript/utils)
 [![NPM License](https://img.shields.io/npm/l/@cashscript/utils.svg)](https://www.npmjs.com/package/@cashscript/utils)
 
-`@cashscript/utils` is a package containing a number of utilities and types used by both the CashScript compiler and the JavaScript SDK. This package can be used by other applications as well, but it should be considered an unstable API and will not necessarily follow semantic versioning rules. So if you want to use `@cashscript/utils` as a standalone package, it is recommended to specify a specific version (instead of a range) in your `package.json`.
+`@cashscript/utils` is a package containing a number of utilities and types used by both the CashScript compiler and the TypeScript SDK. This package can be used by other applications as well, but it should be considered an unstable API and will not necessarily follow semantic versioning rules. So if you want to use `@cashscript/utils` as a standalone package, it is recommended to specify a specific version (instead of a range) in your `package.json`.

package/dist/artifact.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { PathLike } from 'fs';
 export interface AbiInput {
     name: string;
@@ -13,7 +12,7 @@ export interface DebugInformation {
     bytecode: string;
     sourceMap: string;
     logs: LogEntry[];
-    requireMessages: RequireMessage[];
+    requires: RequireStatement[];
 }
 export interface LogEntry {
     ip: number;
@@ -23,12 +22,13 @@ export interface LogEntry {
 export interface StackItem {
     type: string;
     stackIndex: number;
+    ip: number;
 }
-export declare type LogData = StackItem | string;
-export interface RequireMessage {
+export type LogData = StackItem | string;
+export interface RequireStatement {
     ip: number;
     line: number;
-    message: string;
+    message?: string;
 }
 export interface Artifact {
     contractName: 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 type LineToOpcodesMap = Record<string, Script>;
+export type LineToAsmMap = Record<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/script.d.ts

@@ -1,7 +1,7 @@
 export declare const Op: typeof import("@bitauth/libauth").OpcodesBCH2023;
-export declare type Op = number;
-export declare type OpOrData = Op | Uint8Array;
-export declare type Script = OpOrData[];
+export type Op = number;
+export type OpOrData = Op | Uint8Array;
+export type Script = OpOrData[];
 export declare function scriptToAsm(script: Script): string;
 export declare function scriptToBitAuthAsm(script: Script): string;
 export declare function asmToScript(asm: string): Script;

package/dist/script.js

@@ -5,11 +5,9 @@ export const Op = OpcodesBCH;
 export function scriptToAsm(script) {
     return bytecodeToAsm(scriptToBytecode(script));
 }
-// TODO: See note at bytecodeToAsm
 export function scriptToBitAuthAsm(script) {
     return bytecodeToBitAuthAsm(scriptToBytecode(script));
 }
-// TODO: Figure out why OP_0 is decoded to an empty Uint8Array (while e.g. OP_3 is just OP_3)
 export function asmToScript(asm) {
     return bytecodeToScript(asmToBytecode(asm));
 }
@@ -60,8 +58,7 @@ export function bytecodeToAsm(bytecode) {
     asm = asm.replace(/\s+/g, ' ').trim();
     return asm;
 }
-// TODO: If we decide to change the ASM / artifact format, we can remove this function and merge it
-// with bytecodeToAsm
+// TODO: If we decide to change the ASM / artifact format, we can remove this function and merge it with bytecodeToAsm
 export function bytecodeToBitAuthAsm(bytecode) {
     // Convert the bytecode to libauth's ASM format
     let asm = disassembleBytecodeBCH(bytecode);

package/dist/source-map.js

@@ -71,7 +71,7 @@ export const sourceMapToLocationData = (sourceMap) => {
     let prevStartColumn = 0;
     let prevEndLine = 0;
     let prevEndColumn = 0;
-    let prevHint;
+    let prevHint = PositionHint.START;
     return sourceMap.split(';').map((entry) => {
         const [startLineStr, startColumnStr, endLineStr, endColumnStr, positionHintStr] = entry.split(':');
         const startLine = startLineStr ? Number(startLineStr) : prevStartLine;
@@ -89,7 +89,7 @@ export const sourceMapToLocationData = (sourceMap) => {
                 start: { line: startLine, column: startColumn },
                 end: { line: endLine, column: endColumn },
             },
-            ...(hint ? { positionHint: hint } : {}),
+            positionHint: hint,
         };
     });
 };

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-export declare type Type = PrimitiveType | ArrayType | TupleType | BytesType;
+export type Type = PrimitiveType | ArrayType | TupleType | BytesType;
 export declare class ArrayType {
     elementType: Type;
     bound?: number | undefined;
@@ -42,11 +42,11 @@ export interface LocationI {
         column: number;
     };
 }
-export declare type SingleLocationData = {
+export type SingleLocationData = {
     location: LocationI;
-    positionHint?: PositionHint;
+    positionHint: PositionHint;
 };
-export declare type FullLocationData = Array<SingleLocationData>;
+export type FullLocationData = Array<SingleLocationData>;
 export declare enum PositionHint {
     START = 0,
     END = 1

package/dist/types.js

@@ -173,6 +173,11 @@ 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")
+// Examples:
+// require(true); --> the OP_VERIFY comes after the condition (OP_TRUE), so it should get a PositionHint.END
+// !true --> the OP_NOT comes after the condition (OP_TRUE), so it should get a PositionHint.END
+// if (true) { ... } --> the OP_IF comes before the body, so it should get a PositionHint.START,
+//                       the OP_ENDIF comes after the body, so it should get a PositionHint.END
 export var PositionHint;
 (function (PositionHint) {
     PositionHint[PositionHint["START"] = 0] = "START";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cashscript/utils",
-  "version": "0.10.0-next.5",
+  "version": "0.10.0",
   "description": "CashScript utilities and types",
   "keywords": [
     "bitcoin cash",
@@ -10,11 +10,11 @@
   ],
   "homepage": "https://cashscript.org",
   "bugs": {
-    "url": "https://github.com/Bitcoin-com/cashscript/issues"
+    "url": "https://github.com/CashScript/cashscript/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Bitcoin-com/cashscript.git"
+    "url": "git+https://github.com/CashScript/cashscript.git"
   },
   "license": "MIT",
   "author": "Rosco Kalis <roscokalis@gmail.com>",
@@ -40,14 +40,14 @@
     "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest"
   },
   "dependencies": {
-    "@bitauth/libauth": "^2.0.0",
+    "@bitauth/libauth": "^3.0.0",
     "hash.js": "^1.1.7"
   },
   "devDependencies": {
     "@jest/globals": "^29.4.1",
     "eslint": "^8.54.0",
     "jest": "^29.4.1",
-    "typescript": "^4.1.5"
+    "typescript": "^5.5.4"
   },
-  "gitHead": "3d6611410e8c7ed9d760071a8c639e91c2cbb477"
+  "gitHead": "cd3031b60dc4ca2d2351608dfd838a50bcc7bbb9"
 }