Skip to content
Meshline
SDK 0.1.0-alpha.6 · OverviewView source on GitHub

Meshline TypeScript SDK guide

Use MeshlineClient to manage accounts, devices, profiles, contacts, messages, channels, and groups. The SDK stores local state and coordinates relay access; your application provides identity integrations, content hosting, and the UI.

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.

Check platform requirements and limits before selecting a runtime.

First integration

Guide Task
Quick start Install the packages, open storage, and start a client.
Application integrations Configure a network, account signer, relay registry, and secret protector.
Lifecycle and ownership Initialize, start, stop, and dispose the client and its dependencies.
Accounts and devices Establish an account, resolve routes, and manage device authorization.
Idempotent account establishment Authorize, renew, replace explicitly, and resume interrupted setup.

Everyday application work

Guide Task
Profiles and contacts Edit profiles, exchange requests, and manage contacts.
Direct messages and the outbox Send encrypted content and interpret delivery state.
Conversations and unread state Build a conversation list and track local read positions.
Synchronization Await a fresh pass, observe progress, and interpret retention gaps.
Storage and pagination Preserve device state and use local snapshots or relay cursors.
Channels Publish posts, follow channels, and load retained history.
Groups Admit members, exchange encrypted messages, rotate secrets, and recover keys.

Advanced integration and diagnosis

Guide Task
Recovery and home-relay migration Restore access deliberately and move authorization to another relay.
Transport Select HTTP and WebSocket adapters and interpret authentication state.
Events and errors Subscribe to changes and distinguish deadlines, cancellation, and operation failures.
Troubleshooting Diagnose symptoms and resume safely from retained state.

Examples and contributions

The type-checked examples accept your signer, registry, secret protector, and trusted network configuration. They do not supply a funded wallet or deployed relay service. The optional NEP-6 signer and Neo RPC registry are integrations you select explicitly.

Use Testing for behavioral coverage and validation scope, and Maintenance for builds, documentation checks, and publishing. Compiled examples and offline tests do not establish every live deployment.

SDK overview and installation · .NET guide