@utexo/rgb-lib 0.3.0-beta.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2025 RGB-Tools developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+# RGB Lib Node.js bindings
+
+[![npm version](https://badge.fury.io/js/rgb-lib.svg)](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

package/index.js

@@ -0,0 +1,24 @@
+const os = require("os");
+
+// Currently supported platforms
+const supportedCombinations = [
+    { platform: "linux", arch: "x64" },
+    { platform: "linux", arch: "arm64" },
+    { platform: "darwin", arch: "arm64" },
+];
+
+const platform = os.platform();
+const arch = os.arch();
+
+const isSupported = supportedCombinations.some(
+    (combo) => combo.platform === platform && combo.arch === arch
+);
+
+if (!isSupported) {
+    console.error(`Unsupported platform-arch: ${platform}-${arch}`);
+    console.error("Supported combinations: linux-x64, linux-arm64, darwin-arm64");
+    process.exit(1);
+}
+
+let nativePackageName = `@utexo/rgb-lib-${platform}-${arch}`;
+module.exports = require(nativePackageName);

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@utexo/rgb-lib",
+  "version": "0.3.0-beta.10",
+  "description": "Node.js bindings for rgb-lib",
+  "main": "index.js",
+  "files": [
+    "index.js"
+  ],
+  "scripts": {
+    "test": "echo \"No tests available\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/UTEXO-Protocol/rgb-lib-nodejs.git"
+  },
+  "keywords": [
+    "rgb",
+    "bitcoin"
+  ],
+  "author": "UTEXO Protocol",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/UTEXO-Protocol/rgb-lib-nodejs/issues"
+  },
+  "homepage": "https://github.com/UTEXO-Protocol/rgb-lib-nodejs#readme",
+  "optionalDependencies": {
+    "@utexo/rgb-lib-linux-x64": "0.3.0-beta.10",
+    "@utexo/rgb-lib-linux-arm64": "0.3.0-beta.10",
+    "@utexo/rgb-lib-darwin-arm64": "0.3.0-beta.10"
+  }
+}