Skip to content
Meshline
SDK 1.6.0 · OverviewView source on GitHub

Meshline .NET SDK developer guide

.NET 10 · NuGet package Meshline.Sdk · Namespace Meshline

Build applications with self-sovereign accounts, encrypted direct and group messages, public channels, and local SQLite persistence. Start with MeshlineClient, which coordinates the SDK components for one network, account, and device. The application supplies account signing, relay registry access, and local secret protection.

These guides describe the current source checkout. For an installed package, use the documentation at its matching release tag; an API described on main may not yet be available in that package.

First integration

Guide Task
Quick start Install the package, migrate storage, establish an account, and run a session.
Application integrations Bind the network and account; implement signing, registry access, and secret protection.
Lifecycle and ownership Initialize, start, stop, and dispose clients and independently composed components.
Accounts and devices Resolve routes, authorize devices, renew certificates, and publish device state.
Idempotent account establishment Enable an account, resume interrupted setup, renew authorization, and explicitly replace a selected device.

Everyday application work

Guide Task
Profiles and contacts Update profile fields, exchange contact requests, and manage contact authorization.
Direct messages and the outbox Send encrypted content, observe progress, and understand retries and cancellation.
Conversations and unread state Build a unified conversation list and track local read positions.
Synchronization Await a fresh pass, observe progress, and interpret retention gaps.
Storage and pagination Preserve local state and distinguish snapshot readers from relay cursors.
Channels Publish public posts, follow channels, and load retained history.
Groups Create encrypted groups, admit members, manage roles, and recover group keys.

Advanced integration and diagnosis

Guide Task
Recovery and home-relay migration Restore account access deliberately and move authorization to another relay.
Transport and dependency injection Configure HTTP, use relay sessions, and integrate with Microsoft DI.
Events and errors Subscribe to changes and distinguish deadlines, cancellation, and operation failures.
Troubleshooting Diagnose symptoms and resume safely from retained state.

Reference, examples, and contributions

The API reference is generated from the assembly and XML comments. Inherited members are documented on their declaring base type; follow inheritance links. Protected extension points are included, and EF migration types are infrastructure rather than application entry points.

Guide snippets are synchronized from compilable examples. They are integration methods with application-supplied dependencies, not a wallet or relay service. Compilation verifies API usage; offline tests verify behavior against scripted peers. Neither establishes live-network or full platform support. See validation limits.

For source builds, documentation updates, and publishing, use Maintenance. The Protocol 1.0 draft defines wire formats and interoperability rules; these guides describe the .NET implementation. Content hosting, retrieval, and UI rendering remain application responsibilities.

SDK overview · TypeScript guide