@btc-vision/transaction 1.5.4 → 1.6.0

package/src/transaction/builders/DeploymentTransaction.ts

@@ -27,15 +27,18 @@ import { SharedInteractionTransaction } from './SharedInteractionTransaction.js'
 import { ECPairInterface } from 'ecpair';
 import { Address } from '../../keypair/Address.js';
 import { UnisatSigner } from '../browser/extensions/UnisatSigner.js';
-import { ChallengeGenerator, IMineableReward } from '../mineable/ChallengeGenerator.js';
+import { ITimeLockOutput, TimeLockGenerator } from '../mineable/TimelockGenerator.js';
+import { ChallengeSolution } from '../../epoch/ChallengeSolution.js';
+import { Feature, Features } from '../../generators/Features.js';
 
 export class DeploymentTransaction extends TransactionBuilder<TransactionType.DEPLOYMENT> {
     public static readonly MAXIMUM_CONTRACT_SIZE = 128 * 1024;
 
     public type: TransactionType.DEPLOYMENT = TransactionType.DEPLOYMENT;
 
-    protected readonly preimage: Buffer; // ALWAYS 128 bytes for the preimage
-    protected readonly rewardChallenge: IMineableReward;
+    protected readonly preimage: ChallengeSolution;
+    protected readonly epochChallenge: ITimeLockOutput;
+
     /**
      * The contract address
      * @protected
@@ -122,13 +125,13 @@ export class DeploymentTransaction extends TransactionBuilder<TransactionType.DE
             this.verifyCalldata();
         }
 
-        if (!parameters.preimage) throw new Error('Preimage is required');
+        if (!parameters.challenge) throw new Error('Challenge solution is required');
 
         this.randomBytes = parameters.randomBytes || BitcoinUtils.rndBytes();
-        this.preimage = parameters.preimage;
+        this.preimage = parameters.challenge;
 
-        this.rewardChallenge = ChallengeGenerator.generateMineableReward(
-            this.preimage,
+        this.epochChallenge = TimeLockGenerator.generateTimeLockAddress(
+            this.preimage.publicKey.originalPublicKeyBuffer(),
             this.network,
         );
 
@@ -147,6 +150,7 @@ export class DeploymentTransaction extends TransactionBuilder<TransactionType.DE
             this.preimage,
             this.priorityFee,
             this.calldata,
+            this.generateFeatures(parameters),
         );
 
         this.scriptTree = this.getScriptTree();
@@ -190,7 +194,7 @@ export class DeploymentTransaction extends TransactionBuilder<TransactionType.DE
      * Get the contract bytecode
      * @returns {Buffer} The contract bytecode
      */
-    public getPreimage(): Buffer {
+    public getPreimage(): ChallengeSolution {
         return this.preimage;
     }
 
@@ -271,7 +275,7 @@ export class DeploymentTransaction extends TransactionBuilder<TransactionType.DE
         ) {
             this.addOutput({
                 value: Number(amountSpent - amountToCA),
-                address: this.rewardChallenge.address,
+                address: this.epochChallenge.address,
             });
         }
 
@@ -376,6 +380,20 @@ export class DeploymentTransaction extends TransactionBuilder<TransactionType.DE
         };
     }
 
+    private generateFeatures(parameters: IDeploymentParameters): Feature<Features>[] {
+        const features: Feature<Features>[] = [];
+
+        const submission = parameters.challenge.getSubmission();
+        if (submission) {
+            features.push({
+                opcode: Features.EPOCH_SUBMISSION,
+                data: submission,
+            });
+        }
+
+        return features;
+    }
+
     private verifyCalldata(): void {
         if (
             this.calldata &&

package/src/transaction/builders/InteractionTransaction.ts

@@ -31,7 +31,7 @@ export class InteractionTransaction extends SharedInteractionTransaction<Transac
         }
 
         this.contractSecret = Buffer.from(parameters.contract.replace('0x', ''), 'hex');
-        
+
         if (this.contractSecret.length !== 32) {
             throw new Error('Invalid contract secret length. Expected 32 bytes.');
         }
@@ -39,7 +39,7 @@ export class InteractionTransaction extends SharedInteractionTransaction<Transac
         this.compiledTargetScript = this.calldataGenerator.compile(
             this.calldata,
             this.contractSecret,
-            this.preimage,
+            this.challenge,
             this.priorityFee,
             this.generateFeatures(parameters),
         );
@@ -58,6 +58,14 @@ export class InteractionTransaction extends SharedInteractionTransaction<Transac
             });
         }
 
