@gloxx/nodejs 0.1.0

package/README.md

@@ -0,0 +1,80 @@
+## @gloxx/nodejs
+
+
+This package provides native Node.js bindings for the Gloxx network, implemented in Rust. It offers a high-performance and secure way to interact with the core functionalities of the Gloxx ecosystem, such as wallet generation, directly from your Node.js applications.
+
+You should use this package whenever you need to perform Gloxx-related operations in a Node.js environment. This is particularly useful for:
+
+**Backend Services:** Create and manage wallets for users in your web applications.
+Decentralized Applications (dApps): Integrate wallet functionalities into your dApp's backend.
+
+**Command-Line Tools:** Build developer tools that require wallet generation or other cryptographic operations.
+
+**Testing and Automation:** Create scripts for testing and automating tasks on the Gloxx network.
+You can install the package using either npm or yarn:
+
+```bash
+npm install @gloxx/nodejs
+```
+
+or
+```bash
+yarn add @gloxx/nodejs
+```
+
+The package is structured with optionalDependencies, which means that npm or yarn will automatically download the correct binary for your operating system and architecture. There's no need for any manual compilation or extra build steps.
+
+Using the package is straightforward. Here’s how you can generate a new Gloxx wallet:
+
+```javascript
+const { generateWallet } = require('@gloxx/nodejs');
+
+try {
+  const wallet = generateWallet();
+  console.log('Successfully generated wallet:');
+  console.log('Address:', wallet.address);
+  console.log('Mnemonic:', wallet.mnemonic);
+} catch (error) {
+  console.error('Failed to generate wallet:', error);
+}
+
+```
+**Output:**
+Successfully generated wallet:
+Address: glx1......
+Mnemonic: ...
+
+**Description:** Generates a new Gloxx wallet, including a unique address and a 12-word mnemonic phrase for recovery.
+Returns: An object with the following properties:
+**address (string):** The public address of the new wallet.
+**mnemonic (string):** The 12-word mnemonic phrase for wallet recovery.
+**Throws:** An Error if the wallet generation fails.
+
+This package is a N-API wrapper around the powerful and secure Rust codebase of the Gloxx network. By using native Rust code, it ensures high performance and memory safety, giving you a reliable foundation for your applications. The core logic is shared with other Gloxx packages, guaranteeing consistency across the ecosystem.
+
+The @gloxx/nodejs package is designed to be cross-platform and supports the following targets:
+
+Linux: x64 (glibc and musl) and ARM64
+Windows: x64 (MSVC)
+macOS: Universal (x64 and Apple Silicon)
+Android: ARM64 and ARMv7
+
+
+## Development & Build
+
+To work on this crate or build it from source, ensure you have napi-rs installed.
+
+### Build
+```sh
+npx napi build --release 
+```
+
+If you have any issues or questions, please refer to the main Gloxx Network repository.
+
+(@gloxx/nodejs)[https://github.com/gloxx-labs/gloxx-network]
+
+## License
+
+MIT
+
+© 2025 Gloxx Network

package/index.d.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+/** A simple object to represent the wallet in JavaScript */
+export interface NativeWallet {
+  address: string
+  mnemonic: string
+  privateKey: string
+  publicKey: string
+}
+/** Generates a brand new Gloxx wallet */
+export declare function generateWallet(): NativeWallet
+/** Imports a wallet from a recovery phrase */
+export declare function importWallet(phrase: string, passphrase?: string | undefined | null): NativeWallet
+/** Signs a message using a hex-encoded private key */
+export declare function signMessage(message: string | Buffer, privateKeyHex: string): string
+/** Verifies a signature using a hex-encoded public key */
+export declare function verifySignature(message: string | Buffer, signatureHex: string, publicKeyHex: string): boolean
+/** Encrypts a private key and saves it to a keystore file */
+export declare function saveKeystore(privateKeyHex: string, address: string, password: string, path: string): void
+/** Loads and decrypts a private key from a keystore file */
+export declare function loadKeystore(address: string, password: string, path: string): string
+/** Signs a message using a key stored in a keystore file */
+export declare function signMessageFromKeystore(message: string | Buffer, address: string, password: string, path: string): string

package/index.js

@@ -0,0 +1,292 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'gloxx-nodejs.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./gloxx-nodejs.android-arm64.node')
+          } else {
+            nativeBinding = require('@gloxx/nodejs-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'gloxx-nodejs.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./gloxx-nodejs.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@gloxx/nodejs-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'gloxx-nodejs.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./gloxx-nodejs.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@gloxx/nodejs-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'gloxx-nodejs.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./gloxx-nodejs.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@gloxx/nodejs-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'gloxx-nodejs.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./gloxx-nodejs.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@gloxx/nodejs-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'gloxx-nodejs.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./gloxx-nodejs.darwin-universal.node')
+      } else {
+        nativeBinding = require('@gloxx/nodejs-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'gloxx-nodejs.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./gloxx-nodejs.darwin-x64.node')
+          } else {
+            nativeBinding = require('@gloxx/nodejs-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'gloxx-nodejs.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./gloxx-nodejs.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@gloxx/nodejs-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'gloxx-nodejs.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./gloxx-nodejs.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@gloxx/nodejs-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'gloxx-nodejs.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./gloxx-nodejs.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@gloxx/nodejs-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'gloxx-nodejs.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./gloxx-nodejs.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@gloxx/nodejs-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'gloxx-nodejs.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./gloxx-nodejs.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@gloxx/nodejs-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'gloxx-nodejs.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./gloxx-nodejs.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@gloxx/nodejs-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(
+          join(__dirname, 'gloxx-nodejs.linux-arm-gnueabihf.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./gloxx-nodejs.linux-arm-gnueabihf.node')
+          } else {
+            nativeBinding = require('@gloxx/nodejs-linux-arm-gnueabihf')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'gloxx-nodejs.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./gloxx-nodejs.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@gloxx/nodejs-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'gloxx-nodejs.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./gloxx-nodejs.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@gloxx/nodejs-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { generateWallet, importWallet, signMessage, verifySignature, saveKeystore, loadKeystore, signMessageFromKeystore } = nativeBinding
+
+module.exports.generateWallet = generateWallet
+module.exports.importWallet = importWallet
+module.exports.signMessage = signMessage
+module.exports.verifySignature = verifySignature
+module.exports.saveKeystore = saveKeystore
+module.exports.loadKeystore = loadKeystore
+module.exports.signMessageFromKeystore = signMessageFromKeystore

package/npm/android-arm-eabi/README.md

@@ -0,0 +1,3 @@
+# `@gloxx/nodejs-android-arm-eabi`
+
+This is the **armv7-linux-androideabi** binary for `@gloxx/nodejs`

package/npm/android-arm-eabi/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@gloxx/nodejs-android-arm-eabi",
+  "version": "0.1.0",
+  "cpu": [
+    "arm"
+  ],
+  "main": "gloxx-nodejs.android-arm-eabi.node",
+  "files": [
+    "gloxx-nodejs.android-arm-eabi.node"
+  ],
+  "description": "Native Rust bindings for the Gloxx Network wallet",
+  "license": "MIT",
+  "os": [
+    "android"
+  ]
+}

package/npm/android-arm64/README.md

@@ -0,0 +1,3 @@
+# `@gloxx/nodejs-android-arm64`
+
+This is the **aarch64-linux-android** binary for `@gloxx/nodejs`

package/npm/android-arm64/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@gloxx/nodejs-android-arm64",
+  "version": "0.1.0",
+  "cpu": [
+    "arm64"
+  ],
+  "main": "gloxx-nodejs.android-arm64.node",
+  "files": [
+    "gloxx-nodejs.android-arm64.node"
+  ],
+  "description": "Native Rust bindings for the Gloxx Network wallet",
+  "license": "MIT",
+  "os": [
+    "android"
+  ]
+}

package/npm/darwin-arm64/README.md

@@ -0,0 +1,3 @@
+# `@gloxx/nodejs-darwin-arm64`
+
+This is the **aarch64-apple-darwin** binary for `@gloxx/nodejs`

package/npm/darwin-arm64/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@gloxx/nodejs-darwin-arm64",
+  "version": "0.1.0",
+  "cpu": [
+    "arm64"
+  ],
+  "main": "gloxx-nodejs.darwin-arm64.node",
+  "files": [
+    "gloxx-nodejs.darwin-arm64.node"
+  ],
+  "description": "Native Rust bindings for the Gloxx Network wallet",
+  "license": "MIT",
+  "os": [
+    "darwin"
+  ]
+}

package/npm/darwin-x64/README.md

@@ -0,0 +1,3 @@
+# `@gloxx/nodejs-darwin-x64`
+
+This is the **x86_64-apple-darwin** binary for `@gloxx/nodejs`

package/npm/darwin-x64/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@gloxx/nodejs-darwin-x64",
+  "version": "0.1.0",
+  "cpu": [
+    "x64"
+  ],
+  "main": "gloxx-nodejs.darwin-x64.node",
+  "files": [
+    "gloxx-nodejs.darwin-x64.node"
+  ],
+  "description": "Native Rust bindings for the Gloxx Network wallet",
+  "license": "MIT",
+  "os": [
+    "darwin"
+  ]
+}

