Added custom tracker support for webtorrent

Signed-off-by: Robert Gogete <[email protected]>

Author: gogeterobert

README.md

@@ -15,15 +15,20 @@ A TypeScript package that provides peer-to-peer file sharing capabilities using
 - Robust error handling and fallback mechanisms
 - Real-time download progress tracking
 - Cascading network topology detection and error reporting
- - Host your own Gun.js relay for decentralized P2P
- - WebTorrent support for browser-based P2P file sharing
+- Host your own Gun.js relay for decentralized P2P
+- WebTorrent support for browser-based P2P file sharing
+- **Custom WebTorrent tracker configuration** for private or specialized networks
 
 ## Installation
 
 ```bash
 npm install dig-nat-tools
 ```
 
+## Quick Links
+
+- [Custom WebTorrent Tracker Configuration Guide](./CUSTOM_TRACKERS.md) - Learn how to configure custom trackers for WebTorrent
+
 ## Running the Example
 
 To test the package with the included example:

src/client.ts

@@ -24,6 +24,9 @@ export interface FileClientOptions {
   peers?: string[]; // Gun.js peer URLs
   namespace?: string; // Gun.js namespace
   logger?: Logger; // Optional logger for debug output
+  webTorrent?: {
+    trackers?: string[]; // Custom tracker URLs
+  };
 }
 
 
@@ -258,7 +261,11 @@ export class FileClient extends EventEmitter implements IFileClient {
 
     // Initialize the shared WebTorrent manager if not already done
     if (!webTorrentManager.isAvailable()) {
-      await webTorrentManager.initialize(this.logger);
+      const webTorrentOptions = this.options.webTorrent?.trackers 
+        ? { trackers: this.options.webTorrent.trackers }
+        : undefined;
+      
+      await webTorrentManager.initialize(this.logger, webTorrentOptions);
     }
 
     // Set up event listeners (only done once)

src/host.ts

@@ -33,6 +33,9 @@ export interface HostOptions {
     peers: string[]; // Gun.js peer URLs
     namespace?: string; // Registry namespace
   };
+  webTorrent?: {
+    trackers?: string[]; // Custom tracker URLs
+  };
 }
 
 export class FileHost implements IFileHost {
@@ -335,9 +338,13 @@ export class FileHost implements IFileHost {
       try {
         this.logger.debug(`🔄 Initializing shared WebTorrent manager...`);
 
-        // Initialize the shared WebTorrent manager
+        // Initialize the shared WebTorrent manager with custom trackers if provided
         if (!webTorrentManager.isAvailable()) {
-          await webTorrentManager.initialize(this.logger);
+          const webTorrentOptions = this.options.webTorrent?.trackers 
+            ? { trackers: this.options.webTorrent.trackers }
+            : undefined;
+          
+          await webTorrentManager.initialize(this.logger, webTorrentOptions);
         }
 
         this.logger.debug(`✅ Shared WebTorrent manager initialized and ready`);

src/index.ts

@@ -17,4 +17,5 @@ export {
 // Export types for TypeScript users
 export type { HostOptions } from './host';
 export type { FileClientOptions, DownloadOptions } from './client';
-export type { IFileHost, IFileClient, HostCapabilities } from './interfaces';
+export type { IFileHost, IFileClient, HostCapabilities, WebTorrentConfig } from './interfaces';
+export type { WebTorrentOptions } from './webtorrent-manager';

src/interfaces.ts

@@ -1,6 +1,10 @@
 import { Readable } from 'stream';
 import { DownloadOptions } from './client';
 
+export interface WebTorrentConfig {
+  trackers?: string[]; // Custom tracker URLs
+}
+
 export interface HostCapabilities {
   storeId: string;
   // Connection methods (in order of preference)

src/webtorrent-manager.ts

@@ -10,6 +10,10 @@ interface Logger {
   error(message: string, ...args: unknown[]): void;
 }
 
+export interface WebTorrentOptions {
+  trackers?: string[]; // Custom tracker URLs
+}
+
 export interface DownloadProgressEvent {
   downloaded: number; // Total bytes downloaded
   downloadSpeed: number; // Current download speed in bytes/second
@@ -37,6 +41,7 @@ class WebTorrentManager extends EventEmitter {
   private logger: Logger;
   private isInitialized: boolean = false;
   private initializationPromise: Promise<void> | null = null;
+  private customTrackers: string[] = [];
 
   private constructor() {
     super();
@@ -65,7 +70,7 @@ class WebTorrentManager extends EventEmitter {
   /**
    * Initialize the WebTorrent client (only once, atomically)
    */
-  public async initialize(logger?: Logger): Promise<void> {
+  public async initialize(logger?: Logger, options?: WebTorrentOptions): Promise<void> {
     // If already initialized, return immediately
     if (this.isInitialized && this.webTorrentClient) {
       return;
@@ -78,7 +83,7 @@ class WebTorrentManager extends EventEmitter {
     }
 
     // Start the initialization process atomically
-    this.initializationPromise = this.performInitialization(logger);
+    this.initializationPromise = this.performInitialization(logger, options);
 
     try {
       await this.initializationPromise;
@@ -91,15 +96,30 @@ class WebTorrentManager extends EventEmitter {
   /**
    * Perform the actual initialization work
    */
-  private async performInitialization(logger?: Logger): Promise<void> {
+  private async performInitialization(logger?: Logger, options?: WebTorrentOptions): Promise<void> {
     if (logger) {
       this.logger = logger;
     }
 
+    // Store custom trackers if provided
+    if (options?.trackers) {
+      this.customTrackers = options.trackers;
+      this.logger.debug(`🔧 Custom trackers configured: ${this.customTrackers.join(', ')}`);
+    }
+
     this.logger.debug("🚀 Initializing shared WebTorrent client...");
 
     try {
-      this.webTorrentClient = new WebTorrent();
+      const webTorrentOptions: WebTorrent.Options = {};
+      
+      // Add custom trackers to WebTorrent client configuration if provided
+      if (this.customTrackers.length > 0) {
+        webTorrentOptions.tracker = {
+          announce: this.customTrackers
+        } as WebTorrent.Options['tracker'];
+      }
+
+      this.webTorrentClient = new WebTorrent(webTorrentOptions);
 
       // Set unlimited max listeners for the WebTorrent client (if method exists)
       if (typeof this.webTorrentClient.setMaxListeners === 'function') {
@@ -352,7 +372,15 @@ class WebTorrentManager extends EventEmitter {
 
     return new Promise<string>((resolve, reject) => {
       try {
-        this.webTorrentClient!.seed(filePath, (torrent) => {
+        const seedOptions: WebTorrent.TorrentOptions = {};
+        
+        // Add custom trackers to the torrent if configured
+        if (this.customTrackers.length > 0) {
+          seedOptions.announce = this.customTrackers;
+          this.logger.debug(`🔧 Using custom trackers for seeding: ${this.customTrackers.join(', ')}`);
+        }
+
+        this.webTorrentClient!.seed(filePath, seedOptions, (torrent) => {
           const magnetURI = torrent.magnetURI;
           this.logger.debug(`🧲 File seeded successfully: ${filePath}`);
           this.logger.debug(`   Magnet URI: ${magnetURI}`);