@btc-vision/transaction 1.0.97 → 1.0.100

package/src/opnet.ts

@@ -1,82 +1,82 @@
-export { version } from './_version.js';
-
-/** Bytecode */
-export * from './bytecode/Compressor.js';
-
-/** Generators */
-export * from './generators/Generator.js';
-export * from './generators/builders/CalldataGenerator.js';
-export * from './generators/builders/DeploymentGenerator.js';
-export * from './generators/Features.js';
-
-/** Address */
-export * from './generators/AddressGenerator.js';
-export * from './verification/TapscriptVerificator.js';
-
-/** Key Pair */
-export * from './keypair/EcKeyPair.js';
-export * from './keypair/Wallet.js';
-export * from './keypair/interfaces/IWallet.js';
-export * from './keypair/AddressVerificator.js';
-
-/** Metadata */
-export * from './metadata/contracts/wBTC.js';
-export * from './metadata/ContractBaseMetadata.js';
-
-/** Signer */
-export * from './signer/TweakedSigner.js';
-
-/** Transaction */
-export * from './transaction/TransactionFactory.js';
-export * from './transaction/interfaces/ITransactionParameters.js';
-export * from './transaction/interfaces/Tap.js';
-export * from './transaction/enums/TransactionType.js';
-
-/** Builders */
-export * from './transaction/builders/InteractionTransaction.js';
-export * from './transaction/builders/FundingTransaction.js';
-export * from './transaction/builders/TransactionBuilder.js';
-export * from './transaction/builders/WrapTransaction.js';
-export * from './transaction/builders/SharedInteractionTransaction.js';
-export * from './transaction/builders/DeploymentTransaction.js';
-
-/** wBTC */
-export * from './wbtc/WrappedGenerationParameters.js';
-export * from './wbtc/Generate.js';
-export * from './network/ChainId.js';
-
-/** Utils */
-export * from './utils/BitcoinUtils.js';
-
-/** UTXO */
-export * from './utxo/interfaces/IUTXO.js';
-export * from './utxo/OPNetLimitedProvider.js';
-
-/** Processor */
-export * from './transaction/processor/PsbtTransaction.js';
-
-/** Shared */
-export * from './transaction/shared/TweakedTransaction.js';
-export * from './utxo/interfaces/BroadcastResponse.js';
-export * from './transaction/psbt/PSBTTypes.js';
-
-export * from './transaction/builders/MultiSignTransaction.js';
-export * from './generators/builders/MultiSignGenerator.js';
-
-export * from './transaction/shared/P2TR_MS.js';
-export * from './transaction/builders/UnwrapTransaction.js';
-
-export * from './wbtc/UnwrapGeneration.js';
-
-/** Consensus */
-export * from './consensus/ConsensusConfig.js';
-export * from './consensus/Consensus.js';
-export * from './consensus/metadata/RoswellConsensus.js';
-
-/** Custom signers */
-export * from './transaction/browser/BrowserSignerBase.js';
-export * from './transaction/browser/extensions/UnisatSigner.js';
-export * from './transaction/browser/types/Unisat.js';
-
-export * from './transaction/browser/Web3Provider.js';
-export * from './metadata/tokens.js';
+export { version } from './_version.js';
+
+/** Bytecode */
+export * from './bytecode/Compressor.js';
+
+/** Generators */
+export * from './generators/Generator.js';
+export * from './generators/builders/CalldataGenerator.js';
+export * from './generators/builders/DeploymentGenerator.js';
+export * from './generators/builders/CustomGenerator.js';
+export * from './generators/builders/MultiSignGenerator.js';
+export * from './generators/Features.js';
+
+/** Address */
+export * from './generators/AddressGenerator.js';
+export * from './verification/TapscriptVerificator.js';
+
+/** Key Pair */
+export * from './keypair/EcKeyPair.js';
+export * from './keypair/Wallet.js';
+export * from './keypair/interfaces/IWallet.js';
+export * from './keypair/AddressVerificator.js';
+
+/** Metadata */
+export * from './metadata/contracts/wBTC.js';
+export * from './metadata/ContractBaseMetadata.js';
+
+/** Signer */
+export * from './signer/TweakedSigner.js';
+
+/** Transaction */
+export * from './transaction/TransactionFactory.js';
+export * from './transaction/interfaces/ITransactionParameters.js';
+export * from './transaction/interfaces/Tap.js';
+export * from './transaction/enums/TransactionType.js';
+
+/** Builders */
+export * from './transaction/builders/InteractionTransaction.js';
+export * from './transaction/builders/FundingTransaction.js';
+export * from './transaction/builders/TransactionBuilder.js';
+export * from './transaction/builders/WrapTransaction.js';
+export * from './transaction/builders/SharedInteractionTransaction.js';
+export * from './transaction/builders/DeploymentTransaction.js';
+export * from './transaction/builders/UnwrapTransaction.js';
+export * from './transaction/builders/CustomScriptTransaction.js';
+export * from './transaction/builders/MultiSignTransaction.js';
+
+/** wBTC */
+export * from './wbtc/WrappedGenerationParameters.js';
+export * from './wbtc/Generate.js';
+export * from './network/ChainId.js';
+
+/** Utils */
+export * from './utils/BitcoinUtils.js';
+
+/** UTXO */
+export * from './utxo/interfaces/IUTXO.js';
+export * from './utxo/OPNetLimitedProvider.js';
+
+/** Processor */
+export * from './transaction/processor/PsbtTransaction.js';
+
+/** Shared */
+export * from './transaction/shared/TweakedTransaction.js';
+export * from './utxo/interfaces/BroadcastResponse.js';
+export * from './transaction/psbt/PSBTTypes.js';
+
+export * from './transaction/shared/P2TR_MS.js';
+export * from './wbtc/UnwrapGeneration.js';
+
+/** Consensus */
+export * from './consensus/ConsensusConfig.js';
+export * from './consensus/Consensus.js';
+export * from './consensus/metadata/RoswellConsensus.js';
+
+/** Custom signers */
+export * from './transaction/browser/BrowserSignerBase.js';
+export * from './transaction/browser/extensions/UnisatSigner.js';
+export * from './transaction/browser/types/Unisat.js';
+
+export * from './transaction/browser/Web3Provider.js';
+export * from './metadata/tokens.js';

