@btc-vision/transaction 1.0.97 → 1.0.100

package/examples/Deploy.md

@@ -1,188 +0,0 @@
-# Deploying a Smart Contract on OPNet
-
-WARNING: POSSIBLY OUTDATED
-
-This guide will walk you through the process of deploying a smart contract on the OPNet protocol. OPNet allows for the
-execution of smart contracts on the Bitcoin network, leveraging the security and stability of Bitcoin.
-
-## Prerequisites
-
-- Node.js and npm installed
-- Bitcoin regtest wallet
-- Access to an OPNet node
-- Bitcoin RPC configured for regtest
-- Contract bytecode in WebAssembly format
-
-## Setup
-
-First, ensure you have the necessary dependencies installed in your project:
-
-```sh
-npm i
-```
-
-## Step-by-Step Guide
-
-### 1. Import Required Libraries
-
-```typescript
-import { Wallet } from '../keypair/Wallet.js';
-import { OPNetLimitedProvider } from '../utxo/OPNetLimitedProvider.js';
-import { networks, Network } from 'bitcoinjs-lib';
-import { TransactionFactory } from '../transaction/TransactionFactory.js';
-import { BitcoinRPC } from '@btc-vision/bsi-bitcoin-rpc';
-import { IDeploymentParameters } from '../transaction/interfaces/ITransactionParameters.js';
-import { FetchUTXOParams, UTXO } from '../utxo/interfaces/IUTXO.js';
-import * as fs from 'fs';
-```
-
-### Setting Up configurations
-
-We must provide the necessary configurations for the network, wallet, and RPC connection:
-
-- The opnetNode variable is the URL of the OP_NET node.
-- The Testnet variable contains the wallet address, public key, and private key.
-- The config variable inside the testnet object contains the network, host, port, username, and password for the RPC
-  connection.
-
-```typescript
-const network: Network = networks.testnet;
-const opnetNode: string = 'https://testnet.opnet.org';
-const Testnet: NetworkInformation = {
-    wallet: {
-        address: '', // as BECH32
-        publicKey: '', // as HEX
-        privateKey: '', // as WIF
-    },
-
-    config: {
-        BITCOIND_NETWORK: BitcoinNetwork.TestNet, // Bitcoin network
-        BITCOIND_HOST: '', // Bitcoin RPC host
-        BITCOIND_PORT: 9242, // Bitcoin RPC port
-
-        BITCOIND_USERNAME: '', // Bitcoin RPC username
-        BITCOIND_PASSWORD: '', // Bitcoin RPC password
-    },
-};
-```
-
-### 2. Initialize Network and RPC
-
-```typescript
-const rpc: BitcoinRPC = new BitcoinRPC();
-const wallet: Wallet = new Wallet(Testnet.wallet, network);
-```
-
-### 3. Connect to OPNet
-
-```typescript
-const utxoManager: OPNetLimitedProvider = new OPNetLimitedProvider(opnetNode);
-const factory: TransactionFactory = new TransactionFactory();
-```
-
-### 4. Mining a Block (Optional)
-
-If you are using a regtest or need to mine a block to proceed:
-
-```typescript
-const shouldMineBlock: boolean = true;
-
-async function mineBlock(): Promise<boolean> {
-    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;
-}
-```
-
-### 5. Initialize RPC with Testnet Configuration
-
-```typescript
-await rpc.init(Testnet.config);
-```
-
-### 6. Define UTXO Settings and Fetch UTXOs
-
-```typescript
-const utxoSetting: FetchUTXOParams = {
-    address: wallet.p2wpkh,
-    minAmount: 10000n,
-    requestedAmount: 100000n,
-};
-
-const utxos: UTXO[] = await utxoManager.fetchUTXO(utxoSetting);
-if (!utxos) {
-    throw new Error('No UTXOs found');
-}
-```
-
-### 7. Read Contract Bytecode
-
-```typescript
-const bytecode = fs.readFileSync('./bytecode/contract.wasm');
-```
-
-### 8. Create Deployment Parameters and Finalize Transaction
-
-Let's create the deployment parameters and finalize the transaction:
-
-```typescript
-const deploymentParameters: IDeploymentParameters = {
-    from: wallet.p2wpkh,
-    utxos: utxos,
-    signer: wallet.keypair,
-    network: network,
-    feeRate: 150,
-    priorityFee: 50000n,
-    bytecode: bytecode,
-};
-
-const finalTx = factory.signDeployment(deploymentParameters);
-console.log(`Final transaction:`, finalTx);
-```
-
-### 9. Broadcast the Transactions
-
-Broadcast the transactions to the network:
-
-```typescript
-const firstTxBroadcast = await rpc.sendRawTransaction({
-    hexstring: finalTx.transaction[0],
-});
-
-console.log(`First transaction broadcasted: ${firstTxBroadcast}`);
-
-if (!firstTxBroadcast) {
-    throw new Error('Could not broadcast first transaction');
-}
-
-const secondTxBroadcast = await rpc.sendRawTransaction({
-    hexstring: finalTx.transaction[1],
-});
-
-console.log(`Second transaction broadcasted: ${secondTxBroadcast}`);
-
-if (!secondTxBroadcast) {
-    throw new Error('Could not broadcast second transaction');
-}
-```
-
-### 10. (Optional) Mine a Block
-
-If you need to mine a block after broadcasting the transactions:
-
-```typescript
-if (shouldMineBlock) {
-    await mineBlock();
-}
-```
-
-## Conclusion
-
-You have now successfully deployed a smart contract on the OPNet protocol. This contract can interact with the Bitcoin
-network, enabling complex functionalities and decentralized applications.
-
-For any further questions or issues, please refer to the official documentation or reach out to the community for
-support.

