@btc-vision/transaction 1.0.59 → 1.0.61

package/build/transaction/interfaces/ITransactions.d.ts

@@ -0,0 +1,32 @@
+/// <reference types="node" />
+import { Signer } from 'bitcoinjs-lib';
+import { UTXO } from '../../utxo/interfaces/IUTXO.js';
+import { ECPairInterface } from 'ecpair';
+import { Network } from 'bitcoinjs-lib/src/networks.js';
+export interface ITransactionParameters {
+    readonly from: string;
+    readonly utxos: UTXO[];
+    readonly signer: ECPairInterface;
+    readonly network: Network;
+    readonly feeRate: number;
+    readonly priorityFee: bigint;
+}
+export interface SewgitTransactionParameters extends ITransactionParameters {
+}
+export interface ITransactionDataContractInteraction extends ITransactionParameters {
+    readonly contractSecret: Buffer;
+    readonly calldata: Buffer;
+    readonly customSigner: Signer;
+    readonly pubKeys?: Buffer[];
+    readonly minimumSignatures?: number;
+}
+export interface ITransactionDataContractInteractionWrap extends ITransactionDataContractInteraction {
+    readonly amount: bigint;
+    readonly minimumSignatures: number;
+    readonly pubKeys: Buffer[];
+}
+export interface ITransactionDataContractDeployment extends ITransactionParameters {
+    readonly bytecode: Buffer;
+    readonly salt: Buffer;
+    readonly customSigner: Signer;
+}

package/build/transaction/interfaces/ITransactions.js

@@ -0,0 +1 @@
+export {};

package/build/utxo/IUTXO.js

@@ -0,0 +1 @@
+"use strict";

package/build/utxo/OPNetUtils.d.ts

@@ -0,0 +1,7 @@
+import { FetchUTXOParams, UTXO } from './interfaces/IUTXO.js';
+export declare class UTXOManager {
+    private readonly opnetAPIUrl;
+    private readonly utxoPath;
+    constructor(opnetAPIUrl: string);
+    fetchUTXO(settings: FetchUTXOParams): Promise<UTXO[]>;
+}

package/build/utxo/OPNetUtils.js

@@ -0,0 +1,47 @@
+export class UTXOManager {
+    opnetAPIUrl;
+    utxoPath = 'address/utxos';
+    constructor(opnetAPIUrl) {
+        this.opnetAPIUrl = opnetAPIUrl;
+    }
+    async fetchUTXO(settings) {
+        const params = {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+        };
+        const url = `${this.opnetAPIUrl}/api/v1/${this.utxoPath}?address=${settings.address}`;
+        const resp = await fetch(url, params);
+        if (!resp.ok) {
+            throw new Error(`Failed to fetch UTXO data: ${resp.statusText}`);
+        }
+        const fetchedData = await resp.json();
+        if (fetchedData.length === 0) {
+            throw new Error('No UTXO found');
+        }
+        const meetCriteria = fetchedData.filter((utxo) => {
+            return BigInt(utxo.value) >= settings.minAmount;
+        });
+        if (meetCriteria.length === 0) {
+            throw new Error('No UTXO found (minAmount)');
+        }
+        let finalUTXOs = [];
+        let currentAmount = 0n;
+        const amountRequested = settings.requestedAmount;
+        for (const utxo of meetCriteria) {
+            const utxoValue = BigInt(utxo.value);
+            currentAmount += utxoValue;
+            finalUTXOs.push({
+                transactionId: utxo.transactionId,
+                outputIndex: utxo.outputIndex,
+                value: utxoValue,
+                scriptPubKey: utxo.scriptPubKey,
+            });
+            if (currentAmount + utxoValue > amountRequested) {
+                break;
+            }
+        }
+        return finalUTXOs;
+    }
+}

package/build/utxo/UTXOManager.d.ts

@@ -0,0 +1,7 @@
+import { FetchUTXOParams, UTXO } from './interfaces/IUTXO.js';
+export declare class UTXOManager {
+    private readonly opnetAPIUrl;
+    private readonly utxoPath;
+    constructor(opnetAPIUrl: string);
+    fetchUTXO(settings: FetchUTXOParams): Promise<UTXO[]>;
+}

package/build/utxo/UTXOManager.js

