@btc-vision/transaction 1.0.1 → 1.0.3

package/src/tests/transfer.ts

@@ -0,0 +1,102 @@
+import { wBTC } from '../metadata/contracts/wBTC.js';
+import { Wallet } from '../keypair/Wallet.js';
+import { Testnet } from './Regtest.js';
+import { UTXOManager } from '../utxo/UTXOManager.js';
+import { FetchUTXOParams, UTXO } from '../utxo/interfaces/IUTXO.js';
+import { IInteractionParameters } from '../transaction/interfaces/ITransactionParameters.js';
+import { networks } from 'bitcoinjs-lib';
+import { TransactionFactory } from '../transaction/TransactionFactory.js';
+import { BitcoinRPC } from '@btc-vision/bsi-bitcoin-rpc';
+import { ABICoder, BinaryWriter } from '@btc-vision/bsi-binary';
+
+const network: networks.Network = networks.testnet;
+const rpc: BitcoinRPC = new BitcoinRPC();
+const wBtc: wBTC = new wBTC(network);
+const wallet: Wallet = new Wallet(Testnet.wallet, network);
+
+const utxoManager: UTXOManager = new UTXOManager('https://testnet.opnet.org');
+const factory: TransactionFactory = new TransactionFactory();
+
+const abiCoder: ABICoder = new ABICoder();
+const transferSelector = Number(`0x` + abiCoder.encodeSelector('transfer'));
+
+function getTransferToCalldata(to: string, amount: bigint): Buffer {
+    const addCalldata: BinaryWriter = new BinaryWriter();
+    addCalldata.writeSelector(transferSelector);
+    addCalldata.writeAddress(to);
+    addCalldata.writeU256(amount);
+
+    return Buffer.from(addCalldata.getBuffer());
+}
+
+const shouldMineBlock: boolean = false;
+
+async function mineBlock(): Promise<boolean> {
+    // lets mine 1 block.
+    const ok = await rpc.generateToAddress(1, wallet.p2wpkh, 'default');
+    if (!ok) {
+        throw new Error('Could not mine block');
+    }
+
+    console.log(`Mined block`, ok);
+
+    return !!ok.length;
+}
+
+(async () => {
+    await rpc.init(Testnet.config);
+
+    const utxoSetting: FetchUTXOParams = {
+        address: wallet.p2wpkh,
+        minAmount: 10000n,
+        requestedAmount: 100000n,
+    };
+
+    const utxos: UTXO[] = await utxoManager.fetchUTXO(utxoSetting);
+    console.log(`UTXOs:`, utxos);
+
+    if (!utxos) {
+        throw new Error('No UTXOs found');
+    }
+
+    const calldata: Buffer = getTransferToCalldata(
+        'tb1pt3ncc5ktfzpry2uvnag06v3jkv4quvmdydf09q8fx6rkgd7f5s8q3aenuk',
+        5000000n,
+    );
+
+    const interactionParameters: IInteractionParameters = {
+        from: wallet.p2wpkh,
+        to: wBtc.getAddress(),
+        utxos: utxos,
+        signer: wallet.keypair,
+        network: network,
+        feeRate: 150,
+        priorityFee: 50000n,
+        calldata: calldata,
+    };
+
+    const finalTx = factory.signInteraction(interactionParameters);
+    const firstTxBroadcast = await rpc.sendRawTransaction({
+        hexstring: finalTx[0],
+    });
+
+    console.log(`First transaction broadcasted: ${firstTxBroadcast}`);
+
+    if (!firstTxBroadcast) {
+        throw new Error('Could not broadcast first transaction');
+    }
+
+    const secondTxBroadcast = await rpc.sendRawTransaction({
+        hexstring: finalTx[1],
+    });
+
+    console.log(`Second transaction broadcasted: ${secondTxBroadcast}`);
+
+    if (!secondTxBroadcast) {
+        throw new Error('Could not broadcast second transaction');
+    }
+
+    if (shouldMineBlock) {
+        await mineBlock();
+    }
+})();

package/src/transaction/builders/TransactionBuilder.ts

@@ -9,6 +9,7 @@ import { EcKeyPair } from '../../keypair/EcKeyPair.js';
 import { Address } from '@btc-vision/bsi-binary';
 import { UTXO } from '../../utxo/interfaces/IUTXO.js';
 import { ECPairInterface } from 'ecpair';
+import { Logger } from '@btc-vision/logger';
 
 /**
  * Allows to build a transaction like you would on Ethereum.
@@ -16,9 +17,13 @@ import { ECPairInterface } from 'ecpair';
  * @abstract
  * @class TransactionBuilder
  */
