@btc-vision/transaction 1.2.1 → 1.2.3

package/src/transaction/builders/InteractionTransaction.ts

@@ -30,6 +30,7 @@ export class InteractionTransaction extends SharedInteractionTransaction<Transac
         this.compiledTargetScript = this.calldataGenerator.compile(
             this.calldata,
             this.contractSecret,
+            this.preimage,
         );
 
         this.scriptTree = this.getScriptTree();

package/src/transaction/builders/SharedInteractionTransaction.ts

@@ -1,6 +1,6 @@
 import { address, Payment, Psbt, PsbtInput, Signer, Taptree, toXOnly } from '@btc-vision/bitcoin';
 import { ECPairInterface } from 'ecpair';
-import { TransactionBuilder } from './TransactionBuilder.js';
+import { MINIMUM_AMOUNT_CA, MINIMUM_AMOUNT_REWARD, TransactionBuilder } from './TransactionBuilder.js';
 import { TransactionType } from '../enums/TransactionType.js';
 import { CalldataGenerator } from '../../generators/builders/CalldataGenerator.js';
 import { SharedInteractionParameters } from '../interfaces/ITransactionParameters.js';
@@ -8,6 +8,7 @@ import { Compressor } from '../../bytecode/Compressor.js';
 import { EcKeyPair } from '../../keypair/EcKeyPair.js';
 import { BitcoinUtils } from '../../utils/BitcoinUtils.js';
 import { UnisatSigner } from '../browser/extensions/UnisatSigner.js';
+import { ChallengeGenerator, IMineableReward } from '../mineable/ChallengeGenerator.js';
 
 /**
  * Shared interaction transaction
@@ -30,6 +31,9 @@ export abstract class SharedInteractionTransaction<
     protected abstract readonly compiledTargetScript: Buffer;
     protected abstract readonly scriptTree: Taptree;
 
+    protected readonly preimage: Buffer; // ALWAYS 128 bytes for the preimage
+    protected readonly rewardChallenge: IMineableReward;
+
     protected calldataGenerator: CalldataGenerator;
 
     /**
@@ -63,7 +67,13 @@ export abstract class SharedInteractionTransaction<
             throw new Error('Calldata is required');
         }
 
+        this.preimage = parameters.preimage || BitcoinUtils.getSafeRandomValues(128);
+
         this.disableAutoRefund = parameters.disableAutoRefund || false;
+        this.rewardChallenge = ChallengeGenerator.generateMineableReward(
+            this.preimage,
+            this.network,
+        );
 
         this.calldata = Compressor.compress(parameters.calldata);
 
@@ -93,6 +103,13 @@ export abstract class SharedInteractionTransaction<
         return this.randomBytes;
     }
 
+    /**
+     * Get the preimage
+     */
+    public getPreimage(): Buffer {
+        return this.preimage;
+    }
+
     /**
      * Generate the secret for the interaction
      * @protected
@@ -134,8 +151,6 @@ export abstract class SharedInteractionTransaction<
      * @throws {Error} If the to address is required
      */
     protected override async buildTransaction(): Promise<void> {
-        if (!this.to) throw new Error('To address is required');
-
         const selectedRedeem = this.scriptSigner
             ? this.targetScriptRedeem
             : this.leftOverFundsScriptRedeem;
@@ -162,16 +177,7 @@ export abstract class SharedInteractionTransaction<
             this.addInputsFromUTXO();
         }
 
