Skip to main content
The TypeScript SDK is WIP. Today, integrate against the Relayer HTTP API directly. The shapes documented in the SDK pages mirror that API and will be the SDK surface when it ships.
The Tachyon SDK is published for Node.js and modern browsers. Key operations run in WASM so the same package works in both environments.

Install (when published)

Package name is TBD; @tachyon/sdk is a placeholder. The package will ship from the tachyonpe GitHub organization.

Initialize

No API key is required. Rate limits apply at the platform level, see rate limits.

Verify your setup

This calls GET /health on the relayer (API ref).

Browser usage

The browser bundle handles WASM loading automatically. No additional bundler config is required for Vite/Webpack 5 with default settings.

Environments

Testnet vs mainnet

Configuration switches by changing network. Endpoints, supported chains, and rate limits differ between the two. See supported chains and rate limits.

Using the API directly today

If you want to integrate before the SDK ships, hit the relayer endpoints directly. Example: list a recipient’s stealth addresses.
Every SDK call documented in this section maps to one or more endpoints in the Relayer HTTP API.

Authenticate users

Register users and manage stealth identities.