@@ -0,0 +1,47 @@
+export class UTXOManager {
+    opnetAPIUrl;
+    utxoPath = 'address/utxos';
+    constructor(opnetAPIUrl) {
+        this.opnetAPIUrl = opnetAPIUrl;
+    }
+    async fetchUTXO(settings) {
+        const params = {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+        };
+        const url = `${this.opnetAPIUrl}/api/v1/${this.utxoPath}?address=${settings.address}`;
+        const resp = await fetch(url, params);
+        if (!resp.ok) {
+            throw new Error(`Failed to fetch UTXO data: ${resp.statusText}`);
+        }
+        const fetchedData = await resp.json();
+        if (fetchedData.length === 0) {
+            throw new Error('No UTXO found');
+        }
+        const meetCriteria = fetchedData.filter((utxo) => {
+            return BigInt(utxo.value) >= settings.minAmount;
+        });
+        if (meetCriteria.length === 0) {
+            throw new Error('No UTXO found (minAmount)');
+        }
+        let finalUTXOs = [];
+        let currentAmount = 0n;
+        const amountRequested = settings.requestedAmount;
+        for (const utxo of meetCriteria) {
+            const utxoValue = BigInt(utxo.value);
+            currentAmount += utxoValue;
+            finalUTXOs.push({
+                transactionId: utxo.transactionId,
+                outputIndex: utxo.outputIndex,
+                value: utxoValue,
+                scriptPubKey: utxo.scriptPubKey,
+            });
+            if (currentAmount + utxoValue > amountRequested) {
+                break;
+            }
+        }
+        return finalUTXOs;
+    }
+}

package/build/wbtc/BroadcastResponse.js

@@ -0,0 +1 @@
+"use strict";

package/gulpfile.js

