@btc-vision/transaction 1.0.123 → 1.1.0

package/{src/wbtc/Generate.ts → wbtc_disabled/Generate.ts.disabled}

@@ -1,4 +1,4 @@
-import { VaultUTXOs } from '../transaction/processor/PsbtTransaction.js';
+import { VaultUTXOs } from '../src/transaction/processor/PsbtTransaction.js';
 
 export interface GenerationConstraints {
     /** Timestamp of the generation */

package/{src/wbtc/UnwrapGeneration.ts → wbtc_disabled/UnwrapGeneration.ts.disabled}

@@ -1,5 +1,5 @@
 import { UnwrappedGenerationParameters } from './Generate.js';
-import { VaultUTXOs } from '../transaction/processor/PsbtTransaction.js';
+import { VaultUTXOs } from '../src/transaction/processor/PsbtTransaction.js';
 
 export class UnwrapGeneration implements Omit<UnwrappedGenerationParameters, 'balance'> {
     public readonly vaultUTXOs: VaultUTXOs[];

package/browser/metadata/contracts/wBTC.d.ts

@@ -1,13 +0,0 @@
-import { Network } from '@btc-vision/bitcoin';
-import { ChainId } from '../../network/ChainId.js';
-import { ContractBaseMetadata } from '../ContractBaseMetadata.js';
-export declare class wBTC extends ContractBaseMetadata {
-    protected network: Network;
-    readonly tokenName: string;
-    readonly tokenSymbol: string;
-    readonly decimals: number;
-    protected readonly address: string;
-    constructor(network?: Network, chainId?: ChainId);
-    static getAddress(network?: Network, chainId?: ChainId): string;
-    private static getWBTCAddressForChain;
-}

package/browser/transaction/builders/UnwrapSegwitTransaction.d.ts

@@ -1,32 +0,0 @@
-import { Taptree } from '@btc-vision/bitcoin/src/types.js';
-import { TransactionType } from '../enums/TransactionType.js';
-import { IUnwrapParameters } from '../interfaces/ITransactionParameters.js';
-import { SharedInteractionTransaction } from './SharedInteractionTransaction.js';
-import { Psbt } from '@btc-vision/bitcoin';
-import { VaultUTXOs } from '../processor/PsbtTransaction.js';
-export declare class UnwrapSegwitTransaction extends SharedInteractionTransaction<TransactionType.WBTC_UNWRAP> {
-    private static readonly UNWRAP_SELECTOR;
-    type: TransactionType.WBTC_UNWRAP;
-    readonly amount: bigint;
-    protected readonly compiledTargetScript: Buffer;
-    protected readonly scriptTree: Taptree;
-    protected sighashTypes: number[];
-    protected readonly contractSecret: Buffer;
-    protected readonly vaultUTXOs: VaultUTXOs[];
-    private readonly wbtc;
-    private readonly calculatedSignHash;
-    constructor(parameters: IUnwrapParameters);
-    static generateBurnCalldata(amount: bigint): Buffer;
-    signPSBT(): Promise<Psbt>;
-    mergeVaults(input: VaultUTXOs[]): Promise<void>;
-    protected internalBuildTransaction(transaction: Psbt, checkPartialSigs?: boolean): Promise<boolean>;
-    protected generateMultiSignRedeemScript(publicKeys: string[], minimum: number): {
-        witnessUtxo: Buffer;
-        redeemScript: Buffer;
-        witnessScript: Buffer;
-    };
-    private addVaultUTXO;
-    private addVaultInputs;
-    private calculateOutputLeftAmountFromVaults;
-    private getVaultTotalOutputAmount;
-}

package/browser/transaction/builders/UnwrapTransaction.d.ts

@@ -1,41 +0,0 @@
-import { Taptree } from '@btc-vision/bitcoin/src/types.js';
-import { TransactionType } from '../enums/TransactionType.js';
-import { IUnwrapParameters } from '../interfaces/ITransactionParameters.js';
-import { SharedInteractionTransaction } from './SharedInteractionTransaction.js';
-import { Network, Payment, Psbt, PsbtInput } from '@btc-vision/bitcoin';
-import { VaultUTXOs } from '../processor/PsbtTransaction.js';
-export declare class UnwrapTransaction extends SharedInteractionTransaction<TransactionType.WBTC_UNWRAP> {
-    private static readonly UNWRAP_SELECTOR;
-    type: TransactionType.WBTC_UNWRAP;
-    readonly amount: bigint;
-    protected readonly compiledTargetScript: Buffer;
-    protected readonly scriptTree: Taptree;
-    protected sighashTypes: number[];
-    protected readonly contractSecret: Buffer;
-    protected readonly vaultUTXOs: VaultUTXOs[];
-    protected readonly estimatedFeeLoss: bigint;
-    private readonly wbtc;
-    private readonly calculatedSignHash;
-    constructor(parameters: IUnwrapParameters);
-    static generateBurnCalldata(amount: bigint): Buffer;
-    signPSBT(): Promise<Psbt>;
-    getRefund(): bigint;
-    getFeeLossOrRefund(): bigint;
-    protected mergeVaults(): void;
-    protected calculateNumEmptyWitnesses(vault: VaultUTXOs[]): bigint;
-    protected calculateNumSignatures(vault: VaultUTXOs[]): bigint;
-    protected calculateNumInputs(vault: VaultUTXOs[]): bigint;
-    protected internalPubKeyToXOnly(): Buffer;
-    protected generateTapDataForInput(pubkeys: Buffer[], minimumSignatures: number): {
-        internalPubkey: Buffer;
-        network: Network;
-        scriptTree: Taptree;
-        redeem: Payment;
-    };
-    protected getScriptSolution(input: PsbtInput): Buffer[];
-    protected internalBuildTransaction(transaction: Psbt, checkPartialSigs?: boolean): Promise<boolean>;
-    private addVaultUTXO;
-    private addVaultInputs;
-    private calculateOutputLeftAmountFromVaults;
-    private getVaultTotalOutputAmount;
-}

package/browser/transaction/builders/WrapTransaction.d.ts

@@ -1,29 +0,0 @@
-import { Taptree } from '@btc-vision/bitcoin/src/types.js';
-import { TransactionType } from '../enums/TransactionType.js';
-import { TapLeafScript } from '../interfaces/Tap.js';
-import { IWrapParameters } from '../interfaces/ITransactionParameters.js';
-import { SharedInteractionTransaction } from './SharedInteractionTransaction.js';
-import { WrappedGeneration } from '../../wbtc/WrappedGenerationParameters.js';
-import { Address } from '../../keypair/Address.js';
-export declare class WrapTransaction extends SharedInteractionTransaction<TransactionType.WBTC_WRAP> {
-    private static readonly WRAP_SELECTOR;
-    type: TransactionType.WBTC_WRAP;
-    readonly vault: string;
-    readonly amount: bigint;
-    readonly receiver: Address;
-    protected readonly compiledTargetScript: Buffer;
-    protected readonly scriptTree: Taptree;
-    protected tapLeafScript: TapLeafScript | null;
-    protected readonly contractSecret: Buffer;
-    protected readonly interactionPubKeys: Buffer[];
-    protected readonly minimumSignatures: number;
-    private readonly wbtc;
-    constructor(parameters: IWrapParameters);
-    private static generateMintCalldata;
-    verifyPublicKeysConstraints(generation: WrappedGeneration): boolean;
-    protected buildTransaction(): Promise<void>;
-    private verifyRequiredValue;
-    private addVaultOutput;
-    private generateVaultAddress;
-    private generateChecksumSalt;
-}

package/browser/wbtc/Generate.d.ts

@@ -1,18 +0,0 @@
-import { VaultUTXOs } from '../transaction/processor/PsbtTransaction.js';
-export interface GenerationConstraints {
-    readonly timestamp: number;
-    readonly version: string;
-    readonly minimum: number;
-    readonly transactionMinimum: number;
-}
-export interface WrappedGenerationParameters {
-    readonly keys: string[];
-    readonly vault: string;
-    readonly entities: string[];
-    readonly signature: string;
-    readonly constraints: GenerationConstraints;
-}
-export interface UnwrappedGenerationParameters {
-    readonly vaultUTXOs: VaultUTXOs[];
-    readonly balance: string;
-}

package/browser/wbtc/UnwrapGeneration.d.ts

@@ -1,7 +0,0 @@
-import { UnwrappedGenerationParameters } from './Generate.js';
-import { VaultUTXOs } from '../transaction/processor/PsbtTransaction.js';
-export declare class UnwrapGeneration implements Omit<UnwrappedGenerationParameters, 'balance'> {
-    readonly vaultUTXOs: VaultUTXOs[];
-    readonly balance: bigint;
-    constructor(params: UnwrappedGenerationParameters);
-}

package/browser/wbtc/WrappedGenerationParameters.d.ts

@@ -1,10 +0,0 @@
-import { GenerationConstraints, WrappedGenerationParameters } from './Generate.js';
-export declare class WrappedGeneration implements WrappedGenerationParameters {
-    readonly constraints: GenerationConstraints;
-    readonly entities: string[];
-    readonly keys: string[];
-    readonly signature: string;
-    readonly vault: string;
-    readonly pubKeys: Buffer[];
-    constructor(params: WrappedGenerationParameters);
-}

package/build/metadata/contracts/wBTC.d.ts

@@ -1,13 +0,0 @@
-import { Network } from '@btc-vision/bitcoin';
-import { ChainId } from '../../network/ChainId.js';
-import { ContractBaseMetadata } from '../ContractBaseMetadata.js';
-export declare class wBTC extends ContractBaseMetadata {
-    protected network: Network;
-    readonly tokenName: string;
-    readonly tokenSymbol: string;
-    readonly decimals: number;
-    protected readonly address: string;
-    constructor(network?: Network, chainId?: ChainId);
-    static getAddress(network?: Network, chainId?: ChainId): string;
-    private static getWBTCAddressForChain;
-}

package/build/metadata/contracts/wBTC.js

@@ -1,34 +0,0 @@
-import { networks } from '@btc-vision/bitcoin';
-import { ChainId } from '../../network/ChainId.js';
-import { ContractBaseMetadata } from '../ContractBaseMetadata.js';
-import { WBTC_ADDRESS_FRACTAL, WBTC_ADDRESS_REGTEST, WBTC_ADDRESS_TESTNET } from '../tokens.js';
-export class wBTC extends ContractBaseMetadata {
-    constructor(network = networks.bitcoin, chainId = ChainId.Bitcoin) {
-        super(network);
-        this.network = network;
-        this.tokenName = 'Wrapped Bitcoin';
-        this.tokenSymbol = 'wBTC';
-        this.decimals = 8;
-        this.address = wBTC.getAddress(network, chainId);
-    }
-    static getAddress(network = networks.bitcoin, chainId) {
-        switch (network.bech32) {
-            case networks.bitcoin.bech32:
-                return this.getWBTCAddressForChain(chainId ?? ChainId.Bitcoin).p2tr(network);
-            case networks.regtest.bech32:
-                return WBTC_ADDRESS_REGTEST.p2tr(network);
-            case networks.testnet.bech32:
-                return WBTC_ADDRESS_TESTNET.p2tr(network);
-            default:
-                throw new Error(`Invalid network: ${network.bech32}`);
-        }
-    }
-    static getWBTCAddressForChain(chainId) {
-        switch (chainId) {
-            case ChainId.Fractal:
-                return WBTC_ADDRESS_FRACTAL;
-            default:
-                throw new Error(`Unsupported chainId: ${chainId}`);
-        }
-    }
-}

package/build/transaction/builders/UnwrapSegwitTransaction.d.ts

@@ -1,32 +0,0 @@
-import { Taptree } from '@btc-vision/bitcoin/src/types.js';
-import { TransactionType } from '../enums/TransactionType.js';
-import { IUnwrapParameters } from '../interfaces/ITransactionParameters.js';
-import { SharedInteractionTransaction } from './SharedInteractionTransaction.js';
-import { Psbt } from '@btc-vision/bitcoin';
-import { VaultUTXOs } from '../processor/PsbtTransaction.js';
-export declare class UnwrapSegwitTransaction extends SharedInteractionTransaction<TransactionType.WBTC_UNWRAP> {
-    private static readonly UNWRAP_SELECTOR;
-    type: TransactionType.WBTC_UNWRAP;
-    readonly amount: bigint;
-    protected readonly compiledTargetScript: Buffer;
-    protected readonly scriptTree: Taptree;
-    protected sighashTypes: number[];
-    protected readonly contractSecret: Buffer;
-    protected readonly vaultUTXOs: VaultUTXOs[];
-    private readonly wbtc;
-    private readonly calculatedSignHash;
-    constructor(parameters: IUnwrapParameters);
-    static generateBurnCalldata(amount: bigint): Buffer;
-    signPSBT(): Promise<Psbt>;
-    mergeVaults(input: VaultUTXOs[]): Promise<void>;
-    protected internalBuildTransaction(transaction: Psbt, checkPartialSigs?: boolean): Promise<boolean>;
-    protected generateMultiSignRedeemScript(publicKeys: string[], minimum: number): {
-        witnessUtxo: Buffer;
-        redeemScript: Buffer;
-        witnessScript: Buffer;
-    };
-    private addVaultUTXO;
-    private addVaultInputs;
-    private calculateOutputLeftAmountFromVaults;
-    private getVaultTotalOutputAmount;
-}

package/build/transaction/builders/UnwrapSegwitTransaction.js

@@ -1,179 +0,0 @@
-import { TransactionType } from '../enums/TransactionType.js';
-import { SharedInteractionTransaction } from './SharedInteractionTransaction.js';
-import { TransactionBuilder } from './TransactionBuilder.js';
-import { wBTC } from '../../metadata/contracts/wBTC.js';
-import { payments } from '@btc-vision/bitcoin';
-import { EcKeyPair } from '../../keypair/EcKeyPair.js';
-import { PsbtTransaction } from '../processor/PsbtTransaction.js';
-import { currentConsensusConfig } from '../../consensus/ConsensusConfig.js';
-import { ABICoder } from '../../abi/ABICoder.js';
-import { BinaryWriter } from '../../buffer/BinaryWriter.js';
-const abiCoder = new ABICoder();
-export class UnwrapSegwitTransaction extends SharedInteractionTransaction {
-    constructor(parameters) {
-        if (parameters.amount < TransactionBuilder.MINIMUM_DUST) {
-            throw new Error('Amount is below dust limit');
-        }
-        parameters.disableAutoRefund = true;
-        parameters.calldata = UnwrapSegwitTransaction.generateBurnCalldata(parameters.amount);
-        super(parameters);
-        this.type = TransactionType.WBTC_UNWRAP;
-        this.sighashTypes = [];
-        this.calculatedSignHash = PsbtTransaction.calculateSignHash(this.sighashTypes);
-        this.wbtc = new wBTC(parameters.network, parameters.chainId);
-        this.to = this.wbtc.getAddress();
-        this.vaultUTXOs = parameters.unwrapUTXOs;
-        this.amount = parameters.amount;
-        this.contractSecret = this.generateSecret();
-        this.compiledTargetScript = this.calldataGenerator.compile(this.calldata, this.contractSecret);
-        this.scriptTree = this.getScriptTree();
-        this.internalInit();
-    }
-    static generateBurnCalldata(amount) {
-        if (!amount)
-            throw new Error('Amount is required');
-        const bufWriter = new BinaryWriter();
-        bufWriter.writeSelector(UnwrapSegwitTransaction.UNWRAP_SELECTOR);
-        bufWriter.writeU256(amount);
-        return Buffer.from(bufWriter.getBuffer());
-    }
-    async signPSBT() {
-        if (this.to && !EcKeyPair.verifyContractAddress(this.to, this.network)) {
-            throw new Error('Invalid contract address. The contract address must be a taproot address.');
-        }
-        if (!this.vaultUTXOs.length) {
-            throw new Error('No vault UTXOs provided');
-        }
-        if (this.signed)
-            throw new Error('Transaction is already signed');
-        this.signed = true;
-        await this.buildTransaction();
-        this.ignoreSignatureError();
-        await this.mergeVaults(this.vaultUTXOs);
-        const builtTx = await this.internalBuildTransaction(this.transaction);
-        if (builtTx) {
-            return this.transaction;
-        }
-        throw new Error('Could not sign transaction');
-    }
-    async mergeVaults(input) {
-        const firstVault = input[0];
-        if (!firstVault) {
-            throw new Error('No vaults provided');
-        }
-        const total = this.getVaultTotalOutputAmount(input);
-        if (total < this.amount) {
-            throw new Error(`Total vault amount (${total} sat) is less than the amount to unwrap (${this.amount} sat)`);
-        }
-        const outputLeftAmount = this.calculateOutputLeftAmountFromVaults(input);
-        if (outputLeftAmount < currentConsensusConfig.VAULT_MINIMUM_AMOUNT &&
-            outputLeftAmount !== currentConsensusConfig.UNWRAP_CONSOLIDATION_PREPAID_FEES_SAT) {
-            throw new Error(`Output left amount is below minimum consolidation (${currentConsensusConfig.VAULT_MINIMUM_AMOUNT} sat) amount ${outputLeftAmount} for vault ${firstVault.vault}`);
-        }
-        this.addOutput({
-            address: firstVault.vault,
-            value: Number(outputLeftAmount),
-        });
-        this.addOutput({
-            address: this.from,
-            value: Number(this.amount),
-        });
-        for (const vault of input) {
-            await this.addVaultInputs(vault);
-        }
-    }
-    async internalBuildTransaction(transaction, checkPartialSigs = false) {
-        if (transaction.data.inputs.length === 0) {
-            const inputs = this.getInputs();
-            const outputs = this.getOutputs();
-            transaction.setMaximumFeeRate(this._maximumFeeRate);
-            transaction.addInputs(inputs, checkPartialSigs);
-            for (let i = 0; i < this.updateInputs.length; i++) {
-                transaction.updateInput(i, this.updateInputs[i]);
-            }
-            transaction.addOutputs(outputs);
-        }
-        try {
-            await this.signInputs(transaction);
-            if (this.finalized) {
-                this.transactionFee = BigInt(transaction.getFee());
-            }
-            return true;
-        }
-        catch (e) {
-            const err = e;
-            this.error(`[internalBuildTransaction] Something went wrong while getting building the transaction: ${err.stack}`);
-        }
-        return false;
-    }
-    generateMultiSignRedeemScript(publicKeys, minimum) {
-        const p2ms = payments.p2ms({
-            m: minimum,
-            pubkeys: publicKeys.map((key) => Buffer.from(key, 'base64')),
-            network: this.network,
-        });
-        const p2wsh = payments.p2wsh({
-            redeem: p2ms,
-            network: this.network,
-        });
-        const witnessUtxo = p2wsh.output;
-        const redeemScript = p2wsh.redeem?.output;
-        const witnessScript = p2ms.output;
-        if (!witnessUtxo || !redeemScript || !witnessScript) {
-            throw new Error('Failed to generate redeem script');
-        }
-        return {
-            witnessUtxo,
-            redeemScript,
-            witnessScript,
-        };
-    }
-    addVaultUTXO(utxo, witness) {
-        const input = {
-            hash: utxo.hash,
-            index: utxo.outputIndex,
-            witnessUtxo: {
-                script: Buffer.from(utxo.output, 'base64'),
-                value: Number(utxo.value),
-            },
-            witnessScript: witness.witnessScript,
-            sequence: this.sequence,
-        };
-        if (this.calculatedSignHash) {
-            input.sighashType = this.calculatedSignHash;
-        }
-        this.addInput(input);
-    }
-    async addVaultInputs(vault, firstSigner = this.signer) {
-        const p2wshOutput = this.generateMultiSignRedeemScript(vault.publicKeys, vault.minimum);
-        for (const utxo of vault.utxos) {
-            const inputIndex = this.transaction.inputCount;
-            this.addVaultUTXO(utxo, p2wshOutput);
-            if (firstSigner) {
-                try {
-                    await this.signInput(this.transaction, this.transaction.data.inputs[inputIndex], inputIndex, this.signer);
-                    this.log(`Signed input ${inputIndex} with ${firstSigner.publicKey.toString('hex')}`);
-                }
-                catch (e) {
-                    if (!this.ignoreSignatureErrors) {
-                        this.warn(`Failed to sign input ${inputIndex} with ${firstSigner.publicKey.toString('hex')} ${e.message}`);
-                    }
-                }
-            }
-        }
-    }
-    calculateOutputLeftAmountFromVaults(vaults) {
-        const total = this.getVaultTotalOutputAmount(vaults);
-        return total - this.amount;
-    }
-    getVaultTotalOutputAmount(vaults) {
-        let total = BigInt(0);
-        for (const vault of vaults) {
-            for (const utxo of vault.utxos) {
-                total += BigInt(utxo.value);
-            }
-        }
-        return total;
-    }
-}
-UnwrapSegwitTransaction.UNWRAP_SELECTOR = Number('0x' + abiCoder.encodeSelector('burn'));

package/build/transaction/builders/UnwrapTransaction.d.ts

@@ -1,41 +0,0 @@
-import { Taptree } from '@btc-vision/bitcoin/src/types.js';
-import { TransactionType } from '../enums/TransactionType.js';
-import { IUnwrapParameters } from '../interfaces/ITransactionParameters.js';
-import { SharedInteractionTransaction } from './SharedInteractionTransaction.js';
-import { Network, Payment, Psbt, PsbtInput } from '@btc-vision/bitcoin';
-import { VaultUTXOs } from '../processor/PsbtTransaction.js';
-export declare class UnwrapTransaction extends SharedInteractionTransaction<TransactionType.WBTC_UNWRAP> {
-    private static readonly UNWRAP_SELECTOR;
-    type: TransactionType.WBTC_UNWRAP;
-    readonly amount: bigint;
-    protected readonly compiledTargetScript: Buffer;
-    protected readonly scriptTree: Taptree;
-    protected sighashTypes: number[];
-    protected readonly contractSecret: Buffer;
-    protected readonly vaultUTXOs: VaultUTXOs[];
-    protected readonly estimatedFeeLoss: bigint;
-    private readonly wbtc;
-    private readonly calculatedSignHash;
-    constructor(parameters: IUnwrapParameters);
-    static generateBurnCalldata(amount: bigint): Buffer;
-    signPSBT(): Promise<Psbt>;
-    getRefund(): bigint;
-    getFeeLossOrRefund(): bigint;
-    protected mergeVaults(): void;
-    protected calculateNumEmptyWitnesses(vault: VaultUTXOs[]): bigint;
-    protected calculateNumSignatures(vault: VaultUTXOs[]): bigint;
-    protected calculateNumInputs(vault: VaultUTXOs[]): bigint;
-    protected internalPubKeyToXOnly(): Buffer;
-    protected generateTapDataForInput(pubkeys: Buffer[], minimumSignatures: number): {
-        internalPubkey: Buffer;
-        network: Network;
-        scriptTree: Taptree;
-        redeem: Payment;
-    };
-    protected getScriptSolution(input: PsbtInput): Buffer[];
-    protected internalBuildTransaction(transaction: Psbt, checkPartialSigs?: boolean): Promise<boolean>;
-    private addVaultUTXO;
-    private addVaultInputs;
-    private calculateOutputLeftAmountFromVaults;
-    private getVaultTotalOutputAmount;
-}