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-bitcoin-rpc


https://github.com/btc-vision/bsi-bitcoin-rpc

Last synced: 28 days ago
JSON representation

Awesome Lists containing this project

README

        

# OP_NET: BSI Bitcoin RPC

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

A complete, compact and simple library for the Bitcoin ecosystem, written in
TypeScript. This library is designed to be easy to use and understand, while
providing a comprehensive set of functions for creating, reading and
manipulating Bitcoin transactions. This library fully typed and is designed to interact
with the Bitcoin Core RPC.

## Getting Started

### Prerequisites

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

### Installation

```shell
npm i @btc-vision/bsi-bitcoin-rpc
```

### Documentation

Documentation available at [https://dev.opnet.org](https://dev.opnet.org) or in
the `docs/` directory of the repository.

#### Development

1. Clone the repository:
```bash
git clone https://github.com/btc-vision/bsi-bitcoin-rpc.git
```
2. Navigate to the repository directory:
```bash
cd bsi-bitcoin-rpc
```
3. Install the required dependencies:
```bash
npm i
```

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