@btc-vision/transaction 1.0.97 → 1.0.100

package/package.json

@@ -1,113 +1,112 @@
-{
-    "type": "module",
-    "version": "1.0.97",
-    "author": "BlobMaster41",
-    "description": "OPNet transaction library allows you to create and sign transactions for the OPNet network.",
-    "engines": {
-        "node": ">=16.0.0"
-    },
-    "exports": {
-        "node": {
-            "import": "./build/index.js",
-            "require": "./cjs/index.js",
-            "types": "./build/index.d.ts"
-        },
-        "browser": {
-            "import": "./browser/index.js",
-            "require": "./browser/index.js",
-            "types": "./browser/index.d.ts"
-        }
-    },
-    "browser": {
-        "Buffer": "buffer",
-        "crypto": "./src/crypto/crypto-browser.js",
-        "stream": "stream-browserify",
-        "zlib": "browserify-zlib"
-    },
-    "homepage": "https://opnet.org",
-    "keywords": [
-        "opnet",
-        "bsi",
-        "bsi-binary",
-        "bsi-bitcoin-rpc",
-        "bitcoin transaction",
-        "transaction builder",
-        "transaction signer",
-        "bitcoin",
-        "btc",
-        "bitcoin smart contracts",
-        "smart inscriptions",
-        "ordinals"
-    ],
-    "license": "LICENSE.MD",
-    "main": "build/index.js",
-    "types": "build/index.d.ts",
-    "typings": "build/index.d.ts",
-    "module": "build/index.js",
-    "name": "@btc-vision/transaction",
-    "publishConfig": {
-        "access": "public",
-        "tag": "latest"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git://github.com/btc-vision/transaction.git"
-    },
-    "scripts": {
-        "watch": "gulp watch",
-        "build": "gulp && gulp cjs",
-        "setup": "npm npm i && npm run build",
-        "browserBuild": "webpack --mode production",
-        "cjs": "gulp cjs",
-        "docs": "typedoc --out docs --exclude 'src/tests/*.ts' --tsconfig tsconfig.json --readme README.md --name OPNet --plugin typedoc-material-theme --themeColor '#cb9820' --exclude src/tests/test.ts --exclude src/index.ts src",
-        "postinstall": "gulp && gulp cjs",
-        "build:dev": "gulp cjs && gulp && npm run browserBuild"
-    },
-    "devDependencies": {
-        "@babel/plugin-proposal-class-properties": "^7.18.6",
-        "@babel/plugin-transform-runtime": "^7.24.3",
-        "@babel/preset-env": "^7.24.5",
-        "@babel/preset-flow": "^7.24.1",
-        "@babel/preset-react": "^7.24.1",
-        "@babel/preset-typescript": "^7.24.1",
-        "@types/node": "^20.11.30",
-        "eslint": "^8.57.0",
-        "https-browserify": "^1.0.0",
-        "os-browserify": "^0.3.0",
-        "prettier": "^3.3.1",
-        "stream-browserify": "^3.0.0",
-        "stream-http": "^3.2.0",
-        "typedoc": "^0.25.13",
-        "typedoc-material-theme": "^1.0.2",
-        "typescript": "^5.4.5",
-        "typescript-eslint": "^7.4.0",
-        "webpack": "^5.91.0",
-        "webpack-cli": "^5.1.4"
-    },
-    "dependencies": {
-        "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
-        "@bitcoinerlab/secp256k1": "^1.1.1",
-        "@btc-vision/bsi-binary": "^1.0.38",
-        "@btc-vision/bsi-bitcoin-rpc": "^1.0.25",
-        "@btc-vision/logger": "^1.0.3",
-        "assert": "^2.1.0",
-        "babel-loader": "^9.1.3",
-        "babel-plugin-transform-import-meta": "^2.2.1",
-        "babel-preset-react": "^6.24.1",
-        "babelify": "^10.0.0",
-        "bech32": "^2.0.0",
-        "bignumber.js": "^9.1.2",
-        "bip32": "^4.0.0",
-        "bitcoinjs-lib": "github:btc-vision/bitcoinjs-lib",
-        "browserify-zlib": "^0.2.0",
-        "buffer": "^6.0.3",
-        "ecpair": "^2.1.0",
-        "gulp": "^4.0.2",
-        "gulp-cached": "^1.1.1",
-        "gulp-logger": "^0.0.2",
-        "gulp-typescript": "^6.0.0-alpha.1",
-        "gulplog": "^2.2.0",
-        "ts-loader": "^9.5.1",
-        "ts-node": "^10.9.2"
-    }
-}
+{
+    "name": "@btc-vision/transaction",
+    "type": "module",
+    "version": "1.0.100",
+    "author": "BlobMaster41",
+    "description": "OPNet transaction library allows you to create and sign transactions for the OPNet network.",
+    "engines": {
+        "node": ">=16.0.0"
+    },
+    "exports": {
+        ".": {
+            "import": "./build/index.js",
+            "require": "./build/index.js",
+            "types": "./build/index.d.ts"
+        },
+        "./browser": {
+            "import": "./browser/index.js",
+            "require": "./browser/index.js",
+            "types": "./browser/index.d.ts"
+        }
+    },
+    "browser": {
+        "Buffer": "buffer",
+        "crypto": "./src/crypto/crypto-browser.js",
+        "stream": "stream-browserify",
+        "zlib": "browserify-zlib"
+    },
+    "homepage": "https://opnet.org",
+    "keywords": [
+        "opnet",
+        "bsi",
+        "bsi-binary",
+        "bsi-bitcoin-rpc",
+        "bitcoin transaction",
+        "transaction builder",
+        "transaction signer",
+        "bitcoin",
+        "btc",
+        "bitcoin smart contracts",
+        "smart inscriptions",
+        "ordinals"
+    ],
+    "license": "LICENSE.MD",
+    "main": "build/index.js",
+    "types": "build/index.d.ts",
+    "typings": "build/index.d.ts",
+    "module": "build/index.js",
+    "publishConfig": {
+        "access": "public",
+        "tag": "latest"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/btc-vision/transaction.git"
+    },
+    "scripts": {
+        "watch": "gulp watch",
+        "build": "gulp build",
+        "setup": "npm i && npm run build",
+        "browserBuild": "webpack --mode production",
+        "docs": "typedoc --out docs --exclude 'src/tests/*.ts' --tsconfig tsconfig.json --readme README.md --name OPNet --plugin typedoc-material-theme --themeColor '#cb9820' --exclude src/tests/test.ts --exclude src/index.ts src"
+    },
+    "devDependencies": {
+        "@babel/core": "^7.25.2",
+        "@babel/plugin-proposal-class-properties": "^7.18.6",
+        "@babel/plugin-transform-runtime": "^7.24.3",
+        "@babel/preset-env": "^7.24.4",
+        "@babel/preset-flow": "^7.24.1",
+        "@babel/preset-react": "^7.24.1",
+        "@babel/preset-typescript": "^7.24.1",
+        "@types/node": "^22.5.5",
+        "eslint": "^8.57.0",
+        "gulp": "^5.0.0",
+        "gulp-cached": "^1.1.1",
+        "gulp-logger": "^0.0.2",
+        "gulp-typescript": "^6.0.0-alpha.1",
+        "https-browserify": "^1.0.0",
+        "os-browserify": "^0.3.0",
+        "prettier": "^3.3.1",
+        "stream-browserify": "^3.0.0",
+        "stream-http": "^3.2.0",
+        "typedoc": "^0.25.13",
+        "typedoc-material-theme": "^1.0.2",
+        "typescript-eslint": "^7.4.0",
+        "webpack": "^5.91.0",
+        "webpack-cli": "^5.1.4"
+    },
+    "dependencies": {
+        "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
+        "@bitcoinerlab/secp256k1": "^1.1.1",
+        "@btc-vision/bsi-binary": "^1.0.38",
+        "@btc-vision/bsi-bitcoin-rpc": "^1.0.26",
+        "@btc-vision/logger": "^1.0.4",
+        "assert": "^2.1.0",
+        "babel-loader": "^9.1.3",
+        "babel-plugin-transform-import-meta": "^2.2.1",
+        "babel-preset-react": "^6.24.1",
+        "babelify": "^10.0.0",
+        "bech32": "^2.0.0",
+        "bignumber.js": "^9.1.2",
+        "bip32": "^4.0.0",
+        "bitcoinjs-lib": "github:btc-vision/bitcoinjs-lib",
+        "browserify-zlib": "^0.2.0",
+        "buffer": "^6.0.3",
+        "ecpair": "^2.1.0",
+        "gulplog": "^2.2.0",
+        "process": "^0.11.10",
+        "ts-loader": "^9.5.1",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.6.2"
+    }
+}

