@btc-vision/transaction 1.0.0

package/.babelrc

@@ -0,0 +1,7 @@
+{
+    "sourceType": "module",
+    "presets": [
+        "@babel/preset-react",
+        "@babel/preset-env"
+    ]
+}

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/.github/workflows/node.js.yml

@@ -0,0 +1,22 @@
+name: Build Package CI
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  publish-gpr:
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: 21.7.1
+        registry-url: https://npm.pkg.github.com/
+        scope: '@btc-vision'
+    - run: npm install
+    - run: npm run build
+    - run: npm publish
+    env:
+      NODE_AUTH_TOKEN: ${{secrets.BuildToken}}
+      NPM_TOKEN: ${{secrets.NpmToken}}

package/.idea/codeStyles/Project.xml

@@ -0,0 +1,56 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <HTMLCodeStyleSettings>
+      <option name="HTML_SPACE_INSIDE_EMPTY_TAG" value="true" />
+    </HTMLCodeStyleSettings>
+    <JSCodeStyleSettings version="0">
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
+      <option name="USE_DOUBLE_QUOTES" value="false" />
+      <option name="FORCE_QUOTE_STYlE" value="true" />
+      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
+      <option name="USE_EXPLICIT_JS_EXTENSION" value="TRUE" />
+      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
+      <option name="SPACES_WITHIN_IMPORTS" value="true" />
+    </JSCodeStyleSettings>
+    <TypeScriptCodeStyleSettings version="0">
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
+      <option name="USE_DOUBLE_QUOTES" value="false" />
+      <option name="FORCE_QUOTE_STYlE" value="true" />
+      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
+      <option name="USE_EXPLICIT_JS_EXTENSION" value="TRUE" />
+      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
+      <option name="SPACES_WITHIN_IMPORTS" value="true" />
+    </TypeScriptCodeStyleSettings>
+    <VueCodeStyleSettings>
+      <option name="INTERPOLATION_NEW_LINE_AFTER_START_DELIMITER" value="false" />
+      <option name="INTERPOLATION_NEW_LINE_BEFORE_END_DELIMITER" value="false" />
+    </VueCodeStyleSettings>
+    <codeStyleSettings language="HTML">
+      <option name="SOFT_MARGINS" value="100" />
+      <indentOptions>
+        <option name="CONTINUATION_INDENT_SIZE" value="4" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="JSON">
+      <indentOptions>
+        <option name="INDENT_SIZE" value="4" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="JavaScript">
+      <option name="KEEP_BLANK_LINES_IN_CODE" value="4" />
+      <option name="SOFT_MARGINS" value="100" />
+    </codeStyleSettings>
+    <codeStyleSettings language="TypeScript">
+      <option name="SOFT_MARGINS" value="100" />
+    </codeStyleSettings>
+    <codeStyleSettings language="Vue">
+      <option name="SOFT_MARGINS" value="100" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="4" />
+        <option name="TAB_SIZE" value="4" />
+      </indentOptions>
+    </codeStyleSettings>
+  </code_scheme>
+</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/jsLibraryMappings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptLibraryMappings">
+    <includedPredefinedLibrary name="Node.js Core" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/transaction.iml" filepath="$PROJECT_DIR$/.idea/transaction.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/prettier.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="PrettierConfiguration">
+    <option name="myConfigurationMode" value="AUTOMATIC" />
+  </component>
+</project>

package/.idea/transaction.iml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/browser" />
+      <excludeFolder url="file://$MODULE_DIR$/build" />
+      <excludeFolder url="file://$MODULE_DIR$/cjs" />
+      <excludeFolder url="file://$MODULE_DIR$/docs" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/.prettierrc.json

@@ -0,0 +1,12 @@
+{
+    "printWidth": 100,
+    "trailingComma": "all",
+    "tabWidth": 4,
+    "semi": true,
+    "singleQuote": true,
+    "quoteProps": "as-needed",
+    "bracketSpacing": true,
+    "bracketSameLine": true,
+    "arrowParens": "always",
+    "singleAttributePerLine": true
+}

