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.
Start here
- Install the packages and open a session.
- Supply the application integrations.
- Understand lifecycle and resource ownership.
- Send a direct message.
Check platform requirements and limits for your runtime.
Guides
| Guide | What you will build or learn |
|---|---|
| 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. |
| Recovery and home-relay migration | Restore access deliberately and move authorization to another relay. |
| 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. |
| Channels | Publish posts, follow channels, and load retained history. |
| Groups | Admit members, exchange encrypted messages, rotate secrets, and recover keys. |
| Storage and pagination | Preserve device state and use local snapshots or relay cursors. |
| Transport | Select HTTP and WebSocket adapters and interpret authentication state. |
| Events and troubleshooting | Subscribe to updates, handle cancellation, and diagnose failures. |
The examples are functions to incorporate into an application. Select the optional NEP-6 signer and Neo RPC registry or supply your own implementations, then provide a secret protector and trusted network configuration. The examples do not include a funded wallet or a deployed relay service.