@btc-vision/transaction 1.2.12 → 1.2.14

package/browser/transaction/TransactionFactory.d.ts

@@ -15,13 +15,6 @@ export interface DeploymentResult {
     readonly preimage: string;
     readonly utxos: UTXO[];
 }
-export interface WrapResult {
-    readonly transaction: [string, string];
-    readonly vaultAddress: string;
-    readonly amount: bigint;
-    readonly receiverAddress: string;
-    readonly utxos: UTXO[];
-}
 export interface FundingTransactionResponse {
     readonly tx: Transaction;
     readonly original: FundingTransaction;

package/browser/transaction/interfaces/ITransactionParameters.d.ts

@@ -25,7 +25,7 @@ export interface IChallengeSolutionTransactionParameters extends ITransactionPar
 export interface SharedInteractionParameters extends ITransactionParameters {
     calldata?: Buffer;
     disableAutoRefund?: boolean;
-    readonly preimage?: Buffer;
+    readonly preimage: Buffer;
     readonly randomBytes?: Buffer;
 }
 export interface IInteractionParameters extends SharedInteractionParameters {
@@ -36,5 +36,5 @@ export interface IDeploymentParameters extends Omit<ITransactionParameters, 'to'
     readonly bytecode: Buffer;
     readonly calldata?: Buffer;
     readonly randomBytes?: Buffer;
-    readonly preimage?: Buffer;
+    readonly preimage: Buffer;
 }

package/browser/utxo/OPNetLimitedProvider.d.ts

@@ -7,6 +7,9 @@ export interface WalletUTXOs {
     readonly pending: RawUTXOResponse[];
     readonly spentTransactions: RawUTXOResponse[];
 }
+export interface PreimageData {
+    readonly preimage: Buffer;
+}
 export declare class OPNetLimitedProvider {
     private readonly opnetAPIUrl;
     private readonly utxoPath;
@@ -15,6 +18,7 @@ export declare class OPNetLimitedProvider {
     fetchUTXO(settings: FetchUTXOParams): Promise<UTXO[]>;
     fetchUTXOMultiAddr(settings: FetchUTXOParamsMultiAddress): Promise<UTXO[]>;
     broadcastTransaction(transaction: string, psbt: boolean): Promise<BroadcastResponse | undefined>;
+    getPreimage(): Promise<PreimageData | undefined>;
     splitUTXOs(wallet: Wallet, network: Network, splitInputsInto: number, amountPerUTXO: bigint): Promise<BroadcastResponse | {
         error: string;
     }>;

package/build/_version.d.ts

@@ -1 +1 @@
-export declare const version = "1.2.12";
+export declare const version = "1.2.14";

package/build/_version.js

@@ -1 +1 @@
-export const version = '1.2.12';
+export const version = '1.2.14';

package/build/buffer/BinaryWriter.d.ts

@@ -12,6 +12,7 @@ export declare class BinaryWriter {
     writeU64(value: u64): void;
     writeSelector(value: Selector): void;
     writeBoolean(value: boolean): void;
+    writeI128(bigIntValue: bigint): void;
     writeU256(bigIntValue: bigint): void;
     writeU128(bigIntValue: bigint): void;
     writeBytes(value: Uint8Array | Buffer): void;

package/build/buffer/BinaryWriter.js

@@ -1,5 +1,5 @@
 import { BufferHelper } from '../utils/BufferHelper.js';
-import { ADDRESS_BYTE_LENGTH, U128_BYTE_LENGTH, U16_BYTE_LENGTH, U256_BYTE_LENGTH, U32_BYTE_LENGTH, U64_BYTE_LENGTH, U8_BYTE_LENGTH, } from '../utils/lengths.js';
+import { ADDRESS_BYTE_LENGTH, I128_BYTE_LENGTH, U128_BYTE_LENGTH, U16_BYTE_LENGTH, U256_BYTE_LENGTH, U32_BYTE_LENGTH, U64_BYTE_LENGTH, U8_BYTE_LENGTH, } from '../utils/lengths.js';
 import { BinaryReader } from './BinaryReader.js';
 export class BinaryWriter {
     constructor(length = 0) {
@@ -39,6 +39,20 @@ export class BinaryWriter {
     writeBoolean(value) {
         this.writeU8(value ? 1 : 0);
     }
+    writeI128(bigIntValue) {
+        if (bigIntValue > 170141183460469231731687303715884105727n ||
+            bigIntValue < -170141183460469231731687303715884105728n) {
+            throw new Error('i128 value is too large.');
+        }
+        this.allocSafe(I128_BYTE_LENGTH);
+        const bytesToHex = BufferHelper.valueToUint8Array(bigIntValue, I128_BYTE_LENGTH);
+        if (bytesToHex.byteLength !== I128_BYTE_LENGTH) {
+            throw new Error(`Invalid i128 value: ${bigIntValue}`);
+        }
+        for (let i = 0; i < bytesToHex.byteLength; i++) {
+            this.writeU8(bytesToHex[i]);
+        }
+    }
     writeU256(bigIntValue) {
         if (bigIntValue >
             115792089237316195423570985008687907853269984665640564039457584007913129639935n) {

package/build/transaction/TransactionFactory.d.ts

@@ -15,13 +15,6 @@ export interface DeploymentResult {
     readonly preimage: string;
     readonly utxos: UTXO[];
 }
-export interface WrapResult {
-    readonly transaction: [string, string];
-    readonly vaultAddress: string;
-    readonly amount: bigint;
-    readonly receiverAddress: string;
-    readonly utxos: UTXO[];
-}
 export interface FundingTransactionResponse {
     readonly tx: Transaction;
     readonly original: FundingTransaction;

package/build/transaction/builders/DeploymentTransaction.js

@@ -41,8 +41,10 @@ export class DeploymentTransaction extends TransactionBuilder {
             this.calldata = parameters.calldata;
             this.verifyCalldata();
         }
+        if (!parameters.preimage)
+            throw new Error('Preimage is required');
         this.randomBytes = parameters.randomBytes || BitcoinUtils.rndBytes();
-        this.preimage = parameters.preimage || BitcoinUtils.getSafeRandomValues(128);
+        this.preimage = parameters.preimage;
         this.rewardChallenge = ChallengeGenerator.generateMineableReward(this.preimage, this.network);
         this.contractSeed = this.getContractSeed();
         this.contractSigner = EcKeyPair.fromSeedKeyPair(this.contractSeed, this.network);

package/build/transaction/builders/SharedInteractionTransaction.js

@@ -28,7 +28,10 @@ export class SharedInteractionTransaction extends TransactionBuilder {
         if (!parameters.calldata) {
             throw new Error('Calldata is required');
         }
-        this.preimage = parameters.preimage || BitcoinUtils.getSafeRandomValues(128);
+        if (!parameters.preimage) {
+            throw new Error('Preimage is required');
+        }
+        this.preimage = parameters.preimage;
         this.disableAutoRefund = parameters.disableAutoRefund || false;
         this.rewardChallenge = ChallengeGenerator.generateMineableReward(this.preimage, this.network);
         this.calldata = Compressor.compress(parameters.calldata);

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

@@ -25,7 +25,7 @@ export interface IChallengeSolutionTransactionParameters extends ITransactionPar
 export interface SharedInteractionParameters extends ITransactionParameters {
     calldata?: Buffer;
     disableAutoRefund?: boolean;
-    readonly preimage?: Buffer;
+    readonly preimage: Buffer;
     readonly randomBytes?: Buffer;
 }
 export interface IInteractionParameters extends SharedInteractionParameters {
@@ -36,5 +36,5 @@ export interface IDeploymentParameters extends Omit<ITransactionParameters, 'to'
     readonly bytecode: Buffer;
     readonly calldata?: Buffer;
     readonly randomBytes?: Buffer;
-    readonly preimage?: Buffer;
+    readonly preimage: Buffer;
 }

package/build/utxo/OPNetLimitedProvider.d.ts

@@ -7,6 +7,9 @@ export interface WalletUTXOs {
     readonly pending: RawUTXOResponse[];
     readonly spentTransactions: RawUTXOResponse[];
 }
+export interface PreimageData {
+    readonly preimage: Buffer;
+}
 export declare class OPNetLimitedProvider {
     private readonly opnetAPIUrl;
     private readonly utxoPath;
@@ -15,6 +18,7 @@ export declare class OPNetLimitedProvider {
     fetchUTXO(settings: FetchUTXOParams): Promise<UTXO[]>;
     fetchUTXOMultiAddr(settings: FetchUTXOParamsMultiAddress): Promise<UTXO[]>;
     broadcastTransaction(transaction: string, psbt: boolean): Promise<BroadcastResponse | undefined>;
+    getPreimage(): Promise<PreimageData | undefined>;
     splitUTXOs(wallet: Wallet, network: Network, splitInputsInto: number, amountPerUTXO: bigint): Promise<BroadcastResponse | {
         error: string;
     }>;

package/build/utxo/OPNetLimitedProvider.js

@@ -103,6 +103,13 @@ export class OPNetLimitedProvider {
         }
         return result;
     }
+    async getPreimage() {
+        const result = await this.rpcMethod('btc_preimage', []);
+        if (!result) {
+            return;
+        }
+        return result;
+    }
     async splitUTXOs(wallet, network, splitInputsInto, amountPerUTXO) {
         const utxoSetting = {
             addresses: [wallet.p2wpkh, wallet.p2tr],

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@btc-vision/transaction",
     "type": "module",
-    "version": "1.2.12",
+    "version": "1.2.14",
     "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.2.12';
+export const version = '1.2.14';

package/src/buffer/BinaryWriter.ts

@@ -3,6 +3,7 @@ import { Address } from '../keypair/Address.js';
 import { BufferHelper } from '../utils/BufferHelper.js';
 import {
     ADDRESS_BYTE_LENGTH,
+    I128_BYTE_LENGTH,
     U128_BYTE_LENGTH,
     U16_BYTE_LENGTH,
     U256_BYTE_LENGTH,
@@ -60,6 +61,26 @@ export class BinaryWriter {
         this.writeU8(value ? 1 : 0);
     }
 
+    public writeI128(bigIntValue: bigint): void {
+        if (
+            bigIntValue > 170141183460469231731687303715884105727n ||
+            bigIntValue < -170141183460469231731687303715884105728n
+        ) {
+            throw new Error('i128 value is too large.');
+        }
+
+        this.allocSafe(I128_BYTE_LENGTH);
+
+        const bytesToHex = BufferHelper.valueToUint8Array(bigIntValue, I128_BYTE_LENGTH);
+        if (bytesToHex.byteLength !== I128_BYTE_LENGTH) {
+            throw new Error(`Invalid i128 value: ${bigIntValue}`);
+        }
+
+        for (let i = 0; i < bytesToHex.byteLength; i++) {
+            this.writeU8(bytesToHex[i]);
+        }
+    }
+
     public writeU256(bigIntValue: bigint): void {
         if (
             bigIntValue >

package/src/transaction/TransactionFactory.ts

@@ -33,14 +33,6 @@ export interface DeploymentResult {
     readonly utxos: UTXO[];
 }
 
-export interface WrapResult {
-    readonly transaction: [string, string];
-    readonly vaultAddress: string;
-    readonly amount: bigint;
-    readonly receiverAddress: string;
-    readonly utxos: UTXO[];
-}
-
 export interface FundingTransactionResponse {
     readonly tx: Transaction;
     readonly original: FundingTransaction;

package/src/transaction/builders/DeploymentTransaction.ts

@@ -118,8 +118,10 @@ export class DeploymentTransaction extends TransactionBuilder<TransactionType.DE
             this.verifyCalldata();
         }
 
+        if(!parameters.preimage) throw new Error('Preimage is required');
+
         this.randomBytes = parameters.randomBytes || BitcoinUtils.rndBytes();
-        this.preimage = parameters.preimage || BitcoinUtils.getSafeRandomValues(128);
+        this.preimage = parameters.preimage;
 
         this.rewardChallenge = ChallengeGenerator.generateMineableReward(
             this.preimage,

package/src/transaction/builders/SharedInteractionTransaction.ts

@@ -67,7 +67,11 @@ export abstract class SharedInteractionTransaction<
             throw new Error('Calldata is required');
         }
 
-        this.preimage = parameters.preimage || BitcoinUtils.getSafeRandomValues(128);
+        if(!parameters.preimage) {
+            throw new Error('Preimage is required');
+        }
+
+        this.preimage = parameters.preimage;
 
         this.disableAutoRefund = parameters.disableAutoRefund || false;
         this.rewardChallenge = ChallengeGenerator.generateMineableReward(

package/src/transaction/interfaces/ITransactionParameters.ts

@@ -37,7 +37,7 @@ export interface SharedInteractionParameters extends ITransactionParameters {
     calldata?: Buffer;
     disableAutoRefund?: boolean;
 
-    readonly preimage?: Buffer;
+    readonly preimage: Buffer;
     readonly randomBytes?: Buffer;
 }
 
@@ -52,5 +52,5 @@ export interface IDeploymentParameters extends Omit<ITransactionParameters, 'to'
     readonly calldata?: Buffer;
 
     readonly randomBytes?: Buffer;
-    readonly preimage?: Buffer;
+    readonly preimage: Buffer;
 }

package/src/utxo/OPNetLimitedProvider.ts

@@ -14,6 +14,10 @@ export interface WalletUTXOs {
     readonly spentTransactions: RawUTXOResponse[];
 }
 
+export interface PreimageData {
+    readonly preimage: Buffer;
+}
+
 /**
  * Allows to fetch UTXO data from any OPNET node
  */
@@ -177,6 +181,19 @@ export class OPNetLimitedProvider {
         return result as BroadcastResponse;
     }
 
+    /**
+     * Fetches the preimage from the OPNET node
+     * @returns {Promise<PreimageData | undefined>} - The preimage fetched
+     */
+    public async getPreimage(): Promise<PreimageData | undefined> {
+        const result = await this.rpcMethod('btc_preimage', []);
+        if (!result) {
+            return;
+        }
+
+        return result as PreimageData;
+    }
+
     /**
      * Splits UTXOs into smaller UTXOs
      * @param {Wallet} wallet - The wallet to split UTXOs