@btc-vision/transaction/README.md

OPNet transaction library allows you to create and sign transactions for the OPNet network.

# 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)

## Overview

This library is a modern and easy-to-use solution for developers looking to work with Bitcoin transactions and OP_NET
technologies. The OP_NET Transaction Builder library allows you to create and sign transactions for Bitcoin. Written in
TypeScript, this library provides a comprehensive set of functions to facilitate the creation, reading, and manipulation
of OP_NET transactions, smart contracts, and other OP_NET-related technologies.

You can create any sort of transaction, and you don't have to bother about managing signer types or anything
complicated.

## Security Audit

<p align="center">
  <a href="https://verichains.io">
    <img src="https://raw.githubusercontent.com/btc-vision/contract-logo/refs/heads/main/public-assets/verichains.png" alt="Verichains" width="100"/>
  </a>
</p>

<p align="center">
  <a href="https://verichains.io">
    <img src="https://img.shields.io/badge/Security%20Audit-Verichains-4C35E0?style=for-the-badge" alt="Audited by Verichains"/>
  </a>
  <a href="./SECURITY.md">
    <img src="https://img.shields.io/badge/Security-Report-22C55E?style=for-the-badge" alt="Security Report"/>
  </a>
</p>

This library has been professionally audited by [Verichains](https://verichains.io).

See [SECURITY.md](./SECURITY.md) for details.

## Installation

```bash
npm install @btc-vision/transaction
```

## Documentation

Documentation is available [here](./documentation/README.md) and on [docs.opnet.org](https://docs.opnet.org).

## Prerequisites

- Node.js version 24.x or higher
- npm (Node Package Manager)

## 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 install
   ```
4. Build the project:
   ```bash
   npm run build
   ```

## Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests and build
5. Submit a pull request

See the [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) for requirements.

Contributions are welcome! Please read through the `CONTRIBUTING.md` file for guidelines on how to submit issues,
feature requests, and pull requests.

## Reporting Issues

- **Bugs**: Use the [bug report template](https://github.com/btc-vision/transaction/issues/new?template=bug_report.yml)
- **Security**: See [SECURITY.md](./SECURITY.md) - do not open public issues for vulnerabilities

## License

[Apache-2.0](./LICENSE)

## Links

- [OPNet](https://opnet.org)
- [Documentation](https://docs.opnet.org)
- [GitHub](https://github.com/btc-vision/transaction)
- [npm](https://www.npmjs.com/package/@btc-vision/transaction)
- [Verichains](https://verichains.io)