Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TUWA SDK

Build Status

The official umbrella SDKs and server-side Quasar client for the TUWA Ecosystem.


Overview

This monorepo contains the core TUWA SDKs — a production-grade toolkit for interacting with the TUWA ecosystem. It provides the umbrella packages that bundle Orbit, Pulsar, Satellite, and Nova UI into a single seamless installation point, alongside the server-side Quasar Cloud client.

Key Features

  • 🧩 Umbrella Architecture — Install @tuwaio/sdk and get all TUWA functionality out of the box.
  • Framework Agnostic — Clean separation of EVM and Solana specific dependencies.
  • 🔐 Iron Dome Protocol — Server-side Quasar Cloud syncing via @tuwaio/quasar-sdk.
  • 📦 Dual format — Ships as both ESM and CJS (tsup powered).
  • 📖 Auto-generated API docs — TypeDoc → Markdown → Nextra docs site.

🏛️ Ecosystem Layer Architecture

Layer Package Description
L5 @tuwaio/quasar-sdk Quasar Cloud Client (Server/Edge) — Server-side Node.js & Edge SDK for transaction indexing, cloud sync, and signature verification.
L8 @tuwaio/sdk Core Umbrella SDK (UI & Logic) — Bundles framework-agnostic logic (Orbit, Pulsar, Satellite) and Nova UI components into subpath-only entrypoints.
L9 @tuwaio/evm-sdk EVM Network Adapter SDK — EVM-specific transports (Wagmi/Viem), connectors, and background state watchers (EVMConnectorsWatcher).
L9 @tuwaio/solana-sdk Solana Network Adapter SDK — Solana-specific transports (Gill/Wallet-Standard), connectors, and background state watchers (SolanaConnectorsWatcher).

Repository Structure

sdk/
├── packages/
│   ├── quasar-sdk/          # @tuwaio/quasar-sdk (L5 Cloud Client)
│   ├── sdk/                 # @tuwaio/sdk (L8 Core Umbrella SDK)
│   ├── evm-sdk/             # @tuwaio/evm-sdk (L9 EVM Adapter SDK)
│   └── solana-sdk/          # @tuwaio/solana-sdk (L9 Solana Adapter SDK)
├── apps/
│   └── docs/                # Nextra-based documentation site
├── typedoc.json             # TypeDoc config
└── .github/workflows/       # CI: Release Please + npm publish

Installation

1. Base SDK

Install the core SDK and the required React peer dependencies:

pnpm add @tuwaio/sdk react react-dom

2. Network Adapters

Depending on your target blockchain, install the network-specific SDK and its Web3 singletons:

For EVM:

pnpm add @tuwaio/evm-sdk viem @wagmi/core

For Solana:

pnpm add @tuwaio/solana-sdk gill @wallet-standard/react @wallet-standard/app @wallet-standard/ui-core @wallet-standard/ui-registry

3. Quasar Cloud Client (Server-side)

The Quasar SDK requires ofetch and @tuwaio/pulsar-core (for type definitions) as peer dependencies.

pnpm add @tuwaio/quasar-sdk ofetch @tuwaio/pulsar-core

Note: If you plan to use the React Auth Bridges (QuasarAuthBridge), you will also need react and the respective Web3 singletons for your target network (e.g. viem / gill).


🚀 Explore the SDKs (Examples & Guides)

The true power of the TUWA Umbrella SDKs is composability. Because the ecosystem is highly modular, each package has its own detailed documentation and integration examples.

Dive into the specific READMEs below to see how to use them in detail:


Documentation

The full documentation site lives at sdk.docs.tuwa.io.

API Reference Generation

API reference documentation is auto-generated from TypeDoc annotations using typedoc-plugin-markdown:

# Generate API reference pages
pnpm docs:gen

🤝 Contributing & Support

Contributions are welcome! Please read our main Contribution Guidelines.

If you find this library useful, please consider supporting its development. Every contribution helps!

➡️ View Support Options

📄 License

This project is licensed under the Apache-2.0 License — see the LICENSE file for details.

About

The official server-side Node.js & Edge SDK for the TUWA Ecosystem, featuring built-in React authentication bridges.

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages