A comprehensive libp2p pubsub implementation for Dart, featuring GossipSub v1.1, FloodSub, and RandomSub protocols with message validation, peer scoring, and tracing support.
🚀 Multiple PubSub Protocols
- GossipSub v1.1 - Production-ready, efficient pubsub protocol with mesh-based routing
- FloodSub - Simple flooding protocol for development and testing
- RandomSub - Randomized message propagation for research
🔒 Security & Validation
- Message validation with custom validators
- Peer scoring system for network health
- Cryptographic message signing and verification
📊 Monitoring & Debugging
- Comprehensive event tracing
- JSON and Protocol Buffer trace formats
- Built-in logging and metrics
⚡ Performance
- Efficient message caching with MCache
- Optimized RPC queue management
- Configurable mesh parameters for different use cases
Add to your pubspec.yaml:
dependencies:
dart_libp2p_pubsub: ^1.0.1
dart_libp2p: ^0.5.2import 'package:dart_libp2p_pubsub/dart_libp2p_pubsub.dart';
import 'package:dart_libp2p/core/host/host.dart';
// Create a libp2p host
final host = await createLibp2pHost();
// Set up GossipSub router
final router = GossipSubRouter();
final pubsub = PubSub(host, router);
// Start the pubsub system
await pubsub.start();
// Subscribe to a topic
const topic = '/my-app/chat';
final subscription = pubsub.subscribe(topic);
// Listen for messages
subscription.stream.listen((message) {
print('Received: ${String.fromCharCodes(message.data)}');
});
// Publish a message
final messageData = Uint8List.fromList('Hello, World!'.codeUnits);
await pubsub.publish(topic, messageData);Run a simple peer-to-peer chat:
# Terminal 1
dart example/chat.dart
# Terminal 2 (connect to the first node)
dart example/chat.dart /ip4/127.0.0.1/tcp/4001/p2p/QmPeerId...// Define a custom validator
bool validateChatMessage(String topic, dynamic message) {
if (topic != '/chat/1.0.0') return false;
final data = String.fromCharCodes(message.data);
return data.length <= 1000; // Max 1000 characters
}
// Register the validator
pubsub.addValidator('/chat/1.0.0', validateChatMessage);// Configure peer scoring parameters
final scoreParams = PeerScoreParams(
behaviourPenaltyWeight: -10.0,
behaviourPenaltyDecay: 0.99,
behaviourPenaltyThreshold: -100.0,
);
final pubsub = PubSub(host, router, scoreParams: scoreParams);📚 Comprehensive Guides
- Network Setup - Getting your libp2p network running
- GossipSub Usage - How to use GossipSub effectively
- GossipSub Deep Dive - Advanced GossipSub concepts
- Testing - Testing strategies and examples
- Configuration - Tuning parameters for your use case
- Best Practices - Production deployment guidelines
The library is organized into several key components:
lib/
├── src/
│ ├── core/ # Core pubsub functionality
│ │ ├── pubsub.dart # Main PubSub class
│ │ ├── message.dart # Message handling
│ │ ├── subscription.dart # Topic subscriptions
│ │ └── validation.dart # Message validation
│ ├── gossipsub/ # GossipSub v1.1 implementation
│ │ ├── gossipsub.dart # Main router
│ │ ├── mcache.dart # Message cache
│ │ └── score.dart # Peer scoring
│ ├── floodsub/ # FloodSub protocol
│ ├── randomsub/ # RandomSub protocol
│ └── tracing/ # Event tracing
We welcome contributions! Please see our Contributing Guide for details.
# Clone the repository
git clone https://github.com/stephanfeb/dart_libp2p_pubsub.git
cd dart_libp2p_pubsub
# Install dependencies
dart pub get
# Run tests
dart test
# Generate protobuf files
dart run build_runner buildThis project is licensed under the MIT License - see the LICENSE file for details.
- dart_libp2p - Core libp2p implementation for Dart
- dart_libp2p_kad_dht - Kademlia DHT implementation