@btc-vision/transaction 1.0.55 → 1.0.57

package/browser/metadata/tokens.d.ts

@@ -4,3 +4,8 @@ export declare const POOL_ADDRESS_REGTEST: Address;
 export declare const WBTC_ADDRESS_REGTEST: Address;
 export declare const MOTO_ADDRESS_REGTEST: Address;
 export declare const ROUTER_ADDRESS_REGTEST: Address;
+export declare const FACTORY_ADDRESS_TESTNET: Address;
+export declare const POOL_ADDRESS_TESTNET: Address;
+export declare const WBTC_ADDRESS_TESTNET: Address;
+export declare const MOTO_ADDRESS_TESTNET: Address;
+export declare const ROUTER_ADDRESS_TESTNET: Address;

package/browser/transaction/TransactionFactory.d.ts

@@ -5,23 +5,26 @@ export interface DeploymentResult {
     readonly transaction: [string, string];
     readonly contractAddress: Address;
     readonly p2trAddress: Address;
+    readonly utxos: UTXO[];
 }
 export interface WrapResult {
     readonly transaction: [string, string];
     readonly vaultAddress: Address;
     readonly amount: bigint;
     readonly receiverAddress: Address;
+    readonly utxos: UTXO[];
 }
 export interface UnwrapResult {
     readonly fundingTransaction: string;
     readonly psbt: string;
     readonly feeRefundOrLoss: bigint;
+    readonly utxos: UTXO[];
 }
 export declare class TransactionFactory {
     constructor();
     signInteraction(interactionParameters: IInteractionParameters): Promise<[string, string, UTXO[]]>;
     signDeployment(deploymentParameters: IDeploymentParameters): Promise<DeploymentResult>;
-    wrap(warpParameters: IWrapParameters): Promise<WrapResult>;
+    wrap(warpParameters: Omit<IWrapParameters, 'calldata'>): Promise<WrapResult>;
     unwrapSegwit(unwrapParameters: IUnwrapParameters): Promise<UnwrapResult>;
     unwrap(unwrapParameters: IUnwrapParameters): Promise<UnwrapResult>;
     createBTCTransfer(parameters: IFundingTransactionParameters): Promise<{

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

@@ -27,6 +27,7 @@ export interface IInteractionParameters extends SharedInteractionParameters {
 }
 export interface IWrapParameters extends SharedInteractionParameters {
     readonly to?: undefined;
+    readonly from: Address;
     readonly amount: bigint;
     readonly receiver?: Address;
     readonly generationParameters: WrappedGeneration;

package/build/_version.d.ts

@@ -1 +1 @@
-export declare const version = "1.0.55";
+export declare const version = "1.0.57";

package/build/_version.js

@@ -1 +1 @@
-export const version = '1.0.55';
+export const version = '1.0.57';

package/build/metadata/tokens.d.ts

@@ -4,3 +4,8 @@ export declare const POOL_ADDRESS_REGTEST: Address;
 export declare const WBTC_ADDRESS_REGTEST: Address;
 export declare const MOTO_ADDRESS_REGTEST: Address;
 export declare const ROUTER_ADDRESS_REGTEST: Address;
+export declare const FACTORY_ADDRESS_TESTNET: Address;
+export declare const POOL_ADDRESS_TESTNET: Address;
+export declare const WBTC_ADDRESS_TESTNET: Address;
+export declare const MOTO_ADDRESS_TESTNET: Address;
+export declare const ROUTER_ADDRESS_TESTNET: Address;

package/build/metadata/tokens.js

@@ -3,3 +3,8 @@ export const POOL_ADDRESS_REGTEST = 'bcrt1q5nkjpjmh6xwweprcyeylwdw7aud4een7p9pph
 export const WBTC_ADDRESS_REGTEST = 'bcrt1qefq0lwqwpt5lx7hl2dr2r8q6z063725tccuqrg';
 export const MOTO_ADDRESS_REGTEST = 'bcrt1q8reuxx9naek4mqesrfsgdpjv3q7a5g2llkh6ua';
 export const ROUTER_ADDRESS_REGTEST = 'bcrt1qyx492l440f6cm5hdppw5pmkd2fc7k3qayuuvh6';
+export const FACTORY_ADDRESS_TESTNET = 'tb1qa7esg7wal50c287uec0qf6yztr5qaldgmr8lr8';
+export const POOL_ADDRESS_TESTNET = 'tb1q0gua4akdw4jmu5wsat6xf8ll0xa0dyjdwqwcax';
+export const WBTC_ADDRESS_TESTNET = 'tb1ql2lya5u0tv7zvy2rqvvr5qjmlfyw3j8jjvsj0u';
+export const MOTO_ADDRESS_TESTNET = 'tb1q4tyhf8hpu04qjj3qaag20knun0spctultxzakw';
+export const ROUTER_ADDRESS_TESTNET = 'tb1qzyn09v5s5ujpm5zlcqqdz6wjc67qk9sv2wzka9';

package/build/transaction/TransactionFactory.d.ts

@@ -5,23 +5,26 @@ export interface DeploymentResult {
     readonly transaction: [string, string];
     readonly contractAddress: Address;
     readonly p2trAddress: Address;
+    readonly utxos: UTXO[];
 }
 export interface WrapResult {
     readonly transaction: [string, string];
     readonly vaultAddress: Address;
     readonly amount: bigint;
     readonly receiverAddress: Address;
+    readonly utxos: UTXO[];
 }
 export interface UnwrapResult {
     readonly fundingTransaction: string;
     readonly psbt: string;
     readonly feeRefundOrLoss: bigint;
+    readonly utxos: UTXO[];
 }
 export declare class TransactionFactory {
     constructor();
     signInteraction(interactionParameters: IInteractionParameters): Promise<[string, string, UTXO[]]>;
     signDeployment(deploymentParameters: IDeploymentParameters): Promise<DeploymentResult>;
-    wrap(warpParameters: IWrapParameters): Promise<WrapResult>;
+    wrap(warpParameters: Omit<IWrapParameters, 'calldata'>): Promise<WrapResult>;
     unwrapSegwit(unwrapParameters: IUnwrapParameters): Promise<UnwrapResult>;
     unwrap(unwrapParameters: IUnwrapParameters): Promise<UnwrapResult>;
     createBTCTransfer(parameters: IFundingTransactionParameters): Promise<{

package/build/transaction/TransactionFactory.js

@@ -80,6 +80,10 @@ export class TransactionFactory {
             transaction: [signedTransaction.toHex(), outTx.toHex()],
             contractAddress: finalTransaction.contractAddress,
             p2trAddress: finalTransaction.p2trAddress,
+            utxos: [{
+                    ...newUtxo,
+                    outputIndex: 1,
+                }],
         };
     }
     async wrap(warpParameters) {
@@ -118,6 +122,7 @@ export class TransactionFactory {
             vaultAddress: finalTransaction.vault,
             amount: finalTransaction.amount,
             receiverAddress: finalTransaction.receiver,
+            utxos: this.getUTXOAsTransaction(signedTransaction.tx, warpParameters.from, 1),
         };
     }
     async unwrapSegwit(unwrapParameters) {
@@ -162,9 +167,13 @@ export class TransactionFactory {
             fundingTransaction: signedTransaction.tx.toHex(),
             psbt: psbt,
             feeRefundOrLoss: estimatedFees,
+            utxos: []
         };
     }
     async unwrap(unwrapParameters) {
+        if (!unwrapParameters.from) {
+            throw new Error('Field "from" not provided.');
+        }
         const transaction = new UnwrapTransaction(unwrapParameters);
         await transaction.signTransaction();
         const to = transaction.toAddress();
@@ -204,6 +213,7 @@ export class TransactionFactory {
             fundingTransaction: signedTransaction.tx.toHex(),
             psbt: psbt,
             feeRefundOrLoss: finalTransaction.getFeeLossOrRefund(),
+            utxos: this.getUTXOAsTransaction(signedTransaction.tx, unwrapParameters.from, 1),
         };
     }
     async createBTCTransfer(parameters) {

package/build/transaction/builders/UnwrapTransaction.js

@@ -83,17 +83,20 @@ export class UnwrapTransaction extends SharedInteractionTransaction {
         return refund - this.estimatedFeeLoss;
     }
     mergeVaults() {
-        const refund = this.getRefund();
         const totalInputAmount = this.getVaultTotalOutputAmount(this.vaultUTXOs);
-        const outputLeftAmount = totalInputAmount - refund - this.amount;
+        let refund = this.getRefund();
+        let outputLeftAmount = totalInputAmount - refund - this.amount;
+        if (outputLeftAmount === currentConsensusConfig.UNWRAP_CONSOLIDATION_PREPAID_FEES_SAT) {
+            refund += currentConsensusConfig.UNWRAP_CONSOLIDATION_PREPAID_FEES_SAT;
+        }
+        else if (outputLeftAmount < currentConsensusConfig.VAULT_MINIMUM_AMOUNT) {
+            throw new Error(`Output left amount is below the minimum amount: ${outputLeftAmount} below ${currentConsensusConfig.VAULT_MINIMUM_AMOUNT}`);
+        }
         const outAmount = this.amount + refund - this.estimatedFeeLoss;
         const bestVault = BitcoinUtils.findVaultWithMostPublicKeys(this.vaultUTXOs);
         if (!bestVault) {
             throw new Error('No vaults provided');
         }
-        if (outputLeftAmount !== 0n && outputLeftAmount < currentConsensusConfig.VAULT_MINIMUM_AMOUNT) {
-            throw new Error(`Output left amount is below the minimum amount: ${outputLeftAmount} below ${currentConsensusConfig.VAULT_MINIMUM_AMOUNT}`);
-        }
         let hasConsolidation = outputLeftAmount > currentConsensusConfig.VAULT_MINIMUM_AMOUNT &&
             outputLeftAmount - currentConsensusConfig.UNWRAP_CONSOLIDATION_PREPAID_FEES_SAT !== 0n;
         if (hasConsolidation) {

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

@@ -27,6 +27,7 @@ export interface IInteractionParameters extends SharedInteractionParameters {
 }
 export interface IWrapParameters extends SharedInteractionParameters {
     readonly to?: undefined;
+    readonly from: Address;
     readonly amount: bigint;
     readonly receiver?: Address;
     readonly generationParameters: WrappedGeneration;

package/package.json

@@ -1,6 +1,6 @@
 {
     "type": "module",
-    "version": "1.0.55",
+    "version": "1.0.57",
     "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.55';
+export const version = '1.0.57';

package/src/metadata/tokens.ts

@@ -1,7 +1,15 @@
 import { Address } from '@btc-vision/bsi-binary';
 
+// Addresses Regtest
 export const FACTORY_ADDRESS_REGTEST: Address = 'bcrt1qgph2k9dahptnz2vu72ezd9r2p4phjm2pkgu7ht';
 export const POOL_ADDRESS_REGTEST: Address = 'bcrt1q5nkjpjmh6xwweprcyeylwdw7aud4een7p9pphd';
 export const WBTC_ADDRESS_REGTEST: Address = 'bcrt1qefq0lwqwpt5lx7hl2dr2r8q6z063725tccuqrg';
 export const MOTO_ADDRESS_REGTEST: Address = 'bcrt1q8reuxx9naek4mqesrfsgdpjv3q7a5g2llkh6ua';
 export const ROUTER_ADDRESS_REGTEST: Address = 'bcrt1qyx492l440f6cm5hdppw5pmkd2fc7k3qayuuvh6';
+
+// Addresses Testnet
+export const FACTORY_ADDRESS_TESTNET: Address = 'tb1qa7esg7wal50c287uec0qf6yztr5qaldgmr8lr8';
+export const POOL_ADDRESS_TESTNET: Address = 'tb1q0gua4akdw4jmu5wsat6xf8ll0xa0dyjdwqwcax';
+export const WBTC_ADDRESS_TESTNET: Address = 'tb1ql2lya5u0tv7zvy2rqvvr5qjmlfyw3j8jjvsj0u';
+export const MOTO_ADDRESS_TESTNET: Address = 'tb1q4tyhf8hpu04qjj3qaag20knun0spctultxzakw';
+export const ROUTER_ADDRESS_TESTNET: Address = 'tb1qzyn09v5s5ujpm5zlcqqdz6wjc67qk9sv2wzka9';

package/src/transaction/TransactionFactory.ts

@@ -25,6 +25,8 @@ export interface DeploymentResult {
 
     readonly contractAddress: Address;
     readonly p2trAddress: Address;
+
+    readonly utxos: UTXO[];
 }
 
 export interface WrapResult {
@@ -32,6 +34,7 @@ export interface WrapResult {
     readonly vaultAddress: Address;
     readonly amount: bigint;
     readonly receiverAddress: Address;
+    readonly utxos: UTXO[];
 }
 
 export interface UnwrapResult {
@@ -45,6 +48,8 @@ export interface UnwrapResult {
      * @type {bigint}
      */
     readonly feeRefundOrLoss: bigint;
+
+    readonly utxos: UTXO[];
 }
 
 export class TransactionFactory {
@@ -169,6 +174,10 @@ export class TransactionFactory {
             transaction: [signedTransaction.toHex(), outTx.toHex()],
             contractAddress: finalTransaction.contractAddress,
             p2trAddress: finalTransaction.p2trAddress,
+            utxos: [{
+                ...newUtxo,
+                outputIndex: 1, // always 1
+            }],
         };
     }
 
@@ -178,7 +187,7 @@ export class TransactionFactory {
      * @returns {Promise<WrapResult>} - The signed transaction
      * @throws {Error} - If the transaction could not be signed
      */
-    public async wrap(warpParameters: IWrapParameters): Promise<WrapResult> {
+    public async wrap(warpParameters: Omit<IWrapParameters, 'calldata'>): Promise<WrapResult> {
         if (warpParameters.amount < currentConsensusConfig.VAULT_MINIMUM_AMOUNT) {
             throw new Error(
                 `Amount is too low. Minimum consolidation is ${currentConsensusConfig.VAULT_MINIMUM_AMOUNT} sat. Received ${warpParameters.amount} sat. Make sure that you cover the unwrap consolidation fees of ${currentConsensusConfig.UNWRAP_CONSOLIDATION_PREPAID_FEES_SAT}sat.`,
@@ -232,6 +241,7 @@ export class TransactionFactory {
             vaultAddress: finalTransaction.vault,
             amount: finalTransaction.amount,
             receiverAddress: finalTransaction.receiver,
+            utxos: this.getUTXOAsTransaction(signedTransaction.tx, warpParameters.from, 1),
         };
     }
 
@@ -307,6 +317,7 @@ export class TransactionFactory {
             fundingTransaction: signedTransaction.tx.toHex(),
             psbt: psbt,
             feeRefundOrLoss: estimatedFees,
+            utxos: []
         };
     }
 
@@ -317,6 +328,10 @@ export class TransactionFactory {
      * @throws {Error} - If the transaction could not be signed
      */
     public async unwrap(unwrapParameters: IUnwrapParameters): Promise<UnwrapResult> {
+        if(!unwrapParameters.from) {
+            throw new Error('Field "from" not provided.');
+        }
+
         const transaction: UnwrapTransaction = new UnwrapTransaction(unwrapParameters);
         await transaction.signTransaction();
 
@@ -371,6 +386,7 @@ export class TransactionFactory {
             fundingTransaction: signedTransaction.tx.toHex(),
             psbt: psbt,
             feeRefundOrLoss: finalTransaction.getFeeLossOrRefund(),
+            utxos: this.getUTXOAsTransaction(signedTransaction.tx, unwrapParameters.from, 1),
         };
     }
 

package/src/transaction/builders/UnwrapTransaction.ts

@@ -216,21 +216,23 @@ export class UnwrapTransaction extends SharedInteractionTransaction<TransactionT
      * @protected
      */
     protected mergeVaults(): void {
-        const refund: bigint = this.getRefund();
         const totalInputAmount: bigint = this.getVaultTotalOutputAmount(this.vaultUTXOs);
-        const outputLeftAmount = totalInputAmount - refund - this.amount;
 
-        const outAmount: bigint = this.amount + refund - this.estimatedFeeLoss;
+        let refund: bigint = this.getRefund();
+        let outputLeftAmount = totalInputAmount - refund - this.amount;
+
+        if(outputLeftAmount === currentConsensusConfig.UNWRAP_CONSOLIDATION_PREPAID_FEES_SAT) {
+            refund += currentConsensusConfig.UNWRAP_CONSOLIDATION_PREPAID_FEES_SAT;
+        } else if (outputLeftAmount < currentConsensusConfig.VAULT_MINIMUM_AMOUNT) {
+            throw new Error(`Output left amount is below the minimum amount: ${outputLeftAmount} below ${currentConsensusConfig.VAULT_MINIMUM_AMOUNT}`);
+        }
 
+        const outAmount: bigint = this.amount + refund - this.estimatedFeeLoss;
         const bestVault = BitcoinUtils.findVaultWithMostPublicKeys(this.vaultUTXOs);
         if (!bestVault) {
             throw new Error('No vaults provided');
         }
 
-        if (outputLeftAmount !== 0n && outputLeftAmount < currentConsensusConfig.VAULT_MINIMUM_AMOUNT) {
-            throw new Error(`Output left amount is below the minimum amount: ${outputLeftAmount} below ${currentConsensusConfig.VAULT_MINIMUM_AMOUNT}`);
-        }
-
         let hasConsolidation: boolean =
             outputLeftAmount > currentConsensusConfig.VAULT_MINIMUM_AMOUNT &&
             outputLeftAmount - currentConsensusConfig.UNWRAP_CONSOLIDATION_PREPAID_FEES_SAT !== 0n;

package/src/transaction/interfaces/ITransactionParameters.ts

@@ -36,6 +36,7 @@ export interface IInteractionParameters extends SharedInteractionParameters {
 export interface IWrapParameters extends SharedInteractionParameters {
     readonly to?: undefined;
 
+    readonly from: Address;
     readonly amount: bigint;
     readonly receiver?: Address;