Vector SDK

The Vector Bot Library is a Rust-based library for creating and managing Vector Bots that can send and receive private messages using the Nostr protocol. This library provides a structured and modular approach to building bots with configurable metadata and client settings.

Features

Vector Bots

with custom metadata.

Send/Receive Files

Private messages & files.

Custom Notifications

for Gift Wrap events.

Proxy Settings

Configure for .onion relays.

Relays

Add and manage.

Modular

Easy ext. & maintenance.

• Create Vector Bots with customizable metadata

• Send and receive private messages and files

• Handle notifications for gift wrap events

• Configure proxy settings for .onion relays

• Add and manage relays

• Modular architecture for easy extension and maintenance

• Message Layer Security (MLS) for group messaging

• Typing indicators for real-time feedback

• Reaction support for messages

• File uploads with progress tracking

• Automatic failover for media servers

---

MLS Implementation Status

The Vector SDK includes Message Layer Security (MLS) support for group messaging. The following MLS features are currently implemented and ready for use:

Implemented Features

Implemented Features:

• Group joining via welcome events

• Group message sending and processing

• Group typing indicators

• Group file attachments

• Group reactions

• Persistent SQLite-backed storage for group state

Placeholder Functions

---

Documentation

For comprehensive documentation, see:

• CONTRIBUTING - Development guidelines and contribution process

• SECURITY - Security features, best practices, and threat model

• ADVANCED - Advanced features including MLS, typing indicators, and debugging

• TROUBLESHOOTING - Common issues and solutions

• CHANGELOG - Release history and changes

---

Examples

For practical examples and working code demonstrations, see the Vector-SDK-Example repository, which contains:

• Basic bot setup examples

• Direct messaging implementations

• Group messaging examples

• File handling demonstrations

• Advanced use cases

• Complete working applications

---

Architecture

The library is organized into several modules, each responsible for a specific aspect of the bot's functionality:

1. VectorBot: The main struct representing the bot, containing metadata and client configuration.

2. Channel: A struct for managing communication with specific recipients.

3. Client: Functions for building and configuring the Nostr client.

4. Metadata: Functions for creating and managing bot metadata.

5. Subscription: Functions for setting up event subscriptions.

6. Crypto: Functions for encryption and decryption.

7. Upload: Functions for handling file uploads.

High Level Architecture

+---------------------+
|     VectorBot       |
|---------------------|
| - keys              |
| - name              |
| - display_name      |
| - about             |
| - picture           |
| - banner            |
| - nip05             |
| - lud16             |
| - client            |
|---------------------|
| + quick()           |
| + new()             |
| + get_chat()        |
+---------------------+
          |
          v
+---------------------+
|      Channel        |
|---------------------|
| - recipient         |
| - base_bot          |
|---------------------|
| + new()             |
| + send_private_msg()|
+---------------------+

+---------------------+
|      Client        |
|---------------------|
| + build_client()   |
+---------------------+

+---------------------+
|     Metadata       |
|---------------------|
| + create_metadata()|
+---------------------+

+---------------------+
|   Subscription     |
|---------------------|
| + create_gift_wrap_|
|   subscription()    |
+---------------------+

+---------------------+
|      Crypto        |
|---------------------|
| + generate_encryption_params() |
| + encrypt_data()   |
+---------------------+

+---------------------+
|      Upload        |
|---------------------|
| + upload_data_with_progress() |
+---------------------+

For more detailed information about the architecture and advanced features, see ADVANCED.md.

---

License

This project is licensed under the MIT License. See the LICENSE file for details.