package/src/_version.ts

@@ -1 +1 @@
-export const version = '1.0.96';
+export const version = '1.0.100';

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/CalldataGenerator.ts

@@ -69,6 +69,8 @@ export class CalldataGenerator extends Generator {
         vaultPublicKeys: Buffer[] = [],
         minimumSignatures: number = 0,
     ): Buffer {
+        if (!this.contractSaltPubKey) throw new Error('Contract salt public key not set');
+
         const dataChunks: Buffer[][] = this.splitBufferIntoChunks(calldata);
         if (!dataChunks.length) throw new Error('No data chunks found');
 

package/src/generators/builders/CustomGenerator.ts

@@ -0,0 +1,30 @@
+import { Network, networks, script, Stack } from 'bitcoinjs-lib';
+import { Generator } from '../Generator.js';
+
+/**
+ * Class to generate bitcoin script for interaction transactions
+ */
+export class CustomGenerator extends Generator {
+    constructor(senderPubKey: Buffer, network: Network = networks.bitcoin) {
+        super(senderPubKey, undefined, network);
+    }
+
+    /**
+     * Compile an interaction bitcoin script
+     * @param compiledData - The compiled data
+     * @returns {Buffer} - The compiled script
+     * @throws {Error} - If something goes wrong
+     */
+    public compile(compiledData: (Buffer | Stack)[]): Buffer {
+        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/generators/builders/DeploymentGenerator.ts

@@ -32,6 +32,8 @@ export class DeploymentGenerator extends Generator {
     }
 
     private getAsm(contractBytecode: Buffer, contractSalt: Buffer): (number | Buffer)[] {
+        if (!this.contractSaltPubKey) throw new Error('Contract salt public key not set');
+
         const dataChunks = this.splitBufferIntoChunks(contractBytecode);
 
         return [