blackchain-addressgen 1.0.0

package/README.md

@@ -0,0 +1,149 @@
+# BlackChain Address Generator
+
+A simple CLI tool to generate mnemonics and derive deterministic wallet addresses using the BlackChain Crypto Library.
+
+## NPM Usage
+
+This tool is also available as an npm package.
+
+### Installation
+
+```bash
+npm install -g blackchain-addressgen
+```
+
+### Usage
+
+Run via `npx` or installed global command:
+
+```bash
+blackchain-addressgen --show-mnemonic --count 10
+```
+
+---
+
+## Build
+
+```bash
+cd examples/address-generator
+go build -o blackchain-addressgen main.go
+```
+
+---
+
+## Install as a Global CLI Tool (No `./` Required)
+
+After installation, you’ll be able to run:
+
+```bash
+blackchain-addressgen
+```
+
+from **any directory**.
+
+---
+
+### macOS / Linux
+
+#### 1️⃣ Build the binary
+
+```bash
+go build -o blackchain-addressgen main.go
+```
+
+#### 2️⃣ Make it executable
+
+```bash
+chmod +x blackchain-addressgen
+```
+
+#### 3️⃣ Move it to a directory in your PATH
+
+Recommended location:
+
+```bash
+sudo mv blackchain-addressgen /usr/local/bin/
+```
+
+> `/usr/local/bin` is included in `PATH` by default on most systems.
+
+#### 4️⃣ (macOS only) Remove Gatekeeper quarantine
+
+If macOS blocks the binary:
+
+```bash
+sudo xattr -d com.apple.quarantine /usr/local/bin/blackchain-addressgen
+```
+
+#### 5️⃣ Verify installation
+
+```bash
+which blackchain-addressgen
+```
+
+Expected output:
+
+```text
+/usr/local/bin/blackchain-addressgen
+```
+
+You can now run:
+
+```bash
+blackchain-addressgen
+```
+
+from anywhere 🚀
+
+---
+
+## Usage
+
+### Generate a new mnemonic and addresses
+
+```bash
+blackchain-addressgen
+```
+
+### Show the generated mnemonic
+
+```bash
+blackchain-addressgen --show-mnemonic
+```
+
+### Use an existing mnemonic
+
+```bash
+blackchain-addressgen \
+  --mnemonic "your twelve word mnemonic phrase goes here ..." \
+  --show-mnemonic
+```
+
+### Custom Derivation Path
+
+To avoid shell quoting issues, always wrap the path in double quotes:
+
+```bash
+blackchain-addressgen --path "m/44'/60'/0'/1'"
+```
+
+---
+
+## Options
+
+* `--words` — Mnemonic length (12 or 24). Default: `12`
+* `--count` — Number of addresses to derive. Default: `5`
+* `--path` — Base derivation path. Default: `m/44'/60'/0'/0'`
+* `--mnemonic` — Use an existing mnemonic string
+* `--show-mnemonic` — Display the mnemonic in the output
+
+---
+
+## Uninstall
+
+```bash
+sudo rm /usr/local/bin/blackchain-addressgen
+```
+
+---
+

package/bin/index.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+
+const { spawn } = require('child_process');
+const path = require('path');
+const os = require('os');
+
+const supportedPlatforms = {
+    'darwin': 'blackchain-addressgen-macos',
+    'linux': 'blackchain-addressgen-linux',
+    'win32': 'blackchain-addressgen-win.exe'
+};
+
+const platform = os.platform();
+const binaryName = supportedPlatforms[platform];
+
+if (!binaryName) {
+    console.error(`Unsupported platform: ${platform}`);
+    process.exit(1);
+}
+
+const binaryPath = path.join(__dirname, binaryName);
+
+const child = spawn(binaryPath, process.argv.slice(2), {
+    stdio: 'inherit'
+});
+
+child.on('exit', (code) => {
+    process.exit(code);
+});

package/package.json

@@ -0,0 +1,17 @@
+{
+    "name": "blackchain-addressgen",
+    "version": "1.0.0",
+    "description": "BlackChain Address Generator CLI",
+    "bin": {
+        "blackchain-addressgen": "./bin/index.js"
+    },
+    "scripts": {
+        "build": "mkdir -p bin && GOOS=darwin GOARCH=arm64 go build -o bin/blackchain-addressgen-macos main.go && GOOS=linux GOARCH=amd64 go build -o bin/blackchain-addressgen-linux main.go && GOOS=windows GOARCH=amd64 go build -o bin/blackchain-addressgen-win.exe main.go",
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "author": "",
+    "license": "ISC",
+    "files": [
+        "bin"
+    ]
+}