@btc-vision/bitcoin 6.4.9 → 6.4.10

package/src/payments/p2wsh.ts

@@ -1,217 +1,217 @@
-import { bech32 } from 'bech32';
-import * as bcrypto from '../crypto.js';
-import { bitcoin as BITCOIN_NETWORK } from '../networks.js';
-import * as bscript from '../script.js';
-import { isPoint, stacksEqual, typeforce as typef } from '../types.js';
-import { P2WSHPayment, PaymentOpts, PaymentType, StackElement, StackFunction } from './index.js';
-import * as lazy from './lazy.js';
-
-const OPS = bscript.OPS;
-
-const EMPTY_BUFFER = Buffer.alloc(0);
-
-function chunkHasUncompressedPubkey(chunk: StackElement): boolean {
-    if (Buffer.isBuffer(chunk) && chunk.length === 65 && chunk[0] === 0x04 && isPoint(chunk)) {
-        return true;
-    } else {
-        return false;
-    }
-}
-
-// input: <>
-// witness: [redeemScriptSig ...] {redeemScript}
-// output: OP_0 {sha256(redeemScript)}
-/**
- * Creates a Pay-to-Witness-Script-Hash (P2WSH) payment object.
- *
- * @param a - The payment object containing the necessary data.
- * @param opts - Optional payment options.
- * @returns The P2WSH payment object.
- * @throws {TypeError} If the required data is missing or invalid.
- */
-export function p2wsh(a: Omit<P2WSHPayment, 'name'>, opts?: PaymentOpts): P2WSHPayment {
-    if (!a.address && !a.hash && !a.output && !a.redeem && !a.witness)
-        throw new TypeError('Not enough data');
-    opts = Object.assign({ validate: true }, opts || {});
-
-    typef(
-        {
-            network: typef.maybe(typef.Object),
-
-            address: typef.maybe(typef.String),
-            hash: typef.maybe(typef.BufferN(32)),
-            output: typef.maybe(typef.BufferN(34)),
-
-            redeem: typef.maybe({
-                input: typef.maybe(typef.Buffer),
-                network: typef.maybe(typef.Object),
-                output: typef.maybe(typef.Buffer),
-                witness: typef.maybe(typef.arrayOf(typef.Buffer)),
-            }),
-            input: typef.maybe(typef.BufferN(0)),
-            witness: typef.maybe(typef.arrayOf(typef.Buffer)),
-        },
-        a,
-    );
-
-    const _address = lazy.value(() => {
-        const result = bech32.decode(a.address!);
-        const version = result.words.shift();
-        const data = bech32.fromWords(result.words);
-        return {
-            version,
-            prefix: result.prefix,
-            data: Buffer.from(data),
-        };
-    });
-    const _rchunks = lazy.value(() => {
-        return bscript.decompile(a.redeem!.input!);
-    }) as StackFunction;
-
-    let network = a.network;
-    if (!network) {
-        network = (a.redeem && a.redeem.network) || BITCOIN_NETWORK;
-    }
-
-    const o: P2WSHPayment = {
-        network,
-        name: PaymentType.P2WSH
-    };
-
-    lazy.prop(o, 'address', () => {
-        if (!o.hash) return;
-        const words = bech32.toWords(o.hash);
-        words.unshift(0x00);
-        return bech32.encode(network!.bech32, words);
-    });
-    lazy.prop(o, 'hash', () => {
-        if (a.output) return a.output.slice(2);
-        if (a.address) return _address().data;
-        if (o.redeem && o.redeem.output) return bcrypto.sha256(o.redeem.output);
-    });
-    lazy.prop(o, 'output', () => {
-        if (!o.hash) return;
-        return bscript.compile([OPS.OP_0, o.hash]);
-    });
-    lazy.prop(o, 'redeem', () => {
-        if (!a.witness) return;
-        return {
-            output: a.witness[a.witness.length - 1],
-            input: EMPTY_BUFFER,
-            witness: a.witness.slice(0, -1),
-        };
-    });
-    lazy.prop(o, 'input', () => {
-        if (!o.witness) return;
-        return EMPTY_BUFFER;
-    });
-    lazy.prop(o, 'witness', () => {
-        // transform redeem input to witness stack?
-        if (
-            a.redeem &&
-            a.redeem.input &&
-            a.redeem.input.length > 0 &&
-            a.redeem.output &&
-            a.redeem.output.length > 0
-        ) {
-            const stack = bscript.toStack(_rchunks());
-
-            // assign, and blank the existing input
-            o.redeem = Object.assign({ witness: stack }, a.redeem);
-            o.redeem.input = EMPTY_BUFFER;
-            return ([] as Buffer[]).concat(stack, a.redeem.output);
-        }
-
-        if (!a.redeem) return;
-        if (!a.redeem.output) return;
-        if (!a.redeem.witness) return;
-        return ([] as Buffer[]).concat(a.redeem.witness, a.redeem.output);
-    });
-    lazy.prop(o, 'name', () => {
-        const nameParts = ['p2wsh'];
-        if (o.redeem !== undefined && o.redeem.name !== undefined) nameParts.push(o.redeem.name!);
-        return nameParts.join('-');
-    });
-
-    // extended validation
-    if (opts.validate) {
-        let hash: Buffer = Buffer.from([]);
-        if (a.address) {
-            if (_address().prefix !== network.bech32)
-                throw new TypeError('Invalid prefix or Network mismatch');
-            if (_address().version !== 0x00) throw new TypeError('Invalid address version');
-            if (_address().data.length !== 32) throw new TypeError('Invalid address data');
-            hash = _address().data;
-        }
-
-        if (a.hash) {
-            if (hash.length > 0 && !hash.equals(a.hash)) throw new TypeError('Hash mismatch');
-            else hash = a.hash;
-        }
-
-        if (a.output) {
-            if (a.output.length !== 34 || a.output[0] !== OPS.OP_0 || a.output[1] !== 0x20)
-                throw new TypeError('Output is invalid');
-            const hash2 = a.output.slice(2);
-            if (hash.length > 0 && !hash.equals(hash2)) throw new TypeError('Hash mismatch');
-            else hash = hash2;
-        }
-
-        if (a.redeem) {
-            if (a.redeem.network && a.redeem.network !== network)
-                throw new TypeError('Network mismatch');
-
-            // is there two redeem sources?
-            if (
-                a.redeem.input &&
-                a.redeem.input.length > 0 &&
-                a.redeem.witness &&
-                a.redeem.witness.length > 0
-            )
-                throw new TypeError('Ambiguous witness source');
-
-            // is the redeem output non-empty/valid?
-            if (a.redeem.output) {
-                const decompile = bscript.decompile(a.redeem.output);
-                if (!decompile || decompile.length < 1)
-                    throw new TypeError('Redeem.output is invalid');
-                if (a.redeem.output.byteLength > 3600)
-                    throw new TypeError('Redeem.output unspendable if larger than 3600 bytes');
-                if (bscript.countNonPushOnlyOPs(decompile) > 201)
-                    throw new TypeError(
-                        'Redeem.output unspendable with more than 201 non-push ops',
-                    );
-
-                // match hash against other sources
-                const hash2 = bcrypto.sha256(a.redeem.output);
-                if (hash.length > 0 && !hash.equals(hash2)) throw new TypeError('Hash mismatch');
-                else hash = hash2;
-            }
-
-            if (a.redeem.input && !bscript.isPushOnly(_rchunks()))
-                throw new TypeError('Non push-only scriptSig');
-            if (a.witness && a.redeem.witness && !stacksEqual(a.witness, a.redeem.witness))
-                throw new TypeError('Witness and redeem.witness mismatch');
-            if (
-                (a.redeem.input && _rchunks().some(chunkHasUncompressedPubkey)) ||
-                (a.redeem.output &&
-                    (bscript.decompile(a.redeem.output) || []).some(chunkHasUncompressedPubkey))
-            ) {
-                throw new TypeError('redeem.input or redeem.output contains uncompressed pubkey');
-            }
-        }
-
-        if (a.witness && a.witness.length > 0) {
-            const wScript = a.witness[a.witness.length - 1];
-            if (a.redeem && a.redeem.output && !a.redeem.output.equals(wScript))
-                throw new TypeError('Witness and redeem.output mismatch');
-            if (
-                a.witness.some(chunkHasUncompressedPubkey) ||
-                (bscript.decompile(wScript) || []).some(chunkHasUncompressedPubkey)
-            )
-                throw new TypeError('Witness contains uncompressed pubkey');
-        }
-    }
-
-    return Object.assign(o, a);
-}
+import { bech32 } from 'bech32';
+import * as bcrypto from '../crypto.js';
+import { bitcoin as BITCOIN_NETWORK } from '../networks.js';
+import * as bscript from '../script.js';
+import { isPoint, stacksEqual, typeforce as typef } from '../types.js';
+import { P2WSHPayment, PaymentOpts, PaymentType, StackElement, StackFunction } from './index.js';
+import * as lazy from './lazy.js';
+
+const OPS = bscript.opcodes;
+
+const EMPTY_BUFFER = Buffer.alloc(0);
+
+function chunkHasUncompressedPubkey(chunk: StackElement): boolean {
+    if (Buffer.isBuffer(chunk) && chunk.length === 65 && chunk[0] === 0x04 && isPoint(chunk)) {
+        return true;
+    } else {
+        return false;
+    }
+}
+
+// input: <>
+// witness: [redeemScriptSig ...] {redeemScript}
+// output: OP_0 {sha256(redeemScript)}
+/**
+ * Creates a Pay-to-Witness-Script-Hash (P2WSH) payment object.
+ *
+ * @param a - The payment object containing the necessary data.
+ * @param opts - Optional payment options.
+ * @returns The P2WSH payment object.
+ * @throws {TypeError} If the required data is missing or invalid.
+ */
+export function p2wsh(a: Omit<P2WSHPayment, 'name'>, opts?: PaymentOpts): P2WSHPayment {
+    if (!a.address && !a.hash && !a.output && !a.redeem && !a.witness)
+        throw new TypeError('Not enough data');
+    opts = Object.assign({ validate: true }, opts || {});
+
+    typef(
+        {
+            network: typef.maybe(typef.Object),
+
+            address: typef.maybe(typef.String),
+            hash: typef.maybe(typef.BufferN(32)),
+            output: typef.maybe(typef.BufferN(34)),
+
+            redeem: typef.maybe({
+                input: typef.maybe(typef.Buffer),
+                network: typef.maybe(typef.Object),
+                output: typef.maybe(typef.Buffer),
+                witness: typef.maybe(typef.arrayOf(typef.Buffer)),
+            }),
+            input: typef.maybe(typef.BufferN(0)),
+            witness: typef.maybe(typef.arrayOf(typef.Buffer)),
+        },
+        a,
+    );
+
+    const _address = lazy.value(() => {
+        const result = bech32.decode(a.address!);
+        const version = result.words.shift();
+        const data = bech32.fromWords(result.words);
+        return {
+            version,
+            prefix: result.prefix,
+            data: Buffer.from(data),
+        };
+    });
+    const _rchunks = lazy.value(() => {
+        return bscript.decompile(a.redeem!.input!);
+    }) as StackFunction;
+
+    let network = a.network;
+    if (!network) {
+        network = (a.redeem && a.redeem.network) || BITCOIN_NETWORK;
+    }
+
+    const o: P2WSHPayment = {
+        network,
+        name: PaymentType.P2WSH,
+    };
+
+    lazy.prop(o, 'address', () => {
+        if (!o.hash) return;
+        const words = bech32.toWords(o.hash);
+        words.unshift(0x00);
+        return bech32.encode(network!.bech32, words);
+    });
+    lazy.prop(o, 'hash', () => {
+        if (a.output) return a.output.slice(2);
+        if (a.address) return _address().data;
+        if (o.redeem && o.redeem.output) return bcrypto.sha256(o.redeem.output);
+    });
+    lazy.prop(o, 'output', () => {
+        if (!o.hash) return;
+        return bscript.compile([OPS.OP_0, o.hash]);
+    });
+    lazy.prop(o, 'redeem', () => {
+        if (!a.witness) return;
+        return {
+            output: a.witness[a.witness.length - 1],
+            input: EMPTY_BUFFER,
+            witness: a.witness.slice(0, -1),
+        };
+    });
+    lazy.prop(o, 'input', () => {
+        if (!o.witness) return;
+        return EMPTY_BUFFER;
+    });
+    lazy.prop(o, 'witness', () => {
+        // transform redeem input to witness stack?
+        if (
+            a.redeem &&
+            a.redeem.input &&
+            a.redeem.input.length > 0 &&
+            a.redeem.output &&
+            a.redeem.output.length > 0
+        ) {
+            const stack = bscript.toStack(_rchunks());
+
+            // assign, and blank the existing input
+            o.redeem = Object.assign({ witness: stack }, a.redeem);
+            o.redeem.input = EMPTY_BUFFER;
+            return ([] as Buffer[]).concat(stack, a.redeem.output);
+        }
+
+        if (!a.redeem) return;
+        if (!a.redeem.output) return;
+        if (!a.redeem.witness) return;
+        return ([] as Buffer[]).concat(a.redeem.witness, a.redeem.output);
+    });
+    lazy.prop(o, 'name', () => {
+        const nameParts = ['p2wsh'];
+        if (o.redeem !== undefined && o.redeem.name !== undefined) nameParts.push(o.redeem.name!);
+        return nameParts.join('-');
+    });
+
+    // extended validation
+    if (opts.validate) {
+        let hash: Buffer = Buffer.from([]);
+        if (a.address) {
+            if (_address().prefix !== network.bech32)
+                throw new TypeError('Invalid prefix or Network mismatch');
+            if (_address().version !== 0x00) throw new TypeError('Invalid address version');
+            if (_address().data.length !== 32) throw new TypeError('Invalid address data');
+            hash = _address().data;
+        }
+
+        if (a.hash) {
+            if (hash.length > 0 && !hash.equals(a.hash)) throw new TypeError('Hash mismatch');
+            else hash = a.hash;
+        }
+
+        if (a.output) {
+            if (a.output.length !== 34 || a.output[0] !== OPS.OP_0 || a.output[1] !== 0x20)
+                throw new TypeError('Output is invalid');
+            const hash2 = a.output.slice(2);
+            if (hash.length > 0 && !hash.equals(hash2)) throw new TypeError('Hash mismatch');
+            else hash = hash2;
+        }
+
+        if (a.redeem) {
+            if (a.redeem.network && a.redeem.network !== network)
+                throw new TypeError('Network mismatch');
+
+            // is there two redeem sources?
+            if (
+                a.redeem.input &&
+                a.redeem.input.length > 0 &&
+                a.redeem.witness &&
+                a.redeem.witness.length > 0
+            )
+                throw new TypeError('Ambiguous witness source');
+
+            // is the redeem output non-empty/valid?
+            if (a.redeem.output) {
+                const decompile = bscript.decompile(a.redeem.output);
+                if (!decompile || decompile.length < 1)
+                    throw new TypeError('Redeem.output is invalid');
+                if (a.redeem.output.byteLength > 3600)
+                    throw new TypeError('Redeem.output unspendable if larger than 3600 bytes');
+                if (bscript.countNonPushOnlyOPs(decompile) > 201)
+                    throw new TypeError(
+                        'Redeem.output unspendable with more than 201 non-push ops',
+                    );
+
+                // match hash against other sources
+                const hash2 = bcrypto.sha256(a.redeem.output);
+                if (hash.length > 0 && !hash.equals(hash2)) throw new TypeError('Hash mismatch');
+                else hash = hash2;
+            }
+
+            if (a.redeem.input && !bscript.isPushOnly(_rchunks()))
+                throw new TypeError('Non push-only scriptSig');
+            if (a.witness && a.redeem.witness && !stacksEqual(a.witness, a.redeem.witness))
+                throw new TypeError('Witness and redeem.witness mismatch');
+            if (
+                (a.redeem.input && _rchunks().some(chunkHasUncompressedPubkey)) ||
+                (a.redeem.output &&
+                    (bscript.decompile(a.redeem.output) || []).some(chunkHasUncompressedPubkey))
+            ) {
+                throw new TypeError('redeem.input or redeem.output contains uncompressed pubkey');
+            }
+        }
+
+        if (a.witness && a.witness.length > 0) {
+            const wScript = a.witness[a.witness.length - 1];
+            if (a.redeem && a.redeem.output && !a.redeem.output.equals(wScript))
+                throw new TypeError('Witness and redeem.output mismatch');
+            if (
+                a.witness.some(chunkHasUncompressedPubkey) ||
+                (bscript.decompile(wScript) || []).some(chunkHasUncompressedPubkey)
+            )
+                throw new TypeError('Witness contains uncompressed pubkey');
+        }
+    }
+
+    return Object.assign(o, a);
+}

