@cashscript/utils 0.10.1 → 0.10.3

package/dist/artifact.d.ts

@@ -6,7 +6,7 @@ export interface AbiInput {
 export interface AbiFunction {
     name: string;
     covenant?: boolean;
-    inputs: AbiInput[];
+    inputs: readonly AbiInput[];
 }
 export interface DebugInformation {
     bytecode: string;
@@ -32,8 +32,8 @@ export interface RequireStatement {
 }
 export interface Artifact {
     contractName: string;
-    constructorInputs: AbiInput[];
-    abi: AbiFunction[];
+    constructorInputs: readonly AbiInput[];
+    abi: readonly AbiFunction[];
     bytecode: string;
     source: string;
     debug?: DebugInformation;
@@ -44,4 +44,5 @@ export interface Artifact {
     updatedAt: string;
 }
 export declare function importArtifact(artifactFile: PathLike): Artifact;
-export declare function exportArtifact(artifact: Artifact, targetFile: string): void;
+export declare function exportArtifact(artifact: Artifact, targetFile: string, format: 'json' | 'ts'): void;
+export declare function formatArtifact(artifact: Artifact, format: 'json' | 'ts'): string;

package/dist/artifact.js

@@ -2,8 +2,41 @@ import fs from 'fs';
 export function importArtifact(artifactFile) {
     return JSON.parse(fs.readFileSync(artifactFile, { encoding: 'utf-8' }));
 }
-export function exportArtifact(artifact, targetFile) {
-    const jsonString = JSON.stringify(artifact, null, 2);
+export function exportArtifact(artifact, targetFile, format) {
+    const jsonString = formatArtifact(artifact, format);
     fs.writeFileSync(targetFile, jsonString);
 }
+export function formatArtifact(artifact, format) {
+    if (format === 'ts') {
+        return `export default ${stringifyAsTs(artifact)} as const;\n`;
+    }
+    return JSON.stringify(artifact, null, 2);
+}
+const indent = (level) => '  '.repeat(level);
+function stringifyAsTs(obj, indentationLevel = 1) {
+    // For strings, we use JSON.stringify, but we convert double quotes to single quotes
+    if (typeof obj === 'string') {
+        return JSON.stringify(obj).replace(/'/g, "\\'").replace(/"/g, "'");
+    }
+    // Numbers and booleans are just converted to strings
+    if (typeof obj === 'number' || typeof obj === 'boolean') {
+        return JSON.stringify(obj);
+    }
+    // Arrays are recursively formatted with indentation
+    if (Array.isArray(obj)) {
+        if (obj.length === 0)
+            return '[]';
+        const formattedItems = obj.map((item) => `${indent(indentationLevel)}${stringifyAsTs(item, indentationLevel + 1)}`);
+        return `[\n${formattedItems.join(',\n')},\n${indent(indentationLevel - 1)}]`;
+    }
+    // Objects are recursively formatted with indentation
+    if (typeof obj === 'object') {
+        const entries = Object.entries(obj);
+        if (entries.length === 0)
+            return '{}';
+        const formattedEntries = entries.map(([key, value]) => (`${indent(indentationLevel)}${key}: ${stringifyAsTs(value, indentationLevel + 1)}`));
+        return `{\n${formattedEntries.join(',\n')},\n${indent(indentationLevel - 1)}}`;
+    }
+    throw new Error(`Unsupported type: ${typeof obj}`);
+}
 //# sourceMappingURL=artifact.js.map

package/dist/bip68.d.ts

@@ -0,0 +1,7 @@
+interface DecodedSequence {
+    blocks?: number;
+    seconds?: number;
+}
+export declare function decodeBip68(sequence: number): DecodedSequence;
+export declare function encodeBip68({ blocks, seconds }: DecodedSequence): number;
+export {};

package/dist/bip68.js

@@ -0,0 +1,51 @@
+// Code taken and adapted from https://github.com/bitcoinjs/bip68
+// If we make significant changes to this code, we should also take and adapt the tests from that repository.
+// see https://github.com/bitcoin/bips/blob/master/bip-0068.mediawiki#compatibility
+const SEQUENCE_FINAL = 0xffffffff;
+const SEQUENCE_LOCKTIME_DISABLE_FLAG = (1 << 31);
+const SEQUENCE_LOCKTIME_GRANULARITY = 9;
+const SEQUENCE_LOCKTIME_MASK = 0x0000ffff;
+const SEQUENCE_LOCKTIME_TYPE_FLAG = (1 << 22);
+const BLOCKS_MAX = SEQUENCE_LOCKTIME_MASK;
+const SECONDS_MOD = 1 << SEQUENCE_LOCKTIME_GRANULARITY;
+const SECONDS_MAX = SEQUENCE_LOCKTIME_MASK << SEQUENCE_LOCKTIME_GRANULARITY;
+export function decodeBip68(sequence) {
+    // If the disable flag is set, we return an empty object
+    if (sequence & SEQUENCE_LOCKTIME_DISABLE_FLAG)
+        return {};
+    // If the SEQUENCE_LOCKTIME_TYPE_FLAG is set, that means that the sequence is in seconds
+    if (sequence & SEQUENCE_LOCKTIME_TYPE_FLAG) {
+        // If the sequence is in seconds, we need to shift it by the granularity
+        // (because every "unit" of time corresponds to 512 seconds)
+        const seconds = (sequence & SEQUENCE_LOCKTIME_MASK) << SEQUENCE_LOCKTIME_GRANULARITY;
+        return { seconds };
+    }
+    // If the disable flag is not set, and the SEQUENCE_LOCKTIME_TYPE_FLAG is not set, the sequence is in blocks
+    const blocks = sequence & SEQUENCE_LOCKTIME_MASK;
+    return { blocks };
+}
+export function encodeBip68({ blocks, seconds }) {
+    if (blocks !== undefined && seconds !== undefined)
+        throw new TypeError('Cannot encode blocks AND seconds');
+    // If the input is correct, we encode it as a sequence in seconds (using the SEQUENCE_LOCKTIME_TYPE_FLAG)
+    if (seconds !== undefined) {
+        if (!Number.isFinite(seconds))
+            throw new TypeError('Expected Number seconds');
+        if (seconds > SECONDS_MAX)
+            throw new TypeError('Expected Number seconds <= ' + SECONDS_MAX);
+        if (seconds % SECONDS_MOD !== 0)
+            throw new TypeError('Expected Number seconds as a multiple of ' + SECONDS_MOD);
+        return SEQUENCE_LOCKTIME_TYPE_FLAG | (seconds >> SEQUENCE_LOCKTIME_GRANULARITY);
+    }
+    // If the input is correct, we return the blocks (no further encoding needed)
+    if (blocks !== undefined) {
+        if (!Number.isFinite(blocks))
+            throw new TypeError('Expected Number blocks');
+        if (blocks > SEQUENCE_LOCKTIME_MASK)
+            throw new TypeError('Expected Number blocks <= ' + BLOCKS_MAX);
+        return blocks;
+    }
+    // If neither blocks nor seconds are provided, we assume the sequence is final
+    return SEQUENCE_FINAL;
+}
+//# sourceMappingURL=bip68.js.map

package/dist/hash.js

@@ -1,13 +1,12 @@
-// TODO: Replace with libauth
-import hash from 'hash.js';
+import { sha256 as sha256Lib, ripemd160 as ripemd160Lib, sha512 as sha512Lib } from '@bitauth/libauth';
 export function sha512(payload) {
-    return Uint8Array.from(hash.sha512().update(payload).digest());
+    return sha512Lib.hash(payload);
 }
 export function sha256(payload) {
-    return Uint8Array.from(hash.sha256().update(payload).digest());
+    return sha256Lib.hash(payload);
 }
 export function ripemd160(payload) {
-    return Uint8Array.from(hash.ripemd160().update(payload).digest());
+    return ripemd160Lib.hash(payload);
 }
 export function hash160(payload) {
     return ripemd160(sha256(payload));

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 export * from './artifact.js';
+export * from './bip68.js';
+export * from './bitauth-script.js';
 export * from './data.js';
 export * from './hash.js';
 export * from './script.js';
-export * from './types.js';
 export * from './source-map.js';
-export * from './bitauth-script.js';
+export * from './types.js';

package/dist/index.js

@@ -1,8 +1,9 @@
 export * from './artifact.js';
+export * from './bip68.js';
+export * from './bitauth-script.js';
 export * from './data.js';
 export * from './hash.js';
 export * from './script.js';
-export * from './types.js';
 export * from './source-map.js';
-export * from './bitauth-script.js';
+export * from './types.js';
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cashscript/utils",
-  "version": "0.10.1",
+  "version": "0.10.3",
   "description": "CashScript utilities and types",
   "keywords": [
     "bitcoin cash",
@@ -40,8 +40,7 @@
     "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest"
   },
   "dependencies": {
-    "@bitauth/libauth": "^3.0.0",
-    "hash.js": "^1.1.7"
+    "@bitauth/libauth": "^3.0.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.4.1",
@@ -49,5 +48,5 @@
     "jest": "^29.4.1",
     "typescript": "^5.5.4"
   },
-  "gitHead": "0dd95d5b05a438ac1884bdb2252aec6a4c77e5b2"
+  "gitHead": "1aa7c6b26ee8add3ff8cf42227141d9bea8aba66"
 }