package/examples/Unwrap.md

@@ -1,165 +0,0 @@
-# Unwrapping wBTC Guide
-
-WARNING: POSSIBLY OUTDATED
-
-This guide will walk you through the process of unwrapping wBTC (Wrapped Bitcoin) using the OPNet protocol. Unwrapping
-wBTC converts it back into regular Bitcoin, enabling you to use it directly on the Bitcoin network.
-
-## What is Unwrapping?
-
-Unwrapping wBTC involves converting your wrapped tokens back into Bitcoin. This process ensures that the wBTC you hold
-is exchanged for an equivalent amount of Bitcoin, maintaining a 1:1 ratio. This allows you to move seamlessly between
-using Bitcoin in decentralized applications and holding it in its original form.
-
-## Preview
-
-You can check your wBTC balance at any time via [wbtc.opnet.org](https://wbtc.opnet.org).
-
-## Prerequisites
-
-- Node.js and npm installed
-- Bitcoin testnet wallet
-- Access to an OPNet node
-- Bitcoin RPC configured for testnet
-
-## Setup
-
-First, ensure you have the necessary dependencies installed in your project:
-
-```sh
-npm i
-```
-
-## Step-by-Step Guide
-
-### 1. Import Required Libraries
-
-```typescript
-import { Wallet } from '../keypair/Wallet.js';
-import { OPNetLimitedProvider } from '../utxo/OPNetLimitedProvider.js';
-import { networks, Network } from 'bitcoinjs-lib';
-import { TransactionFactory } from '../transaction/TransactionFactory.js';
-import { IUnwrapParameters } from '../transaction/interfaces/ITransactionParameters.js';
-import { FetchUTXOParams, UTXO } from '../utxo/interfaces/IUTXO.js';
-import { UnwrapTransaction } from '../transaction/UnwrapTransaction.js';
-```
-
-### Setting Up Configurations
-
-We must provide the necessary configurations for the network and wallet:
-
-- The opnetNode variable is the URL of the OPNet node.
-- The Testnet variable contains the wallet address, public key, and private key.
-
-```typescript
-const network: Network = networks.testnet;
-const opnetNode: string = 'https://testnet.opnet.org';
-```
-
-### 2. Load Wallet
-
-```typescript
-const wallet: Wallet = new Wallet(Testnet.wallet, network);
-```
-
-### 3. Connect to OPNet
-
-```typescript
-const opnet: OPNetLimitedProvider = new OPNetLimitedProvider(opnetNode);
-const factory: TransactionFactory = new TransactionFactory();
-```
-
-### 4. Initialize RPC with Testnet Configuration
-
-```typescript
-await rpc.init(Testnet.config);
-```
-
-### 5. Define Unwrap Amount and Fetch UTXOs
-
-We must define the amount to unwrap and fetch the UTXOs required for the transaction. Each OPNet vaults have UTXOs. We
-need to fetch these UTXOs to unwrap the wBTC. We request an opnet node for the most optimized UTXOs to unwrap the wBTC.
-If the UTXOs used to unwrap the wBTC do not follow the OPNet consensus rules, the unwrapping request will be denied.
-
-```typescript
-const unwrapAmount: bigint = UnwrapTransaction.MINIMUM_CONSOLIDATION_AMOUNT; // Minimum amount to unwrap
-const unwrapUtxos = await opnet.fetchUnWrapParameters(unwrapAmount, wallet.p2tr);
-if (!unwrapUtxos) {
-    throw new Error('No vault UTXOs or something went wrong. Please try again.');
-}
-
-const utxoSetting: FetchUTXOParams = {
-    address: wallet.p2wpkh,
-    minAmount: 10000n,
-    requestedAmount: unwrapAmount,
-};
-
-const utxos: UTXO[] = await opnet.fetchUTXO(utxoSetting);
-if (!utxos) {
-    throw new Error('No UTXOs found');
-}
-```
-
-### 6. Create Unwrap Parameters and Finalize Transaction
-
-Now, we will create the unwrap parameters and finalize the transaction using the TransactionFactory.
-
-```typescript
-const unwrapParameters: IUnwrapParameters = {
-    from: wallet.p2tr, // Address to unwrap
-    utxos: utxos, // User UTXOs to spend
-    unwrapUTXOs: unwrapUtxos.vaultUTXOs, // Vault UTXOs to unwrap
-    signer: wallet.keypair, // Signer
-    network: network, // Bitcoin network
-    feeRate: 100, // Fee rate in satoshis per byte (bitcoin fee)
-    priorityFee: 10000n, // OPNet priority fee (incl gas.)
-    amount: unwrapAmount, // Amount to unwrap
-};
-
-try {
-    const finalTx = await factory.unwrap(unwrapParameters);
-    console.log(`Due to bitcoin fees, you will lose ${finalTx.unwrapFeeLoss} satoshis by unwrapping. Do you want to proceed?`);
-    console.log(`Final transaction:`, finalTx);
-} catch (e) {
-    console.error(`Something went wrong:`, e);
-}
-```
-
-### 7. Broadcast the Transactions
-
-To broadcast the transactions, we will send the raw transactions to the network.
-
-```typescript
-try {
-    // If this transaction is missing, opnet will deny the unwrapping request.
-    const fundingTransaction = await opnet.broadcastTransaction(finalTx.fundingTransaction, false);
-    console.log(`Broadcasted:`, fundingTransaction);
-
-    // This transaction is partially signed. You can not submit it to the Bitcoin network. It must pass via the OPNet network.
-    const unwrapTransaction = await opnet.broadcastTransaction(finalTx.psbt, true);
-    console.log(`Broadcasted:`, unwrapTransaction);
-} catch (e) {
-    console.error(`Error:`, e);
-}
-```
-
-### 8. Mining a Block (Optional, for Regtest)
-
-If you are using a regtest or need to mine a block to proceed:
-
-```typescript
-const shouldMineBlock: boolean = true;
-
-async function mineBlock(): Promise<boolean> {
-    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;
-}
-```
-
-## Conclusion
-
-You have now successfully unwrapped wBTC into Bitcoin using OPNet!

package/examples/Wrap.md

@@ -1,194 +0,0 @@
-# Wrapping Bitcoin (wBTC) Guide
-
-WARNING: POSSIBLY OUTDATED
-
-This guide will walk you through the process of wrapping Bitcoin (wBTC) using the OPNet protocol. Wrapping Bitcoin
-allows you to use Bitcoin in smart contracts, similar to how ERC-20 tokens are used on Ethereum.
-
-## What is wBTC?
-
-wBTC (Wrapped Bitcoin) is an OP_0 token backed 1:1 with Bitcoin. It enables Bitcoin holders
-to participate in decentralized finance (DeFi) applications, offering greater liquidity and integration within the
-Bitcoin ecosystem. By wrapping Bitcoin, users can leverage their BTC in a broader range of financial services while
-retaining the value and stability of Bitcoin.
-
-## Preview
-
-You can check your wBTC balance at anytime via [wbtc.opnet.org](https://wbtc.opnet.org).
-
-## Prerequisites
-
-- Node.js and npm installed
-- Bitcoin testnet wallet
-- Access to an OPNet node
-- Bitcoin RPC configured for testnet
-
-## Setup
-
-First, ensure you have the necessary dependencies installed in your project:
-
-```sh
-npm i
-```
-
-## Step-by-Step Guide
-
-### 1. Import Required Libraries
-
-```typescript
-import { Wallet } from '../keypair/Wallet.js';
-import { OPNetLimitedProvider } from '../utxo/OPNetLimitedProvider.js';
-import { networks, Network } from 'bitcoinjs-lib';
-import { TransactionFactory } from '../transaction/TransactionFactory.js';
-import { BitcoinRPC } from '@btc-vision/bsi-bitcoin-rpc';
-import { IWrapParameters } from '../transaction/interfaces/ITransactionParameters.js';
-import { FetchUTXOParams, UTXO } from '../utxo/interfaces/IUTXO.js';
-```
-
-### Setting Up configurations
-
-We must provide the necessary configurations for the network, wallet, and RPC connection:
-
-- The opnetNode variable is the URL of the OP_NET node.
-- The Testnet variable contains the wallet address, public key, and private key.
-- The config variable inside the testnet object contains the network, host, port, username, and password for the RPC
-  connection.
-
-```typescript
-const network: Network = networks.testnet;
-const opnetNode: string = 'https://testnet.opnet.org';
-const Testnet: NetworkInformation = {
-    wallet: {
-        address: '', // as BECH32
-        publicKey: '', // as HEX
-        privateKey: '', // as WIF
-    },
-
-    config: {
-        BITCOIND_NETWORK: BitcoinNetwork.TestNet, // Bitcoin network
-        BITCOIND_HOST: '', // Bitcoin RPC host
-        BITCOIND_PORT: 9242, // Bitcoin RPC port
-
-        BITCOIND_USERNAME: '', // Bitcoin RPC username
-        BITCOIND_PASSWORD: '', // Bitcoin RPC password
-    },
-};
-```
-
-### 2. Initialize Network and RPC
-
-```typescript
-const rpc: BitcoinRPC = new BitcoinRPC();
-const wallet: Wallet = new Wallet(Testnet.wallet, network);
-```
-
-### 3. Connect to OPNet
-
-```typescript
-const opnet: OPNetLimitedProvider = new OPNetLimitedProvider(opnetNode);
-const factory: TransactionFactory = new TransactionFactory();
-```
-
-### 4. Mining a Block (Optional)
-
-If you are using a regtest or need to mine a block to proceed:
-
-```typescript
-const shouldMineBlock: boolean = true;
-
-async function mineBlock(): Promise<boolean> {
-    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;
-}
-```
-
-### 5. Initialize RPC with Testnet Configuration
-
-```typescript
-await rpc.init(Testnet.config);
-```
-
-### 6. Define Wrap Amount and Fetch UTXOs
-
-```typescript
-const wrapAmount: bigint = 100000000n; // 1 BTC in satoshis
-const utxoSetting: FetchUTXOParams = {
-    address: wallet.p2wpkh,
-    minAmount: 10000n,
-    requestedAmount: wrapAmount,
-};
-
-const utxos: UTXO[] = await opnet.fetchUTXO(utxoSetting);
-if (!utxos) {
-    throw new Error('No UTXOs found');
-}
-```
-
-### 7. Fetch Wrap Parameters
-
-This will fetch the parameters required for wrapping Bitcoin into WBTC. If no parameters are found, an error will be
-thrown.
-This step is very important as it provides the necessary information for the wrapping process.
-
-```typescript
-const generationParameters = await opnet.fetchWrapParameters(wrapAmount);
-if (!generationParameters) {
-    throw new Error('No generation parameters found');
-}
-```
-
-### 8. Create Wrap Parameters and Finalize Transaction
-
-Now, we will create the wrap parameters and finalize the transaction using the TransactionFactory.
-
-```typescript
-const wrapParameters: IWrapParameters = {
-    from: wallet.p2wpkh,
-    utxos: utxos,
-    signer: wallet.keypair,
-    network: network,
-    feeRate: 350,
-    priorityFee: 50000n,
-    amount: wrapAmount,
-    generationParameters: generationParameters,
-};
-
-const finalTx = factory.wrap(wrapParameters);
-console.log(`Final transaction:`, finalTx);
-```
-
-### 9. Broadcast the Transactions
-
-To broadcast the transactions, we will send the raw transactions to the network.
-
-```typescript
-const firstTxBroadcast = await rpc.sendRawTransaction({
-    hexstring: finalTx.transaction[0],
-});
-
-console.log(`First transaction broadcasted: ${firstTxBroadcast}`);
-
-if (!firstTxBroadcast) {
-    throw new Error('Could not broadcast first transaction');
-}
-
-const secondTxBroadcast = await rpc.sendRawTransaction({
-    hexstring: finalTx.transaction[1],
-});
-
-console.log(`Second transaction broadcasted: ${secondTxBroadcast}`);
-
-if (!secondTxBroadcast) {
-    throw new Error('Could not broadcast second transaction');
-}
-```
-
-## Conclusion
-
-You have now successfully wrapped Bitcoin into WBTC using the OPNet protocol!
-For any further questions or issues, please refer to the official documentation or reach out to the community for
-support.

package/tsconfig.cjs.json

@@ -1,13 +0,0 @@
-{
-    "extends": "./tsconfig.base.json",
-    "compilerOptions": {
-        "module": "CommonJS",
-        "outDir": "cjs",
-        "esModuleInterop": true,
-        "target": "esnext"
-    },
-    "exclude": [
-        "src/tests/**/*",
-        "src/tests/*"
-    ]
-}