Skip to main content

Welcome to Vaultys Peer SDK 🚀

Build powerful peer-to-peer applications that your users will love! Whether you're creating a chat app, file-sharing platform, or collaborative tool, Vaultys Peer SDK gives you everything you need to ship fast.

Why Vaultys Peer SDK?​

🎯 The Problem​

Building P2P applications is hard. You need to:

  • Understand WebRTC complexity
  • Handle connection management
  • Implement reconnection logic
  • Manage peer discovery
  • Deal with NAT traversal
  • Build message protocols
  • Handle file transfers
  • ...and so much more

✨ The Solution​

Vaultys Peer SDK abstracts away the complexity while giving you full control. We handle the hard parts so you can focus on building amazing features.

// This is all it takes to get started!
import { setupVaultysPeerSDK } from '@vaultys/peer-sdk';

const peer = setupVaultysPeerSDK();
await peer.initialize('did:example:alice');

// Connect and chat with a friend
const friend = await peer.addContact('did:example:bob');
await peer.sendMessage(friend.did, 'Hello P2P World! 🌍');

🎮 What Can You Build?​

The possibilities are endless! Here are just a few examples:

💬 Real-time Chat Apps​

Build WhatsApp-like messaging with end-to-end encryption, file sharing, and group chats.

📁 File Sharing Platforms​

Create Dropbox-style file sharing without servers. Direct transfers between users.

🎮 Multiplayer Games​

Low-latency networking for real-time gameplay. Perfect for turn-based or action games.

📹 Video Conferencing​

Add Zoom-like video calls to your app with WebRTC media streaming.

🤝 Collaboration Tools​

Real-time collaborative editing, whiteboarding, and screen sharing.

🔒 Secure Communication​

Private channels for sensitive data with end-to-end encryption.

🚀 Quick Start​

Get your first P2P app running in under 5 minutes with passwordless authentication and automatic offline message handling:

1. Installation​

# Using npm
npm install @vaultys/peer-sdk

# Using yarn
yarn add @vaultys/peer-sdk

# Using pnpm
pnpm add @vaultys/peer-sdk

2. Basic Setup​

import { setupVaultysPeerSDK } from '@vaultys/peer-sdk';
import { VaultysId } from '@vaultys/id'; // Batteries included!

// Authenticate with passkey - incredibly simple!
const identity = await VaultysId.authenticate({
  passkey: true,  // Enable biometric/security key auth
  fallbackToPin: true  // Optional PIN fallback
});
// No passwords needed! 🎉

// Initialize the SDK with authenticated identity
const peerService = setupVaultysPeerSDK({
  identity,  // Use authenticated identity
  debug: true,
  // Optional: Bring your own signaling server
  relay: {
    host: 'your-server.com',
    port: 443,
    secure: true
  }
});

// Already authenticated and connected!
await peerService.initialize(identity.did);

console.log('Connected with DID:', peerService.myDid);

3. Connect with Friends​

// Add contacts - lazy loading means no connection overhead!
const friend = await peerService.addContact('did:vaultys:friend', {
  nickname: 'My Friend',
  accepted: true
});

// Add thousands of contacts efficiently
const contacts = await peerService.bulkAddContacts(thousandsOfDids);
// No connections established yet - zero overhead!

// Connection only happens when you send a message
// Send a message (connection established now!)
await peer.sendMessage(friend.did, 'Hey there! 👋');
// NOW the connection is established!

// Peer offline? No problem! Messages queue automatically
await peer.sendMessage(friend.did, 'This message will queue if offline');
// It will be delivered seamlessly when they come back online!

// Listen for messages
peer.on('message-received', (message) => {
  console.log(`${message.from}: ${message.content}`);
});

// Track delivery status
peer.on('message-delivered', (msg) => {
  console.log(`✅ Message ${msg.id} delivered to ${msg.to}`);
});

4. Share Files​

// Send a file
const file = document.querySelector('input[type="file"]').files[0];
const buffer = await file.arrayBuffer();

await peerService.sendMessage(friend.did, 'Check this file!', 'file', {
  name: file.name,
  size: file.size,
  type: file.type,
  data: buffer
});

// Receive files
peerService.on('message-received', (message) => {
  if (message.type === 'file') {
    const blob = new Blob([message.fileData.data]);
    const url = URL.createObjectURL(blob);
    // Download or display the file
  }
});

🏗️ Architecture Overview​

Vaultys Peer SDK is built with a clean, modular architecture:

Core Components​

  • PeerService: Main service for peer management
  • VaultysPeer: Individual peer connection handling
  • Storage Provider: Pluggable storage interface
  • Event Bus: Decoupled event system
  • Message Queue: Automatic offline message queueing and delivery
  • Health Monitor: Connection health tracking
  • Delivery Manager: Ensures 100% message delivery with retry logic
  • Coming Soon: Relay Server: Open-source signaling server with message relay

🎯 Key Features​

🔋 Batteries Included​

Powered by VaultysId - the leading open-source Decentralized Identity System. Get enterprise-grade DID management out of the box, with W3C compliance and verifiable credentials. Passkey and FIDO2 authentication has never been so easy! Enable passwordless login with just one line of code.

⚡ Lazy Loading at Scale​

Manage thousands of peers with zero overhead. Connections are established only when messages are exchanged. Perfect for large-scale applications with dynamic peer networks.

📬 Never Lose a Message​

Automatic message queueing for offline peers! If a peer is offline, messages are queued seamlessly and delivered automatically when they reconnect. No manual retry logic needed - the SDK handles everything for you.

🏗️ Bring Your Own Infrastructure​

Complete control over your P2P stack. Bring your own signaling server today. Coming soon: We're open-sourcing our production-grade signaling server that also acts as a message relay for ultimate reliability! Plus custom DID system support for maximum flexibility.

🔐 Passwordless Authentication​

Passkey/FIDO2 made simple! VaultysId brings biometric and security key authentication to your P2P apps with minimal code. Say goodbye to passwords forever.

🆔 DID-based Identity​

Use Decentralized Identifiers for peer identification. No central authority needed.

💬 Rich Messaging​

Send text, files, images, and custom data types between peers.

📞 Audio/Video Calls​

Built-in support for WebRTC media streams with easy-to-use APIs.

👥 Group Management​

Organize peers into groups for broadcast messaging and management.

💾 Flexible Storage​

Choose from multiple storage backends or bring your own.

🔄 Auto-Reconnection​

Automatic connection recovery with exponential backoff.

🏥 Health Monitoring​

Real-time connection health tracking and diagnostics.

📦 TypeScript First​

Full TypeScript support with comprehensive type definitions.

🎨 Design Principles​

1. Simple by Default​

Get started with minimal configuration. Advanced features when you need them.

2. Extensible​

Plugin architecture for storage, events, and protocols.

3. Reliable​

Automatic reconnection, message queueing, and error recovery.

4. Privacy-First​

No central servers for messages. Your data stays between peers.

5. Cross-Platform​

Works in modern browsers and Node.js environments.

📚 Learning Path​

For Beginners​

  1. Start with the Quick Start Guide
  2. Build the Chat App Tutorial
  3. Explore Basic Examples

For Advanced Users​

  1. Read about Architecture
  2. Learn Custom Storage Providers
  3. Implement Advanced Patterns

🤝 Community​

Get Help​

Contribute​

🚀 Ready to Build?​

You now have everything you need to start building amazing P2P applications!

Built with 💜 by the Vaultys team and the P2P community

Edit this page
Last updated on by François-Xavier Thoorens