@btc-vision/transaction 1.0.97 → 1.0.99

package/src/bytecode/Compressor.ts

@@ -1,27 +1,27 @@
-import zlib, { ZlibOptions } from 'zlib';
-
-/** Compressor class for compressing and decompressing data. */
-export class Compressor {
-    private static readonly zlibOptions: ZlibOptions = {
-        level: 9,
-        maxOutputLength: 1024 * 1024 * 16, // 16mb, limit it to 16mb.
-    };
-
-    /**
-     * Compresses the data using gzip.
-     * @param {Uint8Array | Buffer} data The data to compress.
-     * @returns {Buffer} The compressed data.
-     */
-    public static compress(data: Uint8Array | Buffer): Buffer {
-        return zlib.gzipSync(data, Compressor.zlibOptions);
-    }
-
-    /**
-     * Decompresses the data using gunzip.
-     * @param {Uint8Array | Buffer} data The data to decompress.
-     * @returns {Buffer} The decompressed data.
-     */
-    public static decompress(data: Uint8Array | Buffer): Buffer {
-        return zlib.gunzipSync(data, Compressor.zlibOptions);
-    }
-}
+import zlib, { ZlibOptions } from 'zlib';
+
+/** Compressor class for compressing and decompressing data. */
+export class Compressor {
+    private static readonly zlibOptions: ZlibOptions = {
+        level: 9,
+        maxOutputLength: 1024 * 1024 * 16, // 16mb, limit it to 16mb.
+    };
+
+    /**
+     * Compresses the data using gzip.
+     * @param {Uint8Array | Buffer} data The data to compress.
+     * @returns {Buffer} The compressed data.
+     */
+    public static compress(data: Uint8Array | Buffer): Buffer {
+        return zlib.gzipSync(data, Compressor.zlibOptions);
+    }
+
+    /**
+     * Decompresses the data using gunzip.
+     * @param {Uint8Array | Buffer} data The data to decompress.
+     * @returns {Buffer} The decompressed data.
+     */
+    public static decompress(data: Uint8Array | Buffer): Buffer {
+        return zlib.gunzipSync(data, Compressor.zlibOptions);
+    }
+}

package/src/consensus/metadata/RoswellConsensus.ts

@@ -1,26 +1,26 @@
-import { ConsensusConfig } from '../ConsensusConfig.js';
-import { Consensus } from '../Consensus.js';
-
-export const RoswellConsensus: ConsensusConfig<Consensus.Roswell> = {
-    CONSENSUS: Consensus.Roswell,
-    CONSENSUS_NAME: 'Roswell',
-
-    // The block height at which this consensus was enabled.
-    ENABLED_AT_BLOCK: 0n,
-
-    // Defines the minimum amount that can be consolidated in a single transaction.
-    VAULT_MINIMUM_AMOUNT: 200000n,
-
-    // Defines the requested minimum acceptance for joining UTXOs when an unwrap is being done.
-    // If the consolidate output going back to the vault is lower than this amount, the transaction will be rejected.
-    // User must pay for the consolidation, this help the network by having fewer UTXOs.
-    VAULT_NETWORK_CONSOLIDATION_ACCEPTANCE: 200000n * 2n,
-
-    // Everytime an user wrap bitcoin, he prepays the fees for the consolidation at a maximum fee rate of the following determined value.
-    // If the fees are lower, the user will be refunded the difference.
-    // If the fees are higher, the user must pay the difference.
-    UNWRAP_CONSOLIDATION_PREPAID_FEES: 250n,
-
-    // Equivalent to 56500 satoshis, calculated from UNWRAP_CONSOLIDATION_PREPAID_FEES.
-    UNWRAP_CONSOLIDATION_PREPAID_FEES_SAT: 56500n,
-};
+import { ConsensusConfig } from '../ConsensusConfig.js';
+import { Consensus } from '../Consensus.js';
+
+export const RoswellConsensus: ConsensusConfig<Consensus.Roswell> = {
+    CONSENSUS: Consensus.Roswell,
+    CONSENSUS_NAME: 'Roswell',
+
+    // The block height at which this consensus was enabled.
+    ENABLED_AT_BLOCK: 0n,
+
+    // Defines the minimum amount that can be consolidated in a single transaction.
+    VAULT_MINIMUM_AMOUNT: 200000n,
+
+    // Defines the requested minimum acceptance for joining UTXOs when an unwrap is being done.
+    // If the consolidate output going back to the vault is lower than this amount, the transaction will be rejected.
+    // User must pay for the consolidation, this help the network by having fewer UTXOs.
+    VAULT_NETWORK_CONSOLIDATION_ACCEPTANCE: 200000n * 2n,
+
+    // Everytime an user wrap bitcoin, he prepays the fees for the consolidation at a maximum fee rate of the following determined value.
+    // If the fees are lower, the user will be refunded the difference.
+    // If the fees are higher, the user must pay the difference.
+    UNWRAP_CONSOLIDATION_PREPAID_FEES: 250n,
+
+    // Equivalent to 56500 satoshis, calculated from UNWRAP_CONSOLIDATION_PREPAID_FEES.
+    UNWRAP_CONSOLIDATION_PREPAID_FEES_SAT: 56500n,
+};