package/src/signer/TweakedSigner.ts

@@ -1,56 +1,56 @@
-import { initEccLib, Network, Signer } from 'bitcoinjs-lib';
-import { tapTweakHash } from 'bitcoinjs-lib/src/payments/bip341.js';
-import { toXOnly } from 'bitcoinjs-lib/src/psbt/bip371.js';
-import * as ecc from '@bitcoinerlab/secp256k1';
-import { EcKeyPair } from '../keypair/EcKeyPair.js';
-import { ECPairInterface } from 'ecpair';
-
-initEccLib(ecc);
-
-/**
- * Tweak settings
- */
-export interface TweakSettings {
-    /**
-     * The network to use
-     */
-    readonly network?: Network;
-
-    /**
-     * The tweak hash to use
-     */
-    tweakHash?: Buffer;
-}
-
-/**
- * Class for tweaking signers
- * @class TweakedSigner
- */
-export class TweakedSigner {
-    /**
-     * Tweak a signer
-     * @param {Signer} signer - The signer to tweak
-     * @param {TweakSettings} opts - The tweak settings
-     */
-    public static tweakSigner(signer: ECPairInterface, opts: TweakSettings = {}): Signer {
-        let privateKey: Uint8Array | undefined = signer.privateKey!;
-        if (!privateKey) {
-            throw new Error('Private key is required for tweaking signer!');
-        }
-        
-        if (signer.publicKey[0] === 3) {
-            privateKey = ecc.privateNegate(privateKey);
-        }
-
-        const tweakedPrivateKey = ecc.privateAdd(
-            privateKey,
-            tapTweakHash(toXOnly(signer.publicKey), opts.tweakHash),
-        );
-
-        if (!tweakedPrivateKey) {
-            throw new Error('Invalid tweaked private key!');
-        }
-
-        return EcKeyPair.fromPrivateKey(Buffer.from(tweakedPrivateKey), opts.network);
-    }
-}
+import { initEccLib, Network, Signer } from 'bitcoinjs-lib';
+import { tapTweakHash } from 'bitcoinjs-lib/src/payments/bip341.js';
+import { toXOnly } from 'bitcoinjs-lib/src/psbt/bip371.js';
+import * as ecc from '@bitcoinerlab/secp256k1';
+import { EcKeyPair } from '../keypair/EcKeyPair.js';
+import { ECPairInterface } from 'ecpair';
+
+initEccLib(ecc);
+
+/**
+ * Tweak settings
+ */
+export interface TweakSettings {
+    /**
+     * The network to use
+     */
+    readonly network?: Network;
+
+    /**
+     * The tweak hash to use
+     */
+    tweakHash?: Buffer;
+}
+
+/**
+ * Class for tweaking signers
+ * @class TweakedSigner
+ */
+export class TweakedSigner {
+    /**
+     * Tweak a signer
+     * @param {Signer} signer - The signer to tweak
+     * @param {TweakSettings} opts - The tweak settings
+     */
+    public static tweakSigner(signer: ECPairInterface, opts: TweakSettings = {}): Signer {
+        let privateKey: Uint8Array | undefined = signer.privateKey!;
+        if (!privateKey) {
+            throw new Error('Private key is required for tweaking signer!');
+        }
+        
+        if (signer.publicKey[0] === 3) {
+            privateKey = ecc.privateNegate(privateKey);
+        }
+
+        const tweakedPrivateKey = ecc.privateAdd(
+            privateKey,
+            tapTweakHash(toXOnly(signer.publicKey), opts.tweakHash),
+        );
+
+        if (!tweakedPrivateKey) {
+            throw new Error('Invalid tweaked private key!');
+        }
+
+        return EcKeyPair.fromPrivateKey(Buffer.from(tweakedPrivateKey), opts.network);
+    }
+}

