@btc-vision/transaction 1.6.13 → 1.6.15

package/browser/transaction/TransactionFactory.d.ts

@@ -5,8 +5,9 @@ import { FundingTransaction } from './builders/FundingTransaction.js';
 import { TransactionBuilder } from './builders/TransactionBuilder.js';
 import { TransactionType } from './enums/TransactionType.js';
 import { IDeploymentParameters, IFundingTransactionParameters, IInteractionParameters } from './interfaces/ITransactionParameters.js';
-import { InteractionParametersWithoutSigner } from './browser/Web3Provider.js';
+import { ICancelTransactionParametersWithoutSigner, ICustomTransactionWithoutSigner, InteractionParametersWithoutSigner } from './browser/Web3Provider.js';
 import { RawChallenge } from '../epoch/interfaces/IChallengeSolution.js';
+import { ICancelTransactionParameters } from './builders/CancelTransaction.js';
 export interface DeploymentResult {
     readonly transaction: [string, string];
     readonly contractAddress: string;
@@ -38,18 +39,24 @@ export interface InteractionResponse {
 export interface BitcoinTransferResponse extends BitcoinTransferBase {
     readonly original: FundingTransaction;
 }
+export interface CancelledTransaction {
+    readonly transaction: string;
+    readonly nextUTXOs: UTXO[];
+}
 export declare class TransactionFactory {
     debug: boolean;
     private readonly DUMMY_PUBKEY;
     private readonly P2TR_SCRIPT;
     private readonly INITIAL_FUNDING_ESTIMATE;
     private readonly MAX_ITERATIONS;
-    createCustomScriptTransaction(interactionParameters: ICustomTransactionParameters): Promise<[string, string, UTXO[]]>;
+    createCancellableTransaction(params: ICancelTransactionParameters | ICancelTransactionParametersWithoutSigner): Promise<CancelledTransaction>;
+    createCustomScriptTransaction(interactionParameters: ICustomTransactionParameters | ICustomTransactionWithoutSigner): Promise<[string, string, UTXO[]]>;
     signInteraction(interactionParameters: IInteractionParameters | InteractionParametersWithoutSigner): Promise<InteractionResponse>;
     signDeployment(deploymentParameters: IDeploymentParameters): Promise<DeploymentResult>;
     createBTCTransfer(parameters: IFundingTransactionParameters): Promise<BitcoinTransferResponse>;
     getAllNewUTXOs(original: TransactionBuilder<TransactionType>, tx: Transaction, to: string): UTXO[];
     private parseOptionalInputs;
+    private detectCancelOPWallet;
     private detectInteractionOPWallet;
     private detectDeploymentOPWallet;
     private createFundTransaction;

package/browser/transaction/browser/Web3Provider.d.ts

@@ -1,10 +1,12 @@
 import { IDeploymentParameters, IInteractionParameters } from '../interfaces/ITransactionParameters.js';
 import { UTXO } from '../../utxo/interfaces/IUTXO.js';
-import { DeploymentResult, InteractionResponse } from '../TransactionFactory';
+import { CancelledTransaction, DeploymentResult, InteractionResponse } from '../TransactionFactory';
 import { ICustomTransactionParameters } from '../builders/CustomScriptTransaction.js';
+import { ICancelTransactionParameters } from '../builders/CancelTransaction.js';
 export type InteractionParametersWithoutSigner = Omit<IInteractionParameters, 'signer' | 'challenge'>;
 export type IDeploymentParametersWithoutSigner = Omit<IDeploymentParameters, 'signer' | 'network' | 'challenge'>;
-export type CustomTransactionWithoutSigner = Omit<ICustomTransactionParameters, 'signer' | 'challenge'>;
+export type ICustomTransactionWithoutSigner = Omit<ICustomTransactionParameters, 'signer' | 'challenge'>;
+export type ICancelTransactionParametersWithoutSigner = Omit<ICancelTransactionParameters, 'signer' | 'challenge' | 'network'>;
 export interface BroadcastTransactionOptions {
     raw: string;
     psbt: boolean;
@@ -18,6 +20,8 @@ export interface BroadcastedTransaction {
 export interface Web3Provider {
     signInteraction(interactionParameters: InteractionParametersWithoutSigner): Promise<InteractionResponse>;
     signAndBroadcastInteraction(interactionParameters: InteractionParametersWithoutSigner): Promise<[BroadcastedTransaction, BroadcastedTransaction, UTXO[], string]>;
+    cancelTransaction(params: ICancelTransactionParametersWithoutSigner): Promise<CancelledTransaction>;
+    customTransaction(params: ICustomTransactionWithoutSigner): Promise<BroadcastedTransaction>;
     deployContract(params: IDeploymentParametersWithoutSigner): Promise<DeploymentResult>;
     broadcast(transactions: BroadcastTransactionOptions[]): Promise<BroadcastedTransaction[]>;
 }

package/build/_version.d.ts

@@ -1 +1 @@
-export declare const version = "1.6.13";
+export declare const version = "1.6.15";

package/build/_version.js

@@ -1 +1 @@
-export const version = '1.6.13';
+export const version = '1.6.15';

package/build/transaction/TransactionFactory.d.ts

@@ -5,8 +5,9 @@ import { FundingTransaction } from './builders/FundingTransaction.js';
 import { TransactionBuilder } from './builders/TransactionBuilder.js';
 import { TransactionType } from './enums/TransactionType.js';
 import { IDeploymentParameters, IFundingTransactionParameters, IInteractionParameters } from './interfaces/ITransactionParameters.js';
-import { InteractionParametersWithoutSigner } from './browser/Web3Provider.js';
+import { ICancelTransactionParametersWithoutSigner, ICustomTransactionWithoutSigner, InteractionParametersWithoutSigner } from './browser/Web3Provider.js';
 import { RawChallenge } from '../epoch/interfaces/IChallengeSolution.js';
+import { ICancelTransactionParameters } from './builders/CancelTransaction.js';
 export interface DeploymentResult {
     readonly transaction: [string, string];
     readonly contractAddress: string;
@@ -38,18 +39,24 @@ export interface InteractionResponse {
 export interface BitcoinTransferResponse extends BitcoinTransferBase {
     readonly original: FundingTransaction;
 }
+export interface CancelledTransaction {
+    readonly transaction: string;
+    readonly nextUTXOs: UTXO[];
+}
 export declare class TransactionFactory {
     debug: boolean;
     private readonly DUMMY_PUBKEY;
     private readonly P2TR_SCRIPT;
     private readonly INITIAL_FUNDING_ESTIMATE;
     private readonly MAX_ITERATIONS;
-    createCustomScriptTransaction(interactionParameters: ICustomTransactionParameters): Promise<[string, string, UTXO[]]>;
+    createCancellableTransaction(params: ICancelTransactionParameters | ICancelTransactionParametersWithoutSigner): Promise<CancelledTransaction>;
+    createCustomScriptTransaction(interactionParameters: ICustomTransactionParameters | ICustomTransactionWithoutSigner): Promise<[string, string, UTXO[]]>;
     signInteraction(interactionParameters: IInteractionParameters | InteractionParametersWithoutSigner): Promise<InteractionResponse>;
     signDeployment(deploymentParameters: IDeploymentParameters): Promise<DeploymentResult>;
     createBTCTransfer(parameters: IFundingTransactionParameters): Promise<BitcoinTransferResponse>;
     getAllNewUTXOs(original: TransactionBuilder<TransactionType>, tx: Transaction, to: string): UTXO[];
     private parseOptionalInputs;
+    private detectCancelOPWallet;
     private detectInteractionOPWallet;
     private detectDeploymentOPWallet;
     private createFundTransaction;

package/build/transaction/TransactionFactory.js

@@ -9,6 +9,7 @@ import { P2WDADetector } from '../p2wda/P2WDADetector.js';
 import { InteractionTransactionP2WDA } from './builders/InteractionTransactionP2WDA.js';
 import { Address } from '../keypair/Address.js';
 import { BitcoinUtils } from '../utils/BitcoinUtils.js';
+import { CancelTransaction } from './builders/CancelTransaction.js';
 export class TransactionFactory {
     constructor() {
         this.debug = false;
@@ -20,6 +21,31 @@ export class TransactionFactory {
         this.INITIAL_FUNDING_ESTIMATE = 2000n;
         this.MAX_ITERATIONS = 10;
     }
+    async createCancellableTransaction(params) {
+        if (!params.to) {
+            throw new Error('Field "to" not provided.');
+        }
+        if (!params.from) {
+            throw new Error('Field "from" not provided.');
+        }
+        if (!params.utxos[0]) {
+            throw new Error('Missing at least one UTXO.');
+        }
+        const opWalletCancel = await this.detectCancelOPWallet(params);
+        if (opWalletCancel) {
+            return opWalletCancel;
+        }
+        if (!('signer' in params)) {
+            throw new Error('Field "signer" not provided, OP_WALLET not detected.');
+        }
+        const cancel = new CancelTransaction(params);
+        const signed = await cancel.signTransaction();
+        const rawTx = signed.toHex();
+        return {
+            transaction: rawTx,
+            nextUTXOs: this.getUTXOAsTransaction(signed, params.from, 0),
+        };
+    }
     async createCustomScriptTransaction(interactionParameters) {
         if (!interactionParameters.to) {
             throw new Error('Field "to" not provided.');
@@ -269,6 +295,24 @@ export class TransactionFactory {
             };
         });
     }
+    async detectCancelOPWallet(interactionParameters) {
+        if (typeof window === 'undefined') {
+            return null;
+        }
+        const _window = window;
+        if (!_window || !_window.opnet || !_window.opnet.web3) {
+            return null;
+        }
+        const opnet = _window.opnet.web3;
+        const interaction = await opnet.cancelTransaction({
+            ...interactionParameters,
+            signer: undefined,
+        });
+        if (!interaction) {
+            throw new Error('Could not sign interaction transaction.');
+        }
+        return interaction;
+    }
     async detectInteractionOPWallet(interactionParameters) {
         if (typeof window === 'undefined') {
             return null;

package/build/transaction/browser/Web3Provider.d.ts

@@ -1,10 +1,12 @@
 import { IDeploymentParameters, IInteractionParameters } from '../interfaces/ITransactionParameters.js';
 import { UTXO } from '../../utxo/interfaces/IUTXO.js';
-import { DeploymentResult, InteractionResponse } from '../TransactionFactory';
+import { CancelledTransaction, DeploymentResult, InteractionResponse } from '../TransactionFactory';
 import { ICustomTransactionParameters } from '../builders/CustomScriptTransaction.js';
+import { ICancelTransactionParameters } from '../builders/CancelTransaction.js';
 export type InteractionParametersWithoutSigner = Omit<IInteractionParameters, 'signer' | 'challenge'>;
 export type IDeploymentParametersWithoutSigner = Omit<IDeploymentParameters, 'signer' | 'network' | 'challenge'>;
-export type CustomTransactionWithoutSigner = Omit<ICustomTransactionParameters, 'signer' | 'challenge'>;
+export type ICustomTransactionWithoutSigner = Omit<ICustomTransactionParameters, 'signer' | 'challenge'>;
+export type ICancelTransactionParametersWithoutSigner = Omit<ICancelTransactionParameters, 'signer' | 'challenge' | 'network'>;
 export interface BroadcastTransactionOptions {
     raw: string;
     psbt: boolean;
@@ -18,6 +20,8 @@ export interface BroadcastedTransaction {
 export interface Web3Provider {
     signInteraction(interactionParameters: InteractionParametersWithoutSigner): Promise<InteractionResponse>;
     signAndBroadcastInteraction(interactionParameters: InteractionParametersWithoutSigner): Promise<[BroadcastedTransaction, BroadcastedTransaction, UTXO[], string]>;
+    cancelTransaction(params: ICancelTransactionParametersWithoutSigner): Promise<CancelledTransaction>;
+    customTransaction(params: ICustomTransactionWithoutSigner): Promise<BroadcastedTransaction>;
     deployContract(params: IDeploymentParametersWithoutSigner): Promise<DeploymentResult>;
     broadcast(transactions: BroadcastTransactionOptions[]): Promise<BroadcastedTransaction[]>;
 }

package/package.json

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

package/src/transaction/TransactionFactory.ts

@@ -1,10 +1,7 @@
 import { Transaction, TxOutput } from '@btc-vision/bitcoin';
 import { currentConsensus } from '../consensus/ConsensusConfig.js';
 import { UTXO } from '../utxo/interfaces/IUTXO.js';
-import {
-    CustomScriptTransaction,
-    ICustomTransactionParameters,
-} from './builders/CustomScriptTransaction.js';
+import { CustomScriptTransaction, ICustomTransactionParameters, } from './builders/CustomScriptTransaction.js';
 import { DeploymentTransaction } from './builders/DeploymentTransaction.js';
 import { FundingTransaction } from './builders/FundingTransaction.js';
 import { InteractionTransaction } from './builders/InteractionTransaction.js';
@@ -18,6 +15,8 @@ import {
 } from './interfaces/ITransactionParameters.js';
 import { PSBTTypes } from './psbt/PSBTTypes.js';
 import {
+    ICancelTransactionParametersWithoutSigner,
+    ICustomTransactionWithoutSigner,
     IDeploymentParametersWithoutSigner,
     InteractionParametersWithoutSigner,
 } from './browser/Web3Provider.js';
@@ -28,6 +27,7 @@ import { InteractionTransactionP2WDA } from './builders/InteractionTransactionP2
 import { ChallengeSolution } from '../epoch/ChallengeSolution.js';
 import { Address } from '../keypair/Address.js';
 import { BitcoinUtils } from '../utils/BitcoinUtils.js';
+import { CancelTransaction, ICancelTransactionParameters } from './builders/CancelTransaction.js';
 
 export interface DeploymentResult {
     readonly transaction: [string, string];
@@ -67,6 +67,11 @@ export interface BitcoinTransferResponse extends BitcoinTransferBase {
     readonly original: FundingTransaction;
 }
 
+export interface CancelledTransaction {
+    readonly transaction: string;
+    readonly nextUTXOs: UTXO[];
+}
+
 export class TransactionFactory {
     public debug: boolean = false;
 
@@ -78,12 +83,44 @@ export class TransactionFactory {
     private readonly INITIAL_FUNDING_ESTIMATE = 2000n;
     private readonly MAX_ITERATIONS = 10;
 
+    public async createCancellableTransaction(
+        params: ICancelTransactionParameters | ICancelTransactionParametersWithoutSigner,
+    ): Promise<CancelledTransaction> {
+        if (!params.to) {
+            throw new Error('Field "to" not provided.');
+        }
+        if (!params.from) {
+            throw new Error('Field "from" not provided.');
+        }
+        if (!params.utxos[0]) {
+            throw new Error('Missing at least one UTXO.');
+        }
+
+        const opWalletCancel = await this.detectCancelOPWallet(params);
+        if (opWalletCancel) {
+            return opWalletCancel;
+        }
+
+        if (!('signer' in params)) {
+            throw new Error('Field "signer" not provided, OP_WALLET not detected.');
+        }
+
+        const cancel = new CancelTransaction(params);
+        const signed = await cancel.signTransaction();
+        const rawTx = signed.toHex();
+
+        return {
+            transaction: rawTx,
+            nextUTXOs: this.getUTXOAsTransaction(signed, params.from, 0),
+        };
+    }
+
     /**
      * @description Generate a transaction with a custom script.
      * @returns {Promise<[string, string]>} - The signed transaction
      */
     public async createCustomScriptTransaction(
-        interactionParameters: ICustomTransactionParameters,
+        interactionParameters: ICustomTransactionParameters | ICustomTransactionWithoutSigner,
     ): Promise<[string, string, UTXO[]]> {
         if (!interactionParameters.to) {
             throw new Error('Field "to" not provided.');
@@ -452,6 +489,35 @@ export class TransactionFactory {
         });
     }
 
+    private async detectCancelOPWallet(
+        interactionParameters:
+            | ICancelTransactionParameters
+            | ICancelTransactionParametersWithoutSigner,
+    ): Promise<CancelledTransaction | null> {
+        if (typeof window === 'undefined') {
+            return null;
+        }
+
+        const _window = window as WindowWithWallets;
+        if (!_window || !_window.opnet || !_window.opnet.web3) {
+            return null;
+        }
+
+        const opnet = _window.opnet.web3;
+        const interaction = await opnet.cancelTransaction({
+            ...interactionParameters,
+
+            // @ts-expect-error no, this is ok
+            signer: undefined,
+        });
+
+        if (!interaction) {
+            throw new Error('Could not sign interaction transaction.');
+        }
+
+        return interaction;
+    }
+
     private async detectInteractionOPWallet(
         interactionParameters: IInteractionParameters | InteractionParametersWithoutSigner,
     ): Promise<InteractionResponse | null> {

package/src/transaction/browser/Web3Provider.ts

@@ -3,8 +3,9 @@ import {
     IInteractionParameters,
 } from '../interfaces/ITransactionParameters.js';
 import { UTXO } from '../../utxo/interfaces/IUTXO.js';
-import { DeploymentResult, InteractionResponse } from '../TransactionFactory';
+import { CancelledTransaction, DeploymentResult, InteractionResponse } from '../TransactionFactory';
 import { ICustomTransactionParameters } from '../builders/CustomScriptTransaction.js';
+import { ICancelTransactionParameters } from '../builders/CancelTransaction.js';
 
 export type InteractionParametersWithoutSigner = Omit<
     IInteractionParameters,
@@ -16,11 +17,16 @@ export type IDeploymentParametersWithoutSigner = Omit<
     'signer' | 'network' | 'challenge'
 >;
 
-export type CustomTransactionWithoutSigner = Omit<
+export type ICustomTransactionWithoutSigner = Omit<
     ICustomTransactionParameters,
     'signer' | 'challenge'
 >;
 
+export type ICancelTransactionParametersWithoutSigner = Omit<
+    ICancelTransactionParameters,
+    'signer' | 'challenge' | 'network'
+>;
+
 export interface BroadcastTransactionOptions {
     raw: string;
     psbt: boolean;
@@ -55,6 +61,12 @@ export interface Web3Provider {
         interactionParameters: InteractionParametersWithoutSigner,
     ): Promise<[BroadcastedTransaction, BroadcastedTransaction, UTXO[], string]>;
 
+    cancelTransaction(
+        params: ICancelTransactionParametersWithoutSigner,
+    ): Promise<CancelledTransaction>;
+
+    customTransaction(params: ICustomTransactionWithoutSigner): Promise<BroadcastedTransaction>;
+
     deployContract(params: IDeploymentParametersWithoutSigner): Promise<DeploymentResult>;
 
     broadcast(transactions: BroadcastTransactionOptions[]): Promise<BroadcastedTransaction[]>;