@@ -1,152 +1,152 @@
-process.on('uncaughtException', function (err) {
-    console.log('Caught exception: ', err);
-});
-
-import gulp from 'gulp';
-import gulpcache from 'gulp-cached';
-import logger from 'gulp-logger';
-import ts from 'gulp-typescript';
-
-const tsProject = ts.createProject('tsconfig.json');
-const tsProjectCJS = ts.createProject('tsconfig.cjs.json');
-
-function onError(e) {
-    console.log('Errored', e);
-}
-
-async function build() {
-    return new Promise(async (resolve) => {
-        tsProject
-            .src()
-            .pipe(gulpcache())
-            .pipe(
-                logger({
-                    before: 'Starting...',
-                    after: 'Project compiled!',
-                    extname: '.js',
-                    showChange: true,
-                }),
-            )
-            .pipe(tsProject())
-            .on('error', onError)
-            .pipe(gulp.dest('build'))
-            .on('end', async () => {
-                resolve();
-            });
-    });
-}
-
-async function buildCJS() {
-    return new Promise(async (resolve) => {
-        tsProject
-            .src()
-            .pipe(gulpcache())
-            .pipe(
-                logger({
-                    before: 'Starting...',
-                    after: 'Project compiled!',
-                    extname: '.js',
-                    showChange: true,
-                }),
-            )
-            .pipe(tsProjectCJS())
-            .on('error', onError)
-            .pipe(gulp.dest('cjs'))
-            .on('end', async () => {
-                resolve();
-            });
-    });
-}
-
-async function buildProtoYaml() {
-    return new Promise(async (resolve) => {
-        gulp.src('./src/**/*.yaml')
-            .pipe(
-                logger({
-                    before: 'Starting...',
-                    after: 'Compiled yaml.',
-                    extname: '.yaml',
-                    showChange: true,
-                }),
-            )
-            .pipe(gulpcache())
-            .pipe(gulp.dest('./build/'))
-            .on('end', () => {
-                gulp.src('./src/**/*.proto')
-                    .pipe(
-                        logger({
-                            before: 'Starting...',
-                            after: 'Compiled protobuf.',
-                            extname: '.proto',
-                            showChange: true,
-                        }),
-                    )
-                    .pipe(gulp.dest('./build/'))
-                    .on('end', async () => {
-                        gulp.src('./src/config/*.conf')
-                            .pipe(
-                                logger({
-                                    before: 'Starting...',
-                                    after: 'Compiled conf.',
-                                    extname: '.conf',
-                                    showChange: true,
-                                }),
-                            )
-                            .pipe(gulpcache())
-                            .pipe(gulp.dest('./build/config'))
-                            .on('end', async () => {
-                                resolve();
-                            });
-                    });
-            });
-    });
-}
-
-gulp.task('default', async () => {
-    await build().catch((e) => {});
-    await buildProtoYaml();
-
-    return true;
-});
-
-gulp.task('cjs', async () => {
-    await buildCJS().catch((e) => {});
-    await buildProtoYaml();
-
-    return true;
-});
-
-gulp.task('watch', () => {
-    gulp.watch(
-        ['src/**/**/*.ts', 'src/**/*.ts', 'src/**/*.js', 'src/*.ts', 'src/*.js'],
-        async (cb) => {
-            await build().catch((e) => {
-                console.log('Errored 2', e);
-            });
-
-            cb();
-        },
-    );
-
-    gulp.watch(
-        [
-            'src/components/*.yaml',
-            'src/**/*.yaml',
-            'src/src/*.yaml',
-            'src/*.proto',
-            'src/**/**/*.proto',
-            'src/**/*.proto',
-            '*.proto',
-            '*.yaml',
-            '*.conf',
-            'src/config/*.conf',
-        ],
-        async (cb) => {
-            await buildProtoYaml().catch((e) => {
-                console.log('Errored 2', e);
-            });
-
-            cb();
-        },
-    );
-});
+process.on('uncaughtException', function (err) {
+    console.log('Caught exception: ', err);
+});
+
+import gulp from 'gulp';
+import gulpcache from 'gulp-cached';
+import logger from 'gulp-logger';
+import ts from 'gulp-typescript';
+
+const tsProject = ts.createProject('tsconfig.json');
+const tsProjectCJS = ts.createProject('tsconfig.cjs.json');
+
+function onError(e) {
+    console.log('Errored', e);
+}
+
+async function build() {
+    return new Promise(async (resolve) => {
+        tsProject
+            .src()
+            .pipe(gulpcache())
+            .pipe(
+                logger({
+                    before: 'Starting...',
+                    after: 'Project compiled!',
+                    extname: '.js',
+                    showChange: true,
+                }),
+            )
+            .pipe(tsProject())
+            .on('error', onError)
+            .pipe(gulp.dest('build'))
+            .on('end', async () => {
+                resolve();
+            });
+    });
+}
+
+async function buildCJS() {
+    return new Promise(async (resolve) => {
+        tsProject
+            .src()
+            .pipe(gulpcache())
+            .pipe(
+                logger({
+                    before: 'Starting...',
+                    after: 'Project compiled!',
+                    extname: '.js',
+                    showChange: true,
+                }),
+            )
+            .pipe(tsProjectCJS())
+            .on('error', onError)
+            .pipe(gulp.dest('cjs'))
+            .on('end', async () => {
+                resolve();
+            });
+    });
+}
+
+async function buildProtoYaml() {
+    return new Promise(async (resolve) => {
+        gulp.src('./src/**/*.yaml')
+            .pipe(
+                logger({
+                    before: 'Starting...',
+                    after: 'Compiled yaml.',
+                    extname: '.yaml',
+                    showChange: true,
+                }),
+            )
+            .pipe(gulpcache())
+            .pipe(gulp.dest('./build/'))
+            .on('end', () => {
+                gulp.src('./src/**/*.proto')
+                    .pipe(
+                        logger({
+                            before: 'Starting...',
+                            after: 'Compiled protobuf.',
+                            extname: '.proto',
+                            showChange: true,
+                        }),
+                    )
+                    .pipe(gulp.dest('./build/'))
+                    .on('end', async () => {
+                        gulp.src('./src/config/*.conf')
+                            .pipe(
+                                logger({
+                                    before: 'Starting...',
+                                    after: 'Compiled conf.',
+                                    extname: '.conf',
+                                    showChange: true,
+                                }),
+                            )
+                            .pipe(gulpcache())
+                            .pipe(gulp.dest('./build/config'))
+                            .on('end', async () => {
+                                resolve();
+                            });
+                    });
+            });
+    });
+}
+
+gulp.task('default', async () => {
+    await build().catch((e) => {});
+    await buildProtoYaml();
+
+    return true;
+});
+
+gulp.task('cjs', async () => {
+    await buildCJS().catch((e) => {});
+    await buildProtoYaml();
+
+    return true;
+});
+
+gulp.task('watch', () => {
+    gulp.watch(
+        ['src/**/**/*.ts', 'src/**/*.ts', 'src/**/*.js', 'src/*.ts', 'src/*.js'],
+        async (cb) => {
+            await build().catch((e) => {
+                console.log('Errored 2', e);
+            });
+
+            cb();
+        },
+    );
+
+    gulp.watch(
+        [
+            'src/components/*.yaml',
+            'src/**/*.yaml',
+            'src/src/*.yaml',
+            'src/*.proto',
+            'src/**/**/*.proto',
+            'src/**/*.proto',
+            '*.proto',
+            '*.yaml',
+            '*.conf',
+            'src/config/*.conf',
+        ],
+        async (cb) => {
+            await buildProtoYaml().catch((e) => {
+                console.log('Errored 2', e);
+            });
+
+            cb();
+        },
+    );
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "type": "module",
-    "version": "1.0.59",
+    "version": "1.0.61",
     "author": "BlobMaster41",
     "description": "OPNet transaction library allows you to create and sign transactions for the OPNet network.",
     "engines": {

package/src/_version.ts

@@ -1 +1 @@
-export const version = '1.0.59';
+export const version = '1.0.61';

package/src/consensus/Consensus.ts

@@ -1,36 +1,36 @@
-/**
- * @description Target consensus updates.
- *
- * @description For one year, there will be a new consensus update every 3 months.
- * @description After one year, there will be a new consensus update every 6 months.
- * @description After two years, there will be a new consensus update every year.
- */
-
-export enum Consensus {
-    Roswell = 0, // Start of the network.
-    Rachel = 1,
-    Kecksburg = 2,
-    Phoenix = 3,
-    Aurora = 4, // End of first year.
-    Rendlesham = 5,
-    Lazar = 6, // End of second year.
-    ShagHarbor = 7,
-    Exeter = 8,
-    Stephenville = 9,
-    Valensole = 10,
-    Socorro = 11,
-    Pascagoula = 12,
-    Tehran = 13,
-    Westall = 14,
-    Hopkinsville = 15,
-    Belgium = 16,
-    Breeze = 17,
-    Flatwoods = 18,
-    Maury = 20,
-    Varginha = 21,
-    Trindade = 22,
-    Levelland = 23,
-    Wanaque = 24,
-    Coyame = 25,
-    Delphos = 26,
-}
+/**
+ * @description Target consensus updates.
+ *
+ * @description For one year, there will be a new consensus update every 3 months.
+ * @description After one year, there will be a new consensus update every 6 months.
+ * @description After two years, there will be a new consensus update every year.
+ */
+
+export enum Consensus {
+    Roswell = 0, // Start of the network.
+    Rachel = 1,
+    Kecksburg = 2,
+    Phoenix = 3,
+    Aurora = 4, // End of first year.
+    Rendlesham = 5,
+    Lazar = 6, // End of second year.
+    ShagHarbor = 7,
+    Exeter = 8,
+    Stephenville = 9,
+    Valensole = 10,
+    Socorro = 11,
+    Pascagoula = 12,
+    Tehran = 13,
+    Westall = 14,
+    Hopkinsville = 15,
+    Belgium = 16,
+    Breeze = 17,
+    Flatwoods = 18,
+    Maury = 20,
+    Varginha = 21,
+    Trindade = 22,
+    Levelland = 23,
+    Wanaque = 24,
+    Coyame = 25,
+    Delphos = 26,
+}

package/src/consensus/ConsensusConfig.ts

@@ -1,39 +1,39 @@
-import { Consensus } from './Consensus.js';
-import { RoswellConsensus } from './metadata/RoswellConsensus.js';
-
-export interface ConsensusConfig<T extends Consensus> {
-    // The consensus type.
-    readonly CONSENSUS: T;
-
-    // The consensus name.
-    readonly CONSENSUS_NAME: string;
-
-    // The block height at which this consensus was enabled.
-    readonly ENABLED_AT_BLOCK: bigint;
-
-    /** WBTC vaults */
-    // Defines the minimum amount that can be consolidated in a single transaction.
-    readonly VAULT_MINIMUM_AMOUNT: bigint;
-
-    // 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.
-    readonly VAULT_NETWORK_CONSOLIDATION_ACCEPTANCE: bigint;
-
-    // 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.
-    readonly UNWRAP_CONSOLIDATION_PREPAID_FEES: bigint;
-
-    // The maximum fee rate for the consolidation.
-    readonly UNWRAP_CONSOLIDATION_PREPAID_FEES_SAT: bigint;
-}
-
-export const OPNetConsensusConfig: { [key in Consensus]?: ConsensusConfig<key> } = {
-    [Consensus.Roswell]: RoswellConsensus,
-};
-
-export const currentConsensus = Consensus.Roswell;
-export const currentConsensusConfig = OPNetConsensusConfig[
-    currentConsensus
-] as ConsensusConfig<Consensus.Roswell>;
+import { Consensus } from './Consensus.js';
+import { RoswellConsensus } from './metadata/RoswellConsensus.js';
+
+export interface ConsensusConfig<T extends Consensus> {
+    // The consensus type.
+    readonly CONSENSUS: T;
+
+    // The consensus name.
+    readonly CONSENSUS_NAME: string;
+
+    // The block height at which this consensus was enabled.
+    readonly ENABLED_AT_BLOCK: bigint;
+
+    /** WBTC vaults */
+    // Defines the minimum amount that can be consolidated in a single transaction.
+    readonly VAULT_MINIMUM_AMOUNT: bigint;
+
+    // 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.
+    readonly VAULT_NETWORK_CONSOLIDATION_ACCEPTANCE: bigint;
+
+    // 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.
+    readonly UNWRAP_CONSOLIDATION_PREPAID_FEES: bigint;
+
+    // The maximum fee rate for the consolidation.
+    readonly UNWRAP_CONSOLIDATION_PREPAID_FEES_SAT: bigint;
+}
+
+export const OPNetConsensusConfig: { [key in Consensus]?: ConsensusConfig<key> } = {
+    [Consensus.Roswell]: RoswellConsensus,
+};
+
+export const currentConsensus = Consensus.Roswell;
+export const currentConsensusConfig = OPNetConsensusConfig[
+    currentConsensus
+] as ConsensusConfig<Consensus.Roswell>;