package/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing Guidelines
+
+Thank you for considering contributing to our project! Please take a moment to
+review the following guidelines before submitting your contribution.
+
+## Pull Requests
+
+When submitting a pull request, please make sure to follow these guidelines:
+
+### Before You Begin
+
+1. **Fork the repository**: If you haven't already, fork the repository to your
+   GitHub account.
+
+2. **Create a new branch**: Create a new branch for your feature or bug fix.
+   This helps keep the main branch clean and makes it easier to review your
+   changes.
+
+3. **Ensure your code is up-to-date**: Before starting work, make sure your
+   forked repository is up-to-date with the latest changes from the main
+   repository.
+
+### Making Changes
+
+1. **Follow coding conventions**: Make sure your code follows the existing
+   coding style and conventions used in the project.
+
+2. **Write descriptive commit messages**: Write clear and descriptive commit
+   messages that explain the purpose of your changes.
+
+3. **Test your changes**: Before submitting your pull request, make sure to test
+   your changes thoroughly to ensure they work as expected.
+
+### Submitting the Pull Request
+
+1. **Create a descriptive title**: Use a clear and descriptive title for your
+   pull request that summarizes the purpose of your changes.
+
+2. **Provide a detailed description**: Include a detailed description of the
+   changes you've made and any relevant context that reviewers should know.
+
+3. **Link related issues**: If your pull request addresses a specific issue,
+   make sure to reference it in the description using GitHub's issue linking
+   syntax (`#issue_number`).
+
+4. **Review and address feedback**: Be responsive to any feedback or comments
+   you receive on your pull request and make any necessary changes.
+
+## Issues
+
+When submitting an issue, please provide as much information as possible to help
+us understand and address the problem. Follow these guidelines when creating an
+issue:
+
+1. **Use a descriptive title**: Use a clear and descriptive title that
+   summarizes the issue you're experiencing.
+
+2. **Provide detailed steps to reproduce**: Include detailed steps to reproduce
+   the issue, including any relevant code or configuration.
+
+3. **Include relevant information**: Provide any relevant information such as
+   error messages, screenshots, or logs that can help diagnose the problem.
+
+4. **Specify your environment**: If the issue is related to a specific
+   environment (e.g., operating system, browser), please specify it in your
+   issue description.
+
+5. **Check for existing issues**: Before submitting a new issue, please check if
+   a similar issue has already been reported to avoid duplicates.
+
+Thank you for your contributions!

package/LICENSE.md