+        const submission = parameters.challenge.getSubmission();
+        if (submission) {
+            features.push({
+                opcode: Features.EPOCH_SUBMISSION,
+                data: submission,
+            });
+        }
+
         return features;
     }
 }

package/src/transaction/builders/SharedInteractionTransaction.ts

@@ -8,7 +8,8 @@ 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';
+import { ITimeLockOutput, TimeLockGenerator } from '../mineable/TimelockGenerator.js';
+import { ChallengeSolution } from '../../epoch/ChallengeSolution.js';
 
 /**
  * Shared interaction transaction
@@ -31,8 +32,8 @@ 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 readonly challenge: ChallengeSolution;
+    protected readonly epochChallenge: ITimeLockOutput;
 
     protected calldataGenerator: CalldataGenerator;
 
@@ -67,15 +68,15 @@ export abstract class SharedInteractionTransaction<
             throw new Error('Calldata is required');
         }
 
-        if (!parameters.preimage) {
-            throw new Error('Preimage is required');
+        if (!parameters.challenge) {
+            throw new Error('Challenge solution is required');
         }
 
-        this.preimage = parameters.preimage;
+        this.challenge = parameters.challenge;
 
         this.disableAutoRefund = parameters.disableAutoRefund || false;
-        this.rewardChallenge = ChallengeGenerator.generateMineableReward(
-            this.preimage,
+        this.epochChallenge = TimeLockGenerator.generateTimeLockAddress(
+            this.challenge.publicKey.originalPublicKeyBuffer(),
             this.network,
         );
 
@@ -110,27 +111,10 @@ export abstract class SharedInteractionTransaction<
     /**
      * Get the preimage
      */
