librats 0.5.4 → 0.7.0

package/lib/index.d.ts

@@ -2,7 +2,7 @@
  * LibRats Node.js Bindings - TypeScript Definitions
  * 
  * High-performance peer-to-peer networking library with support for DHT, GossipSub,
- * file transfer, NAT traversal, and more.
+ * file transfer, and more.
  */
 
 /**
@@ -15,22 +15,6 @@ export interface VersionInfo {
   build: number;
 }
 
-/**
- * Connection strategy options for connecting to peers
- */
-export enum ConnectionStrategy {
-  /** Direct connection only, no NAT traversal */
-  DIRECT_ONLY = 0,
-  /** STUN-assisted connection */
-  STUN_ASSISTED = 1,
-  /** Full ICE negotiation with STUN and connection checks */
-  ICE_FULL = 2,
-  /** TURN relay connection */
-  TURN_RELAY = 3,
-  /** Automatic strategy selection based on network conditions */
-  AUTO_ADAPTIVE = 4
-}
-
 /**
  * Error codes returned by various operations
  */
@@ -53,6 +37,39 @@ export enum ErrorCodes {
   JSON_PARSE = -7
 }
 
+/**
+ * ICE connection states
+ */
+export enum IceConnectionState {
+  NEW = 0,
+  GATHERING = 1,
+  CHECKING = 2,
+  CONNECTED = 3,
+  COMPLETED = 4,
+  FAILED = 5,
+  DISCONNECTED = 6,
+  CLOSED = 7
+}
+
+/**
+ * ICE gathering states
+ */
+export enum IceGatheringState {
+  NEW = 0,
+  GATHERING = 1,
+  COMPLETE = 2
+}
+
+/**
+ * ICE candidate types
+ */
+export enum IceCandidateType {
+  HOST = 0,
+  SRFLX = 1,
+  PRFLX = 2,
+  RELAY = 3
+}
+
 /**
  * Main RatsClient class for peer-to-peer networking
  */
