RGB Lib Node.js bindings

This project builds Node.js packages for the rgb-lib Rust library, which is included as a git submodule. The bindings are created using the rgb-lib C++ bindings, which are located inside the rgb-lib submodule, and Swig.

Platform-specific packages

Bindings are platform-specific and are published into dedicated packages (under the @rgb-tools namespace). The main package is a thin layer that depends on the correct platform-specific package for the platform where it's being installed.

Requirements

• Python 3
• development tools (e.g. make, g++)

Installation

Install the package with npm:

npm install rgb-lib

Usage

Import the package with:

const rgblib = require("rgb-lib");

Then call its exported functions. As an example:

let keys = rgblib.generateKeys(rgblib.BitcoinNetwork.Regtest);
console.log(keys);

⚠️ Warning: memory will be leaked if not taken care of manually

Check the example to see how you can manually avoid memory leaks