Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/btc-vision/bsi-binary

Last synced: 28 days ago
JSON representation

Host: GitHub
URL: https://github.com/btc-vision/bsi-binary
Owner: btc-vision
License: mit
Created: 2024-04-27T22:56:00.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-10-19T22:51:14.000Z (3 months ago)
Last Synced: 2024-10-20T08:48:42.208Z (3 months ago)
Language: TypeScript
Size: 85 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # BSI Binary Writer & Reader

![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)

## ⚠️ DEPRECATION NOTICE ⚠️

This package have been merged with @btc-vision/transaction instead.

## Introduction

This package contains the required classes to be able to easily create and read any sort of calldata for BSI transactions.

## Getting Started

### Prerequisites

- Node.js version 20.x or higher

- npm (Node Package Manager)

### Installation

1. Clone the repository:

   ```bash

   git clone https://github.com/btc-vision/bsi-binary.git

   ```

2. Navigate to the repository directory:

   ```bash

   cd bsi-binary

   ```

3. Install the required dependencies:

   ```bash

   npm i

   ```

## Usage

Refer to the `docs/` directory for detailed guides on how to use the BSI Transaction Builder. Start

with `getting_started.md` and explore `api_reference.md` for comprehensive information about the functions available.

## 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 the BSI Transaction

Builder.

## License

This project is licensed under a STRICT license - see the `LICENSE.md` file for details.