@zelana/sdk 0.1.0

package/dist/zelana.d.ts

@@ -0,0 +1,213 @@
+/**
+ * Zelana SDK - High-level Client
+ *
+ * Combines keypair management and API client for a convenient developer experience.
+ * This is the main entry point for interacting with Zelana L2.
+ */
+import { Keypair } from './keypair';
+import { ApiClient, ApiClientConfig } from './client';
+import type { AccountState, TransferResponse, WithdrawResponse, HealthInfo, StateRoots, BatchStatusInfo, GlobalStats, TxSummary, BatchSummary, PaginationParams, DevDepositResponse, DevSealResponse } from './types';
+/**
+ * Configuration for ZelanaClient
+ */
+export interface ZelanaClientConfig extends ApiClientConfig {
+    /** Default chain ID for transactions (default: 1) */
+    chainId?: bigint;
+}
+/**
+ * High-level Zelana L2 client
+ *
+ * Provides a convenient interface for common operations:
+ * - Account management (balance, nonce)
+ * - Transfers (sign + submit in one call)
+ * - Withdrawals (sign + submit in one call)
+ * - Transaction queries
+ *
+ * @example
+ * ```typescript
+ * import { ZelanaClient, Keypair } from '@zelana/sdk';
+ *
+ * const keypair = Keypair.generate();
+ * const client = new ZelanaClient({
+ *   baseUrl: 'http://localhost:3000',
+ *   keypair,
+ * });
+ *
+ * // Check balance
+ * const account = await client.getAccount();
+ * console.log(`Balance: ${account.balance}`);
+ *
+ * // Send transfer
+ * const result = await client.transfer(recipientPubkey, 1_000_000n);
+ * console.log(`TX Hash: ${result.txHash}`);
+ * ```
+ */
+export declare class ZelanaClient {
+    private readonly api;
+    private readonly keypair;
+    private readonly chainId;
+    constructor(config: ZelanaClientConfig & {
+        keypair?: Keypair;
+    });
+    /**
+     * Get the underlying API client for low-level operations
+     */
+    get apiClient(): ApiClient;
+    /**
+     * Get the public key of the configured keypair
+     */
+    get publicKey(): Uint8Array | null;
+    /**
+     * Get the public key as hex string
+     */
+    get publicKeyHex(): string | null;
+    /**
+     * Check if the sequencer is healthy
+     */
+    isHealthy(): Promise<boolean>;
+    /**
+     * Get health info
+     */
+    health(): Promise<HealthInfo>;
+    /**
+     * Get current state roots
+     */
+    getStateRoots(): Promise<StateRoots>;
+    /**
+     * Get current batch status
+     */
+    getBatchStatus(): Promise<BatchStatusInfo>;
+    /**
+     * Get global statistics
+     */
+    getStats(): Promise<GlobalStats>;
+    /**
+     * Get account state for the configured keypair
+     */
+    getAccount(): Promise<AccountState>;
+    /**
+     * Get account state by public key
+     */
+    getAccountFor(pubkey: Uint8Array | string): Promise<AccountState>;
+    /**
+     * Get current balance for the configured keypair
+     */
+    getBalance(): Promise<bigint>;
+    /**
+     * Get current nonce for the configured keypair
+     */
+    getNonce(): Promise<bigint>;
+    /**
+     * Transfer funds to another account
+     *
+     * Signs and submits a transfer transaction in one call.
+     * Automatically fetches the current nonce if not provided.
+     *
+     * @param to - Recipient public key (bytes or hex string)
+     * @param amount - Amount to transfer in lamports
+     * @param nonce - Optional nonce (auto-fetched if not provided)
+     * @returns Transfer response with transaction hash
+     */
+    transfer(to: Uint8Array | string, amount: bigint, nonce?: bigint): Promise<TransferResponse>;
+    /**
+     * Transfer all funds to another account (minus a small reserve)
+     *
+     * @param to - Recipient public key
+     * @param reserve - Amount to keep (default: 0)
+     */
+    transferAll(to: Uint8Array | string, reserve?: bigint): Promise<TransferResponse>;
+    /**
+     * Withdraw funds to L1 (Solana)
+     *
+     * Signs and submits a withdrawal request in one call.
+     * Automatically fetches the current nonce if not provided.
+     *
+     * @param toL1Address - Destination Solana address (bytes or base58)
+     * @param amount - Amount to withdraw in lamports
+     * @param nonce - Optional nonce (auto-fetched if not provided)
+     * @returns Withdrawal response with transaction hash
+     */
+    withdraw(toL1Address: Uint8Array | string, amount: bigint, nonce?: bigint): Promise<WithdrawResponse>;
+    /**
+     * Get withdrawal status
+     */
+    getWithdrawalStatus(txHash: string): Promise<import("./types").WithdrawalStatus>;
+    /**
+     * Get fast withdrawal quote
+     */
+    getFastWithdrawQuote(amount: bigint): Promise<import("./types").FastWithdrawQuote>;
+    /**
+     * Get transaction by hash
+     */
+    getTransaction(txHash: string): Promise<TxSummary | null>;
+    /**
+     * List transactions with optional filters
+     */
+    listTransactions(params?: PaginationParams & {
+        batchId?: bigint;
+        txType?: string;
+        status?: string;
+    }): Promise<{
+        transactions: TxSummary[];
+        total: number;
+    }>;
+    /**
+     * Get batch by ID
+     */
+    getBatch(batchId: bigint): Promise<BatchSummary | null>;
+    /**
+     * List batches
+     */
+    listBatches(params?: PaginationParams): Promise<{
+        batches: BatchSummary[];
+        total: number;
+    }>;
+    /**
+     * Wait for a transaction to reach a specific status
+     *
+     * @param txHash - Transaction hash to wait for
+     * @param targetStatus - Status to wait for (default: 'executed')
+     * @param timeoutMs - Maximum wait time (default: 60000)
+     * @param pollIntervalMs - Poll interval (default: 1000)
+     */
+    waitForTransaction(txHash: string, targetStatus?: 'included' | 'executed' | 'settled', timeoutMs?: number, pollIntervalMs?: number): Promise<TxSummary>;
+    /**
+     * Wait for a batch to be settled on L1
+     */
+    waitForBatch(batchId: bigint, timeoutMs?: number, pollIntervalMs?: number): Promise<BatchSummary>;
+    /**
+     * Simulate a deposit from L1 (DEV MODE ONLY)
+     *
+     * This method is only available when the sequencer is running with DEV_MODE=true.
+     * It bypasses the L1 indexer and directly credits funds to the configured keypair's account.
+     *
+     * @param amount - Amount to deposit in lamports
+     * @returns Deposit response with new balance
+     * @throws ZelanaError if dev mode is not enabled (404) or no keypair configured
+     */
+    devDeposit(amount: bigint): Promise<DevDepositResponse>;
+    /**
+     * Simulate a deposit to a specific account (DEV MODE ONLY)
+     *
+     * This method is only available when the sequencer is running with DEV_MODE=true.
+     * It bypasses the L1 indexer and directly credits funds to the specified account.
+     *
+     * @param to - Recipient public key (bytes or hex string)
+     * @param amount - Amount to deposit in lamports
+     * @returns Deposit response with new balance
+     * @throws ZelanaError if dev mode is not enabled (404)
+     */
+    devDepositTo(to: Uint8Array | string, amount: bigint): Promise<DevDepositResponse>;
+    /**
+     * Force seal the current batch (DEV MODE ONLY)
+     *
+     * This method is only available when the sequencer is running with DEV_MODE=true.
+     * It forces the current batch to seal immediately, bypassing the normal seal triggers.
+     *
+     * @param waitForProof - Whether to wait for proof generation (default: false)
+     * @returns Seal response with batch ID and transaction count
+     * @throws ZelanaError if dev mode is not enabled (404)
+     */
+    devSeal(waitForProof?: boolean): Promise<DevSealResponse>;
+}
+//# sourceMappingURL=zelana.d.ts.map

