p2p-transfer 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 P2P Transfer
+
+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,248 @@
+# P2P Transfer
+
+🚀 A pure CLI tool for peer-to-peer file transfer between different networks, powered by WebTorrent and BitTorrent DHT.
+
+## ✨ Features
+
+- 🌐 **Pure CLI** - No web UI or browser required, operate directly in terminal
+- 🔧 **Zero Configuration** - One command to send, one command to receive
+- 👶 **Beginner Friendly** - Intuitive commands with progress bar and speed display
+- ⚡ **Maximum Speed** - DHT + configurable Tracker subscription for optimal peer discovery
+- 🔒 **Cross-Network** - Transfer between different LANs without requiring public IP
+- 📦 **Large File Support** - Handles files of any size with automatic chunking
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+# Install via npm (after publishing)
+npm install -g p2p-transfer
+
+# Or use npx directly
+npx p2p-transfer share <file>
+```
+
+### Basic Usage
+
+**Share a file (on sender's machine):**
+```bash
+p2p share ~/movies/vacation.mp4
+```
+
+**Download a file (on receiver's machine):**
+```bash
+p2p get "magnet:?xt=urn:btih:abc123..."
+```
+
+## 📖 Detailed Usage
+
+### Share Command
+
+```bash
+p2p share <file> [options]
+
+Options:
+  -v, --verbose    Show detailed logs
+```
+
+**Example:**
+```bash
+p2p share ~/documents/report.pdf
+p2p share ./large-video.mp4 --verbose
+```
+
+**Output:**
+```
+🚀 Initializing P2P share...
+📁 File: report.pdf
+📊 Size: 2.5 MB
+
+✅ Share successful!
+
+🔗 Magnet URI (copy and send to receiver):
+magnet:?xt=urn:btih:abc123def456...
+
+📋 BTIH Hash: abc123def456
+
+⏳ Waiting for connections... (Press Ctrl+C to stop)
+```
+
+### Download Command
+
+```bash
+p2p get <magnet> [path] [options]
+
+Arguments:
+  magnet             Magnet URI
+  path               Download directory (default: current directory)
+
+Options:
+  -v, --verbose    Show detailed logs
+```
+
+**Example:**
+```bash
+p2p get "magnet:?xt=urn:btih:abc123..." ~/Downloads
+p2p get "magnet:?xt=urn:btih:abc123..." ./my-files
+```
+
+**Output:**
+```
+📥 Initializing P2P download...
+
+✅ File found!
+
+📁 Filename: report.pdf
+📊 Total size: 2.5 MB
+📋 Hash: abc123def456
+📁 Save to: ~/Downloads
+
+📥 Download Progress |████████████░░░░| 45% | 1.1 MB/2.5 MB | 5.2 MB/s | ETA: 00:00:03
+
+✅ Download complete!
+⏱️  Total time: 2.50 seconds
+📁 Location: ~/Downloads/report.pdf
+```
+
+### Help Command
+
+```bash
+p2p info
+```
+
+## 🎯 How It Works
+
+```
+┌─────────────────┐         ┌─────────────────┐
+│   Sender        │   P2P   │   Receiver      │
+│                 │◄───────►│                 │
+│  1. Seed file   │   DHT   │  2. Download    │
+│  3. Get Magnet  │         │  4. Parse Magnet│
+│  4. Share Link  │         │  5. Start D/L   │
+└─────────────────┘         └─────────────────┘
+```
+
+1. **Sender** runs `p2p share <file>` to start seeding
+2. Generates unique **Magnet URI** containing file hash and Tracker addresses
+3. **Receiver** runs `p2p get <magnet>` with the received URI
+4. **DHT + Trackers** discover peers automatically
+5. **P2P connection** established for direct transfer
+
+## 🔧 Technical Details
+
+- **Protocol**: BitTorrent
+- **Peer Discovery**: DHT (Distributed Hash Table)
+- **Trackers**: 7 public trackers for maximum connectivity
+- **No Public IP Required**: Works behind NAT and firewalls
+
+### Default Trackers
+
+```
+- udp://tracker.opentrackr.org:1337/announce
+- udp://tracker.openbittorrent.com:6969/announce
+- udp://exodus.desync.com:6969/announce
+- udp://tracker.coppersurfer.tk:6969/announce
+- wss://tracker.btorrent.xyz
+- wss://tracker.openwebtorrent.com
+- wss://tracker.webtorrent.io
+```
+
+## 💡 Use Cases
+
+- **NAS to Local**: Transfer files from NAS to your computer
+- **Cross-Network**: Share files between different networks (home ↔ office)
+- **Quick Sharing**: No need to upload to cloud first
+- **Large Files**: Perfect for big files without size limits
+- **Offline Sharing**: Works without internet servers (via DHT)
+
+## ⚙️ Requirements
+
+- Node.js >= 18.0.0
+- npm >= 8.0.0
+
+## 📦 Installation from Source
+
+```bash
+git clone https://gitcode.com/yunqiang_wu/p2p-transfer.git
+cd p2p-transfer
+npm install
+```
+
+## 🌟 Advanced Usage
+
+### Global Installation
+
+```bash
+npm install -g p2p-transfer
+
+# Now you can use it anywhere
+p2p share ~/file.txt
+```
+
+### Use as Project Dependency
+
+```bash
+npm install p2p-transfer
+```
+
+Then in your code:
+```javascript
+import { share, get } from 'p2p-transfer';
+
+await share('/path/to/file');
+await get('magnet:?xt=urn:btih:...');
+```
+
+## 🐛 Troubleshooting
+
+### No peers connecting?
+
+1. **Check firewall**: Ensure outbound UDP/TCP is allowed
+2. **Wait longer**: DHT peer discovery may take 1-2 minutes
+3. **Try verbose mode**: `p2p share <file> -v`
+4. **Use more trackers**: Add additional trackers in code
+
+### Download speed is slow?
+
+1. **Wait for more peers**: Speed increases with more seeders
+2. **Check NAT**: Some networks have bandwidth limits
+3. **Try different network**: Some ISPs throttle BitTorrent
+
+### Connection issues?
+
+- Ensure both sides have internet access
+- Check if magnet link is complete (no truncation)
+- Try restarting both sender and receiver
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- [WebTorrent](https://webtorrent.io/) - BitTorrent implementation for Node.js
+- [BitTorrent DHT](https://en.wikipedia.org/wiki/Mainline_DHT) - Distributed hash table
+- All the public tracker operators
+
+## 📈 Roadmap
+
+- [ ] Add WebRTC support for browser-based sharing
+- [ ] Implement pause/resume functionality
+- [ ] Add multiple file sharing support
+- [ ] Implement bandwidth limiting
+- [ ] Add encryption option
+- [ ] Create GUI version
+
+## 📞 Support
+
+- 🐛 Issues: [GitHub Issues](https://gitcode.com/yunqiang_wu/p2p-transfer/issues)
+- 💬 Discussions: [GitHub Discussions](https://gitcode.com/yunqiang_wu/p2p-transfer/discussions)
+
+---
+
+Made with ❤️ for the P2P community

package/p2p.js

@@ -0,0 +1,289 @@
+#!/usr/bin/env node
+
+import WebTorrent from 'webtorrent';
+import cliProgress from 'cli-progress';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import chalk from 'chalk';
+import fs from 'fs';
+import path from 'path';
+import os from 'os';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const DEFAULT_TRACKERS = [
+  'udp://tracker.opentrackr.org:1337/announce',
+  'udp://tracker.openbittorrent.com:6969/announce',
+  'udp://exodus.desync.com:6969/announce',
+  'udp://tracker.coppersurfer.tk:6969/announce',
+  'wss://tracker.btorrent.xyz',
+  'wss://tracker.openwebtorrent.com',
+  'wss://tracker.webtorrent.io',
+];
+
+function formatSize(bytes) {
+  if (bytes === 0) return '0 B';
+  const k = 1024;
+  const sizes = ['B', 'KB', 'MB', 'GB', 'TB'];
+  const i = Math.floor(Math.log(bytes) / Math.log(k));
+  return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
+}
+
+function formatSpeed(bytesPerSecond) {
+  return formatSize(bytesPerSecond) + '/s';
+}
+
+function formatTime(seconds) {
+  if (!isFinite(seconds) || seconds < 0) return '--:--:--';
+  const h = Math.floor(seconds / 3600);
+  const m = Math.floor((seconds % 3600) / 60);
+  const s = Math.floor(seconds % 60);
+  return `${h.toString().padStart(2, '0')}:${m.toString().padStart(2, '0')}:${s.toString().padStart(2, '0')}`;
+}
+
+async function shareFile(filePath, options) {
+  console.log(chalk.blue('🚀 初始化 P2P 分享...'));
+  
+  const client = new WebTorrent({
+    tracker: {
+      RTCPeerConnection: false,
+    },
+    dht: {
+      pool: true,
+    },
+  });
+
+  const absolutePath = path.resolve(filePath);
+  
+  if (!fs.existsSync(absolutePath)) {
+    console.error(chalk.red('❌ 文件不存在: ' + absolutePath));
+    client.destroy();
+    process.exit(1);
+  }
+
+  const stats = fs.statSync(absolutePath);
+  const fileName = path.basename(absolutePath);
+  
+  console.log(chalk.cyan('📁 文件: ') + fileName);
+  console.log(chalk.cyan('📊 大小: ') + formatSize(stats.size));
+
+  return new Promise((resolve, reject) => {
+    client.seed(absolutePath, { 
+      announceList: [DEFAULT_TRACKERS],
+      name: fileName,
+    }, (torrent) => {
+      console.log(chalk.green('\n✅ 分享成功！\n'));
+      console.log(chalk.yellow('🔗 Magnet 链接 (复制发送给接收方):'));
+      console.log(chalk.white(torrent.magnetURI));
+      console.log(chalk.cyan('\n📋 BTIH Hash: ') + torrent.infoHash);
+      
+      console.log(chalk.blue('\n⏳ 等待连接中... (按 Ctrl+C 停止)\n'));
+      
+      torrent.on('wire', (wire) => {
+        const peerAddr = wire.remoteAddress || 'unknown';
+        console.log(chalk.green('🔗 新连接: ') + peerAddr);
+      });
+
+      torrent.on('error', (err) => {
+        console.error(chalk.red('Torrent error:'), err.message);
+      });
+
+      if (options.verbose) {
+        torrent.on('warning', (warning) => {
+          console.log(chalk.yellow('⚠️  Warning:'), warning.message);
+        });
+      }
+    });
+
+    client.on('error', (err) => {
+      console.error(chalk.red('❌ 客户端错误:'), err.message);
+      reject(err);
+    });
+  });
+}
+
+async function getFile(magnetUri, downloadPath, options) {
+  console.log(chalk.blue('📥 初始化 P2P 下载...'));
+  
+  const client = new WebTorrent({
+    tracker: {
+      RTCPeerConnection: false,
+    },
+    dht: {
+      pool: true,
+    },
+  });
+
+  const savePath = downloadPath || process.cwd();
+  
+  if (!fs.existsSync(savePath)) {
+    fs.mkdirSync(savePath, { recursive: true });
+  }
+
+  return new Promise((resolve, reject) => {
+    const torrent = client.add(magnetUri, { 
+      path: savePath,
+      announceList: [DEFAULT_TRACKERS],
+    });
+
+    const progressBar = new cliProgress.SingleBar({
+      format: chalk.cyan('📥 下载进度') + ' |' + chalk.cyan('{bar}') + '| {percentage}% | {downloaded}/{total} | {speed} | ETA: {eta}',
+      barCompleteChar: '\u2588',
+      barIncompleteChar: '\u2591',
+      hideCursor: true,
+    });
+
+    let startTime = Date.now();
+    let lastDownloaded = 0;
+    let updateInterval;
+
+    torrent.on('metadata', () => {
+      console.log(chalk.green('\n✅ 找到文件！\n'));
+      console.log(chalk.cyan('📁 文件名: ') + torrent.name);
+      console.log(chalk.cyan('📊 总大小: ') + formatSize(torrent.length));
+      console.log(chalk.cyan('📋 Hash: ') + torrent.infoHash);
+      console.log(chalk.cyan('📁 保存到: ') + savePath);
+      
+      progressBar.start(torrent.length, 0, {
+        downloaded: '0 B',
+        total: formatSize(torrent.length),
+        speed: '0 B/s',
+        eta: '--:--:--',
+      });
+
+      updateInterval = setInterval(() => {
+        if (torrent.length > 0) {
+          const downloaded = torrent.downloaded || 0;
+          const speed = torrent.downloadSpeed || 0;
+          const eta = torrent.timeRemaining / 1000;
+          
+          progressBar.update(downloaded, {
+            downloaded: formatSize(downloaded),
+            total: formatSize(torrent.length),
+            speed: formatSpeed(speed),
+            eta: formatTime(eta),
+          });
+        }
+      }, 500);
+    });
+
+    torrent.on('done', () => {
+      clearInterval(updateInterval);
+      const totalTime = ((Date.now() - startTime) / 1000).toFixed(2);
+      console.log(chalk.green('\n✅ 下载完成！'));
+      console.log(chalk.cyan('⏱️  总耗时: ') + totalTime + ' 秒');
+      console.log(chalk.cyan('📁 保存位置: ') + path.join(savePath, torrent.name));
+    });
+
+    torrent.on('wire', (wire) => {
+      const peerAddr = wire.remoteAddress || 'unknown';
+      console.log(chalk.green('🔗 新连接: ') + peerAddr + ' (已连接: ' + torrent.numPeers + ' 个节点)');
+    });
+
+    torrent.on('peer', (peer) => {
+      console.log(chalk.green('➕ 新节点: ') + (peer.remoteAddress || peer.ip || 'unknown'));
+    });
+
+    torrent.on('error', (err) => {
+      console.error(chalk.red('❌ 下载错误:'), err.message);
+      clearInterval(updateInterval);
+      reject(err);
+    });
+
+    client.on('error', (err) => {
+      console.error(chalk.red('❌ 客户端错误:'), err.message);
+      clearInterval(updateInterval);
+      reject(err);
+    });
+
+    process.on('SIGINT', () => {
+      console.log(chalk.yellow('\n\n⚠️  正在停止下载...'));
+      clearInterval(updateInterval);
+      if (progressBar.isActive) {
+        progressBar.stop();
+      }
+      client.destroy(() => {
+        console.log(chalk.green('✅ 已停止。'));
+        process.exit(0);
+      });
+    });
+  });
+}
+
+function showInfo() {
+  console.log(chalk.bold('\n🌐 P2P 文件传输工具\n'));
+  console.log(chalk.cyan('使用方法:'));
+  console.log('  发送文件:');
+  console.log(chalk.white('    p2p share <文件路径>'));
+  console.log('    例如: p2p share ~/movies/vacation.mp4\n');
+  console.log('  接收文件:');
+  console.log(chalk.white('    p2p get <magnet链接> [保存目录]'));
+  console.log('    例如: p2p get "magnet:?xt=..." ~/Downloads\n');
+  console.log(chalk.cyan('原理:'));
+  console.log('  - 使用 BitTorrent 协议进行 P2P 传输');
+  console.log('  - 通过 DHT 网络发现节点，无需公网 IP');
+  console.log('  - 支持跨局域网传输\n');
+}
+
+const argv = yargs(hideBin(process.argv))
+  .usage(chalk.bold('\n🌐 P2P 文件传输工具\n\n用法: $0 <命令> [参数]'))
+  .command('share', '分享文件，生成 magnet 链接', (yargs) => {
+    return yargs
+      .positional('file', {
+        describe: '要分享的文件路径',
+        type: 'string',
+      })
+      .option('v', {
+        alias: 'verbose',
+        describe: '显示详细日志',
+        type: 'boolean',
+        default: false,
+      });
+  }, async (argv) => {
+    const file = argv._[1];
+    if (!file) {
+      console.error(chalk.red('❌ 请指定要分享的文件路径'));
+      process.exit(1);
+    }
+    await shareFile(file, argv);
+  })
+  .command('get', '下载文件', (yargs) => {
+    return yargs
+      .positional('magnet', {
+        describe: 'Magnet 链接',
+        type: 'string',
+      })
+      .positional('path', {
+        describe: '保存目录',
+        type: 'string',
+        default: process.cwd(),
+      })
+      .option('v', {
+        alias: 'verbose',
+        describe: '显示详细日志',
+        type: 'boolean',
+        default: false,
+      });
+  }, async (argv) => {
+    const magnet = argv._[1];
+    const savePath = argv._[2] || process.cwd();
+    if (!magnet) {
+      console.error(chalk.red('❌ 请提供 Magnet 链接'));
+      process.exit(1);
+    }
+    await getFile(magnet, savePath, argv);
+  })
+  .command('info', '显示帮助信息', {}, () => {
+    showInfo();
+  })
+  .demandCommand(1, chalk.red('❌ 请指定命令: share 或 get'))
+  .help('h', '显示帮助')
+  .alias('h', 'help')
+  .version('v', '版本', '1.0.0')
+  .alias('v', 'version')
+  .epilog(chalk.cyan('\n💡 提示:'))
+  .epilog(chalk.cyan('  发送方运行: p2p share <文件>'))
+  .epilog(chalk.cyan('  接收方运行: p2p get <magnet链接>'))
+  .parse();

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "p2p-transfer",
+  "version": "1.0.0",
+  "description": "🚀 Pure CLI P2P file transfer tool using WebTorrent and BitTorrent DHT. Transfer files between different networks without public IP.",
+  "keywords": [
+    "p2p",
+    "bittorrent",
+    "webtorrent",
+    "file-transfer",
+    "cli",
+    "peer-to-peer",
+    "dht",
+    "magnet",
+    "share",
+    "download"
+  ],
+  "homepage": "https://gitcode.com/yunqiang_wu/p2p-transfer#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://gitcode.com/yunqiang_wu/p2p-transfer.git"
+  },
+  "bugs": {
+    "url": "https://gitcode.com/yunqiang_wu/p2p-transfer/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Yunqiang Wu",
+    "email": "your.email@example.com",
+    "url": "https://gitcode.com/yunqiang_wu"
+  },
+  "main": "p2p.js",
+  "bin": {
+    "p2p": "./p2p.js"
+  },
+  "type": "module",
+  "scripts": {
+    "start": "node p2p.js",
+    "share": "node p2p.js share",
+    "get": "node p2p.js get",
+    "info": "node p2p.js info",
+    "test": "echo \"No tests specified\" && exit 0"
+  },
+  "dependencies": {
+    "webtorrent": "^2.0.0",
+    "cli-progress": "^3.12.0",
+    "yargs": "^17.7.2",
+    "chalk": "^5.3.0"
+  },
+  "devDependencies": {},
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "preferGlobal": true,
+  "files": [
+    "p2p.js",
+    "README.md",
+    "LICENSE"
+  ]
+}