@tuwaio/quasar-sdk

utils

const utils: object

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

Security and authentication utilities.

Includes methods for creating, signing, and verifying Mini-Session signatures to protect your API quota. These can be used without initializing the Quasar class.

Type Declaration

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.

Parameters

connection

ConnectionData

The current active wallet connection data (address, signer, etc).

store

A store implementation (Zustand or compatible) for session persistence.

miniSession

MiniSessionAuth | null

setMiniSession

(session) => void

Returns

Promise<MiniSessionAuth>

A promise resolving to a valid MiniSessionAuth object.

Throws

If the wallet is disconnected or signing fails.

See

getMiniSessionAuth

signMiniSession

signMiniSession: (params) => Promise<SignSessionResult> = authUtils.signMiniSession

Triggers a signature request in the connected wallet.

Triggers a signature request in the connected wallet to create a Mini-Session.

This function detects the signer’s capabilities and uses the most appropriate signing method available (e.g., Web3 v2, Standard, or Legacy).

Parameters

params

SignSessionParams

Parameters containing the signer and target ecosystem.

Returns

Promise<SignSessionResult>

A promise resolving to the signature and timestamp.

Throws

If signing fails or the signer lacks required methods.

See

signMiniSession

verifyMiniSession

verifyMiniSession: (params) => Promise<boolean> = authUtils.verifyMiniSession

Verifies a Mini-Session signature (EVM or Solana).

Verifies a Mini-Session signature for authenticity and freshness.

Performs cryptographic verification against the provided wallet address and ensures the signature hasn’t expired according to the maxAge parameter.

Parameters

params

VerifySessionParams

Verification data including signature and timestamp.

Returns

Promise<boolean>

A promise resolving to true if the session is valid.

See

verifyMiniSession