-        const amountSpent: bigint = this.getTransactionOPNetFee();
-        this.addOutput({
-            value: Number(amountSpent),
-            address: this.to,
-        });
-
-        const amount = this.addOptionalOutputsAndGetAmount();
-        if (!this.disableAutoRefund) {
-            await this.addRefundOutput(amountSpent + amount);
-        }
+        await this.createMineableRewardOutputs();
     }
 
     /**
@@ -236,7 +242,6 @@ export abstract class SharedInteractionTransaction<
 
         return [
             this.contractSecret,
-            this.internalPubKeyToXOnly(),
             input.tapScriptSig[0].signature,
             input.tapScriptSig[1].signature,
         ] as Buffer[];
@@ -311,6 +316,41 @@ export abstract class SharedInteractionTransaction<
         }
     }
 
+    private async createMineableRewardOutputs(): Promise<void> {
+        if (!this.to) throw new Error('To address is required');
+
+        const amountSpent: bigint = this.getTransactionOPNetFee();
+
+        let amountToCA: bigint;
+        if (amountSpent > MINIMUM_AMOUNT_REWARD + MINIMUM_AMOUNT_CA) {
+            amountToCA = MINIMUM_AMOUNT_CA;
+        } else {
+            amountToCA = amountSpent;
+        }
+
+        // ALWAYS THE FIRST INPUT.
+        this.addOutput({
+            value: Number(amountToCA),
+            address: this.to,
+        });
+
+        // ALWAYS SECOND.
+        if (
+            amountToCA === MINIMUM_AMOUNT_CA &&
+            amountSpent - MINIMUM_AMOUNT_CA > MINIMUM_AMOUNT_REWARD
+        ) {
+            this.addOutput({
+                value: Number(amountSpent - amountToCA),
+                address: this.rewardChallenge.address,
+            });
+        }
+
+        const amount = this.addOptionalOutputsAndGetAmount();
+        if (!this.disableAutoRefund) {
+            await this.addRefundOutput(amountSpent + amount);
+        }
+    }
+
     private async signInputsNonWalletBased(transaction: Psbt): Promise<void> {
         for (let i = 0; i < transaction.data.inputs.length; i++) {
             if (i === 0) {

package/src/transaction/builders/TransactionBuilder.ts

@@ -26,6 +26,9 @@ import { UnisatSigner } from '../browser/extensions/UnisatSigner.js';
 
 initEccLib(ecc);
 
+export const MINIMUM_AMOUNT_REWARD: bigint = 540n;
+export const MINIMUM_AMOUNT_CA: bigint = 330n;
+
 /**
  * Allows to build a transaction like you would on Ethereum.
  * @description The transaction builder class

package/src/transaction/enums/TransactionType.ts

@@ -3,8 +3,7 @@ export enum TransactionType {
     FUNDING = 1,
     DEPLOYMENT = 2,
     INTERACTION = 3,
-    WBTC_WRAP = 4,
-    WBTC_UNWRAP = 5,
-    MULTI_SIG = 6,
-    CUSTOM_CODE = 7,
+    MULTI_SIG = 4,
+    CUSTOM_CODE = 5,
+    CHALLENGE_SOLUTION = 6,
 }

package/src/transaction/interfaces/ITransactionParameters.ts

@@ -26,10 +26,17 @@ export interface IFundingTransactionParameters extends ITransactionParameters {
     splitInputsInto?: number;
 }
 
+export interface IChallengeSolutionTransactionParameters extends ITransactionParameters {
+    amount: bigint;
+
+    readonly challengeSolution: Buffer;
+}
+
 export interface SharedInteractionParameters extends ITransactionParameters {
     calldata?: Buffer;
     disableAutoRefund?: boolean;
 
+    readonly preimage?: Buffer;
     readonly randomBytes?: Buffer;
 }
 
@@ -39,24 +46,10 @@ export interface IInteractionParameters extends SharedInteractionParameters {
     readonly to: string;
 }
 
-/*export interface IWrapParameters extends Omit<SharedInteractionParameters, 'optionalOutputs'> {
-    readonly to?: string;
-    readonly from: string;
-
-    readonly amount: bigint;
-    readonly receiver?: Address;
-
-    readonly generationParameters: WrappedGeneration;
-}
-
-export interface IUnwrapParameters extends Omit<SharedInteractionParameters, 'optionalOutputs'> {
-    readonly unwrapUTXOs: VaultUTXOs[];
-    readonly amount: bigint;
-}*/
-
 export interface IDeploymentParameters extends Omit<ITransactionParameters, 'to'> {
     readonly bytecode: Buffer;
     readonly calldata?: Buffer;
 
     readonly randomBytes?: Buffer;
+    readonly preimage?: Buffer;
 }

package/src/transaction/mineable/ChallengeGenerator.ts