package/src/push_data.ts

@@ -1,4 +1,4 @@
-import { OPS } from './ops.js';
+import { opcodes } from './opcodes.js';
 
 /**
  * Calculates the encoding length of a number used for push data in Bitcoin transactions.
@@ -6,7 +6,7 @@ import { OPS } from './ops.js';
  * @returns The encoding length of the number.
  */
 export function encodingLength(i: number): number {
-    return i < OPS.OP_PUSHDATA1 ? 1 : i <= 0xff ? 2 : i <= 0xffff ? 3 : 5;
+    return i < opcodes.OP_PUSHDATA1 ? 1 : i <= 0xff ? 2 : i <= 0xffff ? 3 : 5;
 }
 
 /**
@@ -28,17 +28,17 @@ export function encode(buffer: Buffer, num: number, offset: number): number {
 
         // 8 bit
     } else if (size === 2) {
-        buffer.writeUInt8(OPS.OP_PUSHDATA1, offset);
+        buffer.writeUInt8(opcodes.OP_PUSHDATA1, offset);
         buffer.writeUInt8(num, offset + 1);
 
         // 16 bit
     } else if (size === 3) {
-        buffer.writeUInt8(OPS.OP_PUSHDATA2, offset);
+        buffer.writeUInt8(opcodes.OP_PUSHDATA2, offset);
         buffer.writeUInt16LE(num, offset + 1);
 
         // 32 bit
     } else {
-        buffer.writeUInt8(OPS.OP_PUSHDATA4, offset);
+        buffer.writeUInt8(opcodes.OP_PUSHDATA4, offset);
         buffer.writeUInt32LE(num, offset + 1);
     }
 
@@ -64,18 +64,18 @@ export function decode(
     let size: number;
 
     // ~6 bit
-    if (opcode < OPS.OP_PUSHDATA1) {
+    if (opcode < opcodes.OP_PUSHDATA1) {
         num = opcode;
         size = 1;
 
         // 8 bit
-    } else if (opcode === OPS.OP_PUSHDATA1) {
+    } else if (opcode === opcodes.OP_PUSHDATA1) {
         if (offset + 2 > buffer.length) return null;
         num = buffer.readUInt8(offset + 1);
         size = 2;
 
         // 16 bit
-    } else if (opcode === OPS.OP_PUSHDATA2) {
+    } else if (opcode === opcodes.OP_PUSHDATA2) {
         if (offset + 3 > buffer.length) return null;
         num = buffer.readUInt16LE(offset + 1);
         size = 3;
@@ -83,7 +83,7 @@ export function decode(
         // 32 bit
     } else {
         if (offset + 5 > buffer.length) return null;
-        if (opcode !== OPS.OP_PUSHDATA4) throw new Error('Unexpected opcode');
+        if (opcode !== opcodes.OP_PUSHDATA4) throw new Error('Unexpected opcode');
 
         num = buffer.readUInt32LE(offset + 1);
         size = 5;

package/src/script.ts

@@ -3,7 +3,7 @@
  * @packageDocumentation
  */
 import * as bip66 from './bip66.js';
