Skip to content

SDK overview

Zentalk does not yet ship a standalone, published SDK package. Two client implementations exist in the codebase today — a TypeScript client library that powers the Zentalk web application, and a Go client package for the relay/mesh network — and official installable SDKs are planned.

Client Language Distribution Status
Zentalk API client (src/api/) TypeScript Lives inside the web application repository Reference implementation; not published to npm
pkg/client Go go get github.com/ZentaChain/zentalk-node/pkg/client Importable today
zentalk-client CLI Go (binary) Built from cmd/zentalk-client in the zentalk-node repository Available today
@zentalk/sdk-js JavaScript/TypeScript npm Planned
zentalk-python Python PyPI Planned

Building a web or Node.js integration. There is no published npm package yet. Use the REST API directly over HTTPS, and treat the TypeScript client library (src/api/ in the web application) as the reference implementation: it shows the authentication flow, token refresh, E2EE messaging, error handling, real-time WebSocket events, and mesh storage that your own client should replicate. When @zentalk/sdk-js ships, it will supersede this approach.

Building in Go. You have two options:

  • Call the REST API directly with net/http — this is the officially recommended path for API integrations.
  • Import the Go client package (github.com/ZentaChain/zentalk-node/pkg/client) if you are integrating with the Zentalk relay network itself: anonymous (ZKP-based) registration and connection, encrypted peer-to-peer messaging, username lookup, and group messaging over relays. This package speaks the relay wire protocol, not the REST API.

Exploring from the command line. The zentalk-client command-line tool (part of zentalk-node) exercises the zero-knowledge-proof messaging flow end to end without requiring any code. See Go client.

Building in Python. Use the REST API directly until zentalk-python is released.