https://github.com/btc-vision/transaction

OP_NET transaction library allows you to create and sign transactions for the OP_NET network.
https://github.com/btc-vision/transaction

Last synced: 28 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/btc-vision/transaction
• Owner: btc-vision
• License: mit
• Created: 2024-06-05T23:26:04.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-11-30T00:36:38.000Z (about 1 month ago)
• Last Synced: 2024-11-30T01:21:58.360Z (about 1 month ago)
• Language: TypeScript
• Homepage:
• Size: 5.75 MB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OP_NET - 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 OP_NET Transaction Builder library allows you to create and sign transactions for the OP_NET network. 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.

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

   ```

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

To learn how to unwrap Bitcoin on OP_NET, please refer to

the [Unwrap.md](https://github.com/btc-vision/transaction/blob/main/Unwrap.md) guide.

To learn how to deploy smart contracts on OP_NET, please refer to

the [Deploy.md](https://github.com/btc-vision/transaction/blob/main/Deploy.md) guide.

## Usage

OUTDATED EXAMPLE. New examples will be added soon.

## 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 OP_NET.

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