package/src/crypto/crypto.ts

@@ -1 +1 @@
-export { createHash, createHmac, pbkdf2Sync, randomBytes } from 'crypto';
+export { createHash, createHmac, pbkdf2Sync, randomBytes } from 'crypto';

package/src/generators/Generator.ts

@@ -1,75 +1,75 @@
-import { Network, networks } from 'bitcoinjs-lib';
-
-/** Bitcoin Script Generator */
-export abstract class Generator {
-    /**
-     * The maximum size of a data chunk
-     */
-    public static readonly DATA_CHUNK_SIZE: number = 512;
-
-    /**
-     * The magic number of OPNet
-     */
-    public static readonly MAGIC: Buffer = Buffer.from('bsi', 'utf-8');
-
-    /**
-     * The public key of the sender
-     * @protected
-     */
-    protected readonly senderPubKey: Buffer;
-
-    /**
-     * The public key of the contract salt
-     * @protected
-     */
-    protected readonly contractSaltPubKey: Buffer;
-
-    /**
-     * The network to use
-     * @protected
-     */
-    protected readonly network: Network = networks.bitcoin;
-
-    protected constructor(
-        senderPubKey: Buffer,
-        contractSaltPubKey: Buffer,
-        network: Network = networks.bitcoin,
-    ) {
-        this.senderPubKey = senderPubKey;
-        this.contractSaltPubKey = contractSaltPubKey;
-        this.network = network;
-    }
-
-    /**
-     * Compile the script
-     * @param args - The arguments to use when compiling the script
-     * @returns {Buffer} - The compiled script
-     */
-    public abstract compile(...args: unknown[]): Buffer;
-
-    /**
-     * Split a buffer into chunks
-     * @param {Buffer} buffer - The buffer to split
-     * @param {number} chunkSize - The size of each chunk
-     * @protected
-     * @returns {Array<Buffer[]>} - The chunks
-     */
-    protected splitBufferIntoChunks(
-        buffer: Buffer,
-        chunkSize: number = Generator.DATA_CHUNK_SIZE,
-    ): Array<Buffer[]> {
-        const chunks: Array<Buffer[]> = [];
-        for (let i = 0; i < buffer.length; i += chunkSize) {
-            const dataLength = Math.min(chunkSize, buffer.length - i);
-
-            const buf2 = Buffer.alloc(dataLength);
-            for (let j = 0; j < dataLength; j++) {
-                buf2.writeUInt8(buffer[i + j], j);
-            }
-
-            chunks.push([buf2]);
-        }
-
-        return chunks;
-    }
-}
+import { Network, networks } from 'bitcoinjs-lib';
+
+/** Bitcoin Script Generator */
+export abstract class Generator {
+    /**
+     * The maximum size of a data chunk
+     */
+    public static readonly DATA_CHUNK_SIZE: number = 512;
+
+    /**
+     * The magic number of OPNet
+     */
+    public static readonly MAGIC: Buffer = Buffer.from('bsi', 'utf-8');
+
+    /**
+     * The public key of the sender
+     * @protected
+     */
+    protected readonly senderPubKey: Buffer;
+
+    /**
+     * The public key of the contract salt
+     * @protected
+     */
+    protected readonly contractSaltPubKey: Buffer;
+
+    /**
+     * The network to use
+     * @protected
+     */
+    protected readonly network: Network = networks.bitcoin;
+
+    protected constructor(
+        senderPubKey: Buffer,
+        contractSaltPubKey: Buffer,
+        network: Network = networks.bitcoin,
+    ) {
+        this.senderPubKey = senderPubKey;
+        this.contractSaltPubKey = contractSaltPubKey;
+        this.network = network;
+    }
+
+    /**
+     * Compile the script
+     * @param args - The arguments to use when compiling the script
+     * @returns {Buffer} - The compiled script
+     */
+    public abstract compile(...args: unknown[]): Buffer;
+
+    /**
+     * Split a buffer into chunks
+     * @param {Buffer} buffer - The buffer to split
+     * @param {number} chunkSize - The size of each chunk
+     * @protected
+     * @returns {Array<Buffer[]>} - The chunks
+     */
+    protected splitBufferIntoChunks(
+        buffer: Buffer,
+        chunkSize: number = Generator.DATA_CHUNK_SIZE,
+    ): Array<Buffer[]> {
+        const chunks: Array<Buffer[]> = [];
+        for (let i = 0; i < buffer.length; i += chunkSize) {
+            const dataLength = Math.min(chunkSize, buffer.length - i);
+
+            const buf2 = Buffer.alloc(dataLength);
+            for (let j = 0; j < dataLength; j++) {
+                buf2.writeUInt8(buffer[i + j], j);
+            }
+
+            chunks.push([buf2]);
+        }
+
+        return chunks;
+    }
+}