package/src/transaction/TransactionFactory.ts

@@ -21,6 +21,10 @@ import { UnwrapTransaction } from './builders/UnwrapTransaction.js';
 import { currentConsensus, currentConsensusConfig } from '../consensus/ConsensusConfig.js';
 import { TransactionBuilder } from './builders/TransactionBuilder.js';
 import { TransactionType } from './enums/TransactionType.js';
+import {
+    CustomScriptTransaction,
+    ICustomTransactionParameters,
+} from './builders/CustomScriptTransaction';
 
 export interface DeploymentResult {
     readonly transaction: [string, string];
@@ -71,6 +75,74 @@ export interface UnwrapResult {
 export class TransactionFactory {
     constructor() {}
 
+    /**
+     * @description Generate a transaction with a custom script.
+     * @returns {Promise<[string, string]>} - The signed transaction
+     */
+    public async createCustomScriptTransaction(
+        interactionParameters: ICustomTransactionParameters,
+    ): Promise<[string, string, UTXO[]]> {
+        if (!interactionParameters.to) {
+            throw new Error('Field "to" not provided.');
+        }
+
+        if (!interactionParameters.from) {
+            throw new Error('Field "from" not provided.');
+        }
+
+        const preTransaction: CustomScriptTransaction = new CustomScriptTransaction({
+            ...interactionParameters,
+            utxos: [interactionParameters.utxos[0]], // we simulate one input here.
+        });
+
+        // we don't sign that transaction, we just need the parameters.
+
+        await preTransaction.generateTransactionMinimalSignatures();
+
+        const parameters: IFundingTransactionParameters =
+            await preTransaction.getFundingTransactionParameters();
+
+        parameters.utxos = interactionParameters.utxos;
+        parameters.amount =
+            (await preTransaction.estimateTransactionFees()) + interactionParameters.priorityFee;
+
+        const feeEstimationFundingTransaction = await this.createFundTransaction({ ...parameters });
+        if (!feeEstimationFundingTransaction) {
+            throw new Error('Could not sign funding transaction.');
+        }
+
+        parameters.estimatedFees = feeEstimationFundingTransaction.estimatedFees;
+
+        const signedTransaction = await this.createFundTransaction(parameters);
+        if (!signedTransaction) {
+            throw new Error('Could not sign funding transaction.');
+        }
+
+        interactionParameters.utxos = this.getUTXOAsTransaction(
+            signedTransaction.tx,
+            interactionParameters.to,
+            0,
+        );
+
+        const newParams: ICustomTransactionParameters = {
+            ...interactionParameters,
+            utxos: this.getUTXOAsTransaction(signedTransaction.tx, interactionParameters.to, 0), // always 0
+            randomBytes: preTransaction.getRndBytes(),
+            nonWitnessUtxo: signedTransaction.tx.toBuffer(),
+            estimatedFees: preTransaction.estimatedFees,
+        };
+
+        const finalTransaction: CustomScriptTransaction = new CustomScriptTransaction(newParams);
+
+        // We have to regenerate using the new utxo
+        const outTx: Transaction = await finalTransaction.signTransaction();
+        return [
+            signedTransaction.tx.toHex(),
+            outTx.toHex(),
+            this.getUTXOAsTransaction(signedTransaction.tx, interactionParameters.from, 1), // always 1
+        ];
+    }
+
     /**
      * @description Generates the required transactions.
      * @returns {Promise<[string, string]>} - The signed transaction
@@ -132,7 +204,6 @@ export class TransactionFactory {
 
         // We have to regenerate using the new utxo
         const outTx: Transaction = await finalTransaction.signTransaction();
-
         return [
             signedTransaction.tx.toHex(),
             outTx.toHex(),
@@ -243,8 +314,6 @@ export class TransactionFactory {
         const parameters: IFundingTransactionParameters =
             await preTransaction.getFundingTransactionParameters();
 
-        console.log('wrap parameters', parameters);
-
         // We add the amount
         parameters.amount += childTransactionRequiredValue;
         parameters.utxos = fundingParameters.utxos;
@@ -300,15 +369,6 @@ export class TransactionFactory {
             this.maxPubKeySize(unwrapParameters.unwrapUTXOs),
         );
 
-        console.log(
-            'estimatedFees',
-            estimatedFees,
-            'estimatedGas',
-            estimatedGas,
-            'priority',
-            unwrapParameters.priorityFee,
-        );
-
         const fundingParameters: IFundingTransactionParameters = {
             ...unwrapParameters,
             amount: estimatedGas + estimatedFees,
@@ -402,8 +462,6 @@ export class TransactionFactory {
         parameters.amount =
             (await preTransaction.estimateTransactionFees()) + unwrapParameters.priorityFee;
 
-        console.log('parameters', parameters);
-
         const signedTransaction = await this.createFundTransaction(parameters);
         if (!signedTransaction) {
             throw new Error('Could not sign funding transaction.');