@@ -0,0 +1,39 @@
+import bitcoin, { Network } from '@btc-vision/bitcoin';
+import { MineableReward } from '../../generators/builders/MineableReward.js';
+
+export interface IMineableReward {
+    address: string;
+    p2shOutputScript: Buffer;
+    redeemScript: Buffer;
+}
+
+export class ChallengeGenerator {
+    public static generateMineableReward(preimage1: Buffer, network: Network): IMineableReward {
+        const mineableReward = new MineableReward(Buffer.alloc(0), network);
+        const redeemScript = mineableReward.compile(preimage1);
+        const p2sh = bitcoin.payments.p2sh({
+            redeem: { output: redeemScript },
+            network,
+        });
+
+        const outputRedeem: Buffer | undefined = p2sh.redeem?.output;
+        if (!outputRedeem) {
+            throw new Error('Output redeem is required');
+        }
+
+        if (!p2sh.address) {
+            throw new Error('P2SH address is required');
+        }
+
+        const p2shOutputScript: Buffer | undefined = p2sh?.redeem?.output;
+        if (!p2shOutputScript) {
+            throw new Error('No redeem output');
+        }
+
+        return {
+            address: p2sh.address,
+            p2shOutputScript,
+            redeemScript: redeemScript,
+        };
+    }
+}

package/src/transaction/shared/TweakedTransaction.ts

@@ -814,7 +814,7 @@ export abstract class TweakedTransaction extends Logger {
     } => {
         const inputDecoded = this.inputs[inputIndex];
         if (isP2SH && input.partialSig && inputDecoded && inputDecoded.redeemScript) {
-            const signatures = input.partialSig.map((sig) => sig.signature);
+            const signatures = input.partialSig.map((sig) => sig.signature) || [];
             const scriptSig = script.compile([...signatures, inputDecoded.redeemScript]);
 
             return {

package/src/utxo/interfaces/IUTXO.ts

@@ -1,4 +1,4 @@
-import { ScriptPubKey } from '@btc-vision/bsi-bitcoin-rpc';
+import { ScriptPubKey } from '@btc-vision/bitcoin-rpc';
 
 export interface UTXO {
     readonly transactionId: string;

package/src/verification/TapscriptVerificator.ts

@@ -9,13 +9,13 @@ import {
 } from '@btc-vision/bitcoin';
 import { DeploymentGenerator } from '../generators/builders/DeploymentGenerator.js';
 import { TransactionBuilder } from '../transaction/builders/TransactionBuilder.js';
-import { Address } from '../keypair/Address.js';
 
 export interface ContractAddressVerificationParams {
     readonly deployerPubKey: Buffer;
     readonly contractSaltPubKey: Buffer;
     readonly originalSalt: Buffer;
     readonly bytecode: Buffer;
+    readonly preimage: Buffer;
     readonly calldata?: Buffer;
     readonly network?: Network;
 }
@@ -36,6 +36,7 @@ export class TapscriptVerificator {
         const compiledTargetScript: Buffer = scriptBuilder.compile(
             params.bytecode,
             params.originalSalt,
+            params.preimage,
             params.calldata,
         );
 
@@ -67,6 +68,7 @@ export class TapscriptVerificator {
         const compiledTargetScript: Buffer = scriptBuilder.compile(
             params.bytecode,
             params.originalSalt,
+            params.preimage,
             params.calldata,
         );
 
@@ -112,23 +114,6 @@ export class TapscriptVerificator {
         return bitCrypto.hash256(buf);
     }
 
-    public static generateContractVirtualAddress(
-        deployerPubKey: Buffer,
-        bytecode: Buffer,
-        saltHash: Buffer,
-        network: Network = networks.bitcoin,
-    ): string {
-        const virtualAddress: Buffer = TapscriptVerificator.getContractSeed(
-            deployerPubKey,
-            bytecode,
-            saltHash,
-        );
-
-        const address = new Address(virtualAddress);
-
-        return address.p2tr(network);
-    }
-
     public static generateAddressFromScript(
         params: ContractAddressVerificationParams,
         scriptTree: Taptree,