@btc-vision/transaction 1.0.89 → 1.0.91

package/README.md

@@ -50,6 +50,8 @@ of the repository.
 
 ## Deployments, Wrapping and Unwrapping
 
+WARNING: POSSIBLY OUTDATED
+
 To learn how to wrap and unwrap Bitcoin on OP_NET, please refer to
 the [Wrap.md](https://github.com/btc-vision/transaction/blob/main/Wrap.md) guide.
 
@@ -61,158 +63,7 @@ the [Deploy.md](https://github.com/btc-vision/transaction/blob/main/Deploy.md) g
 
 ## Usage
 
-Here's a basic example of how to use the OP_NET Transaction Builder library to create and sign a transaction:
-The following example demonstrates how to create a wBTC transfer transaction.
-
-### Import Statements
-
-This section imports the necessary modules and libraries required for building and broadcasting transactions.
-
-```typescript
-import {
-    TransactionFactory,
-    IInteractionParameters,
-    FetchUTXOParams,
-    UTXO,
-    UTXOManager,
-    Wallet,
-    wBTC
-} from '@btc-vision/transaction';
-import { networks } from 'bitcoinjs-lib';
-import { BitcoinRPC } from '@btc-vision/bsi-bitcoin-rpc';
-import { ABICoder, BinaryWriter } from '@btc-vision/bsi-binary';
-import { BitcoinNetwork } from '@btc-vision/bsi-common';
-```
-
-### 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 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
-    },
-};
-```
-
-### Setting Up the Network and RPC
-
-This section sets up the network, RPC, and wallet instances required for the transaction.
-
-```typescript
-// Set up the network, RPC, and wallet
-const network: networks.Network = networks.testnet; // Network
-const rpc: BitcoinRPC = new BitcoinRPC();
-const wBtc: wBTC = new wBTC(network); // wBTC metadata
-
-const wallet: Wallet = new Wallet(Regtest.wallet, network); // Wallet
-const utxoManager: UTXOManager = new UTXOManager(opnetNode); // UTXO manager
-
-const factory: TransactionFactory = new TransactionFactory(); // Transaction factory
-const abiCoder: ABICoder = new ABICoder();
-const transferSelector = Number(`0x` + abiCoder.encodeSelector('transfer')); // Selector for the transfer function
-```
-
-### Creating Transfer Calldata
-
-This section demonstrates how to create the calldata required for the `transfer` function.
-
-```typescript
-// Function to create the transfer calldata
-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());
-}
-```
-
-### Initializing and Fetching UTXOs
-
-This section initializes the RPC connection and fetches UTXOs for the wallet.
-
-```typescript
-
-await rpc.init(Testnet.config); // Initialize the RPC connection
-
-// Fetch UTXOs for the wallet
-const utxoSetting: FetchUTXOParams = {
-    address: wallet.p2wpkh,
-    minAmount: 10000n,
-    requestedAmount: 100000n,
-};
-
-const utxos: UTXO[] = await utxoManager.fetchUTXO(utxoSetting);
-console.log(`UTXOs:`, utxos);
-
-if (!utxos.length) {
-    throw new Error('No UTXOs found');
-}
-```
-
-### Preparing and Signing the Transaction
-
-This section prepares the interaction parameters and signs the transaction.
-
-```typescript
-// Prepare the interaction parameters for the transaction
-const amountToSend: bigint = 5000000n; // Amount to send
-const calldata: Buffer = getTransferToCalldata(wBtc.getAddress(), amountToSend);
-const interactionParameters: IInteractionParameters = {
-    from: wallet.p2wpkh, // From address
-    to: wBtc.getAddress(), // To address
-    utxos: utxos, // UTXOs
-    signer: wallet.keypair, // Signer
-    network: network, // Network
-    feeRate: 150, // Fee rate (satoshi per byte)
-    priorityFee: 50000n, // Priority fee (opnet)
-    calldata: calldata, // Calldata
-};
-
-// Sign and broadcast the transaction
-const finalTx = factory.signInteraction(interactionParameters);
-```
-
-### Broadcasting the Transaction
-
-This section broadcasts the signed transaction to the network.
-
-```typescript
-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');
-}
-```
-
-That's it! You have successfully created and broadcasted a transaction using OP_NET.
+OUTDATED EXAMPLE. New examples will be added soon.
 
 ## Contribution
 

package/browser/_version.d.ts

@@ -1 +1 @@
-export declare const version = "1.0.89";
+export declare const version = "1.0.91";