Initial commit: libp2p-native-bridge package

- Extracted libp2p component from main app - Created modular package structure with interfaces and implementations - Added dependency injection for NativeModules - Configured for IOR loading from Gitea - Added comprehensive README and documentation
2025-08-29 11:18:37 +02:00
commit 6f1d6ec37b
14 changed files with 2060 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,233 @@
+# libp2p-native-bridge
+
+Native libp2p bridge for React Native applications, providing a unified interface for iOS and Android libp2p implementations.
+
+## Installation
+
+### Via IOR (Interoperable Object Reference)
+
+```typescript
+import { Libp2pComponent } from 'ior:gitea:gitea.metatrom.net:universal-components/libp2p-native-bridge@1.0.0';
+```
+
+### Via npm/yarn (if published)
+
+```bash
+npm install @metatrom/libp2p-native-bridge
+# or
+yarn add @metatrom/libp2p-native-bridge
+```
+
+## Features
+
+- 🌐 Unified libp2p interface for React Native
+- 📱 iOS and Android native module support
+- 🔧 Configurable settings management
+- 🎛️ Settings UI component
+- 🔌 Protocol handler support
+- 🔍 Peer discovery and connection management
+- 🚀 TypeScript support with full type definitions
+
+## Usage
+
+### Basic Setup
+
+```typescript
+import { Libp2pComponent } from '@metatrom/libp2p-native-bridge';
+
+// Create libp2p instance
+const libp2p = new Libp2pComponent({
+  config: {
+    tcpPort: 10000,
+    wsPort: 10005,
+  },
+  protocols: [
+    {
+      protocolId: '/my-protocol/1.0.0',
+      handler: async ({ peerId, data }) => {
+        console.log(`Received data from ${peerId}:`, data);
+      },
+    },
+  ],
+});
+
+// Start the node
+await libp2p.start();
+
+// Listen for peer discovery
+libp2p.addEventListener('peer:discovery', (evt) => {
+  console.log('Discovered peer:', evt.detail.id.toString());
+});
+
+// Connect to a peer
+await libp2p.dial('/ip4/192.168.1.2/tcp/10000/p2p/12D3KooW...');
+```
+
+### Using with React Hook
+
+```typescript
+import { useLibp2p } from './hooks/useLibp2p';
+import { Libp2pComponent } from '@metatrom/libp2p-native-bridge';
+
+function MyComponent() {
+  const { isStarted, peerId, discoveredPeers, start, stop } = useLibp2p({
+    config: {
+      tcpPort: 10000,
+      wsPort: 10005,
+    },
+  });
+
+  return (
+    <View>
+      <Text>Status: {isStarted ? 'Started' : 'Stopped'}</Text>
+      <Text>Peer ID: {peerId?.toString()}</Text>
+      <Button title="Start" onPress={start} />
+      <Button title="Stop" onPress={stop} />
+    </View>
+  );
+}
+```
+
+### Settings Management
+
+```typescript
+import { getSettingsService, SettingsUI } from '@metatrom/libp2p-native-bridge';
+
+// Get settings service instance
+const settingsService = getSettingsService();
+
+// Load settings
+const settings = await settingsService.loadSettings();
+
+// Update settings
+await settingsService.updateSetting('tcpPort', 10100);
+
+// Use the Settings UI component
+<SettingsUI
+  initialSettings={settings}
+  onSettingsChange={(newSettings) => {
+    console.log('Settings changed:', newSettings);
+  }}
+/>
+```
+
+## API Reference
+
+### Libp2pComponent
+
+Main class for interacting with the native libp2p implementation.
+
+#### Constructor Options
+
+```typescript
+interface Libp2pOptions {
+  config?: {
+    tcpPort?: number;    // Default: 10000
+    wsPort?: number;     // Default: 10005
+  };
+  protocols?: ProtocolHandler[];
+  keypair?: {
+    privateKey: Uint8Array;
+    publicKey: Uint8Array;
+  };
+}
+```
+
+#### Methods
+
+- `start()`: Start the libp2p node
+- `stop()`: Stop the libp2p node
+- `dial(multiaddr: string)`: Connect to a peer
+- `hangUp(peerId: string)`: Disconnect from a peer
+- `getConnections(peerId?: string)`: Get active connections
+- `sendProtocolData(peerId: string, protocolId: string, data: Uint8Array)`: Send data via protocol
+- `refreshDiscovery()`: Refresh peer discovery
+- `pingPeer(peerId: string)`: Ping a peer
+
+#### Events
+
+- `peer:discovery`: New peer discovered
+- `peer:lost`: Peer lost
+- `peer:connect`: Peer connected
+- `peer:disconnect`: Peer disconnected
+- `connection:open`: Connection opened
+- `connection:close`: Connection closed
+- `self:peer:update`: Own peer info updated
+
+### SettingsService
+
+Singleton service for managing application settings.
+
+#### Methods
+
+- `getInstance()`: Get singleton instance
+- `initialize()`: Initialize settings
+- `loadSettings()`: Load settings from storage
+- `saveSettings(settings)`: Save settings
+- `getSettings()`: Get current settings
+- `updateSetting(key, value)`: Update specific setting
+- `resetAllData()`: Reset all application data
+
+## Native Module Requirements
+
+This package requires the following native modules to be implemented in your React Native project:
+
+### iOS
+- `Libp2pModule`: Swift implementation of libp2p
+- `DiscoveryModule`: mDNS/Bonjour discovery
+- `SecureStorageModule`: Keychain storage (optional)
+
+### Android
+- `Libp2pModule`: Kotlin implementation of libp2p
+- `DiscoveryModule`: Network Service Discovery
+- `SecureStorageModule`: Keystore storage (optional)
+
+## Configuration
+
+### Default Settings
+
+```typescript
+{
+  tcpPort: 10000,
+  wsPort: 10005,
+  discoveryTimeout: 30000,
+  enableDebugLogs: false,
+  autoDiscovery: false,
+  useCustomPorts: false,
+  dhtServerUrl: 'ws://192.168.188.40:3000/ws'
+}
+```
+
+## Platform Considerations
+
+### iOS
+- Uses Swift libp2p packages
+- Native Bonjour/mDNS discovery
+- Compile-time protocol registration
+
+### Android
+- Uses Kotlin with JVM libp2p
+- Network Service Discovery (NSD)
+- Dynamic protocol registration
+
+## Dependencies
+
+### Peer Dependencies
+- `react`: >=18.0.0
+- `react-native`: >=0.72.0
+- `@react-native-async-storage/async-storage`: *
+
+### External IOR Dependencies
+- `ior:gitea:gitea.metatrom.net:universal-components/logger@1.0.0`
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Support
+
+For issues and questions, please open an issue on the repository.