magnetk 2.2.0 → 2.2.4

package/README.md

@@ -99,6 +99,33 @@ magnetk download "magnetk:?..." --output ./file.zip
 - `connection-type`: `{ type }` (DIRECT, RELAYED, LOCAL)
 - `error`: `{ code, message }`
 
+## Prerequisites
+
+The JavaScript SDK is a lightweight wrapper around the high-performance **Magnetk Go Binaries**. You must have these binaries on your system to use seeding or relay features.
+
+1.  **Download** the latest binaries for your platform (Windows/Linux/macOS).
+2.  **Ensure** they are in your system `PATH` OR provide the path manually in the SDK config.
+
+### Manual Configuration
+```javascript
+const client = new MagnetkClient({
+    seederPath: 'C:\\path\\to\\seed.exe', // Explicit path
+    relayUrl: '69.169.109.243'
+});
+```
+
+### Environment Variables
+You can also set the binary path globally:
+- `MAGNETK_SEEDER_PATH`: Path to the `seed.exe` binary.
+
+## Troubleshooting
+
+### "spawn seed.exe ENOENT" Error
+This means the SDK cannot find the Go seeder binary.
+1. Check if `seed.exe` is in your system `PATH`.
+2. Or provide `seederPath` in the `MagnetkClient` constructor.
+3. Or set the `MAGNETK_SEEDER_PATH` environment variable.
+
 ## License
 MIT
 

package/client.js

@@ -12,6 +12,7 @@ import crypto from 'crypto';
 import path from 'path';
 import { spawn } from 'child_process';
 import { EventEmitter } from 'events';
+import { fileURLToPath } from 'url';
 import { MagnetkLink } from './magnetk.js';
 
 const MSG_TYPE = {
@@ -41,6 +42,8 @@ export class MagnetkClient extends EventEmitter {
             relayPort: 4003,
             seedPort: 4002,
             enableSTUN: true,
+            seederPath: null,
+            configPath: null,
             ...config
         };
         this.processes = [];
@@ -206,7 +209,9 @@ export class MagnetkClient extends EventEmitter {
             console.warn(`[Magnetk-JS] Failed to fetch relay identity: ${e.message}. Using default/configured address might fail if Peer ID is missing.`);
         }
 
-        const binPath = this._resolveBinPath('seed.exe');
+        const isWin = process.platform === 'win32';
+        const binName = isWin ? 'seed.exe' : 'seed';
+        const binPath = this._resolveBinPath(binName);
         const configPath = this._resolveConfigPath();
 
         // Construct full multiaddr if we have the Peer ID
@@ -405,7 +410,19 @@ export class MagnetkClient extends EventEmitter {
     }
 
     _resolveBinPath(binName) {
-        // Try to find bin in likely locations
+        const isWin = process.platform === 'win32';
+        const isSeeder = binName.includes('seed');
+
+        // 1. Check explicit config
+        if (isSeeder && this.config.seederPath) return this.config.seederPath;
+
+        // 2. Check environment variable
+        const envVar = isSeeder ? 'MAGNETK_SEEDER_PATH' : null;
+        if (envVar && process.env[envVar] && fs.existsSync(process.env[envVar])) {
+            return process.env[envVar];
+        }
+
+        // 3. Check local dev environment paths
         const paths = [
             path.join(process.cwd(), 'bin', binName),
             path.join(process.cwd(), '..', '..', '..', 'bin', binName),
@@ -415,10 +432,15 @@ export class MagnetkClient extends EventEmitter {
         for (const p of paths) {
             if (fs.existsSync(p)) return p;
         }
-        return binName; // Fallback to PATH
+
+        return binName; // Fallback to PATH (e.g. "seed" or "seed.exe")
     }
 
     _resolveConfigPath() {
+        // 1. Check explicit config
+        if (this.config.configPath) return this.config.configPath;
+
+        // 2. Check local dev environment
         const paths = [
             path.join(process.cwd(), 'config', 'settings.conf'),
             path.join(process.cwd(), '..', '..', '..', 'config', 'settings.conf'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "magnetk",
-  "version": "2.2.0",
+  "version": "2.2.4",
   "description": "JavaScript SDK for Magnetk P2P File Transfer System",
   "main": "index.js",
   "bin": {
@@ -14,7 +14,9 @@
     "utils.js",
     "README.md",
     "LICENSE",
-    "package.json"
+    "package.json",
+    "share.js",
+    "download.js"
   ],
   "scripts": {
     "test": "node test.js"