package/npm/linux-x64-gnu/README.md

@@ -0,0 +1,3 @@
+# `@gloxx/nodejs-linux-x64-gnu`
+
+This is the **x86_64-unknown-linux-gnu** binary for `@gloxx/nodejs`

package/npm/linux-x64-gnu/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@gloxx/nodejs-linux-x64-gnu",
+  "version": "0.1.0",
+  "cpu": [
+    "x64"
+  ],
+  "main": "gloxx-nodejs.linux-x64-gnu.node",
+  "files": [
+    "gloxx-nodejs.linux-x64-gnu.node"
+  ],
+  "description": "Native Rust bindings for the Gloxx Network wallet",
+  "license": "MIT",
+  "os": [
+    "linux"
+  ],
+  "libc": [
+    "glibc"
+  ]
+}

package/npm/win32-x64-msvc/README.md

@@ -0,0 +1,3 @@
+# `@gloxx/nodejs-win32-x64-msvc`
+
+This is the **x86_64-pc-windows-msvc** binary for `@gloxx/nodejs`

package/npm/win32-x64-msvc/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@gloxx/nodejs-win32-x64-msvc",
+  "version": "0.1.0",
+  "cpu": [
+    "x64"
+  ],
+  "main": "gloxx-nodejs.win32-x64-msvc.node",
+  "files": [
+    "gloxx-nodejs.win32-x64-msvc.node"
+  ],
+  "description": "Native Rust bindings for the Gloxx Network wallet",
+  "license": "MIT",
+  "os": [
+    "win32"
+  ]
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@gloxx/nodejs",
+  "version": "0.1.0",
+  "description": "Native Rust bindings for the Gloxx Network wallet",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [ 
+    "index.js",
+    "*.d.ts",
+    "npm/**",
+    "README.md"
+  ],
+  "napi": {
+    "binaryName": "gloxx-nodejs",
+    "package": {
+      "name": "@gloxx/nodejs"
+    },
+    "targets": [
+      "aarch64-apple-darwin",
+      "x86_64-apple-darwin",
+      "x86_64-pc-windows-msvc",
+      "x86_64-unknown-linux-gnu",
+      "aarch64-linux-android",
+      "armv7-linux-androideabi"
+    ]
+    
+  },
+
+  "license": "MIT",
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.0"
+  },
+  "optionalDependencies": {
+    "@gloxx/nodejs-android-arm64": "0.1.0",
+    "@gloxx/nodejs-android-arm-eabi": "0.1.0",
+    "@gloxx/nodejs-win32-x64-msvc": "0.1.0",
+    "@gloxx/nodejs-darwin-universal": "0.1.0",
+    "@gloxx/nodejs-linux-x64-gnu": "0.1.0",
+    "@gloxx/nodejs-linux-x64-musl": "0.1.0",
+    "@gloxx/nodejs-linux-arm64-gnu": "0.1.0",
+    "@gloxx/nodejs-linux-arm64-musl": "0.1.0"
+  }
+}