-export abstract class TransactionBuilder<T extends TransactionType> {
-    protected static readonly LOCK_LEAF_SCRIPT: Buffer = script.compile([opcodes.OP_0]);
-    protected static readonly MINIMUM_DUST: bigint = 330n;
+export abstract class TransactionBuilder<T extends TransactionType> extends Logger {
+    public static readonly LOCK_LEAF_SCRIPT: Buffer = script.compile([
+        opcodes.OP_0,
+        opcodes.OP_VERIFY,
+    ]);
+
+    public static readonly MINIMUM_DUST: bigint = 330n;
 
     public abstract readonly type: T;
     public readonly logColor: string = '#785def';
@@ -105,6 +110,8 @@ export abstract class TransactionBuilder<T extends TransactionType> {
      * @param {ITransactionParameters} parameters - The transaction parameters
      */
     protected constructor(parameters: ITransactionParameters) {
+        super();
+
         this.signer = parameters.signer;
         this.network = parameters.network;
         this.feeRate = parameters.feeRate;
@@ -277,7 +284,7 @@ export abstract class TransactionBuilder<T extends TransactionType> {
             return;
         }
 
-        console.warn(
+        this.warn(
             `Amount to send back is less than the minimum dust, will be consumed in fees instead.`,
         );
     }
@@ -568,7 +575,7 @@ export abstract class TransactionBuilder<T extends TransactionType> {
         } catch (e) {
             const err: Error = e as Error;
 
-            console.error(
+            this.error(
                 `[internalBuildTransaction] Something went wrong while getting building the transaction: ${err.stack}`,
             );
         }

package/src/verification/TapscriptVerificator.ts

@@ -0,0 +1,89 @@
+import bitcoin, { Network, networks, Payment, payments } from 'bitcoinjs-lib';
+import { toXOnly } from 'bitcoinjs-lib/src/psbt/bip371.js';
+import { Taptree } from 'bitcoinjs-lib/src/types.js';
+import { DeploymentGenerator } from '../generators/builders/DeploymentGenerator.js';
+import { TransactionBuilder } from '../transaction/builders/TransactionBuilder.js';
+import { AddressGenerator } from '../generators/AddressGenerator.js';
+
+export interface ContractAddressVerificationParams {
+    readonly deployerPubKeyXOnly: Buffer;
+    readonly contractSaltPubKey: Buffer;
+    readonly originalSalt: Buffer;
+    readonly bytecode: Buffer;
+    readonly network?: Network;
+}
+
+export class TapscriptVerificator {
+    private static readonly TAP_SCRIPT_VERSION: number = 192;
+
+    public static getContractAddress(
+        params: ContractAddressVerificationParams,
+    ): string | undefined {
+        const network = params.network || networks.bitcoin;
+        const scriptBuilder: DeploymentGenerator = new DeploymentGenerator(
+            params.deployerPubKeyXOnly,
+            toXOnly(params.contractSaltPubKey),
+            network,
+        );
+
+        const compiledTargetScript: Buffer = scriptBuilder.compile(
+            params.bytecode,
+            params.originalSalt,
+        );
+
+        const scriptTree: Taptree = [
+            {
+                output: compiledTargetScript,
+                version: TapscriptVerificator.TAP_SCRIPT_VERSION,
+            },
+            {
+                output: TransactionBuilder.LOCK_LEAF_SCRIPT,
+                version: TapscriptVerificator.TAP_SCRIPT_VERSION,
+            },
+        ];
+
+        return TapscriptVerificator.generateAddressFromScript(params, scriptTree);
+    }
+
+    public static getContractSeed(
+        deployerPubKey: Buffer,
+        bytecode: Buffer,
+        saltHash: Buffer,
+    ): Buffer {
+        const sha256OfBytecode: Buffer = bitcoin.crypto.hash256(bytecode);
+        const buf: Buffer = Buffer.concat([deployerPubKey, saltHash, sha256OfBytecode]);
+
+        return bitcoin.crypto.hash256(buf);
+    }
+
+    public static generateContractVirtualAddress(
+        deployerPubKey: Buffer,
+        bytecode: Buffer,
+        saltHash: Buffer,
+        network: Network = networks.bitcoin,
+    ): string {
+        const virtualAddress: Buffer = TapscriptVerificator.getContractSeed(
+            deployerPubKey,
+            bytecode,
+            saltHash,
+        );
+
+        return AddressGenerator.generatePKSH(virtualAddress, network);
+    }
+
+    public static generateAddressFromScript(
+        params: ContractAddressVerificationParams,
+        scriptTree: Taptree,
+    ): string | undefined {
+        const network = params.network || networks.bitcoin;
+
+        const transactionData: Payment = {
+            internalPubkey: params.deployerPubKeyXOnly,
+            network: network,
+            scriptTree: scriptTree,
+        };
+
+        const tx: Payment = payments.p2tr(transactionData);
+        return tx.address;
+    }
+}

package/tests/TransactionBuilder.test.ts

@@ -1,58 +1,58 @@
-import 'jest';
-import { Regtest } from '../src/tests/Regtest.js';
-import { Logger } from '@btc-vision/logger';
-import { networks } from 'bitcoinjs-lib';
-import {
-    FetchUTXOParams,
-    IInteractionParameters,
-    TransactionFactory,
-    UTXO,
-    UTXOManager,
-    Wallet,
-    wBTC,
-} from '../src/index.js';
-
-const logger: Logger = new Logger();
-const network: networks.Network = networks.regtest;
-
-describe('Transaction Builder', () => {
-    const wBtc: wBTC = new wBTC(network);
-
-    const wallet: Wallet = new Wallet(Regtest.wallet, network);
-    logger.log(`Loaded wallet: ${wallet.p2tr} - ${wallet.p2wpkh}`);
-
-    const utxoManager: UTXOManager = new UTXOManager('http://localhost:9001');
-    const factory: TransactionFactory = new TransactionFactory();
-
-    /** @test {TransactionBuilder#build} */
-    test('should be able to build a transaction', async () => {
-        const utxoSetting: FetchUTXOParams = {
-            address: wallet.p2wpkh,
-            minAmount: 10000n,
-            requestedAmount: 100000n,
-        };
-
-        const utxos: UTXO[] = await utxoManager.fetchUTXO(utxoSetting);
-        console.log(`UTXOs:`, utxos);
-
-        if (!utxos) {
-            throw new Error('No UTXOs found');
-        }
-
-        logger.log(`UTXOs fetched. Count: ${utxos.length}`);
-
-        const interactionParameters: IInteractionParameters = {
-            from: wallet.p2wpkh,
-            to: wBtc.getAddress(),
-            utxos: utxos,
-            signer: wallet.keypair,
-            network: network,
-            feeRate: 150,
-            priorityFee: 500n,
-            calldata: Buffer.from('test'),
-        };
-
-        const finalTx = factory.signInteraction(interactionParameters);
-        console.log(`Transaction:`, finalTx);
-    });
-});
+import 'jest';
+import { Regtest } from '../src/tests/Regtest.js';
+import { Logger } from '@btc-vision/logger';
+import { networks } from 'bitcoinjs-lib';
+import {
+    FetchUTXOParams,
+    IInteractionParameters,
+    TransactionFactory,
+    UTXO,
+    UTXOManager,
+    Wallet,
+    wBTC,
+} from '../src/index.js';
+
+const logger: Logger = new Logger();
+const network: networks.Network = networks.regtest;
+
+describe('Transaction Builder', () => {
+    const wBtc: wBTC = new wBTC(network);
+
+    const wallet: Wallet = new Wallet(Regtest.wallet, network);
+    logger.log(`Loaded wallet: ${wallet.p2tr} - ${wallet.p2wpkh}`);
+
+    const utxoManager: UTXOManager = new UTXOManager('http://localhost:9001');
+    const factory: TransactionFactory = new TransactionFactory();
+
+    /** @test {TransactionBuilder#build} */
+    test('should be able to build a transaction', async () => {
+        const utxoSetting: FetchUTXOParams = {
+            address: wallet.p2wpkh,
+            minAmount: 10000n,
+            requestedAmount: 100000n,
+        };
+
+        const utxos: UTXO[] = await utxoManager.fetchUTXO(utxoSetting);
+        console.log(`UTXOs:`, utxos);
+
+        if (!utxos) {
+            throw new Error('No UTXOs found');
+        }
+
+        logger.log(`UTXOs fetched. Count: ${utxos.length}`);
+
+        const interactionParameters: IInteractionParameters = {
+            from: wallet.p2wpkh,
+            to: wBtc.getAddress(),
+            utxos: utxos,
+            signer: wallet.keypair,
+            network: network,
+            feeRate: 150,
+            priorityFee: 500n,
+            calldata: Buffer.from('test'),
+        };
+
+        const finalTx = factory.signInteraction(interactionParameters);
+        console.log(`Transaction:`, finalTx);
+    });
+});

package/tsconfig.webpack.json

@@ -6,6 +6,14 @@
         "target": "esnext",
         "declaration": true,
         "esModuleInterop": true,
+        "skipLibCheck": true,
+        "strict": true,
+        "baseUrl": ".",
+        "paths": {
+            "@btc-vision/logger": [
+                "node_modules/@btc-vision/logger"
+            ]
+        },
         "moduleResolution": "bundler"
     }
 }