package/src/generators/builders/MultiSignGenerator.ts

@@ -1,73 +1,73 @@
-import { opcodes, script } from 'bitcoinjs-lib';
-import { toXOnly } from 'bitcoinjs-lib/src/psbt/bip371.js';
-
-/**
- * Generate a bitcoin script for a multisign interaction
- */
-export class MultiSignGenerator {
-    public static readonly MAXIMUM_SUPPORTED_SIGNATURE = 255;
-
-    public static compile(
-        vaultPublicKeys: Buffer[],
-        minimumSignatures: number = 0,
-        internal?: Buffer,
-    ): Buffer {
-        if (minimumSignatures < 2) {
-            throw new Error('Minimum signatures must be greater than 1');
-        }
-
-        if (vaultPublicKeys.length < minimumSignatures) {
-            throw new Error('The amount of public keys is lower than the minimum required');
-        }
-
-        if (minimumSignatures > MultiSignGenerator.MAXIMUM_SUPPORTED_SIGNATURE) {
-            throw new Error(`The maximum amount of signatures is ${MultiSignGenerator.MAXIMUM_SUPPORTED_SIGNATURE}`);
-        }
-
-        const minimumRequired = Buffer.alloc(1);
-        minimumRequired.writeUInt8(minimumSignatures);
-
-        /** Remove duplicates **/
-        vaultPublicKeys = vaultPublicKeys.filter((buf, index, self) =>
-            index === self.findIndex(otherBuf => buf.equals(otherBuf))
-        );
-
-        /** We must order the pub keys. */
-        vaultPublicKeys = vaultPublicKeys.sort((a, b) => a.compare(b));
-
-        let included = false;
-        const data = vaultPublicKeys.map((key) => {
-            let newKey = toXOnly(key);
-            if (internal && !included) included = internal.equals(newKey);
-
-            return newKey;
-        });
-
-        if (internal && !included) data.push(internal);
-        const compiledData: (number | Buffer)[] = [
-            // Push the initial 0 (for OP_CHECKSIGADD)
-            opcodes.OP_0,
-
-            // For each public key, add CHECKSIGADD operation
-            ...data.flatMap((key) => [
-                key, // Push the public key
-                opcodes.OP_CHECKSIGADD, // Add the public key to the signature set
-            ]),
-
-            // Finally, compare the sum with the minimum required signatures
-            minimumRequired,
-            opcodes.OP_NUMEQUAL, // Use NUMEQUALVERIFY to ensure the correct number of signatures
-        ];
-
-        const asm = compiledData.flat();
-        const compiled = script.compile(asm);
-
-        /** Verify the validity of the script */
-        const decompiled = script.decompile(compiled);
-        if (!decompiled) {
-            throw new Error('Failed to decompile script.');
-        }
-
-        return compiled;
-    }
-}
+import { opcodes, script } from 'bitcoinjs-lib';
+import { toXOnly } from 'bitcoinjs-lib/src/psbt/bip371.js';
+
+/**
+ * Generate a bitcoin script for a multisign interaction
+ */
+export class MultiSignGenerator {
+    public static readonly MAXIMUM_SUPPORTED_SIGNATURE = 255;
+
+    public static compile(
+        vaultPublicKeys: Buffer[],
+        minimumSignatures: number = 0,
+        internal?: Buffer,
+    ): Buffer {
+        if (minimumSignatures < 2) {
+            throw new Error('Minimum signatures must be greater than 1');
+        }
+
+        if (vaultPublicKeys.length < minimumSignatures) {
+            throw new Error('The amount of public keys is lower than the minimum required');
+        }
+
+        if (minimumSignatures > MultiSignGenerator.MAXIMUM_SUPPORTED_SIGNATURE) {
+            throw new Error(`The maximum amount of signatures is ${MultiSignGenerator.MAXIMUM_SUPPORTED_SIGNATURE}`);
+        }
+
+        const minimumRequired = Buffer.alloc(1);
+        minimumRequired.writeUInt8(minimumSignatures);
+
+        /** Remove duplicates **/
+        vaultPublicKeys = vaultPublicKeys.filter((buf, index, self) =>
+            index === self.findIndex(otherBuf => buf.equals(otherBuf))
+        );
+
+        /** We must order the pub keys. */
+        vaultPublicKeys = vaultPublicKeys.sort((a, b) => a.compare(b));
+
+        let included = false;
+        const data = vaultPublicKeys.map((key) => {
+            let newKey = toXOnly(key);
+            if (internal && !included) included = internal.equals(newKey);
+
+            return newKey;
+        });
+
+        if (internal && !included) data.push(internal);
+        const compiledData: (number | Buffer)[] = [
+            // Push the initial 0 (for OP_CHECKSIGADD)
+            opcodes.OP_0,
+
+            // For each public key, add CHECKSIGADD operation
+            ...data.flatMap((key) => [
+                key, // Push the public key
+                opcodes.OP_CHECKSIGADD, // Add the public key to the signature set
+            ]),
+
+            // Finally, compare the sum with the minimum required signatures
+            minimumRequired,
+            opcodes.OP_NUMEQUAL, // Use NUMEQUALVERIFY to ensure the correct number of signatures
+        ];
+
+        const asm = compiledData.flat();
+        const compiled = script.compile(asm);
+
+        /** Verify the validity of the script */
+        const decompiled = script.decompile(compiled);
+        if (!decompiled) {
+            throw new Error('Failed to decompile script.');
+        }
+
+        return compiled;
+    }
+}

