Quasar

Defined in: packages/quasar-sdk/src/index.ts:89

Main entry point for the Quasar SDK.

The Quasar class provides a unified interface for interacting with the Quasar Cloud API. It handles authentication, base URL configuration, and exposes domain-specific modules like PulsarModule for transaction management.

Example


import { Quasar } from '@tuwaio/quasar-sdk';
 
// Initialize with your secret API key
const quasar = new Quasar({
  secretKey: 'sk_live_your_secret_key',
  baseUrl: 'https://api.tuwa.io', // Optional
  timeout: 10000,                // Optional, default is 10s
});
 
// Access domain-specific modules
const history = await quasar.pulsar.getHistory({ chainId: 1 });

Constructors

Constructor

new Quasar(config): Quasar

Defined in: packages/quasar-sdk/src/index.ts:123

Creates a new instance of the Quasar SDK.

Parameters

config

QuasarConfig

Configuration options for the SDK.

Returns

Quasar

Throws

If the secretKey is missing or invalid.

Example


const quasar = new Quasar({ secretKey: process.env.QUASAR_SECRET_KEY! });

Properties

pulsar

readonly pulsar: PulsarModule

Defined in: packages/quasar-sdk/src/index.ts:110

The Pulsar Transaction Engine module.

This module provides methods to sync transaction states to the Quasar Cloud and retrieve indexed transaction history across multiple blockchain networks.

See

PulsarModule

utils

readonly static utils: object

Defined in: packages/quasar-sdk/src/index.ts:94

Security and authentication utilities. Shared across all instances and available statically.

createMiniSessionMessage

createMiniSessionMessage: (timestamp) => string = authUtils.createMiniSessionMessage

Standardizes the message format for Quasar Mini-Session login.

Standardizes the message format for Mini-Session authentication. Both frontend and backend MUST use this exact template for verification to pass.

Parameters

timestamp

string

ISO string timestamp (e.g., new Date().toISOString()).

Returns

string

The formatted message string to be signed.

Example


const msg = createMiniSessionMessage(new Date().toISOString());
// msg -> "Mini-Session Login: 2026-05-13T10:00:00.000Z"

See

createMiniSessionMessage

createMiniSessionStore

createMiniSessionStore: (storageName) => UseBoundStore<WithPersist<StoreApi<MiniSessionStore>, MiniSessionStore>> = authUtils.createMiniSessionStore

Creates a persistent Zustand store for session management.

Creates a persistent Zustand store to cache Mini-Session signatures. This is the recommended way to manage sessions in React applications.

Parameters

storageName?

string = 'mini-session-storage'

The localStorage key for persistence. Defaults to ‘mini-session-storage’.

Returns

UseBoundStore<WithPersist<StoreApi<MiniSessionStore>, MiniSessionStore>>

A Zustand store instance initialized with MiniSessionStore interface.

See

createMiniSessionStore

getMiniSessionAuth

getMiniSessionAuth: (connection, store) => Promise<MiniSessionAuth> = authUtils.getMiniSessionAuth

Reusable helper to manage signing and session caching.

High-level orchestrator to retrieve an existing Mini-Session or trigger a new signature.

This function checks the provided store for a valid, non-expired session matching the current wallet connection. If no session is found or it has expired, it triggers a signature request through the wallet.