@tuwaio/quasar-sdk 1.0.0-fix-pulsar-alpha.1.fc19e24

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 FOP Tkach Oleksandr
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,89 @@
+# Quasar SDK
+
+[![NPM Version](https://img.shields.io/npm/v/@tuwaio/quasar-sdk.svg)](https://www.npmjs.com/package/@tuwaio/quasar-sdk)
+[![License](https://img.shields.io/npm/l/@tuwaio/quasar-sdk.svg)](./LICENSE)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/TuwaIO/sdk/release.yml?branch=main)](https://github.com/TuwaIO/sdk/actions)
+
+> The official server-side Node.js & Edge SDK for the **TUWA Quasar Cloud**.
+
+## Installation
+
+```bash
+pnpm add @tuwaio/quasar-sdk
+```
+
+### Peer Dependencies
+
+| Package              | Version   |
+| -------------------- | --------- |
+| `@tuwaio/pulsar-core` | `>=0.5.1` |
+| `ofetch`             | `>=1.5.1` |
+
+## Quick Start
+
+```typescript
+import { Quasar } from '@tuwaio/quasar-sdk';
+
+const quasar = new Quasar({ secretKey: 'sk_live_your_secret_key' });
+
+// Sync a pending transaction
+const { txKey } = await quasar.pulsar.syncCreate(tx);
+
+// Update status
+await quasar.pulsar.syncUpdate(txKey, { status: 'confirmed' });
+
+// Query history
+const history = await quasar.pulsar.getHistory({ chainId: 1 });
+```
+
+## Modules
+
+### Pulsar — `quasar.pulsar`
+
+| Method | Description |
+| --- | --- |
+| `syncCreate(tx)` | Sync a new pending transaction to the cloud |
+| `syncUpdate(txKey, patches)` | Update an existing transaction's status or fields |
+| `getHistory(query?)` | Retrieve paginated transaction history |
+
+## Error Handling
+
+```typescript
+import { QuasarSDKError } from '@tuwaio/quasar-sdk';
+
+try {
+  await quasar.pulsar.getHistory();
+} catch (err) {
+  if (err instanceof QuasarSDKError) {
+    console.error(err.status);        // HTTP status code
+    console.error(err.message);       // Formatted error message
+    console.error(err.originalError); // Raw fetch error
+  }
+}
+```
+
+## Configuration
+
+| Property    | Type     | Required | Default               | Description |
+| ----------- | -------- | -------- | --------------------- | ----------- |
+| `secretKey` | `string` | ✅       | —                     | Server-side API key (`sk_live_*`) |
+| `baseUrl`   | `string` | ❌       | `https://api.tuwa.io` | API base URL |
+| `timeout`   | `number` | ❌       | `10000`               | Request timeout (ms) |
+
+## Documentation
+
+Full API reference: [sdk.docs.tuwa.io](https://sdk.docs.tuwa.io/)
+
+---
+
+## 🤝 Contributing & Support
+
+Contributions are welcome! Please read our main **[Contribution Guidelines](https://github.com/TuwaIO/workflows/blob/main/CONTRIBUTING.md)**.
+
+If you find this library useful, please consider supporting its development. Every contribution helps!
+
+[**➡️ View Support Options**](https://github.com/TuwaIO/workflows/blob/main/Donation.md)
+
+## 📄 License
+
+This project is licensed under the **Apache-2.0 License** - see the [LICENSE](./LICENSE) file for details.

package/dist/index.d.mts

@@ -0,0 +1,380 @@
+import { FetchOptions } from 'ofetch';
+import { Transaction, UpdatableTransactionFields } from '@tuwaio/pulsar-core';
+export { Transaction, UpdatableTransactionFields } from '@tuwaio/pulsar-core';
+
+/**
+ * @module types
+ * @description Shared type definitions for the Quasar SDK.
+ * Contains configuration interfaces, query parameters, paginated result structure,
+ * and re-exports from `@tuwaio/pulsar-core`.
+ */
+
+/**
+ * Configuration options for initializing the {@link Quasar} SDK client.
+ *
+ * @example
+ * ```typescript
+ * const config: QuasarConfig = {
+ *   secretKey: 'sk_live_abc123...',
+ *   baseUrl: 'https://api.tuwa.io',
+ *   timeout: 15000,
+ * };
+ * ```
+ */
+interface QuasarConfig {
+    /**
+     * Your secret API key starting with `sk_live_`.
+     *
+     * @remarks
+     * This key authenticates every request through the Iron Dome security perimeter.
+     * It **MUST** be kept secure on the server side — never expose it in client bundles.
+     */
+    secretKey: string;
+    /**
+     * The base URL of the Quasar Cloud API.
+     *
+     * @defaultValue `'https://api.tuwa.io'`
+     */
+    baseUrl?: string;
+    /**
+     * Request timeout in milliseconds.
+     *
+     * @defaultValue `10000`
+     */
+    timeout?: number;
+}
+/**
+ * Query parameters for filtering transaction history.
+ *
+ * All fields are optional — omitted fields apply no filter.
+ *
+ * @example
+ * ```typescript
+ * const query: HistoryQuery = {
+ *   page: 2,
+ *   limit: 25,
+ *   chainId: 1,
+ *   status: 'confirmed',
+ * };
+ * ```
+ */
+interface HistoryQuery {
+    /**
+     * Page number for pagination (1-indexed).
+     *
+     * @defaultValue `1`
+     */
+    page?: number;
+    /**
+     * Maximum number of results per page.
+     *
+     * @defaultValue `10`
+     */
+    limit?: number;
+    /**
+     * Filter by blockchain chain ID (e.g. `1` for Ethereum Mainnet, `'solana'` for Solana).
+     */
+    chainId?: string | number;
+    /**
+     * Filter by transaction status (e.g. `'pending'`, `'confirmed'`, `'failed'`).
+     */
+    status?: string;
+    /**
+     * Filter by a specific transaction key (unique identifier assigned by Quasar).
+     */
+    txKey?: string;
+}
+/**
+ * Generic wrapper for paginated API responses.
+ *
+ * @typeParam T - The type of each document in the result set.
+ *
+ * @example
+ * ```typescript
+ * const result: PaginatedResult<Transaction> = await quasar.pulsar.getHistory();
+ * console.log(result.docs);       // Transaction[]
+ * console.log(result.totalPages);  // number
+ * console.log(result.hasNextPage); // boolean
+ * ```
+ */
+interface PaginatedResult<T> {
+    /** Array of documents for the current page. */
+    docs: T[];
+    /** Total number of documents matching the query across all pages. */
+    totalDocs: number;
+    /** Total number of available pages. */
+    totalPages: number;
+    /** Current page number (1-indexed). */
+    page: number;
+    /** Whether a subsequent page exists. */
+    hasNextPage: boolean;
+    /** Whether a previous page exists. */
+    hasPrevPage: boolean;
+}
+
+/**
+ * @module core/client
+ * @description Core HTTP client for the Quasar SDK.
+ * Handles authenticated requests through the Iron Dome security perimeter
+ * and provides structured error handling for all API interactions.
+ */
+
+/**
+ * Custom error class for all Quasar SDK API failures.
+ *
+ * Wraps the underlying HTTP error with a structured format including
+ * status code, human-readable message, and the original error reference.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await quasar.pulsar.getHistory();
+ * } catch (err) {
+ *   if (err instanceof QuasarSDKError) {
+ *     console.error(err.status);        // e.g. 401
+ *     console.error(err.message);       // "[Quasar SDK] Request Failed (401): Unauthorized"
+ *     console.error(err.originalError); // Raw FetchError from ofetch
+ *   }
+ * }
+ * ```
+ */
+declare class QuasarSDKError extends Error {
+    /** HTTP status code returned by the API, if available. */
+    readonly status: number | undefined;
+    /** The original error thrown by the HTTP client. */
+    readonly originalError: Error;
+    /**
+     * Creates a new QuasarSDKError instance.
+     *
+     * @param message - Formatted error message with SDK prefix and status.
+     * @param status - HTTP status code, or `undefined` if unavailable.
+     * @param originalError - The raw error from the HTTP layer.
+     */
+    constructor(message: string, status: number | undefined, originalError: Error);
+}
+/**
+ * Internal HTTP client for the Quasar Cloud API.
+ *
+ * Manages authenticated requests by injecting the `x-tuwa-secret-key` header
+ * into every outgoing request. Uses `ofetch` as the transport layer.
+ *
+ * @remarks
+ * This class is not exported from the public API surface.
+ * Consumers interact with it indirectly through the {@link Quasar} entry point.
+ *
+ * @internal
+ */
+declare class QuasarClient {
+    /** The secret API key used for authentication. */
+    private readonly secretKey;
+    /** The base URL for all API requests. */
+    private readonly baseUrl;
+    /** Request timeout in milliseconds. */
+    private readonly timeout;
+    /**
+     * Creates a new QuasarClient instance.
+     *
+     * @param config - SDK configuration containing the secret key and optional overrides.
+     * @throws {Error} If `config.secretKey` is missing or empty.
+     */
+    constructor(config: QuasarConfig);
+    /**
+     * Sends an authenticated request to the Quasar Cloud API.
+     *
+     * Automatically injects Iron Dome headers (`x-tuwa-secret-key`, `Content-Type`)
+     * and wraps all transport errors into {@link QuasarSDKError}.
+     *
+     * @typeParam T - Expected response body type.
+     * @param path - API endpoint path (e.g. `/api/v1/engine/tx-sync`).
+     * @param options - Fetch options (method, body, query, headers, etc.).
+     *                  `baseURL` and `timeout` are managed internally and cannot be overridden.
+     * @returns The parsed JSON response body typed as `T`.
+     * @throws {QuasarSDKError} On any HTTP or network error.
+     */
+    request<T>(path: string, options?: Omit<FetchOptions<'json'>, 'baseURL' | 'timeout'>): Promise<T>;
+    /**
+     * Transforms a raw fetch error into a structured {@link QuasarSDKError}.
+     *
+     * Extracts status code and error message from the response body or fallback fields.
+     * Logs a console warning for authentication failures (401/403).
+     *
+     * @param error - The raw error caught from `ofetch`.
+     * @returns A formatted QuasarSDKError instance.
+     */
+    private buildError;
+}
+
+/**
+ * @module modules/pulsar
+ * @description Pulsar Transaction Engine module.
+ * Provides methods for syncing transaction states to the Quasar Cloud
+ * and retrieving paginated transaction history.
+ */
+
+/**
+ * Pulsar module — the transaction engine interface for Quasar Cloud.
+ *
+ * Handles all operations related to blockchain transaction lifecycle:
+ * creating, updating, and querying transactions through the API.
+ *
+ * @remarks
+ * Access this module via `quasar.pulsar` after initializing the SDK.
+ * All methods authenticate automatically using the configured secret key.
+ *
+ * @example
+ * ```typescript
+ * const quasar = new Quasar({ secretKey: 'sk_live_...' });
+ *
+ * // Create
+ * const { txKey } = await quasar.pulsar.syncCreate(transaction);
+ *
+ * // Update
+ * await quasar.pulsar.syncUpdate(txKey, { status: 'confirmed' });
+ *
+ * // Read
+ * const history = await quasar.pulsar.getHistory({ chainId: 1 });
+ * ```
+ */
+declare class PulsarModule {
+    private readonly client;
+    /**
+     * Creates a new PulsarModule instance.
+     *
+     * @param client - The internal {@link QuasarClient} instance for making authenticated API calls.
+     * @internal
+     */
+    constructor(client: QuasarClient);
+    /**
+     * Syncs a newly created pending transaction to the Quasar Cloud.
+     *
+     * Sends the full transaction object to the `tx-sync` endpoint via POST.
+     * The server assigns a unique `txKey` that can be used for subsequent updates.
+     *
+     * @param tx - The complete transaction object to sync.
+     * @returns An object containing `success: true` and the assigned `txKey`.
+     * @throws {QuasarSDKError} On authentication failure, validation error, or network issue.
+     *
+     * @example
+     * ```typescript
+     * const { txKey } = await quasar.pulsar.syncCreate({
+     *   hash: '0xabc...',
+     *   chainId: 1,
+     *   status: 'pending',
+     *   from: '0x123...',
+     *   to: '0x456...',
+     * });
+     * ```
+     */
+    syncCreate(tx: Transaction): Promise<{
+        success: true;
+        txKey: string;
+    }>;
+    /**
+     * Updates an existing transaction's status or mutable fields.
+     *
+     * Sends a PATCH request to the `tx-sync` endpoint with the transaction key
+     * and the fields to update.
+     *
+     * @param txKey - The unique transaction key assigned by Quasar during {@link syncCreate}.
+     * @param patches - An object containing the fields to update (e.g. `status`, `blockNumber`).
+     * @returns An object containing `success: true` on successful update.
+     * @throws {QuasarSDKError} On authentication failure, invalid txKey, or network issue.
+     *
+     * @example
+     * ```typescript
+     * await quasar.pulsar.syncUpdate('tx_abc123', {
+     *   status: 'confirmed',
+     * });
+     * ```
+     */
+    syncUpdate(txKey: string, patches: UpdatableTransactionFields): Promise<{
+        success: true;
+    }>;
+    /**
+     * Retrieves paginated transaction history from the Quasar Cloud.
+     *
+     * Supports filtering by chain ID, status, and specific transaction key.
+     * Returns a typed {@link PaginatedResult} with navigation metadata.
+     *
+     * @param query - Optional query parameters for filtering and pagination.
+     * @returns A paginated result containing an array of {@link Transaction} documents.
+     * @throws {QuasarSDKError} On authentication failure or network issue.
+     *
+     * @example
+     * ```typescript
+     * const result = await quasar.pulsar.getHistory({
+     *   page: 1,
+     *   limit: 20,
+     *   chainId: 1,
+     *   status: 'confirmed',
+     * });
+     *
+     * for (const tx of result.docs) {
+     *   console.log(tx.hash, tx.status);
+     * }
+     * ```
+     */
+    getHistory(query?: HistoryQuery): Promise<PaginatedResult<Transaction>>;
+}
+
+/**
+ * @module @tuwaio/quasar-sdk
+ * The official server-side Node.js & Edge SDK for the TUWA Quasar Cloud.
+ *
+ * Provides a type-safe client for interacting with the Quasar API,
+ * including transaction syncing, status tracking, and history retrieval
+ * through the Iron Dome security perimeter.
+ *
+ * @example
+ * ```typescript
+ * import { Quasar } from '@tuwaio/quasar-sdk';
+ *
+ * const quasar = new Quasar({ secretKey: 'sk_live_...' });
+ * const history = await quasar.pulsar.getHistory({ chainId: 1 });
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * Main entry point for the Quasar SDK.
+ *
+ * Initializes the internal HTTP client with your secret key
+ * and exposes domain-specific modules for interacting with the Quasar Cloud API.
+ *
+ * @example
+ * ```typescript
+ * import { Quasar } from '@tuwaio/quasar-sdk';
+ *
+ * const quasar = new Quasar({
+ *   secretKey: 'sk_live_your_secret_key',
+ *   baseUrl: 'https://api.tuwa.io',
+ *   timeout: 15000,
+ * });
+ *
+ * // Access the Pulsar transaction engine
+ * const { txKey } = await quasar.pulsar.syncCreate(tx);
+ * ```
+ */
+declare class Quasar {
+    /** @internal */
+    private readonly client;
+    /**
+     * The Pulsar Transaction Engine module.
+     *
+     * Use this to sync transaction states to the Quasar Cloud
+     * and retrieve paginated transaction history.
+     *
+     * @see {@link PulsarModule}
+     */
+    readonly pulsar: PulsarModule;
+    /**
+     * Creates a new Quasar SDK instance.
+     *
+     * @param config - SDK configuration. See {@link QuasarConfig} for available options.
+     * @throws {Error} If `config.secretKey` is missing.
+     */
+    constructor(config: QuasarConfig);
+}
+
+export { type HistoryQuery, type PaginatedResult, PulsarModule, Quasar, type QuasarConfig, QuasarSDKError };

package/dist/index.d.ts

@@ -0,0 +1,380 @@
+import { FetchOptions } from 'ofetch';
+import { Transaction, UpdatableTransactionFields } from '@tuwaio/pulsar-core';
+export { Transaction, UpdatableTransactionFields } from '@tuwaio/pulsar-core';
+
+/**
+ * @module types
+ * @description Shared type definitions for the Quasar SDK.
+ * Contains configuration interfaces, query parameters, paginated result structure,
+ * and re-exports from `@tuwaio/pulsar-core`.
+ */
+
+/**
+ * Configuration options for initializing the {@link Quasar} SDK client.
+ *
+ * @example
+ * ```typescript
+ * const config: QuasarConfig = {
+ *   secretKey: 'sk_live_abc123...',
+ *   baseUrl: 'https://api.tuwa.io',
+ *   timeout: 15000,
+ * };
+ * ```
+ */
+interface QuasarConfig {
+    /**
+     * Your secret API key starting with `sk_live_`.
+     *
+     * @remarks
+     * This key authenticates every request through the Iron Dome security perimeter.
+     * It **MUST** be kept secure on the server side — never expose it in client bundles.
+     */
+    secretKey: string;
+    /**
+     * The base URL of the Quasar Cloud API.
+     *
+     * @defaultValue `'https://api.tuwa.io'`
+     */
+    baseUrl?: string;
+    /**
+     * Request timeout in milliseconds.
+     *
+     * @defaultValue `10000`
+     */
+    timeout?: number;
+}
+/**
+ * Query parameters for filtering transaction history.
+ *
+ * All fields are optional — omitted fields apply no filter.
+ *
+ * @example
+ * ```typescript
+ * const query: HistoryQuery = {
+ *   page: 2,
+ *   limit: 25,
+ *   chainId: 1,
+ *   status: 'confirmed',
+ * };
+ * ```
+ */
+interface HistoryQuery {
+    /**
+     * Page number for pagination (1-indexed).
+     *
+     * @defaultValue `1`
+     */
+    page?: number;
+    /**
+     * Maximum number of results per page.
+     *
+     * @defaultValue `10`
+     */
+    limit?: number;
+    /**
+     * Filter by blockchain chain ID (e.g. `1` for Ethereum Mainnet, `'solana'` for Solana).
+     */
+    chainId?: string | number;
+    /**
+     * Filter by transaction status (e.g. `'pending'`, `'confirmed'`, `'failed'`).
+     */
+    status?: string;
+    /**
+     * Filter by a specific transaction key (unique identifier assigned by Quasar).
+     */
+    txKey?: string;
+}
+/**
+ * Generic wrapper for paginated API responses.
+ *
+ * @typeParam T - The type of each document in the result set.
+ *
+ * @example
+ * ```typescript
+ * const result: PaginatedResult<Transaction> = await quasar.pulsar.getHistory();
+ * console.log(result.docs);       // Transaction[]
+ * console.log(result.totalPages);  // number
+ * console.log(result.hasNextPage); // boolean
+ * ```
+ */
+interface PaginatedResult<T> {
+    /** Array of documents for the current page. */
+    docs: T[];
+    /** Total number of documents matching the query across all pages. */
+    totalDocs: number;
+    /** Total number of available pages. */
+    totalPages: number;
+    /** Current page number (1-indexed). */
+    page: number;
+    /** Whether a subsequent page exists. */
+    hasNextPage: boolean;
+    /** Whether a previous page exists. */
+    hasPrevPage: boolean;
+}
+
+/**
+ * @module core/client
+ * @description Core HTTP client for the Quasar SDK.
+ * Handles authenticated requests through the Iron Dome security perimeter
+ * and provides structured error handling for all API interactions.
+ */
+
+/**
+ * Custom error class for all Quasar SDK API failures.
+ *
+ * Wraps the underlying HTTP error with a structured format including
+ * status code, human-readable message, and the original error reference.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await quasar.pulsar.getHistory();
+ * } catch (err) {
+ *   if (err instanceof QuasarSDKError) {
+ *     console.error(err.status);        // e.g. 401
+ *     console.error(err.message);       // "[Quasar SDK] Request Failed (401): Unauthorized"
+ *     console.error(err.originalError); // Raw FetchError from ofetch
+ *   }
+ * }
+ * ```
+ */
+declare class QuasarSDKError extends Error {
+    /** HTTP status code returned by the API, if available. */
+    readonly status: number | undefined;
+    /** The original error thrown by the HTTP client. */
+    readonly originalError: Error;
+    /**
+     * Creates a new QuasarSDKError instance.
+     *
+     * @param message - Formatted error message with SDK prefix and status.
+     * @param status - HTTP status code, or `undefined` if unavailable.
+     * @param originalError - The raw error from the HTTP layer.
+     */
+    constructor(message: string, status: number | undefined, originalError: Error);
+}
+/**
+ * Internal HTTP client for the Quasar Cloud API.
+ *
+ * Manages authenticated requests by injecting the `x-tuwa-secret-key` header
+ * into every outgoing request. Uses `ofetch` as the transport layer.
+ *
+ * @remarks
+ * This class is not exported from the public API surface.
+ * Consumers interact with it indirectly through the {@link Quasar} entry point.
+ *
+ * @internal
+ */
+declare class QuasarClient {
+    /** The secret API key used for authentication. */
+    private readonly secretKey;
+    /** The base URL for all API requests. */
+    private readonly baseUrl;
+    /** Request timeout in milliseconds. */
+    private readonly timeout;
+    /**
+     * Creates a new QuasarClient instance.
+     *
+     * @param config - SDK configuration containing the secret key and optional overrides.
+     * @throws {Error} If `config.secretKey` is missing or empty.
+     */
+    constructor(config: QuasarConfig);
+    /**
+     * Sends an authenticated request to the Quasar Cloud API.
+     *
+     * Automatically injects Iron Dome headers (`x-tuwa-secret-key`, `Content-Type`)
+     * and wraps all transport errors into {@link QuasarSDKError}.
+     *
+     * @typeParam T - Expected response body type.
+     * @param path - API endpoint path (e.g. `/api/v1/engine/tx-sync`).
+     * @param options - Fetch options (method, body, query, headers, etc.).
+     *                  `baseURL` and `timeout` are managed internally and cannot be overridden.
+     * @returns The parsed JSON response body typed as `T`.
+     * @throws {QuasarSDKError} On any HTTP or network error.
+     */
+    request<T>(path: string, options?: Omit<FetchOptions<'json'>, 'baseURL' | 'timeout'>): Promise<T>;
+    /**
+     * Transforms a raw fetch error into a structured {@link QuasarSDKError}.
+     *
+     * Extracts status code and error message from the response body or fallback fields.
+     * Logs a console warning for authentication failures (401/403).
+     *
+     * @param error - The raw error caught from `ofetch`.
+     * @returns A formatted QuasarSDKError instance.
+     */
+    private buildError;
+}
+
+/**
+ * @module modules/pulsar
+ * @description Pulsar Transaction Engine module.
+ * Provides methods for syncing transaction states to the Quasar Cloud
+ * and retrieving paginated transaction history.
+ */
+
+/**
+ * Pulsar module — the transaction engine interface for Quasar Cloud.
+ *
+ * Handles all operations related to blockchain transaction lifecycle:
+ * creating, updating, and querying transactions through the API.
+ *
+ * @remarks
+ * Access this module via `quasar.pulsar` after initializing the SDK.
+ * All methods authenticate automatically using the configured secret key.
+ *
+ * @example
+ * ```typescript
+ * const quasar = new Quasar({ secretKey: 'sk_live_...' });
+ *
+ * // Create
+ * const { txKey } = await quasar.pulsar.syncCreate(transaction);
+ *
+ * // Update
+ * await quasar.pulsar.syncUpdate(txKey, { status: 'confirmed' });
+ *
+ * // Read
+ * const history = await quasar.pulsar.getHistory({ chainId: 1 });
+ * ```
+ */
+declare class PulsarModule {
+    private readonly client;
+    /**
+     * Creates a new PulsarModule instance.
+     *
+     * @param client - The internal {@link QuasarClient} instance for making authenticated API calls.
+     * @internal
+     */
+    constructor(client: QuasarClient);
+    /**
+     * Syncs a newly created pending transaction to the Quasar Cloud.
+     *
+     * Sends the full transaction object to the `tx-sync` endpoint via POST.
+     * The server assigns a unique `txKey` that can be used for subsequent updates.
+     *
+     * @param tx - The complete transaction object to sync.
+     * @returns An object containing `success: true` and the assigned `txKey`.
+     * @throws {QuasarSDKError} On authentication failure, validation error, or network issue.
+     *
+     * @example
+     * ```typescript
+     * const { txKey } = await quasar.pulsar.syncCreate({
+     *   hash: '0xabc...',
+     *   chainId: 1,
+     *   status: 'pending',
+     *   from: '0x123...',
+     *   to: '0x456...',
+     * });
+     * ```
+     */
+    syncCreate(tx: Transaction): Promise<{
+        success: true;
+        txKey: string;
+    }>;
+    /**
+     * Updates an existing transaction's status or mutable fields.
+     *
+     * Sends a PATCH request to the `tx-sync` endpoint with the transaction key
+     * and the fields to update.
+     *
+     * @param txKey - The unique transaction key assigned by Quasar during {@link syncCreate}.
+     * @param patches - An object containing the fields to update (e.g. `status`, `blockNumber`).
+     * @returns An object containing `success: true` on successful update.
+     * @throws {QuasarSDKError} On authentication failure, invalid txKey, or network issue.
+     *
+     * @example
+     * ```typescript
+     * await quasar.pulsar.syncUpdate('tx_abc123', {
+     *   status: 'confirmed',
+     * });
+     * ```
+     */
+    syncUpdate(txKey: string, patches: UpdatableTransactionFields): Promise<{
+        success: true;
+    }>;
+    /**
+     * Retrieves paginated transaction history from the Quasar Cloud.
+     *
+     * Supports filtering by chain ID, status, and specific transaction key.
+     * Returns a typed {@link PaginatedResult} with navigation metadata.
+     *
+     * @param query - Optional query parameters for filtering and pagination.
+     * @returns A paginated result containing an array of {@link Transaction} documents.
+     * @throws {QuasarSDKError} On authentication failure or network issue.
+     *
+     * @example
+     * ```typescript
+     * const result = await quasar.pulsar.getHistory({
+     *   page: 1,
+     *   limit: 20,
+     *   chainId: 1,
+     *   status: 'confirmed',
+     * });
+     *
+     * for (const tx of result.docs) {
+     *   console.log(tx.hash, tx.status);
+     * }
+     * ```
+     */
+    getHistory(query?: HistoryQuery): Promise<PaginatedResult<Transaction>>;
+}
+
+/**
+ * @module @tuwaio/quasar-sdk
+ * The official server-side Node.js & Edge SDK for the TUWA Quasar Cloud.
+ *
+ * Provides a type-safe client for interacting with the Quasar API,
+ * including transaction syncing, status tracking, and history retrieval
+ * through the Iron Dome security perimeter.
+ *
+ * @example
+ * ```typescript
+ * import { Quasar } from '@tuwaio/quasar-sdk';
+ *
+ * const quasar = new Quasar({ secretKey: 'sk_live_...' });
+ * const history = await quasar.pulsar.getHistory({ chainId: 1 });
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * Main entry point for the Quasar SDK.
+ *
+ * Initializes the internal HTTP client with your secret key
+ * and exposes domain-specific modules for interacting with the Quasar Cloud API.
+ *
+ * @example
+ * ```typescript
+ * import { Quasar } from '@tuwaio/quasar-sdk';
+ *
+ * const quasar = new Quasar({
+ *   secretKey: 'sk_live_your_secret_key',
+ *   baseUrl: 'https://api.tuwa.io',
+ *   timeout: 15000,
+ * });
+ *
+ * // Access the Pulsar transaction engine
+ * const { txKey } = await quasar.pulsar.syncCreate(tx);
+ * ```
+ */
+declare class Quasar {
+    /** @internal */
+    private readonly client;
+    /**
+     * The Pulsar Transaction Engine module.
+     *
+     * Use this to sync transaction states to the Quasar Cloud
+     * and retrieve paginated transaction history.
+     *
+     * @see {@link PulsarModule}
+     */
+    readonly pulsar: PulsarModule;
+    /**
+     * Creates a new Quasar SDK instance.
+     *
+     * @param config - SDK configuration. See {@link QuasarConfig} for available options.
+     * @throws {Error} If `config.secretKey` is missing.
+     */
+    constructor(config: QuasarConfig);
+}
+
+export { type HistoryQuery, type PaginatedResult, PulsarModule, Quasar, type QuasarConfig, QuasarSDKError };

package/dist/index.js

@@ -0,0 +1,2 @@
+'use strict';var ofetch=require('ofetch');var a=class extends Error{status;originalError;constructor(r,t,e){super(r),this.name="QuasarSDKError",this.status=t,this.originalError=e;}},i=class{secretKey;baseUrl;timeout;constructor(r){if(!r.secretKey)throw new Error("[Quasar SDK] Missing API Key. Provide a secretKey starting with sk_live_.");this.secretKey=r.secretKey,this.baseUrl=r.baseUrl||"https://api.tuwa.io",this.timeout=r.timeout||1e4;}async request(r,t={}){try{return await ofetch.ofetch(r,{baseURL:this.baseUrl,timeout:this.timeout,...t,headers:{"Content-Type":"application/json","x-tuwa-secret-key":this.secretKey,...t.headers}})}catch(e){throw this.buildError(e)}}buildError(r){let t=r,e=t.statusCode??t.response?.status,u=(t.data??t.response?._data)?.error??t.message??"Unknown Error";return (e===401||e===403)&&console.error("\u{1F6A8} [Quasar SDK] Auth Error. Check your Secret Key and scopes."),new a(`[Quasar SDK] Request Failed (${e}): ${u}`,e,t)}};var s=class{constructor(r){this.client=r;}async syncCreate(r){return this.client.request("/api/v1/engine/tx-sync",{method:"POST",body:r})}async syncUpdate(r,t){return this.client.request("/api/v1/engine/tx-sync",{method:"PATCH",body:{txKey:r,...t}})}async getHistory(r={}){return this.client.request("/api/v1/engine/txs-history",{method:"GET",query:{page:r.page??1,limit:r.limit??10,chainId:r.chainId,status:r.status,txKey:r.txKey}})}};var n=class{client;pulsar;constructor(r){this.client=new i(r),this.pulsar=new s(this.client);}};
+exports.PulsarModule=s;exports.Quasar=n;exports.QuasarSDKError=a;

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import {ofetch}from'ofetch';var a=class extends Error{status;originalError;constructor(r,t,e){super(r),this.name="QuasarSDKError",this.status=t,this.originalError=e;}},i=class{secretKey;baseUrl;timeout;constructor(r){if(!r.secretKey)throw new Error("[Quasar SDK] Missing API Key. Provide a secretKey starting with sk_live_.");this.secretKey=r.secretKey,this.baseUrl=r.baseUrl||"https://api.tuwa.io",this.timeout=r.timeout||1e4;}async request(r,t={}){try{return await ofetch(r,{baseURL:this.baseUrl,timeout:this.timeout,...t,headers:{"Content-Type":"application/json","x-tuwa-secret-key":this.secretKey,...t.headers}})}catch(e){throw this.buildError(e)}}buildError(r){let t=r,e=t.statusCode??t.response?.status,u=(t.data??t.response?._data)?.error??t.message??"Unknown Error";return (e===401||e===403)&&console.error("\u{1F6A8} [Quasar SDK] Auth Error. Check your Secret Key and scopes."),new a(`[Quasar SDK] Request Failed (${e}): ${u}`,e,t)}};var s=class{constructor(r){this.client=r;}async syncCreate(r){return this.client.request("/api/v1/engine/tx-sync",{method:"POST",body:r})}async syncUpdate(r,t){return this.client.request("/api/v1/engine/tx-sync",{method:"PATCH",body:{txKey:r,...t}})}async getHistory(r={}){return this.client.request("/api/v1/engine/txs-history",{method:"GET",query:{page:r.page??1,limit:r.limit??10,chainId:r.chainId,status:r.status,txKey:r.txKey}})}};var n=class{client;pulsar;constructor(r){this.client=new i(r),this.pulsar=new s(this.client);}};
+export{s as PulsarModule,n as Quasar,a as QuasarSDKError};

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@tuwaio/quasar-sdk",
+  "version": "1.0.0-fix-pulsar-alpha.1.fc19e24",
+  "private": false,
+  "author": "Oleksandr Tkach",
+  "license": "Apache-2.0",
+  "description": "The official server-side Node.js & Edge SDK for the TUWA Quasar Cloud.",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "web3",
+    "transaction",
+    "tracking",
+    "sdk"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TuwaIO/sdk.git",
+    "directory": "packages/quasar-sdk"
+  },
+  "homepage": "https://github.com/TuwaIO/sdk",
+  "bugs": {
+    "url": "https://github.com/TuwaIO/sdk/issues"
+  },
+  "contributors": [
+    {
+      "name": "Oleksandr Tkach",
+      "url": "https://github.com/Argeare5"
+    }
+  ],
+  "peerDependencies": {
+    "@tuwaio/pulsar-core": ">=0.5.1",
+    "ofetch": ">=1.5.1"
+  },
+  "devDependencies": {
+    "@tuwaio/pulsar-core": "1.0.0-fix-remote-alpha.2.3ed5f1e",
+    "ofetch": "^1.5.1",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  },
+  "scripts": {
+    "start": "tsup src/index.ts --watch",
+    "build": "tsup"
+  }
+}