https://github.com/RGB-Tools/rgb-lib-nodejs
https://github.com/RGB-Tools/rgb-lib-nodejs
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/RGB-Tools/rgb-lib-nodejs
- Owner: RGB-Tools
- Created: 2023-12-13T13:48:18.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-07-29T09:53:56.000Z (2 months ago)
- Last Synced: 2025-08-08T21:53:18.962Z (about 2 months ago)
- Language: JavaScript
- Size: 78.1 KB
- Stars: 3
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-rgb-protocol - RGB Lib Node.js bindings
README
# RGB Lib Node.js bindings
[](https://badge.fury.io/js/rgb-lib)
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:
```sh
npm install rgb-lib
```
## Usage
Import the package with:
```javascript
const rgblib = require("rgb-lib");
```
Then call its exported functions. As an example:
```javascript
let keys = rgblib.generateKeys(rgblib.BitcoinNetwork.Regtest);
console.log(keys);
```
> :warning: **Warning: memory will be leaked if not taken care of manually**
>
> Check the example to see how you can manually avoid memory leaks
[Swig]: https://github.com/swig/swig
[rgb-lib C++ bindings]: https://github.com/RGB-Tools/rgb-lib/tree/master/bindings/c-ffi
[rgb-lib]: https://github.com/RGB-Tools/rgb-lib