-    public getPreimage(): Buffer {
-        return this.preimage;
+    public getPreimage(): ChallengeSolution {
+        return this.challenge;
     }
 
-    /**
-     * Generate the secret for the interaction
-     * @protected
-     * @returns {Buffer} The secret
-     * @throws {Error} If the to address is invalid
-     */
-
-    /*protected generateSecret(): Buffer {
-        if (!this.to) throw new Error('To address is required');
-
-        if (this.to.startsWith('0x')) {
-            throw new Error(`Legacy not support at this time. Reserved for future use.`);
-        }
-
-        return address.fromBech32(this.to).data;
-    }*/
-
     /**
      * Get the internal pubkey as an x-only key
      * @protected
@@ -381,7 +365,7 @@ export abstract class SharedInteractionTransaction<
         ) {
             this.addOutput({
                 value: Number(amountSpent - amountToCA),
-                address: this.rewardChallenge.address,
+                address: this.epochChallenge.address,
             });
         }
 

package/src/transaction/builders/TransactionBuilder.ts

@@ -148,6 +148,8 @@ export abstract class TransactionBuilder<T extends TransactionType> extends Twea
      */
     protected isPubKeyDestination: boolean;
 
+    protected note?: Buffer;
+
     protected constructor(parameters: ITransactionParameters) {
         super(parameters);
 
@@ -164,6 +166,14 @@ export abstract class TransactionBuilder<T extends TransactionType> extends Twea
         this.optionalInputs = parameters.optionalInputs || [];
         this.to = parameters.to || undefined;
 
+        if (parameters.note) {
+            if (typeof parameters.note === 'string') {
+                this.note = Buffer.from(parameters.note, 'utf8');
+            } else {
+                this.note = parameters.note;
+            }
+        }
+
         this.isPubKeyDestination = this.to
             ? AddressVerificator.isValidPublicKey(this.to, this.network)
             : false;
@@ -228,6 +238,15 @@ export abstract class TransactionBuilder<T extends TransactionType> extends Twea
         return buffer;
     }
 
+    public addOPReturn(buffer: Buffer): void {
+        const compileScript = script.compile([opcodes.OP_RETURN, buffer]);
+
+        this.addOutput({
+            value: 0,
+            script: compileScript,
+        });
+    }
+
     public async getFundingTransactionParameters(): Promise<IFundingTransactionParameters> {
         if (!this.estimatedFees) {
             this.estimatedFees = await this.estimateTransactionFees();
@@ -368,8 +387,23 @@ export abstract class TransactionBuilder<T extends TransactionType> extends Twea
      * @returns {void}
      */
     public addOutput(output: PsbtOutputExtended): void {
-        if (output.value === 0) return;
-        if (output.value < TransactionBuilder.MINIMUM_DUST) {
+        if (output.value === 0) {
+            const script = output as {
+                script: Buffer;
+            };
+
+            if (!script.script || script.script.length === 0) {
+                throw new Error('Output value is 0 and no script provided');
+            }
+
+            if (script.script.length < 2) {
+                throw new Error('Output script is too short');
+            }
+
+            if (script.script[0] !== opcodes.OP_RETURN) {
+                throw new Error('Output script must start with OP_RETURN when value is 0');
+            }
+        } else if (output.value < TransactionBuilder.MINIMUM_DUST) {
             throw new Error(
                 `Output value is less than the minimum dust ${output.value} < ${TransactionBuilder.MINIMUM_DUST}`,
             );
@@ -479,6 +513,10 @@ export abstract class TransactionBuilder<T extends TransactionType> extends Twea
      * @returns {Promise<void>}
      */
     protected async addRefundOutput(amountSpent: bigint): Promise<void> {
+        if (this.note) {
+            this.addOPReturn(this.note);
+        }
+
         /** Add the refund output */
         const sendBackAmount: bigint = this.totalInputAmount - amountSpent;
         if (sendBackAmount >= TransactionBuilder.MINIMUM_DUST) {

package/src/transaction/interfaces/ITransactionParameters.ts

@@ -2,6 +2,7 @@ import { UTXO } from '../../utxo/interfaces/IUTXO.js';
 import { ITweakedTransactionData } from '../shared/TweakedTransaction.js';
 import { ChainId } from '../../network/ChainId.js';
 import { PsbtOutputExtended } from '@btc-vision/bitcoin';
+import { ChallengeSolution } from '../../epoch/ChallengeSolution.js';
 
 export interface LoadedStorage {
     [key: string]: string[];
@@ -22,6 +23,8 @@ export interface ITransactionParameters extends ITweakedTransactionData {
     chainId?: ChainId;
     noSignatures?: boolean;
 
+    readonly note?: string | Buffer;
+
     readonly feeRate: number;
     readonly priorityFee: bigint;
     readonly gasSatFee: bigint;
@@ -33,17 +36,11 @@ 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 challenge: ChallengeSolution;
     readonly randomBytes?: Buffer;
 
     readonly loadedStorage?: LoadedStorage;
@@ -61,5 +58,5 @@ export interface IDeploymentParameters extends Omit<ITransactionParameters, 'to'
     readonly calldata?: Buffer;
 
     readonly randomBytes?: Buffer;
-    readonly preimage: Buffer;
+    readonly challenge: ChallengeSolution;
 }

package/src/transaction/mineable/TimelockGenerator.ts

@@ -0,0 +1,42 @@
+import bitcoin, { Network, networks, opcodes, script } from '@btc-vision/bitcoin';
+
+export interface ITimeLockOutput {
+    address: string;
+    witnessScript: Buffer;
+}
+
+export class TimeLockGenerator {
+    private static readonly CSV_BLOCKS = 75;
+
+    /**
+     * Generate a P2WSH address with CSV timelock
+     * Note: This uses ECDSA, not Schnorr (Schnorr only available in Taproot)
+     */
+    public static generateTimeLockAddress(
+        publicKey: Buffer,
+        network: Network = networks.bitcoin,
+        csvBlocks: number = TimeLockGenerator.CSV_BLOCKS,
+    ): ITimeLockOutput {
+        const witnessScript = script.compile([
+            script.number.encode(csvBlocks),
+            opcodes.OP_CHECKSEQUENCEVERIFY,
+            opcodes.OP_DROP,
+            publicKey,
+            opcodes.OP_CHECKSIG,
+        ]);
+
+        const p2wsh = bitcoin.payments.p2wsh({
+            redeem: { output: witnessScript },
+            network,
+        });
+
+        if (!p2wsh.address) {
+            throw new Error('Failed to generate P2WSH address');
+        }
+
+        return {
+            address: p2wsh.address,
+            witnessScript: witnessScript,
+        };
+    }
+}

package/src/utils/StringToBuffer.ts

@@ -0,0 +1,3 @@
+export function stringToBuffer(str: string): Buffer {
+    return Buffer.from(str.replace('0x', ''), 'hex');
+}

package/src/verification/TapscriptVerificator.ts

@@ -9,14 +9,17 @@ import {
 } from '@btc-vision/bitcoin';
 import { DeploymentGenerator } from '../generators/builders/DeploymentGenerator.js';
 import { TransactionBuilder } from '../transaction/builders/TransactionBuilder.js';
+import { ChallengeSolution } from '../epoch/ChallengeSolution.js';
+import { Feature, Features } from '../generators/Features.js';
 
 export interface ContractAddressVerificationParams {
     readonly deployerPubKey: Buffer;
     readonly contractSaltPubKey: Buffer;
     readonly originalSalt: Buffer;
     readonly bytecode: Buffer;
-    readonly preimage: Buffer;
+    readonly challenge: ChallengeSolution;
     readonly priorityFee: bigint;
+    readonly features: Feature<Features>[];
     readonly calldata?: Buffer;
     readonly network?: Network;
 }
@@ -37,9 +40,10 @@ export class TapscriptVerificator {
         const compiledTargetScript: Buffer = scriptBuilder.compile(
             params.bytecode,
             params.originalSalt,
-            params.preimage,
+            params.challenge,
             params.priorityFee,
             params.calldata,
+            params.features,
         );
 
         const scriptTree: Taptree = [
@@ -70,9 +74,10 @@ export class TapscriptVerificator {
         const compiledTargetScript: Buffer = scriptBuilder.compile(
             params.bytecode,
             params.originalSalt,
-            params.preimage,
+            params.challenge,
             params.priorityFee,
             params.calldata,
+            params.features,
         );
 
         const scriptTree: Taptree = [
@@ -91,7 +96,6 @@ export class TapscriptVerificator {
             network: network,
             scriptTree: scriptTree,
             redeem: {
-                //pubkeys: [params.deployerPubKey, params.contractSaltPubKey],
                 output: compiledTargetScript,
                 redeemVersion: TapscriptVerificator.TAP_SCRIPT_VERSION,
             },

package/browser/generators/builders/MineableReward.d.ts

@@ -1,7 +0,0 @@
-import { Network } from '@btc-vision/bitcoin';
-import { Generator } from '../Generator.js';
-export declare class MineableReward extends Generator {
-    constructor(senderPubKey: Buffer, network?: Network);
-    compile(preimage1: Buffer): Buffer;
-    private isTestnet;
-}

package/browser/transaction/mineable/ChallengeGenerator.d.ts

@@ -1,9 +0,0 @@
-import { Network } from '@btc-vision/bitcoin';
-export interface IMineableReward {
-    address: string;
-    p2shOutputScript: Buffer;
-    redeemScript: Buffer;
-}
-export declare class ChallengeGenerator {
-    static generateMineableReward(preimage1: Buffer, network: Network): IMineableReward;
-}

package/build/generators/builders/MineableReward.d.ts

@@ -1,7 +0,0 @@
-import { Network } from '@btc-vision/bitcoin';
-import { Generator } from '../Generator.js';
-export declare class MineableReward extends Generator {
-    constructor(senderPubKey: Buffer, network?: Network);
-    compile(preimage1: Buffer): Buffer;
-    private isTestnet;
-}

package/build/generators/builders/MineableReward.js

@@ -1,48 +0,0 @@
-import { networks, opcodes, script } from '@btc-vision/bitcoin';
-import { Generator } from '../Generator.js';
-export class MineableReward extends Generator {
-    constructor(senderPubKey, network = networks.bitcoin) {
-        super(senderPubKey, Buffer.alloc(0), network);
-    }
-    compile(preimage1) {
-        let compiledData;
-        if (this.isTestnet()) {
-            compiledData = [
-                preimage1,
-                opcodes.OP_SHA1,
-                opcodes.OP_SHA1,
-                opcodes.OP_SWAP,
-                opcodes.OP_SHA1,
-                opcodes.OP_SHA1,
-                opcodes.OP_EQUAL,
-            ];
-        }
-        else {
-            compiledData = [
-                preimage1,
-                opcodes.OP_SWAP,
-                opcodes.OP_2DUP,
-                opcodes.OP_EQUAL,
-                opcodes.OP_NOT,
-                opcodes.OP_VERIFY,
-                opcodes.OP_SHA1,
-                opcodes.OP_SHA1,
-                opcodes.OP_SWAP,
-                opcodes.OP_SHA1,
-                opcodes.OP_SHA1,
-                opcodes.OP_EQUAL,
-            ];
-        }
-        const asm = compiledData.flat();
-        const compiled = script.compile(asm);
-        const decompiled = script.decompile(compiled);
-        if (!decompiled) {
-            throw new Error('Failed to decompile script??');
-        }
-        return compiled;
-    }
-    isTestnet() {
-        return (this.network.bech32 === networks.testnet.bech32 ||
-            this.network.bech32 === networks.regtest.bech32);
-    }
-}

package/build/transaction/mineable/ChallengeGenerator.d.ts

@@ -1,9 +0,0 @@
-import { Network } from '@btc-vision/bitcoin';
-export interface IMineableReward {
-    address: string;
-    p2shOutputScript: Buffer;
-    redeemScript: Buffer;
-}
-export declare class ChallengeGenerator {
-    static generateMineableReward(preimage1: Buffer, network: Network): IMineableReward;
-}

package/build/transaction/mineable/ChallengeGenerator.js

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

package/src/generators/builders/MineableReward.ts

@@ -1,66 +0,0 @@
-import { Network, networks, opcodes, script } from '@btc-vision/bitcoin';
-import { Generator } from '../Generator.js';
-
-/**
- * Class to generate bitcoin script for interaction transactions
- */
-export class MineableReward extends Generator {
-    constructor(senderPubKey: Buffer, network: Network = networks.bitcoin) {
-        super(senderPubKey, Buffer.alloc(0), network);
-    }
-
-    /**
-     * Compile an interaction bitcoin script
-     * @param {Buffer} preimage1 - Preimage 1
-     * @returns {Buffer} - The compiled script
-     * @throws {Error} - If something goes wrong
-     */
-    public compile(preimage1: Buffer): Buffer {
-        let compiledData: (number | Buffer)[];
-
-        if (this.isTestnet()) {
-            compiledData = [
-                preimage1,
-                opcodes.OP_SHA1,
-                opcodes.OP_SHA1,
-                opcodes.OP_SWAP,
-                opcodes.OP_SHA1,
-                opcodes.OP_SHA1,
-                opcodes.OP_EQUAL,
-            ];
-        } else {
-            compiledData = [
-                preimage1,
-                opcodes.OP_SWAP,
-                opcodes.OP_2DUP,
-                opcodes.OP_EQUAL,
-                opcodes.OP_NOT,
-                opcodes.OP_VERIFY,
-                opcodes.OP_SHA1,
-                opcodes.OP_SHA1,
-                opcodes.OP_SWAP,
-                opcodes.OP_SHA1,
-                opcodes.OP_SHA1,
-                opcodes.OP_EQUAL,
-            ];
-        }
-
-        const asm = compiledData.flat();
-        const compiled = script.compile(asm);
-
-        /** Verify the validity of the script */
-        const decompiled = script.decompile(compiled);
-        if (!decompiled) {
-            throw new Error('Failed to decompile script??');
-        }
-
-        return compiled;
-    }
-
-    private isTestnet(): boolean {
-        return (
-            this.network.bech32 === networks.testnet.bech32 ||
-            this.network.bech32 === networks.regtest.bech32
-        );
-    }
-}

package/src/transaction/mineable/ChallengeGenerator.ts

@@ -1,39 +0,0 @@
-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,
-        };
-    }
-}