package/dist/zelana.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zelana.d.ts","sourceRoot":"","sources":["../src/zelana.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,EAAa,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAGtD,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,eAAe,EACf,WAAW,EACX,SAAS,EACT,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAChB,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD,qDAAqD;IACrD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAY;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,MAAM,EAAE,kBAAkB,GAAG;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE;IAM9D;;OAEG;IACH,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,UAAU,GAAG,IAAI,CAEjC;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,MAAM,GAAG,IAAI,CAEhC;IAMD;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IASnC;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC;IAInC;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC;IAI1C;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,eAAe,CAAC;IAIhD;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAC;IAQtC;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,YAAY,CAAC;IAOzC;;OAEG;IACG,aAAa,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAOvE;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAKnC;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IASjC;;;;;;;;;;OAUG;IACG,QAAQ,CACZ,EAAE,EAAE,UAAU,GAAG,MAAM,EACvB,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,gBAAgB,CAAC;IAoB5B;;;;;OAKG;IACG,WAAW,CACf,EAAE,EAAE,UAAU,GAAG,MAAM,EACvB,OAAO,GAAE,MAAkB,GAC1B,OAAO,CAAC,gBAAgB,CAAC;IAkB5B;;;;;;;;;;OAUG;IACG,QAAQ,CACZ,WAAW,EAAE,UAAU,GAAG,MAAM,EAChC,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,gBAAgB,CAAC;IAoB5B;;OAEG;IACG,mBAAmB,CAAC,MAAM,EAAE,MAAM;IAIxC;;OAEG;IACG,oBAAoB,CAAC,MAAM,EAAE,MAAM;IAQzC;;OAEG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAI/D;;OAEG;IACG,gBAAgB,CACpB,MAAM,GAAE,gBAAgB,GAAG;QACzB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;KACZ,GACL,OAAO,CAAC;QAAE,YAAY,EAAE,SAAS,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAIxD;;OAEG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAI7D;;OAEG;IACG,WAAW,CACf,MAAM,GAAE,gBAAqB,GAC5B,OAAO,CAAC;QAAE,OAAO,EAAE,YAAY,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAQtD;;;;;;;OAOG;IACG,kBAAkB,CACtB,MAAM,EAAE,MAAM,EACd,YAAY,GAAE,UAAU,GAAG,UAAU,GAAG,SAAsB,EAC9D,SAAS,GAAE,MAAc,EACzB,cAAc,GAAE,MAAa,GAC5B,OAAO,CAAC,SAAS,CAAC;IA8BrB;;OAEG;IACG,YAAY,CAChB,OAAO,EAAE,MAAM,EACf,SAAS,GAAE,MAAe,EAC1B,cAAc,GAAE,MAAa,GAC5B,OAAO,CAAC,YAAY,CAAC;IA8BxB;;;;;;;;;OASG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAO7D;;;;;;;;;;OAUG;IACG,YAAY,CAAC,EAAE,EAAE,UAAU,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAKxF;;;;;;;;;OASG;IACG,OAAO,CAAC,YAAY,GAAE,OAAe,GAAG,OAAO,CAAC,eAAe,CAAC;CAGvE"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@zelana/sdk",
+  "version": "0.1.0",
+  "description": "TypeScript SDK for Zelana L2",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "bun build src/index.ts --outdir dist --target browser && tsc --emitDeclarationOnly --declaration --outDir dist",
+    "prepack": "npm run build",
+    "prepublishOnly": "npm run build",
+    "test": "bun test",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@noble/ed25519": "^2.1.0",
+    "@noble/hashes": "^1.4.0"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5.3.0"
+  },
+  "keywords": [
+    "zelana",
+    "solana",
+    "l2",
+    "rollup",
+    "privacy",
+    "zk"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zelana/zelana"
+  }
+}