-import { Opcodes, OPS, REVERSE_OPS } from './ops.js';
+import { Opcodes, opcodes, REVERSE_OPS } from './opcodes.js';
 import { Stack } from './payments/index.js';
 import * as pushdata from './push_data.js';
 import * as scriptNumber from './script_number.js';
@@ -12,15 +12,15 @@ import * as types from './types.js';
 
 const { typeforce } = types;
 
-const OP_INT_BASE = OPS.OP_RESERVED; // OP_1 - 1
-export { OPS };
+const OP_INT_BASE = opcodes.OP_RESERVED; // OP_1 - 1
+export { opcodes };
 
 function isOPInt(value: number): boolean {
     return (
         types.Number(value) &&
-        (value === OPS.OP_0 ||
-            (value >= OPS.OP_1 && value <= OPS.OP_16) ||
-            value === OPS.OP_1NEGATE)
+        (value === opcodes.OP_0 ||
+            (value >= opcodes.OP_1 && value <= opcodes.OP_16) ||
+            value === opcodes.OP_1NEGATE)
     );
 }
 
@@ -37,10 +37,10 @@ export function countNonPushOnlyOPs(value: Stack): number {
 }
 
 function asMinimalOP(buffer: Buffer): number | void {
-    if (buffer.length === 0) return OPS.OP_0;
+    if (buffer.length === 0) return opcodes.OP_0;
     if (buffer.length !== 1) return;
     if (buffer[0] >= 1 && buffer[0] <= 16) return OP_INT_BASE + buffer[0];
-    if (buffer[0] === 0x81) return OPS.OP_1NEGATE;
+    if (buffer[0] === 0x81) return opcodes.OP_1NEGATE;
 }
 
 function chunksIsBuffer(buf: Buffer | Stack): buf is Buffer {
@@ -125,7 +125,7 @@ export function decompile(buffer: Buffer | Array<number | Buffer>): Array<number
         const opcode = buffer[i];
 
         // data chunk
-        if (opcode > OPS.OP_0 && opcode <= OPS.OP_PUSHDATA4) {
+        if (opcode > opcodes.OP_0 && opcode <= opcodes.OP_PUSHDATA4) {
             const d = pushdata.decode(buffer, i);
 
             // did reading a pushDataInt fail?
@@ -196,8 +196,8 @@ export function fromASM(asm: string): Buffer {
     return compile(
         asm.split(' ').map((chunkStr) => {
             // opcode?
-            if (OPS[chunkStr as keyof Opcodes] !== undefined) {
-                return OPS[chunkStr as keyof Opcodes];
+            if (opcodes[chunkStr as keyof Opcodes] !== undefined) {
+                return opcodes[chunkStr as keyof Opcodes];
             }
             typeforce(types.Hex, chunkStr);
 
@@ -219,7 +219,7 @@ export function toStack(chunks: Buffer | Array<number | Buffer>): Buffer[] {
 
     return chunks.map((op) => {
         if (singleChunkIsBuffer(op)) return op;
-        if (op === OPS.OP_0) return Buffer.allocUnsafe(0);
+        if (op === opcodes.OP_0) return Buffer.allocUnsafe(0);
 
         return scriptNumber.encode(op - OP_INT_BASE);
     });

package/src/transaction.ts

@@ -1,7 +1,7 @@
 import { BufferReader, BufferWriter, reverseBuffer, varuint } from './bufferutils.js';
 import * as bcrypto from './crypto.js';
 import * as bscript from './script.js';
-import { OPS as opcodes } from './script.js';
+import { opcodes } from './script.js';
 import * as types from './types.js';
 
 const { typeforce } = types;

package/test/script.spec.ts

@@ -41,7 +41,7 @@ describe('script', () => {
     });
 
     describe('toASM', () => {
-        const OP_RETURN = bscript.OPS.OP_RETURN;
+        const OP_RETURN = bscript.opcodes.OP_RETURN;
         it('encodes empty buffer as OP_0', () => {
             const chunks = [OP_RETURN, Buffer.from([])];
             assert.strictEqual(bscript.toASM(chunks), 'OP_RETURN OP_0');