# 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

		Cover image
Vector Bots	with custom metadata.	Vector Bots.png
Send/Receive Files	Private messages & files.	Send-Receive Files.png
Custom Notifications	for Gift Wrap events.	Notifications.png
Proxy Settings	Configure for .onion relays.	Onion.png
Relays	Add and manage.	Relays.png
Modular	Easy ext. & maintenance.	Modular.png

* 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: {% tabs fullWidth="false" %} {% tab title="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 {% endtab %} {% tab title="Placeholder Functions" %}

### **Placeholder Functions (Not Yet Implemented):** The following MLS functions exist as stubs and will be implemented in future versions when needed: * `create_group()` - Group creation functionality * `add_member_device()` - Adding members to groups * `leave_group()` - Leaving groups * `remove_member_device_from_group()` - Removing members * `send_group_message()` - Direct group message sending (use `Group::send_group_message()` instead) These placeholder functions are available in the API but will return errors if called. They are included to provide a complete API surface for future expansion. {% endtab %} {% endtabs %} *** ## Documentation For comprehensive documentation, see: * [**CONTRIBUTING**](https://vector-privacy.gitbook.io/vector-privacy/vector-sdk/docs/contributing) - Development guidelines and contribution process * [**SECURITY**](https://vector-privacy.gitbook.io/vector-privacy/vector-sdk/docs/security) - Security features, best practices, and threat model * [**ADVANCED**](https://vector-privacy.gitbook.io/vector-privacy/vector-sdk/docs/advanced) - Advanced features including MLS, typing indicators, and debugging * [**TROUBLESHOOTING**](https://vector-privacy.gitbook.io/vector-privacy/vector-sdk/docs/troubleshooting) - Common issues and solutions * [**CHANGELOG**](https://changelog.mdhttps/github.com/VectorPrivacy/Vector-SDK/blob/mls-groups/CHANGELOG.md) - Release history and changes *** ## Examples For practical examples and working code demonstrations, see the [Vector-SDK-Example](https://github.com/Luke-Larsen/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**](https://vector-privacy.gitbook.io/vector-privacy/vector-sdk/basics/components#vectorbot): The main struct representing the bot, containing metadata and client configuration. 2. [**Channel**](https://vector-privacy.gitbook.io/vector-privacy/vector-sdk/basics/components#channel): A struct for managing communication with specific recipients. 3. [**Client**](https://vector-privacy.gitbook.io/vector-privacy/vector-sdk/basics/components#client): Functions for building and configuring the Nostr client. 4. [**Metadata**](https://vector-privacy.gitbook.io/vector-privacy/vector-sdk/basics/components#metadata): Functions for creating and managing bot metadata. 5. [**Subscription**](https://vector-privacy.gitbook.io/vector-privacy/vector-sdk/basics/components#subscription): Functions for setting up event subscriptions. 6. [**Crypto**](https://vector-privacy.gitbook.io/vector-privacy/vector-sdk/basics/components#crypto): Functions for encryption and decryption. 7. [**Upload**](https://vector-privacy.gitbook.io/vector-privacy/vector-sdk/basics/components#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](https://github.com/VectorPrivacy/Vector-SDK/blob/mls-groups/ADVANCED.md). *** ## License This project is licensed under the MIT License. See the [LICENSE](https://github.com/VectorPrivacy/Vector-SDK/blob/mls-groups/LICENSE) file for details.

:robot:

:envelope-open-text:

:bell:

:onion:

:network-wired:

:cubes: