@veilo/sdk-core 0.4.0 → 0.6.0

package/dist/esm/relayer/types.d.ts

@@ -0,0 +1,275 @@
+/** Retry configuration for the relayer HTTP client. */
+export interface RetryPolicy {
+    /** Max number of retry attempts (default: 3) */
+    maxRetries: number;
+    /** Base delay in ms for exponential backoff (default: 1000) */
+    baseDelayMs: number;
+    /** HTTP status codes that trigger a retry (default: [429, 502, 503, 504]) */
+    retryableStatuses: number[];
+}
+export interface RelayerEncryptedNote {
+    noteId: string;
+    commitment: string;
+    ephemeralPublicKey: string;
+    encryptedBlob: string;
+    timestamp: number;
+    blockHeight?: number;
+    txSignature?: string;
+    spent?: boolean;
+    onchainId?: string;
+    spentTx?: string;
+    spentAt?: number;
+    compactEphemeralKey?: string | null;
+    compactBlob?: string | null;
+    viewTag?: number | null;
+    leafIndex?: number | null;
+    mintAddress?: string | null;
+    treeId?: number | null;
+}
+export interface QueryNotesRequest {
+    lastCheckedTimestamp?: number;
+    limit?: number;
+    offset?: number;
+    walletPublicKey?: string;
+}
+export interface QueryNotesResponse {
+    success: boolean;
+    notes: RelayerEncryptedNote[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+/** Nullifiers to test for spend status. Max 200 per request, 64-char hex. */
+export interface CheckNullifiersRequest {
+    nullifiers: string[];
+}
+export interface CheckNullifiersResponse {
+    success: boolean;
+    /** The SPENT subset, lowercase hex. Absent entries are unspent. */
+    spent: string[];
+}
+export interface SaveEncryptedNoteRequest {
+    commitment: string;
+    ephemeralPublicKey: string;
+    encryptedBlob: string;
+    timestamp: number;
+    blockHeight?: number;
+    txSignature?: string;
+    recipientWalletPublicKey?: string;
+    compactEphemeralKey?: string | null;
+    compactBlob?: string | null;
+    viewTag?: number | null;
+    leafIndex?: number;
+    newRoot?: string;
+    mintAddress?: string;
+    treeId?: number;
+    amountRaw?: string;
+}
+export interface SaveEncryptedNoteResponse {
+    success: boolean;
+    noteId?: string;
+    message?: string;
+    error?: string;
+}
+export interface MerkleRootResponse {
+    success: boolean;
+    data: {
+        root: string;
+        nextIndex: number;
+        treeId: number;
+        onChainTreeId: number;
+        mintAddress: string;
+    };
+}
+export interface MerkleTreeResponse {
+    success: boolean;
+    data: {
+        treeId: number;
+        onChainTreeId: number;
+        mintAddress: string;
+        height: number;
+        nextIndex: number;
+        root: string;
+        totalCommitments: number;
+        leaves: Array<{
+            commitment: string;
+            index: number;
+            txSignature: string;
+            slot: number;
+            timestamp: string;
+        }>;
+        reconstructionInfo: {
+            instructions: string;
+            treeHeight: number;
+            hashFunction?: string;
+        };
+    };
+}
+export interface TransactNote {
+    /** Relayer database identifier when the note came from relayer sync. */
+    id?: string;
+    /** Client-side alias used by the dapp, wallet, and extension. */
+    noteId?: string;
+    amount: string;
+    commitment: string;
+    root?: string;
+    nullifier: string;
+    blinding: string;
+    privateKey: string;
+    publicKey: string;
+    /** Optional because the relayer corrects it against commitment events. */
+    leafIndex?: number;
+    timestamp?: number;
+    spent?: boolean;
+    spentAt?: number;
+    txSignature?: string;
+    treeId?: number;
+    mintAddress?: string;
+    merklePath?: {
+        pathElements: string[];
+        pathIndices: number[];
+    };
+}
+export interface WithdrawRequest {
+    notes: TransactNote[];
+    recipient: string;
+    amount: string;
+    userPublicKey: string;
+    mintAddress: string;
+    feeOnTop?: boolean;
+}
+export interface WithdrawResponse {
+    success: boolean;
+    message: string;
+    data?: {
+        withdrawRecipient: string;
+        withdrawAmount: number;
+        fee: number;
+        feeBps: number;
+        feeOnTop: boolean;
+        totalDebited: number;
+        changeAmount: number;
+        changeNote: {
+            commitment: string;
+            amount: string;
+            leafIndex: number;
+        };
+        savedNoteId?: string;
+    };
+}
+export interface PrivateTransferRequest {
+    notes: TransactNote[];
+    amount: string;
+    recipientUsername: string;
+    userPublicKey?: string;
+    mintAddress?: string;
+    mode?: "merge";
+    recipientSolanaAddress?: string;
+    /** Legacy extension field; current relayer resolves the key itself. */
+    recipientShieldedKey?: string;
+}
+export interface PrivateTransferResponse {
+    success: boolean;
+    message: string;
+    data?: {
+        merged: false;
+    } | {
+        recipient: string;
+        transferAmount: number;
+        senderChangeAmount: number;
+        txSignature: string;
+        recipientNote: {
+            commitment: string;
+            amount: string;
+            leafIndex: number;
+            savedNoteId: string;
+        };
+        senderChangeNote: {
+            commitment: string;
+            amount: string;
+            leafIndex: number;
+        } | null;
+    };
+}
+export interface PrivateSwapRequest {
+    notes: TransactNote[];
+    sourceMintAddress: string;
+    destMintAddress: string;
+    sourceJupiterMint?: string;
+    destJupiterMint?: string;
+    swapAmountRaw: string;
+    minAmountOut: string;
+    slippageBps: number;
+    userPublicKey: string;
+    veiloPublicKey: string;
+    /** Optional veilo-connect intent forwarded by the browser extension. */
+    intentCommit?: {
+        origin: string;
+        fromMint: string;
+        toMint: string;
+        amountIn: string;
+        minAmountOut: string;
+        deadline: number;
+        nonce: string;
+    };
+    intentHash?: string;
+    intentDeadlineMs?: number;
+}
+export interface PrivateSwapResponse {
+    success: boolean;
+    message: string;
+    data?: {
+        txSignature: string;
+        swapAmountRaw: string;
+        outputAmount: string;
+        minAmountOut: string;
+        changeAmount: string;
+    };
+}
+export interface ChallengeResponse {
+    success: boolean;
+    challenge: string;
+    expiresAt: number;
+}
+export interface RegisterRequest {
+    username: string;
+    walletPublicKey: string;
+    signature: string;
+    challenge: string;
+    veiloPublicKey: string;
+}
+export interface RegisterResponse {
+    success: boolean;
+    token: string;
+    message?: string;
+}
+export interface RestoreRequest {
+    walletPublicKey: string;
+    signature: string;
+    challenge: string;
+}
+export interface RestoreResponse {
+    success: boolean;
+    token: string;
+    username: string;
+    veiloPublicKey: string;
+}
+export interface CheckUsernameResponse {
+    success: boolean;
+    available: boolean;
+}
+export interface VeiloPublicKeyResponse {
+    success: boolean;
+    username: string;
+    pubK: string;
+    veiloPublicKey: string;
+}
+export interface PreRegisterKeyResponse {
+    success: boolean;
+    veiloPublicKey: string;
+}
+export interface DeleteUserDataResponse {
+    success: boolean;
+    message: string;
+    deletedCount?: number;
+}

package/dist/esm/relayer/types.js

@@ -0,0 +1,4 @@
+// =============================================================================
+// Retry Policy
+// =============================================================================
+export {};

package/dist/esm/relayer.d.ts

@@ -1,318 +1 @@
-export interface VeiloRelayerConfig {
-    /** Base URL of the relayer. Defaults to Veilo's production service. */
-    relayerUrl?: string;
-    /** API key sent as x-api-key header */
-    apiKey: string;
-    /** Relayer's NaCl box public key (base64-encoded, 32 bytes) */
-    relayerPublicKey: string;
-    /** Optional JWT auth token for authenticated endpoints */
-    authToken?: string;
-}
-/** Structured error thrown by VeiloRelayerClient on API failures. */
-export declare class VeiloApiError extends Error {
-    code: string;
-    status: number;
-    details?: unknown;
-    constructor(code: string, message: string, status: number, details?: unknown);
-}
-/** Retry configuration for the relayer HTTP client. */
-export interface RetryPolicy {
-    /** Max number of retry attempts (default: 3) */
-    maxRetries: number;
-    /** Base delay in ms for exponential backoff (default: 1000) */
-    baseDelayMs: number;
-    /** HTTP status codes that trigger a retry (default: [429, 502, 503, 504]) */
-    retryableStatuses: number[];
-}
-export interface RelayerEncryptedNote {
-    noteId: string;
-    commitment: string;
-    ephemeralPublicKey: string;
-    encryptedBlob: string;
-    timestamp: number;
-    blockHeight?: number;
-    txSignature?: string;
-    spent?: boolean;
-    onchainId?: string;
-    spentTx?: string;
-    spentAt?: number;
-    compactEphemeralKey?: string | null;
-    compactBlob?: string | null;
-    viewTag?: number | null;
-    leafIndex?: number | null;
-    mintAddress?: string | null;
-    treeId?: number | null;
-}
-export interface QueryNotesRequest {
-    lastCheckedTimestamp?: number;
-    limit?: number;
-    offset?: number;
-    walletPublicKey?: string;
-}
-export interface QueryNotesResponse {
-    success: boolean;
-    notes: RelayerEncryptedNote[];
-    total: number;
-    limit: number;
-    offset: number;
-}
-export interface SaveEncryptedNoteRequest {
-    commitment: string;
-    ephemeralPublicKey: string;
-    encryptedBlob: string;
-    timestamp: number;
-    blockHeight?: number;
-    txSignature?: string;
-    recipientWalletPublicKey?: string;
-    compactEphemeralKey?: string | null;
-    compactBlob?: string | null;
-    viewTag?: number | null;
-    leafIndex?: number;
-    newRoot?: string;
-    mintAddress?: string;
-    treeId?: number;
-    amountRaw?: string;
-}
-export interface SaveEncryptedNoteResponse {
-    success: boolean;
-    noteId?: string;
-    message?: string;
-    error?: string;
-}
-export interface MerkleRootResponse {
-    success: boolean;
-    data: {
-        root: string;
-        nextIndex: number;
-        treeId: number;
-        onChainTreeId: number;
-        mintAddress: string;
-    };
-}
-export interface MerkleTreeResponse {
-    success: boolean;
-    data: {
-        treeId: number;
-        onChainTreeId: number;
-        mintAddress: string;
-        height: number;
-        nextIndex: number;
-        root: string;
-        totalCommitments: number;
-        leaves: Array<{
-            commitment: string;
-            index: number;
-            txSignature: string;
-            slot: number;
-            timestamp: string;
-        }>;
-        reconstructionInfo: {
-            instructions: string;
-            treeHeight: number;
-            hashFunction?: string;
-        };
-    };
-}
-export interface TransactNote {
-    commitment: string;
-    privateKey: string;
-    publicKey: string;
-    blinding: string;
-    amount: string;
-    nullifier: string;
-    leafIndex?: number;
-    noteId?: string;
-}
-export interface WithdrawRequest {
-    notes: TransactNote[];
-    recipient: string;
-    amount: string;
-    userPublicKey: string;
-    mintAddress: string;
-}
-export interface WithdrawResponse {
-    success: boolean;
-    message: string;
-    data?: {
-        withdrawRecipient: string;
-        withdrawAmount: number;
-        changeAmount: number;
-        changeNote: {
-            commitment: string;
-            privateKey: string;
-            publicKey: string;
-            blinding: string;
-            amount: string;
-            nullifier: string;
-        };
-        spentNoteIds?: string[];
-        txSignature?: string;
-    };
-}
-export interface PrivateTransferRequest {
-    notes: TransactNote[];
-    amount: string;
-    recipientUsername: string;
-    userPublicKey?: string;
-    mintAddress?: string;
-}
-export interface PrivateTransferResponse {
-    success: boolean;
-    message: string;
-    data?: {
-        recipient: string;
-        transferAmount: number;
-        senderChangeAmount: number;
-        txSignature: string;
-        recipientNote: {
-            commitment: string;
-            amount: string;
-            leafIndex: number;
-            savedNoteId: string;
-        };
-        senderChangeNote: {
-            commitment: string;
-            privateKey: string;
-            publicKey: string;
-            blinding: string;
-            amount: string;
-            leafIndex: number;
-            savedNoteId: string;
-        } | null;
-    };
-}
-export interface PrivateSwapRequest {
-    notes: TransactNote[];
-    sourceMintAddress: string;
-    destMintAddress: string;
-    sourceJupiterMint?: string;
-    destJupiterMint?: string;
-    swapAmountRaw: string;
-    minAmountOut: string;
-    slippageBps: number;
-    userPublicKey: string;
-    veiloPublicKey: string;
-}
-export interface PrivateSwapResponse {
-    success: boolean;
-    message: string;
-    data?: {
-        txSignature: string;
-        swapAmountRaw: string;
-        outputAmount: string;
-        minAmountOut: string;
-        changeAmount: string;
-    };
-}
-export interface ChallengeResponse {
-    success: boolean;
-    challenge: string;
-    expiresAt: number;
-}
-export interface RegisterRequest {
-    username: string;
-    walletPublicKey: string;
-    signature: string;
-    challenge: string;
-    veiloPublicKey: string;
-}
-export interface RegisterResponse {
-    success: boolean;
-    token: string;
-    message?: string;
-}
-export interface RestoreRequest {
-    walletPublicKey: string;
-    signature: string;
-    challenge: string;
-}
-export interface RestoreResponse {
-    success: boolean;
-    token: string;
-    username: string;
-    veiloPublicKey: string;
-}
-export interface CheckUsernameResponse {
-    success: boolean;
-    available: boolean;
-}
-export interface VeiloPublicKeyResponse {
-    success: boolean;
-    username: string;
-    pubK: string;
-    veiloPublicKey: string;
-}
-export interface PreRegisterKeyResponse {
-    success: boolean;
-    veiloPublicKey: string;
-}
-export interface DeleteUserDataResponse {
-    success: boolean;
-    message: string;
-    deletedCount?: number;
-}
-/**
- * HTTP client for the Veilo relayer API.
- *
- * Handles auth, notes, merkle, and encrypted transact endpoints with
- * automatic retry on transient failures and NaCl box payload encryption.
- *
- * @example
- * ```ts
- * const client = new VeiloRelayerClient({
- *   apiKey: "your-api-key",
- *   relayerPublicKey: "<base64 NaCl public key>",
- * });
- * const root = await client.getMerkleRoot("So111...");
- * ```
- */
-export declare class VeiloRelayerClient {
-    private readonly baseUrl;
-    private readonly apiKey;
-    private readonly relayerPubKey;
-    private authToken;
-    private readonly retry;
-    constructor(config: VeiloRelayerConfig, retry?: Partial<RetryPolicy>);
-    /** Update the auth token (e.g. after register/restore). */
-    setAuthToken(token: string): void;
-    private headers;
-    private request;
-    private encrypt;
-    /** Request a signature challenge for wallet authentication. */
-    getChallenge(walletPublicKey: string): Promise<ChallengeResponse>;
-    /** Register a new account with a signed challenge. Returns a JWT auth token. */
-    register(data: RegisterRequest): Promise<RegisterResponse>;
-    /** Restore an existing account using a signed challenge. Returns a JWT auth token. */
-    restore(data: RestoreRequest): Promise<RestoreResponse>;
-    /** Check whether a username is available for registration. */
-    checkUsername(username: string): Promise<CheckUsernameResponse>;
-    /** Look up a user's Veilo public key by username or wallet public key. */
-    getVeiloPublicKey(params: {
-        username: string;
-        publicKey?: never;
-    } | {
-        publicKey: string;
-        username?: never;
-    }): Promise<VeiloPublicKeyResponse>;
-    /**
-     * Provision (or retrieve) the Veilo spend key paired with a Solana address.
-     * Public and idempotent; the response contains public key material only.
-     */
-    preRegisterKey(solanaAddress: string): Promise<PreRegisterKeyResponse>;
-    /** Save an encrypted note to the relayer's database. */
-    saveEncryptedNote(data: SaveEncryptedNoteRequest): Promise<SaveEncryptedNoteResponse>;
-    /** Query encrypted notes for the authenticated user. Requires auth token. */
-    queryEncryptedNotes(params?: QueryNotesRequest): Promise<QueryNotesResponse>;
-    /** Delete all stored data for the authenticated user. Requires auth token. */
-    deleteUserData(): Promise<DeleteUserDataResponse>;
-    /** Fetch the current Merkle root for a pool, optionally filtered by mint and tree ID. */
-    getMerkleRoot(mintAddress?: string, treeId?: number): Promise<MerkleRootResponse>;
-    /** Fetch the full Merkle tree (all leaves) for a pool. */
-    getMerkleTree(mintAddress?: string, treeId?: number): Promise<MerkleTreeResponse>;
-    /** Submit an encrypted withdrawal request to the relayer. Not retried on failure. */
-    submitWithdraw(data: WithdrawRequest): Promise<WithdrawResponse>;
-    /** Submit an encrypted private transfer request. Not retried on failure. */
-    submitPrivateTransfer(data: PrivateTransferRequest): Promise<PrivateTransferResponse>;
-    /** Submit an encrypted private swap request. Not retried on failure. */
-    submitPrivateSwap(data: PrivateSwapRequest): Promise<PrivateSwapResponse>;
-}
+export * from "./relayer/index.js";