@btc-vision/bitcoin 6.5.6 → 7.0.0-alpha.1

package/build/script.js

@@ -1,23 +1,30 @@
+/**
+ * Script tools, including decompile, compile, toASM, fromASM, toStack, isCanonicalPubKey, isCanonicalScriptSignature
+ * @packageDocumentation
+ */
 import * as bip66 from './bip66.js';
+import { alloc, fromHex, toHex } from './io/index.js';
 import { opcodes, REVERSE_OPS } from './opcodes.js';
 import * as pushdata from './push_data.js';
 import * as scriptNumber from './script_number.js';
 import * as scriptSignature from './script_signature.js';
+import { isDefinedHashType } from './script_signature.js';
 import * as types from './types.js';
-const { typeforce } = types;
-const OP_INT_BASE = opcodes.OP_RESERVED;
+const OP_INT_BASE = opcodes.OP_RESERVED; // OP_1 - 1
 export { opcodes };
 function isOPInt(value) {
-    return (types.Number(value) &&
+    return (types.isNumber(value) &&
         (value === opcodes.OP_0 ||
             (value >= opcodes.OP_1 && value <= opcodes.OP_16) ||
             value === opcodes.OP_1NEGATE));
 }
 function isPushOnlyChunk(value) {
-    return types.Buffer(value) || isOPInt(value);
+    if (value instanceof Uint8Array)
+        return true;
+    return isOPInt(value);
 }
 export function isPushOnly(value) {
-    return types.Array(value) && value.every(isPushOnlyChunk);
+    return types.isArray(value) && value.every(isPushOnlyChunk);
 }
 export function countNonPushOnlyOPs(value) {
     return value.length - value.filter(isPushOnlyChunk).length;
@@ -26,50 +33,67 @@ function asMinimalOP(buffer) {
     if (buffer.length === 0)
         return opcodes.OP_0;
     if (buffer.length !== 1)
-        return;
+        return undefined;
     if (buffer[0] >= 1 && buffer[0] <= 16)
         return OP_INT_BASE + buffer[0];
     if (buffer[0] === 0x81)
         return opcodes.OP_1NEGATE;
+    return undefined;
 }
-function chunksIsBuffer(buf) {
-    return Buffer.isBuffer(buf);
+function chunksIsUint8Array(buf) {
+    return buf instanceof Uint8Array;
 }
 function chunksIsArray(buf) {
-    return types.Array(buf);
+    return types.isArray(buf);
 }
-function singleChunkIsBuffer(buf) {
-    return Buffer.isBuffer(buf);
+function singleChunkIsUint8Array(buf) {
+    return buf instanceof Uint8Array;
 }
+/**
+ * Compiles an array of chunks into a Uint8Array.
+ *
+ * @param chunks - The array of chunks to compile.
+ * @returns The compiled Uint8Array.
+ * @throws Error if the compilation fails.
+ */
 export function compile(chunks) {
-    if (chunksIsBuffer(chunks))
+    // Already compiled - return as-is
+    if (chunksIsUint8Array(chunks))
         return chunks;
-    typeforce(types.Array, chunks);
+    if (!types.isArray(chunks)) {
+        throw new TypeError('Expected an array');
+    }
     const bufferSize = chunks.reduce((accum, chunk) => {
-        if (singleChunkIsBuffer(chunk)) {
+        // data chunk
+        if (singleChunkIsUint8Array(chunk)) {
+            // adhere to BIP62.3, minimal push policy
             if (chunk.length === 1 && asMinimalOP(chunk) !== undefined) {
                 return accum + 1;
             }
             return accum + pushdata.encodingLength(chunk.length) + chunk.length;
         }
+        // opcode
         return accum + 1;
     }, 0.0);
-    const buffer = Buffer.allocUnsafe(bufferSize);
+    const buffer = new Uint8Array(bufferSize);
     let offset = 0;
     chunks.forEach((chunk) => {
-        if (singleChunkIsBuffer(chunk)) {
+        // data chunk
+        if (singleChunkIsUint8Array(chunk)) {
+            // adhere to BIP62.3, minimal push policy
             const opcode = asMinimalOP(chunk);
             if (opcode !== undefined) {
-                buffer.writeUInt8(opcode, offset);
+                buffer[offset] = opcode;
                 offset += 1;
                 return;
             }
             offset += pushdata.encode(buffer, chunk.length, offset);
-            chunk.copy(buffer, offset);
+            buffer.set(chunk, offset);
             offset += chunk.length;
+            // opcode
         }
         else {
-            buffer.writeUInt8(chunk, offset);
+            buffer[offset] = chunk;
             offset += 1;
         }
     });
@@ -78,22 +102,29 @@ export function compile(chunks) {
     return buffer;
 }
 export function decompile(buffer) {
+    // Already decompiled - return as-is
     if (chunksIsArray(buffer))
         return buffer;
-    typeforce(types.Buffer, buffer);
+    if (!(buffer instanceof Uint8Array)) {
+        throw new TypeError('Expected a Uint8Array');
+    }
     const chunks = [];
     let i = 0;
     while (i < buffer.length) {
         const opcode = buffer[i];
+        // data chunk
         if (opcode > opcodes.OP_0 && opcode <= opcodes.OP_PUSHDATA4) {
             const d = pushdata.decode(buffer, i);
+            // did reading a pushDataInt fail?
             if (d === null)
                 return null;
             i += d.size;
+            // attempt to read too much data?
             if (i + d.number > buffer.length)
                 return null;
             const data = buffer.subarray(i, i + d.number);
             i += d.number;
+            // decompile minimally
             const op = asMinimalOP(data);
             if (op !== undefined) {
                 chunks.push(op);
@@ -101,6 +132,7 @@ export function decompile(buffer) {
             else {
                 chunks.push(data);
             }
+            // opcode
         }
         else {
             chunks.push(opcode);
@@ -109,52 +141,83 @@ export function decompile(buffer) {
     }
     return chunks;
 }
+/**
+ * Converts the given chunks into an ASM (Assembly) string representation.
+ * If the chunks parameter is a Uint8Array, it will be decompiled into a Stack before conversion.
+ * @param chunks - The chunks to convert into ASM.
+ * @returns The ASM string representation of the chunks.
+ */
 export function toASM(chunks) {
-    if (chunksIsBuffer(chunks)) {
-        chunks = decompile(chunks);
+    let resolved;
+    if (chunksIsUint8Array(chunks)) {
+        const decompiled = decompile(chunks);
+        if (!decompiled) {
+            throw new Error('Could not convert invalid chunks to ASM');
+        }
+        resolved = decompiled;
     }
-    if (!chunks) {
-        throw new Error('Could not convert invalid chunks to ASM');
+    else {
+        resolved = chunks;
     }
-    return chunks
+    return resolved
         .map((chunk) => {
-        if (singleChunkIsBuffer(chunk)) {
+        // data?
+        if (singleChunkIsUint8Array(chunk)) {
             const op = asMinimalOP(chunk);
             if (op === undefined)
-                return chunk.toString('hex');
+                return toHex(chunk);
             chunk = op;
         }
+        // opcode!
         return REVERSE_OPS[chunk];
     })
         .join(' ');
 }
+/**
+ * Converts an ASM string to a Uint8Array.
+ * @param asm The ASM string to convert.
+ * @returns The converted Uint8Array.
+ */
 export function fromASM(asm) {
-    typeforce(types.String, asm);
+    if (typeof asm !== 'string') {
+        throw new TypeError('Expected a string');
+    }
     return compile(asm.split(' ').map((chunkStr) => {
+        // opcode?
         if (opcodes[chunkStr] !== undefined) {
             return opcodes[chunkStr];
         }
-        typeforce(types.Hex, chunkStr);
-        return Buffer.from(chunkStr, 'hex');
+        if (!types.isHex(chunkStr)) {
+            throw new TypeError('Expected hex string');
+        }
+        // data!
+        return fromHex(chunkStr);
     }));
 }
+/**
+ * Converts the given chunks into a stack of Uint8Arrays.
+ *
+ * @param chunks - The chunks to convert.
+ * @returns The stack of Uint8Arrays.
+ */
 export function toStack(chunks) {
-    chunks = decompile(chunks);
-    typeforce(isPushOnly, chunks);
-    return chunks.map((op) => {
-        if (singleChunkIsBuffer(op))
+    const resolved = chunksIsUint8Array(chunks) ? decompile(chunks) : chunks;
+    if (!resolved || !isPushOnly(resolved)) {
+        throw new TypeError('Expected push-only script');
+    }
+    return resolved.map((op) => {
+        if (singleChunkIsUint8Array(op))
             return op;
         if (op === opcodes.OP_0)
-            return Buffer.allocUnsafe(0);
+            return alloc(0);
         return scriptNumber.encode(op - OP_INT_BASE);
     });
 }
 export function isCanonicalPubKey(buffer) {
     return types.isPoint(buffer);
 }
-import { isDefinedHashType } from './script_signature.js';
 export function isCanonicalScriptSignature(buffer) {
-    if (!Buffer.isBuffer(buffer))
+    if (!(buffer instanceof Uint8Array))
         return false;
     if (!isDefinedHashType(buffer[buffer.length - 1]))
         return false;
@@ -162,3 +225,4 @@ export function isCanonicalScriptSignature(buffer) {
 }
 export const number = scriptNumber;
 export const signature = scriptSignature;
+//# sourceMappingURL=script.js.map

package/build/script.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"script.js","sourceRoot":"","sources":["../src/script.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,YAAY,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,eAAe,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE1D,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AAEpC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,WAAW;AACpD,OAAO,EAAE,OAAO,EAAE,CAAC;AAEnB,SAAS,OAAO,CAAC,KAAa;IAC1B,OAAO,CACH,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;QACrB,CAAC,KAAK,KAAK,OAAO,CAAC,IAAI;YACnB,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,IAAI,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC;YACjD,KAAK,KAAK,OAAO,CAAC,UAAU,CAAC,CACpC,CAAC;AACN,CAAC;AAED,SAAS,eAAe,CAAC,KAA0B;IAC/C,IAAI,KAAK,YAAY,UAAU;QAAE,OAAO,IAAI,CAAC;IAC7C,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAY;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,KAAY;IAC5C,OAAO,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC;AAC/D,CAAC;AAED,SAAS,WAAW,CAAC,MAAkB;IACnC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC,IAAI,CAAC;IAC7C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1C,IAAI,MAAM,CAAC,CAAC,CAAE,IAAI,CAAC,IAAI,MAAM,CAAC,CAAC,CAAE,IAAI,EAAE;QAAE,OAAO,WAAW,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;IACzE,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI;QAAE,OAAO,OAAO,CAAC,UAAU,CAAC;IAClD,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,SAAS,kBAAkB,CAAC,GAAuB;IAC/C,OAAO,GAAG,YAAY,UAAU,CAAC;AACrC,CAAC;AAED,SAAS,aAAa,CAAC,GAAuB;IAC1C,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,uBAAuB,CAAC,GAAwB;IACrD,OAAO,GAAG,YAAY,UAAU,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,MAA0B;IAC9C,kCAAkC;IAClC,IAAI,kBAAkB,CAAC,MAAM,CAAC;QAAE,OAAO,MAAgB,CAAC;IAExD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,SAAS,CAAC,mBAAmB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAa,EAAE,KAAK,EAAE,EAAE;QACtD,aAAa;QACb,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,yCAAyC;YACzC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;gBACzD,OAAO,KAAK,GAAG,CAAC,CAAC;YACrB,CAAC;YAED,OAAO,KAAK,GAAG,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;QACxE,CAAC;QAED,SAAS;QACT,OAAO,KAAK,GAAG,CAAC,CAAC;IACrB,CAAC,EAAE,GAAG,CAAC,CAAC;IAER,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;IAC1C,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACrB,aAAa;QACb,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,yCAAyC;YACzC,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACvB,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;gBACxB,MAAM,IAAI,CAAC,CAAC;gBACZ,OAAO;YACX,CAAC;YAED,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACxD,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;YAEvB,SAAS;QACb,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;YACvB,MAAM,IAAI,CAAC,CAAC;QAChB,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,MAAM,KAAK,MAAM,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACzE,OAAO,MAAgB,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,MAA0B;IAChD,oCAAoC;IACpC,IAAI,aAAa,CAAC,MAAM,CAAC;QAAE,OAAO,MAAoC,CAAC;IAEvE,IAAI,CAAC,CAAC,MAAM,YAAY,UAAU,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,SAAS,CAAC,uBAAuB,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,MAAM,GAA+B,EAAE,CAAC;IAC9C,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;QAE1B,aAAa;QACb,IAAI,MAAM,GAAG,OAAO,CAAC,IAAI,IAAI,MAAM,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YAC1D,MAAM,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAErC,kCAAkC;YAClC,IAAI,CAAC,KAAK,IAAI;gBAAE,OAAO,IAAI,CAAC;YAC5B,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;YAEZ,iCAAiC;YACjC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM;gBAAE,OAAO,IAAI,CAAC;YAE9C,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;YAC9C,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;YAEd,sBAAsB;YACtB,MAAM,EAAE,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;gBACnB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACpB,CAAC;iBAAM,CAAC;gBACJ,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;YAED,SAAS;QACb,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEpB,CAAC,IAAI,CAAC,CAAC;QACX,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAC,MAA0B;IAC5C,IAAI,QAAe,CAAC;IACpB,IAAI,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7B,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC/D,CAAC;QACD,QAAQ,GAAG,UAAU,CAAC;IAC1B,CAAC;SAAM,CAAC;QACJ,QAAQ,GAAG,MAAM,CAAC;IACtB,CAAC;IACD,OAAO,QAAQ;SACV,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACX,QAAQ;QACR,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,MAAM,EAAE,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;YAC9B,IAAI,EAAE,KAAK,SAAS;gBAAE,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,KAAK,GAAG,EAAE,CAAC;QACf,CAAC;QAED,UAAU;QACV,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW;IAC/B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC1B,MAAM,IAAI,SAAS,CAAC,mBAAmB,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,OAAO,CACV,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC5B,UAAU;QACV,IAAI,OAAO,CAAC,QAAyB,CAAC,KAAK,SAAS,EAAE,CAAC;YACnD,OAAO,OAAO,CAAC,QAAyB,CAAC,CAAC;QAC9C,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,SAAS,CAAC,qBAAqB,CAAC,CAAC;QAC/C,CAAC;QAED,QAAQ;QACR,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC,CAAC,CACL,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,MAA0B;IAC9C,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACzE,IAAI,CAAC,QAAQ,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,SAAS,CAAC,2BAA2B,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;QACvB,IAAI,uBAAuB,CAAC,EAAE,CAAC;YAAE,OAAO,EAAE,CAAC;QAC3C,IAAI,EAAE,KAAK,OAAO,CAAC,IAAI;YAAE,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;QAEzC,OAAO,YAAY,CAAC,MAAM,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAkB;IAChD,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,MAAkB;IACzD,IAAI,CAAC,CAAC,MAAM,YAAY,UAAU,CAAC;QAAE,OAAO,KAAK,CAAC;IAClD,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAE,CAAC;QAAE,OAAO,KAAK,CAAC;IAEjE,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,YAAY,CAAC;AACnC,MAAM,CAAC,MAAM,SAAS,GAAG,eAAe,CAAC"}

package/build/script_number.d.ts

@@ -1,2 +1,19 @@
+/**
+ * Decodes a script number from a buffer.
+ *
+ * @param buffer - The buffer containing the script number.
+ * @param maxLength - The maximum length of the script number. Defaults to 4.
+ * @param minimal - Whether the script number should be minimal. Defaults to true.
+ * @returns The decoded script number.
+ * @throws {TypeError} If the script number overflows the maximum length.
+ * @throws {Error} If the script number is not minimally encoded when minimal is true.
+ */
 export declare function decode(buffer: Buffer, maxLength?: number, minimal?: boolean): number;
+/**
+ * Encodes a number into a Buffer using a specific format.
+ *
+ * @param _number - The number to encode.
+ * @returns The encoded number as a Buffer.
+ */
 export declare function encode(_number: number): Buffer;
+//# sourceMappingURL=script_number.d.ts.map

package/build/script_number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"script_number.d.ts","sourceRoot":"","sources":["../src/script_number.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CA+BpF;AAMD;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAkB9C"}

package/build/script_number.js

@@ -1,3 +1,13 @@
+/**
+ * Decodes a script number from a buffer.
+ *
+ * @param buffer - The buffer containing the script number.
+ * @param maxLength - The maximum length of the script number. Defaults to 4.
+ * @param minimal - Whether the script number should be minimal. Defaults to true.
+ * @returns The decoded script number.
+ * @throws {TypeError} If the script number overflows the maximum length.
+ * @throws {Error} If the script number is not minimally encoded when minimal is true.
+ */
 export function decode(buffer, maxLength, minimal) {
     maxLength = maxLength || 4;
     minimal = minimal === undefined ? true : minimal;
@@ -12,6 +22,7 @@ export function decode(buffer, maxLength, minimal) {
                 throw new Error('Non-minimally encoded script number');
         }
     }
+    // 40-bit
     if (length === 5) {
         const a = buffer.readUInt32LE(0);
         const b = buffer.readUInt8(4);
@@ -19,6 +30,7 @@ export function decode(buffer, maxLength, minimal) {
             return -((b & ~0x80) * 0x100000000 + a);
         return b * 0x100000000 + a;
     }
+    // 32-bit / 24-bit / 16-bit / 8-bit
     let result = 0;
     for (let i = 0; i < length; ++i) {
         result |= buffer[i] << (8 * i);
@@ -30,6 +42,12 @@ export function decode(buffer, maxLength, minimal) {
 function scriptNumSize(i) {
     return i > 0x7fffffff ? 5 : i > 0x7fffff ? 4 : i > 0x7fff ? 3 : i > 0x7f ? 2 : i > 0x00 ? 1 : 0;
 }
+/**
+ * Encodes a number into a Buffer using a specific format.
+ *
+ * @param _number - The number to encode.
+ * @returns The encoded number as a Buffer.
+ */
 export function encode(_number) {
     let value = Math.abs(_number);
     const size = scriptNumSize(value);
@@ -47,3 +65,4 @@ export function encode(_number) {
     }
     return buffer;
 }
+//# sourceMappingURL=script_number.js.map

package/build/script_number.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"script_number.js","sourceRoot":"","sources":["../src/script_number.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,UAAU,MAAM,CAAC,MAAc,EAAE,SAAkB,EAAE,OAAiB;IACxE,SAAS,GAAG,SAAS,IAAI,CAAC,CAAC;IAC3B,OAAO,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;IAEjD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7B,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC;IAC3B,IAAI,MAAM,GAAG,SAAS;QAAE,MAAM,IAAI,SAAS,CAAC,wBAAwB,CAAC,CAAC;IACtE,IAAI,OAAO,EAAE,CAAC;QACV,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACrC,IAAI,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAE,GAAG,IAAI,CAAC,KAAK,CAAC;gBACjD,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QAC/D,CAAC;IACL,CAAC;IAED,SAAS;IACT,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;QACf,MAAM,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAE9B,IAAI,CAAC,GAAG,IAAI;YAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,WAAW,GAAG,CAAC,CAAC,CAAC;QACtD,OAAO,CAAC,GAAG,WAAW,GAAG,CAAC,CAAC;IAC/B,CAAC;IAED,mCAAmC;IACnC,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,MAAM,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACpC,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,CAAE,GAAG,IAAI;QAAE,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACjF,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAS,aAAa,CAAC,CAAS;IAC5B,OAAO,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpG,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAC,OAAe;IAClC,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,QAAQ,GAAG,OAAO,GAAG,CAAC,CAAC;IAE7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC;QAC5B,MAAM,CAAC,UAAU,CAAC,KAAK,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;QACnC,KAAK,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,CAAE,GAAG,IAAI,EAAE,CAAC;QAC3B,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC;SAAM,IAAI,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,IAAI,GAAG,CAAC,CAAE,IAAI,IAAI,CAAC;IAC9B,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC"}

package/build/script_signature.d.ts

@@ -1,8 +1,26 @@
+/**
+ * Checks if a hash type is defined (valid for Bitcoin signatures).
+ * @param hashType - The hash type to check.
+ * @returns True if the hash type is valid, false otherwise.
+ */
 export declare function isDefinedHashType(hashType: number): boolean;
-interface ScriptSignature {
-    signature: Buffer;
+export interface ScriptSignature {
+    signature: Uint8Array;
     hashType: number;
 }
-export declare function decode(buffer: Buffer): ScriptSignature;
-export declare function encode(signature: Buffer, hashType: number): Buffer;
-export {};
+/**
+ * Decodes a Uint8Array into a ScriptSignature object.
+ * @param buffer - The Uint8Array to decode.
+ * @returns The decoded ScriptSignature object.
+ * @throws Error if the hashType is invalid.
+ */
+export declare function decode(buffer: Uint8Array): ScriptSignature;
+/**
+ * Encodes a signature and hash type into a Uint8Array.
+ * @param signature - The signature to encode.
+ * @param hashType - The hash type to encode.
+ * @returns The encoded Uint8Array.
+ * @throws Error if the hashType is invalid.
+ */
+export declare function encode(signature: Uint8Array, hashType: number): Uint8Array;
+//# sourceMappingURL=script_signature.d.ts.map

package/build/script_signature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"script_signature.d.ts","sourceRoot":"","sources":["../src/script_signature.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAG3D;AA+BD,MAAM,WAAW,eAAe;IAC5B,SAAS,EAAE,UAAU,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAGD;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,eAAe,CAY1D;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,UAAU,CAkB1E"}

package/build/script_signature.js

@@ -1,11 +1,21 @@
 import * as bip66 from './bip66.js';
-import * as types from './types.js';
-const { typeforce } = types;
-const ZERO = Buffer.alloc(1, 0);
+import { alloc, concat } from './io/index.js';
+import { isUInt8, isUint8ArrayN } from './types.js';
+const ZERO = new Uint8Array([0]);
+/**
+ * Checks if a hash type is defined (valid for Bitcoin signatures).
+ * @param hashType - The hash type to check.
+ * @returns True if the hash type is valid, false otherwise.
+ */
 export function isDefinedHashType(hashType) {
     const hashTypeMod = hashType & ~0x80;
     return hashTypeMod > 0x00 && hashTypeMod < 0x04;
 }
+/**
+ * Converts a Uint8Array to a DER-encoded Uint8Array.
+ * @param x - The Uint8Array to be converted.
+ * @returns The DER-encoded Uint8Array.
+ */
 function toDER(x) {
     let i = 0;
     while (x[i] === 0)
@@ -14,39 +24,62 @@ function toDER(x) {
         return ZERO;
     x = x.subarray(i);
     if (x[0] & 0x80)
-        return Buffer.concat([ZERO, x], 1 + x.length);
+        return concat([ZERO, x]);
     return x;
 }
+/**
+ * Converts a DER-encoded signature to a Uint8Array.
+ * If the first byte of the input is 0x00, it is skipped.
+ * The resulting Uint8Array is 32 bytes long, filled with zeros if necessary.
+ * @param x - The DER-encoded signature.
+ * @returns The converted Uint8Array.
+ */
 function fromDER(x) {
     if (x[0] === 0x00)
         x = x.subarray(1);
-    const buffer = Buffer.alloc(32, 0);
+    const buffer = alloc(32);
     const bstart = Math.max(0, 32 - x.length);
-    x.copy(buffer, bstart);
+    buffer.set(x, bstart);
     return buffer;
 }
+// BIP62: 1 byte hashType flag (only 0x01, 0x02, 0x03, 0x81, 0x82 and 0x83 are allowed)
+/**
+ * Decodes a Uint8Array into a ScriptSignature object.
+ * @param buffer - The Uint8Array to decode.
+ * @returns The decoded ScriptSignature object.
+ * @throws Error if the hashType is invalid.
+ */
 export function decode(buffer) {
-    const hashType = buffer.readUInt8(buffer.length - 1);
+    const hashType = buffer[buffer.length - 1];
     if (!isDefinedHashType(hashType)) {
         throw new Error(`Invalid hashType ${hashType}`);
     }
     const decoded = bip66.decode(buffer.subarray(0, -1));
     const r = fromDER(decoded.r);
     const s = fromDER(decoded.s);
-    const signature = Buffer.concat([r, s], 64);
+    const signature = concat([r, s]);
     return { signature, hashType };
 }
+/**
+ * Encodes a signature and hash type into a Uint8Array.
+ * @param signature - The signature to encode.
+ * @param hashType - The hash type to encode.
+ * @returns The encoded Uint8Array.
+ * @throws Error if the hashType is invalid.
+ */
 export function encode(signature, hashType) {
-    typeforce({
-        signature: types.BufferN(64),
-        hashType: types.UInt8,
-    }, { signature, hashType });
+    if (!isUint8ArrayN(signature, 64)) {
+        throw new TypeError('Expected signature to be a 64-byte Uint8Array');
+    }
+    if (!isUInt8(hashType)) {
+        throw new TypeError('Expected hashType to be a UInt8');
+    }
     if (!isDefinedHashType(hashType)) {
         throw new Error(`Invalid hashType ${hashType}`);
     }
-    const hashTypeBuffer = Buffer.allocUnsafe(1);
-    hashTypeBuffer.writeUInt8(hashType, 0);
+    const hashTypeBuffer = new Uint8Array([hashType]);
     const r = toDER(signature.subarray(0, 32));
     const s = toDER(signature.subarray(32, 64));
-    return Buffer.concat([bip66.encode(r, s), hashTypeBuffer]);
+    return concat([bip66.encode(r, s), hashTypeBuffer]);
 }
+//# sourceMappingURL=script_signature.js.map

package/build/script_signature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"script_signature.js","sourceRoot":"","sources":["../src/script_signature.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEpD,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjC;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAgB;IAC9C,MAAM,WAAW,GAAG,QAAQ,GAAG,CAAC,IAAI,CAAC;IACrC,OAAO,WAAW,GAAG,IAAI,IAAI,WAAW,GAAG,IAAI,CAAC;AACpD,CAAC;AAED;;;;GAIG;AACH,SAAS,KAAK,CAAC,CAAa;IACxB,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAAE,EAAE,CAAC,CAAC;IACvB,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IAChC,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAClB,IAAI,CAAC,CAAC,CAAC,CAAE,GAAG,IAAI;QAAE,OAAO,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3C,OAAO,CAAC,CAAC;AACb,CAAC;AAED;;;;;;GAMG;AACH,SAAS,OAAO,CAAC,CAAa;IAC1B,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI;QAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;IACzB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACtB,OAAO,MAAM,CAAC;AAClB,CAAC;AAOD,uFAAuF;AACvF;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAC,MAAkB;IACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAE,CAAC;IAC5C,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,oBAAoB,QAAQ,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEjC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;AACnC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,SAAqB,EAAE,QAAgB;IAC1D,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,SAAS,CAAC,+CAA+C,CAAC,CAAC;IACzE,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,oBAAoB,QAAQ,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAElD,MAAM,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3C,MAAM,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAE5C,OAAO,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC;AACxD,CAAC"}