@@ -0,0 +1,16 @@
+MIT License
+
+Copyright (c) 2024-2025 to the user BlobMaster41 on GitHub
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,213 @@
+# OPNet - Transaction Builder
+
+![Bitcoin](https://img.shields.io/badge/Bitcoin-000?style=for-the-badge&logo=bitcoin&logoColor=white)
+![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
+![NodeJS](https://img.shields.io/badge/Node%20js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)
+![NPM](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)
+![Gulp](https://img.shields.io/badge/GULP-%23CF4647.svg?style=for-the-badge&logo=gulp&logoColor=white)
+![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white)
+
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+## Introduction
+
+The OPNet Transaction Builder library allows you to create and sign transactions for the OPNet network. Written in
+TypeScript, this library provides a comprehensive set of functions to facilitate the creation, reading, and manipulation
+of OPNet transactions, smart contracts, and other OPNet-related technologies.
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js version 16.x or higher
+- npm (Node Package Manager)
+
+### Installation
+
+```shell
+npm i @btc-vision/transaction
+```
+
+### Documentation
+
+Documentation is available at [https://transaction.opnet.org](https://transaction.opnet.org) or in the `docs/` directory
+of the repository.
+
+#### Development
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/btc-vision/transaction.git
+   ```
+2. Navigate to the repository directory:
+   ```bash
+   cd transaction
+   ```
+3. Install the required dependencies:
+   ```bash
+   npm i
+   ```
+
+## Usage
+
+Here's a basic example of how to use the OPNet 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';
+```
+
+### Setting Up configurations
+
+We must provide the necessary configurations for the network, wallet, and RPC connection:
+
+- The opnetNode variable is the URL of the OPNet 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 OPNet.
+
+## Contribution
+
+Contributions are welcome! Please read through the `CONTRIBUTING.md` file for guidelines on how to submit issues,
+feature requests, and pull requests. We appreciate your input and encourage you to help us improve OPNet.
+
+## License
+
+This project is open source and available under the [MIT License](LICENSE). If you have any suggestions or
+contributions, please feel free to submit a pull request.

package/browser/_version.d.ts

@@ -0,0 +1 @@
+export declare const version = "1.0.0";

package/browser/bytecode/Compressor.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+export declare class Compressor {
+    private static readonly zlibOptions;
+    static compress(data: Uint8Array | Buffer): Buffer;
+    static decompress(data: Uint8Array | Buffer): Buffer;
+}

package/browser/crypto/crypto-browser.d.ts

@@ -0,0 +1,40 @@
+export function createHash(algo: any): import("@noble/hashes/utils").Hash<{
+    A: number;
+    B: number;
+    C: number;
+    D: number;
+    E: number;
+    F: number;
+    G: number;
+    H: number;
+    get(): [number, number, number, number, number, number, number, number];
+    set(A: number, B: number, C: number, D: number, E: number, F: number, G: number, H: number): void;
+    process(view: DataView, offset: number): void;
+    roundClean(): void;
+    destroy(): void;
+    readonly blockLen: number;
+    outputLen: number;
+    readonly padOffset: number;
+    readonly isLE: boolean;
+    buffer: Uint8Array;
+    view: DataView;
+    finished: boolean;
+    length: number;
+    pos: number;
+    destroyed: boolean;
+    update(data: import("@noble/hashes/utils").Input): any;
+    digestInto(out: Uint8Array): void;
+    digest(): Uint8Array;
+    _cloneInto(to?: any | undefined): any;
+    clone(): any;
+}> | import("@noble/hashes/utils").Hash<import("@noble/hashes/sha512").SHA512> | undefined;
+export function createHmac(_algo: any, key: any): import("@noble/hashes/hmac").HMAC<any>;
+export function pbkdf2Sync(password: any, salt: any, iterations: any, keylen: any, _algo: any): Uint8Array;
+export function randomBytes(length: any): Uint8Array;
+declare namespace _default {
+    export { createHash };
+    export { createHmac };
+    export { pbkdf2Sync };
+    export { randomBytes };
+}
+export default _default;

package/browser/crypto/crypto.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="node" />
+export { createHash, createHmac, pbkdf2Sync, randomBytes } from 'crypto';

package/browser/generators/Generator.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+import { Network } from 'bitcoinjs-lib';
+export declare abstract class Generator {
+    static readonly DATA_CHUNK_SIZE: number;
+    static readonly MAGIC: Buffer;
+    protected readonly senderPubKey: Buffer;
+    protected readonly contractSaltPubKey: Buffer;
+    protected readonly network: Network;
+    protected constructor(senderPubKey: Buffer, contractSaltPubKey: Buffer, network?: Network);
+    abstract compile(...args: unknown[]): Buffer;
+    protected splitBufferIntoChunks(buffer: Buffer, chunkSize?: number): Array<Buffer[]>;
+}

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

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { Network } from 'bitcoinjs-lib';
+import { Generator } from '../Generator.js';
+export declare class CalldataGenerator extends Generator {
+    constructor(senderPubKey: Buffer, contractSaltPubKey: Buffer, network?: Network);
+    compile(calldata: Buffer, contractSecret: Buffer, vaultPublicKeys?: Buffer[], minimumSignatures?: number): Buffer;
+    private getPubKeyAsBuffer;
+}

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

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+import { Network } from 'bitcoinjs-lib';
+import { Generator } from '../Generator.js';
+export declare class DeploymentGenerator extends Generator {
+    constructor(senderPubKey: Buffer, contractSaltPubKey: Buffer, network?: Network);
+    compile(contractBytecode: Buffer, contractSalt: Buffer): Buffer;
+}

package/browser/index.d.ts

@@ -0,0 +1,3 @@
+import * as opnet from './opnet.js';
+export { opnet };
+export * from './opnet.js';