package/src/metadata/contracts/wBTC.ts

@@ -1,60 +1,60 @@
-import { Network, networks } from 'bitcoinjs-lib';
-import { ContractBaseMetadata } from '../ContractBaseMetadata.js';
-import { Address } from '@btc-vision/bsi-binary';
-import { WBTC_ADDRESS_FRACTAL, WBTC_ADDRESS_REGTEST, WBTC_ADDRESS_TESTNET } from '../tokens.js';
-import { ChainId } from '../../network/ChainId.js';
-
-/**
- * @description Wrapped Bitcoin (wBTC) contract metadata.
- * */
-export class wBTC extends ContractBaseMetadata {
-    /**
-     * @description Token Name
-     */
-    public readonly tokenName: string = 'Wrapped Bitcoin';
-
-    /**
-     * @description Token Symbol
-     */
-    public readonly tokenSymbol: string = 'wBTC';
-
-    /**
-     * @description Token Decimals, same as Bitcoin
-     */
-    public readonly decimals: number = 8;
-
-    protected readonly address: Address;
-
-    constructor(
-        protected network: Network = networks.bitcoin,
-        chainId: ChainId = ChainId.Bitcoin,
-    ) {
-        super(network);
-
-        this.address = wBTC.getAddress(network, chainId);
-    }
-
-    public static getAddress(network: Network = networks.bitcoin, chainId?: ChainId): Address {
-        switch (network.bech32) {
-            case networks.bitcoin.bech32:
-                return this.getWBTCAddressForChain(chainId ?? ChainId.Bitcoin);
-            case networks.regtest.bech32:
-                return WBTC_ADDRESS_REGTEST;
-            case networks.testnet.bech32:
-                return WBTC_ADDRESS_TESTNET;
-            default:
-                throw new Error(`Invalid network: ${network}`);
-        }
-    }
-
-    private static getWBTCAddressForChain(chainId: ChainId): Address {
-        switch (chainId) {
-            case ChainId.Bitcoin:
-                return 'unknown';
-            case ChainId.Fractal:
-                return WBTC_ADDRESS_FRACTAL;
-            default:
-                throw new Error(`Invalid chainId: ${chainId}`);
-        }
-    }
-}
+import { Network, networks } from 'bitcoinjs-lib';
+import { ContractBaseMetadata } from '../ContractBaseMetadata.js';
+import { Address } from '@btc-vision/bsi-binary';
+import { WBTC_ADDRESS_FRACTAL, WBTC_ADDRESS_REGTEST, WBTC_ADDRESS_TESTNET } from '../tokens.js';
+import { ChainId } from '../../network/ChainId.js';
+
+/**
+ * @description Wrapped Bitcoin (wBTC) contract metadata.
+ * */
+export class wBTC extends ContractBaseMetadata {
+    /**
+     * @description Token Name
+     */
+    public readonly tokenName: string = 'Wrapped Bitcoin';
+
+    /**
+     * @description Token Symbol
+     */
+    public readonly tokenSymbol: string = 'wBTC';
+
+    /**
+     * @description Token Decimals, same as Bitcoin
+     */
+    public readonly decimals: number = 8;
+
+    protected readonly address: Address;
+
+    constructor(
+        protected network: Network = networks.bitcoin,
+        chainId: ChainId = ChainId.Bitcoin,
+    ) {
+        super(network);
+
+        this.address = wBTC.getAddress(network, chainId);
+    }
+
+    public static getAddress(network: Network = networks.bitcoin, chainId?: ChainId): Address {
+        switch (network.bech32) {
+            case networks.bitcoin.bech32:
+                return this.getWBTCAddressForChain(chainId ?? ChainId.Bitcoin);
+            case networks.regtest.bech32:
+                return WBTC_ADDRESS_REGTEST;
+            case networks.testnet.bech32:
+                return WBTC_ADDRESS_TESTNET;
+            default:
+                throw new Error(`Invalid network: ${network}`);
+        }
+    }
+
+    private static getWBTCAddressForChain(chainId: ChainId): Address {
+        switch (chainId) {
+            case ChainId.Bitcoin:
+                return 'unknown';
+            case ChainId.Fractal:
+                return WBTC_ADDRESS_FRACTAL;
+            default:
+                throw new Error(`Invalid chainId: ${chainId}`);
+        }
+    }
+}