@@ -84,15 +101,6 @@ export class RatsClient {
    */
   connect(host: string, port: number): boolean;
 
-  /**
-   * Connect to a peer with a specific connection strategy
-   * @param host - IP address or hostname of the peer
-   * @param port - Port number of the peer
-   * @param strategy - Connection strategy to use
-   * @returns true if connection initiated successfully
-   */
-  connectWithStrategy(host: string, port: number, strategy: ConnectionStrategy): boolean;
-
   /**
    * Disconnect from a peer
    * @param peerId - ID of the peer to disconnect from
@@ -101,6 +109,12 @@ export class RatsClient {
 
   // ============ Information ============
 
+  /**
+   * Get the port the client is listening on
+   * @returns Listen port number
+   */
+  getListenPort(): number;
+
   /**
    * Get the number of connected peers
    * @returns Number of connected peers
@@ -276,6 +290,13 @@ export class RatsClient {
    */
   resumeFileTransfer(transferId: string): boolean;
 
+  /**
+   * Get file transfer progress information as JSON string
+   * @param transferId - ID of the transfer to query
+   * @returns JSON string with progress info, or null if not found
+   */
+  getFileTransferProgress(transferId: string): string | null;
+
   // ============ GossipSub ============
 
   /**
@@ -340,6 +361,12 @@ export class RatsClient {
    */
   getTopicPeers(topic: string): string[];
 
+  /**
+   * Get GossipSub statistics as JSON string
+   * @returns JSON string with statistics, or null if unavailable
+   */
+  getGossipsubStatistics(): string | null;
+
   // ============ DHT ============
 
   /**
@@ -395,6 +422,20 @@ export class RatsClient {
    */
   isMdnsRunning(): boolean;
 
+  /**
+   * Query for mDNS services
+   * @returns true if query sent successfully
+   */
+  queryMdnsServices(): boolean;
+
+  // ============ Address Blocking ============
+
+  /**
+   * Add an IP address to the ignore list
+   * @param ipAddress - IP address to ignore
+   */
+  addIgnoredAddress(ipAddress: string): void;
+
   // ============ Encryption ============
 
   /**
@@ -411,23 +452,157 @@ export class RatsClient {
   isEncryptionEnabled(): boolean;
 
   /**
-   * Generate a new encryption key
-   * @returns Hex-encoded encryption key, or null if failed
+   * Initialize encryption system
+   * @param enable - Whether to enable encryption
+   * @returns true if initialized successfully
    */
-  generateEncryptionKey(): string | null;
+  initializeEncryption(enable: boolean): boolean;
 
   /**
-   * Set the encryption key
-   * @param keyHex - Hex-encoded encryption key
+   * Check if a specific peer connection is encrypted
+   * @param peerId - Peer ID to check
+   * @returns true if peer connection is encrypted
+   */
+  isPeerEncrypted(peerId: string): boolean;
+
+  /**
+   * Set custom Noise Protocol static keypair
+   * @param privateKeyHex - 32-byte private key as 64-char hex string
    * @returns true if set successfully
    */
-  setEncryptionKey(keyHex: string): boolean;
+  setNoiseStaticKeypair(privateKeyHex: string): boolean;
+
+  /**
+   * Get our Noise Protocol static public key
+   * @returns 64-char hex string, or null if not available
+   */
+  getNoiseStaticPublicKey(): string | null;
+
+  /**
+   * Get remote peer's Noise static public key
+   * @param peerId - Peer ID to query
+   * @returns 64-char hex string, or null if not available
+   */
+  getPeerNoisePublicKey(peerId: string): string | null;
+
+  /**
+   * Get handshake hash for channel binding
+   * @param peerId - Peer ID to query
+   * @returns 64-char hex string, or null if not available
+   */
+  getPeerHandshakeHash(peerId: string): string | null;
+
+  // ============ ICE (NAT Traversal) ============
+
+  /**
+   * Check if ICE is available
+   * @returns true if ICE is available
+   */
+  isIceAvailable(): boolean;
+
+  /**
+   * Add a STUN server for NAT traversal
+   * @param host - STUN server hostname or IP
+   * @param port - STUN server port (default: 3478)
+   */
+  addStunServer(host: string, port?: number): void;
+
+  /**
+   * Add a TURN server for relay-based NAT traversal
+   * @param host - TURN server hostname or IP
+   * @param port - TURN server port
+   * @param username - TURN username
+   * @param password - TURN password
+   */
+  addTurnServer(host: string, port: number, username: string, password: string): void;
+
+  /**
+   * Clear all ICE (STUN/TURN) servers
+   */
+  clearIceServers(): void;
+
+  /**
+   * Start gathering ICE candidates
+   * @returns true if gathering started successfully
+   */
+  gatherIceCandidates(): boolean;
+
+  /**
+   * Get local ICE candidates as JSON string
+   * @returns JSON string of candidates, or null if unavailable
+   */
+  getIceCandidates(): string | null;
+
+  /**
+   * Check if ICE candidate gathering is complete
+   * @returns true if gathering is complete
+   */
+  isIceGatheringComplete(): boolean;
+
+  /**
+   * Get public address discovered via STUN
+   * @returns Address string (ip:port), or null if not discovered
+   */
+  getPublicAddress(): string | null;
+
+  /**
+   * Perform a simple STUN binding request to discover public address
+   * @param stunServer - STUN server hostname (default: "stun.l.google.com")
+   * @param port - STUN server port (default: 19302)
+   * @param timeoutMs - Timeout in milliseconds (default: 5000)
+   * @returns Address string (ip:port), or null on failure
+   */
+  discoverPublicAddress(stunServer?: string, port?: number, timeoutMs?: number): string | null;
+
+  /**
+   * Add a remote ICE candidate from SDP
+   * @param candidateSdp - SDP candidate string
+   */
+  addRemoteIceCandidate(candidateSdp: string): void;
+
+  /**
+   * Signal end of remote ICE candidates (trickle ICE complete)
+   */
+  endOfRemoteIceCandidates(): void;
+
+  /**
+   * Start ICE connectivity checks
+   */
+  startIceChecks(): void;
+
+  /**
+   * Get current ICE connection state
+   * @returns ICE connection state value
+   */
+  getIceConnectionState(): number;
+
+  /**
+   * Get ICE gathering state
+   * @returns ICE gathering state value
+   */
+  getIceGatheringState(): number;
+
+  /**
+   * Check if ICE is connected
+   * @returns true if ICE connection is established
+   */
+  isIceConnected(): boolean;
+
+  /**
+   * Get the selected ICE candidate pair as JSON string
+   * @returns JSON string of selected pair, or null if unavailable
+   */
+  getIceSelectedPair(): string | null;
+
+  /**
+   * Close ICE manager and release resources
+   */
+  closeIce(): void;
 
   /**
-   * Get the current encryption key
-   * @returns Hex-encoded encryption key, or null if not set
+   * Restart ICE (re-gather candidates and restart checks)
    */
-  getEncryptionKey(): string | null;
+  restartIce(): void;
 
   // ============ Configuration Persistence ============
 

package/native-src/CMakeLists.txt

@@ -77,11 +77,13 @@ endif()
 option(RATS_BUILD_EXAMPLES "Build examples" ON)
 option(RATS_BUILD_TESTS "Build unit tests" ON)
 option(RATS_ENABLE_ASAN "Enable AddressSanitizer" OFF)
+option(RATS_ENABLE_TSAN "Enable ThreadSanitizer" OFF)
 option(RATS_BINDINGS "Enable bindings" ON)
 option(RATS_CROSSCOMPILING "Force cross-compilation flags" OFF)
 option(RATS_SHARED_LIBRARY "Build as shared library" OFF)
 option(RATS_STATIC_LIBRARY "Build as static library" ON)
 option(RATS_SEARCH_FEATURES "Features related to rats-search project (like bittorrent)" OFF)
+option(RATS_STORAGE "Enable distributed storage module" OFF)
 
 # Validate library type options
 if(RATS_SHARED_LIBRARY AND RATS_STATIC_LIBRARY)
@@ -127,31 +129,22 @@ set(LIBRARY_SOURCES
     src/krpc.cpp
     src/krpc.h
     src/librats.cpp
+    src/librats_reconnection.cpp
     src/librats_logging.cpp
+    src/librats_encryption.cpp
     src/librats_file_transfer.cpp
     src/librats_gossipsub.cpp
-    src/librats_nat.cpp
-    src/librats_ice.cpp
     src/librats_mdns.cpp
     src/librats_persistence.cpp
-    src/librats_encryption.cpp
     src/librats.h
     src/sha1.cpp
     src/sha1.h
     src/os.cpp
     src/os.h
-    src/stun.cpp
-    src/stun.h
-    src/ice.cpp
-    src/ice.h
     src/fs.cpp
     src/fs.h
     src/logger.h
     src/logger.cpp
-    src/noise.cpp
-    src/noise.h
-    src/encrypted_socket.cpp
-    src/encrypted_socket.h
     src/mdns.cpp
     src/mdns.h
     src/threadmanager.cpp
@@ -163,6 +156,46 @@ set(LIBRARY_SOURCES
     src/version.cpp
     src/rats_export.h
     ${PROJECT_BINARY_DIR}/src/version.h
+
+# Buffer utilities for bittorrent and file transfer
+    src/receive_buffer.h
+    src/receive_buffer.cpp
+    src/chained_send_buffer.h
+    src/chained_send_buffer.cpp
+
+# Cypto algorithms including Noise Protocol needed
+    src/crypto/curve25519.c
+    src/crypto/curve25519.h
+    src/crypto/chacha.c
+    src/crypto/chacha.h
+    src/crypto/poly1305.c
+    src/crypto/poly1305.h
+    src/crypto/chachapoly.c
+    src/crypto/chachapoly.h
+    src/crypto/sha256.c
+    src/crypto/sha256.h
+    src/crypto/sha512.c
+    src/crypto/sha512.h
+    src/crypto/hkdf.c
+    src/crypto/hkdf.h
+    src/crypto/blake2s.c
+    src/crypto/blake2s.h
+    src/crypto/blake2b.c
+    src/crypto/blake2b.h
+    src/crypto/blake2_endian.h
+
+# Noise Protocol implementation
+    src/noise.cpp
+    src/noise.h
+
+# NAT traversal (STUN/TURN/ICE)
+    src/stun.cpp
+    src/stun.h
+    src/turn.cpp
+    src/turn.h
+    src/ice.cpp
+    src/ice.h
+    src/librats_ice.cpp
 )
 
 # Add BitTorrent sources if RATS_SEARCH_FEATURES is enabled
@@ -171,8 +204,50 @@ if(RATS_SEARCH_FEATURES)
         src/librats_bittorrent.cpp
         src/bittorrent.cpp
         src/bittorrent.h
+        src/bt_types.h
+        src/bt_bitfield.h
+        src/bt_bitfield.cpp
+        src/bt_file_storage.h
+        src/bt_file_storage.cpp
+        src/bt_torrent_info.h
+        src/bt_torrent_info.cpp
+        src/bt_piece_picker.h
+        src/bt_piece_picker.cpp
+        src/bt_messages.h
+        src/bt_messages.cpp
+        src/bt_handshake.h
+        src/bt_handshake.cpp
+        src/bt_peer_connection.h
+        src/bt_peer_connection.cpp
+        src/bt_extension.h
+        src/bt_extension.cpp
+        src/bt_choker.h
+        src/bt_choker.cpp
+        src/bt_torrent.h
+        src/bt_torrent.cpp
+        src/bt_client.h
+        src/bt_client.cpp
+        src/bt_network.h
+        src/bt_network.cpp
+        src/disk_io.cpp
+        src/disk_io.h
         src/tracker.cpp
         src/tracker.h
+        src/bt_create_torrent.h
+        src/bt_create_torrent.cpp
+        src/bt_resume_data.h
+        src/bt_resume_data.cpp
+    )
+endif()
+
+# Add Storage sources if RATS_STORAGE is enabled
+if(RATS_STORAGE)
+    list(APPEND LIBRARY_SOURCES
+        src/crc32.cpp
+        src/crc32.h
+        src/storage.cpp
+        src/storage.h
+        src/librats_storage.cpp
     )
 endif()
 
@@ -200,6 +275,7 @@ set_target_properties(rats PROPERTIES POSITION_INDEPENDENT_CODE ON)
 
 # Include directories
 target_include_directories(rats PUBLIC ${PROJECT_BINARY_DIR}/src src)
+target_include_directories(rats PUBLIC ${PROJECT_SOURCE_DIR}/src/crypto)
 
 # Find and link threading support
 find_package(Threads REQUIRED)
@@ -235,6 +311,11 @@ if(RATS_SEARCH_FEATURES)
     target_compile_definitions(rats PUBLIC RATS_SEARCH_FEATURES)
 endif(RATS_SEARCH_FEATURES)
 
+if(RATS_STORAGE)
+    message(STATUS "Enable distributed storage module")
+    target_compile_definitions(rats PUBLIC RATS_STORAGE)
+endif(RATS_STORAGE)
+
 # Create the main executable
 if(RATS_BUILD_EXAMPLES)
     add_executable(rats-client src/main.cpp)
@@ -258,6 +339,11 @@ set_target_properties(rats PROPERTIES
     RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin
 )
 
+# Sanitizer configuration - ASAN and TSAN are mutually exclusive
+if(RATS_ENABLE_ASAN AND RATS_ENABLE_TSAN)
+    message(FATAL_ERROR "AddressSanitizer and ThreadSanitizer cannot be enabled simultaneously")
+endif()
+
 # AddressSanitizer configuration
 if(RATS_ENABLE_ASAN)
     if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
@@ -278,6 +364,21 @@ if(RATS_ENABLE_ASAN)
     endif()
 endif()
 
+# ThreadSanitizer configuration
+if(RATS_ENABLE_TSAN)
+    if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+        set(TSAN_FLAGS "-fsanitize=thread -fno-omit-frame-pointer -g")
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${TSAN_FLAGS}")
+        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${TSAN_FLAGS}")
+        set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${TSAN_FLAGS}")
+        set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${TSAN_FLAGS}")
+        
+        message(STATUS "ThreadSanitizer enabled (GCC/Clang)")
+    else()
+        message(WARNING "ThreadSanitizer is only supported by GCC/Clang compilers")
+    endif()
+endif()
+
 if(RATS_BUILD_TESTS)
     target_compile_definitions(rats PUBLIC TESTING)
 
@@ -311,23 +412,55 @@ if(RATS_BUILD_TESTS)
         tests/test_dht.cpp
         tests/test_rats_client.cpp
         tests/test_os.cpp
-        tests/test_stun.cpp
-        tests/test_ice.cpp
         tests/test_fs.cpp
         tests/test_config_persistence.cpp
         tests/test_main.cpp
         tests/test_message_exchange.cpp
-        tests/test_noise.cpp
         tests/test_gossipsub.cpp
         tests/test_logging_api_gtest.cpp
         tests/test_file_transfer.cpp
+        tests/test_reconnection.cpp
+# Noise Protocol Crypto tests
+        tests/test_crypto_curve25519.cpp
+        tests/test_crypto_chacha_poly.cpp
+        tests/test_crypto_sha2.cpp
+        tests/test_crypto_blake2.cpp
+        tests/test_noise.cpp
+# NAT traversal tests (STUN/TURN/ICE)
+        tests/test_stun.cpp
+        tests/test_turn.cpp
+        tests/test_ice.cpp
+# Buffer utilities for file transfer and bittorrent
+        tests/test_receive_buffer.cpp
+        tests/test_chained_send_buffer.cpp
     )
-    
+
     # Add BitTorrent tests if RATS_SEARCH_FEATURES is enabled
     if(RATS_SEARCH_FEATURES)
         list(APPEND TEST_SOURCES 
             tests/test_bittorrent.cpp
             tests/test_tracker.cpp
+            tests/test_disk_io.cpp
+            tests/test_bt_bitfield.cpp
+            tests/test_bt_file_storage.cpp
+            tests/test_bt_torrent_info.cpp
+            tests/test_bt_piece_picker.cpp
+            tests/test_bt_messages.cpp
+            tests/test_bt_handshake.cpp
+            tests/test_bt_peer_connection.cpp
+            tests/test_bt_extension.cpp
+            tests/test_bt_network.cpp
+            tests/test_bt_integration.cpp
+            tests/test_bt_create_torrent.cpp
+            tests/test_bt_resume_data.cpp
+        )
+    endif()
+
+    # Add Storage tests if RATS_STORAGE is enabled
+    if(RATS_STORAGE)
+        list(APPEND TEST_SOURCES 
+            tests/test_crc32.cpp
+            tests/test_storage.cpp
         )
     endif()
 

package/native-src/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 librats contributors
+Copyright (c) 2026 librats contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal