@veilo/sdk-core 0.4.0 → 0.5.0

package/dist/esm/proofs/swap.d.ts

@@ -0,0 +1,87 @@
+import { PublicKey } from "@solana/web3.js";
+import type { InputUTXO, SerializedUTXO } from "../notes/model.js";
+import type { ExtData, RawProof } from "./types.js";
+/**
+ * Swap circuit inputs. Matches the signal shape declared by swap.circom's
+ * main component (see zk-circuits/swap.circom lines 208-238). Unlike the
+ * transaction circuit, the swap circuit distinguishes a "change" output
+ * (same mint as source) from a "dest" output (dest mint) and takes a
+ * swap-specific params hash and swapAmount alongside the usual inputs.
+ */
+export type SwapCircuitInputs = {
+    sourceRoot: Uint8Array;
+    swapParamsHash: Uint8Array;
+    extDataHash: Uint8Array;
+    sourceMint: PublicKey;
+    destMint: PublicKey;
+    inputNullifiers: [Uint8Array, Uint8Array];
+    changeCommitment: Uint8Array;
+    destCommitment: Uint8Array;
+    swapAmount: bigint;
+    inAmount: [bigint, bigint];
+    inPubkey: [bigint, bigint];
+    inBlinding: [bigint, bigint];
+    inPathIndex: [number, number];
+    inPathElements: [bigint[], bigint[]];
+    inPrivateKey: [bigint, bigint];
+    changeAmount: bigint;
+    changePubkey: bigint;
+    changeBlinding: bigint;
+    destAmount: bigint;
+    destPubkey: bigint;
+    destBlinding: bigint;
+    minAmountOut: bigint;
+    deadline: bigint;
+};
+/** Proof builder accepted by SDK-side private swap flows. */
+export type SwapProofBuilder = (inputs: SwapCircuitInputs) => Promise<RawProof>;
+/**
+ * Prepare the exact witness/public inputs used by the relayer's swap circuit.
+ * Output 0 must be source-mint change and output 1 the destination-mint note.
+ */
+export declare function prepareSwapInputs(params: {
+    inputUTXOs: [InputUTXO, InputUTXO];
+    changeUTXO: SerializedUTXO;
+    destUTXO: SerializedUTXO;
+    sourceRoot: Uint8Array;
+    sourceMint: PublicKey;
+    destMint: PublicKey;
+    swapAmount: bigint;
+    minAmountOut: bigint;
+    deadline: bigint;
+    extData: ExtData;
+}): SwapCircuitInputs;
+/**
+ * Convert SwapCircuitInputs into the shape expected by
+ * snarkjs.groth16.fullProve() for swap.circom. Every value is emitted as a
+ * decimal string (or string array) because snarkjs only accepts field
+ * elements as strings.
+ *
+ * Mirrors `generateSwapProof` in
+ * relayer-server/src/controllers/swap.helpers.ts so SDK-side swap proofs
+ * verify against the same circuit the relayer uses.
+ */
+export declare function formatSwapInputsForSnarkjs(inputs: SwapCircuitInputs): Record<string, any>;
+/**
+ * Compute the swap params hash that the swap circuit and on-chain program verify.
+ * Mirrors relayer-server/src/controllers/swap.helpers.ts `computeSwapParamsHash`.
+ *
+ * Circuit formula (swap.circom lines 293-307):
+ *   mintPairHash   = Poseidon(sourceMint, destMint)
+ *   swapTermsHash  = Poseidon(minAmountOut, deadline, destAmount)
+ *   swapParamsHash = Poseidon(mintPairHash, swapTermsHash)
+ *
+ * @param sourceMint   Source pool mint
+ * @param destMint     Destination pool mint
+ * @param minAmountOut Minimum accepted output amount (slippage protected)
+ * @param deadline     Positive Unix timestamp deadline (the program rejects 0)
+ * @param destAmount   Actual amount committed to destination UTXO (≥ minAmountOut -
+ *                     relayerFee). If omitted, defaults to minAmountOut.
+ */
+export declare function computeSwapParamsHash(sourceMint: PublicKey, destMint: PublicKey, minAmountOut: bigint, deadline: bigint, destAmount?: bigint): Uint8Array;
+/**
+ * Compute the swap data hash committed on-chain for Jupiter instruction integrity.
+ * SHA-256 of the raw Jupiter swap instruction data bytes.
+ * Mirrors relayer-server/src/controllers/swap.helpers.ts `computeSwapDataHash`.
+ */
+export declare function computeSwapDataHash(swapData: Uint8Array | Buffer): Uint8Array;

package/dist/esm/proofs/swap.js

@@ -0,0 +1,138 @@
+import { sha256 } from "@noble/hashes/sha256";
+import { BN254_FR_MODULUS, bigIntToBytesBE, bytesToBigIntBE, poseidon2, poseidon3, pubkeyToField, } from "../poseidon.js";
+import { deriveNullifier } from "../notes/nullifier.js";
+import { computeExtDataHash } from "./transaction.js";
+/**
+ * Prepare the exact witness/public inputs used by the relayer's swap circuit.
+ * Output 0 must be source-mint change and output 1 the destination-mint note.
+ */
+export function prepareSwapInputs(params) {
+    const { inputUTXOs, changeUTXO, destUTXO, sourceRoot, sourceMint, destMint, swapAmount, minAmountOut, deadline, extData, } = params;
+    const totalInput = inputUTXOs[0].amount + inputUTXOs[1].amount;
+    if (swapAmount <= 0n)
+        throw new Error("swapAmount must be positive");
+    if (deadline <= 0n) {
+        throw new Error("deadline must be a positive Unix timestamp");
+    }
+    if (totalInput !== swapAmount + changeUTXO.amount) {
+        throw new Error(`Swap balance mismatch: inputs=${totalInput}, swap=${swapAmount}, change=${changeUTXO.amount}`);
+    }
+    if (destUTXO.amount < minAmountOut) {
+        throw new Error("Destination note amount is below minAmountOut");
+    }
+    if (changeUTXO.mintAddress !== pubkeyToField(sourceMint)) {
+        throw new Error("Change UTXO must use the source mint");
+    }
+    if (destUTXO.mintAddress !== pubkeyToField(destMint)) {
+        throw new Error("Destination UTXO must use the destination mint");
+    }
+    return {
+        sourceRoot,
+        swapParamsHash: computeSwapParamsHash(sourceMint, destMint, minAmountOut, deadline, destUTXO.amount),
+        extDataHash: computeExtDataHash(extData),
+        sourceMint,
+        destMint,
+        inputNullifiers: [
+            deriveNullifier(inputUTXOs[0], inputUTXOs[0].pathIndex, inputUTXOs[0].privateKey),
+            deriveNullifier(inputUTXOs[1], inputUTXOs[1].pathIndex, inputUTXOs[1].privateKey),
+        ],
+        changeCommitment: changeUTXO.commitment,
+        destCommitment: destUTXO.commitment,
+        swapAmount,
+        inAmount: [inputUTXOs[0].amount, inputUTXOs[1].amount],
+        inPubkey: [inputUTXOs[0].pubkey, inputUTXOs[1].pubkey],
+        inBlinding: [inputUTXOs[0].blinding, inputUTXOs[1].blinding],
+        inPathIndex: [inputUTXOs[0].pathIndex, inputUTXOs[1].pathIndex],
+        inPathElements: [
+            inputUTXOs[0].pathElements.map((element) => bytesToBigIntBE(element) % BN254_FR_MODULUS),
+            inputUTXOs[1].pathElements.map((element) => bytesToBigIntBE(element) % BN254_FR_MODULUS),
+        ],
+        inPrivateKey: [inputUTXOs[0].privateKey, inputUTXOs[1].privateKey],
+        changeAmount: changeUTXO.amount,
+        changePubkey: changeUTXO.pubkey,
+        changeBlinding: changeUTXO.blinding,
+        destAmount: destUTXO.amount,
+        destPubkey: destUTXO.pubkey,
+        destBlinding: destUTXO.blinding,
+        minAmountOut,
+        deadline,
+    };
+}
+/**
+ * Convert SwapCircuitInputs into the shape expected by
+ * snarkjs.groth16.fullProve() for swap.circom. Every value is emitted as a
+ * decimal string (or string array) because snarkjs only accepts field
+ * elements as strings.
+ *
+ * Mirrors `generateSwapProof` in
+ * relayer-server/src/controllers/swap.helpers.ts so SDK-side swap proofs
+ * verify against the same circuit the relayer uses.
+ */
+export function formatSwapInputsForSnarkjs(inputs) {
+    return {
+        // Public inputs
+        sourceRoot: bytesToBigIntBE(inputs.sourceRoot).toString(),
+        swapParamsHash: bytesToBigIntBE(inputs.swapParamsHash).toString(),
+        extDataHash: bytesToBigIntBE(inputs.extDataHash).toString(),
+        sourceMint: pubkeyToField(inputs.sourceMint).toString(),
+        destMint: pubkeyToField(inputs.destMint).toString(),
+        inputNullifier: inputs.inputNullifiers.map((n) => bytesToBigIntBE(n).toString()),
+        changeCommitment: bytesToBigIntBE(inputs.changeCommitment).toString(),
+        destCommitment: bytesToBigIntBE(inputs.destCommitment).toString(),
+        swapAmount: inputs.swapAmount.toString(),
+        // Private inputs - Input UTXOs
+        inAmount: inputs.inAmount.map((a) => a.toString()),
+        inPubkey: inputs.inPubkey.map((p) => p.toString()),
+        inBlinding: inputs.inBlinding.map((b) => b.toString()),
+        inPathIndex: inputs.inPathIndex.map((i) => i.toString()),
+        inPathElements: inputs.inPathElements.map((path) => path.map((e) => e.toString())),
+        inPrivateKey: inputs.inPrivateKey.map((k) => k.toString()),
+        // Private inputs - Change UTXO
+        changeAmount: inputs.changeAmount.toString(),
+        changePubkey: inputs.changePubkey.toString(),
+        changeBlinding: inputs.changeBlinding.toString(),
+        // Private inputs - Destination UTXO
+        destAmount: inputs.destAmount.toString(),
+        destPubkey: inputs.destPubkey.toString(),
+        destBlinding: inputs.destBlinding.toString(),
+        // Swap params
+        minAmountOut: inputs.minAmountOut.toString(),
+        deadline: inputs.deadline.toString(),
+    };
+}
+// -----------------------------------------------------------------------------
+// Swap Parameter Hashing
+// -----------------------------------------------------------------------------
+/**
+ * Compute the swap params hash that the swap circuit and on-chain program verify.
+ * Mirrors relayer-server/src/controllers/swap.helpers.ts `computeSwapParamsHash`.
+ *
+ * Circuit formula (swap.circom lines 293-307):
+ *   mintPairHash   = Poseidon(sourceMint, destMint)
+ *   swapTermsHash  = Poseidon(minAmountOut, deadline, destAmount)
+ *   swapParamsHash = Poseidon(mintPairHash, swapTermsHash)
+ *
+ * @param sourceMint   Source pool mint
+ * @param destMint     Destination pool mint
+ * @param minAmountOut Minimum accepted output amount (slippage protected)
+ * @param deadline     Positive Unix timestamp deadline (the program rejects 0)
+ * @param destAmount   Actual amount committed to destination UTXO (≥ minAmountOut -
+ *                     relayerFee). If omitted, defaults to minAmountOut.
+ */
+export function computeSwapParamsHash(sourceMint, destMint, minAmountOut, deadline, destAmount) {
+    const srcField = pubkeyToField(sourceMint);
+    const dstField = pubkeyToField(destMint);
+    const mintPairHash = poseidon2(srcField, dstField);
+    const dest = destAmount ?? minAmountOut;
+    const swapTermsHash = poseidon3(minAmountOut, deadline, dest);
+    const paramsHash = poseidon2(mintPairHash, swapTermsHash);
+    return bigIntToBytesBE(paramsHash);
+}
+/**
+ * Compute the swap data hash committed on-chain for Jupiter instruction integrity.
+ * SHA-256 of the raw Jupiter swap instruction data bytes.
+ * Mirrors relayer-server/src/controllers/swap.helpers.ts `computeSwapDataHash`.
+ */
+export function computeSwapDataHash(swapData) {
+    return sha256(swapData instanceof Buffer ? new Uint8Array(swapData) : swapData);
+}

package/dist/esm/proofs/transaction.d.ts

@@ -0,0 +1,28 @@
+import { PublicKey } from "@solana/web3.js";
+import type { InputUTXO, SerializedUTXO } from "../notes/model.js";
+import type { ExtData, TransactionCircuitInputs } from "./types.js";
+/**
+ * Compute the external data hash.
+ * Matches on-chain computation:
+ *   hash1 = Poseidon(recipient, relayer)
+ *   hash2 = Poseidon(fee, refund)
+ *   extDataHash = Poseidon(hash1, hash2, claimant)
+ */
+export declare function computeExtDataHash(extData: ExtData): Uint8Array;
+/**
+ * Convert i64 to field element (handles negative via modular arithmetic).
+ * For negative values, we add the field modulus to get the equivalent positive representation.
+ */
+export declare function i64ToField(value: bigint): bigint;
+/**
+ * Prepare transaction circuit inputs from high-level parameters.
+ * This converts the SDK types into the format expected by the circuit.
+ */
+export declare function prepareTransactionInputs(params: {
+    inputUTXOs: [InputUTXO, InputUTXO];
+    outputUTXOs: [SerializedUTXO, SerializedUTXO];
+    root: Uint8Array;
+    publicAmount: bigint;
+    extData: ExtData;
+    mintAddress: PublicKey;
+}): TransactionCircuitInputs;

package/dist/esm/proofs/transaction.js

@@ -0,0 +1,105 @@
+import { BN254_FR_MODULUS, bigIntToBytesBE, bytesToBigIntBE, poseidon2, poseidon3, pubkeyToField, } from "../poseidon.js";
+import { deriveNullifier } from "../notes/nullifier.js";
+// -----------------------------------------------------------------------------
+// ExtData Hash Computation
+// -----------------------------------------------------------------------------
+/**
+ * Compute the external data hash.
+ * Matches on-chain computation:
+ *   hash1 = Poseidon(recipient, relayer)
+ *   hash2 = Poseidon(fee, refund)
+ *   extDataHash = Poseidon(hash1, hash2, claimant)
+ */
+export function computeExtDataHash(extData) {
+    const recipientField = pubkeyToField(extData.recipient);
+    const relayerField = pubkeyToField(extData.relayer);
+    const feeField = extData.fee % BN254_FR_MODULUS;
+    const refundField = extData.refund % BN254_FR_MODULUS;
+    const claimantField = pubkeyToField(extData.claimant);
+    const hash1 = poseidon2(recipientField, relayerField);
+    const hash2 = poseidon2(feeField, refundField);
+    const finalHash = poseidon3(hash1, hash2, claimantField);
+    return bigIntToBytesBE(finalHash);
+}
+// -----------------------------------------------------------------------------
+// Circuit Input Preparation
+// -----------------------------------------------------------------------------
+/**
+ * Convert i64 to field element (handles negative via modular arithmetic).
+ * For negative values, we add the field modulus to get the equivalent positive representation.
+ */
+export function i64ToField(value) {
+    if (value >= 0n) {
+        return value % BN254_FR_MODULUS;
+    }
+    return (BN254_FR_MODULUS + value) % BN254_FR_MODULUS;
+}
+/**
+ * Prepare transaction circuit inputs from high-level parameters.
+ * This converts the SDK types into the format expected by the circuit.
+ */
+export function prepareTransactionInputs(params) {
+    const { inputUTXOs, outputUTXOs, root, publicAmount, extData, mintAddress } = params;
+    const extDataHash = computeExtDataHash(extData);
+    const mintField = pubkeyToField(mintAddress);
+    // Prepare input UTXO data
+    const inAmount = [
+        inputUTXOs[0].amount,
+        inputUTXOs[1].amount,
+    ];
+    const inPubkey = [
+        inputUTXOs[0].pubkey,
+        inputUTXOs[1].pubkey,
+    ];
+    const inBlinding = [
+        inputUTXOs[0].blinding,
+        inputUTXOs[1].blinding,
+    ];
+    const inPathIndex = [
+        inputUTXOs[0].pathIndex,
+        inputUTXOs[1].pathIndex,
+    ];
+    const inPathElements = [
+        inputUTXOs[0].pathElements.map((e) => bytesToBigIntBE(e) % BN254_FR_MODULUS),
+        inputUTXOs[1].pathElements.map((e) => bytesToBigIntBE(e) % BN254_FR_MODULUS),
+    ];
+    const inPrivateKey = [
+        inputUTXOs[0].privateKey,
+        inputUTXOs[1].privateKey,
+    ];
+    // Prepare output UTXO data
+    const outAmount = [
+        outputUTXOs[0].amount,
+        outputUTXOs[1].amount,
+    ];
+    const outPubkey = [
+        outputUTXOs[0].pubkey,
+        outputUTXOs[1].pubkey,
+    ];
+    const outBlinding = [
+        outputUTXOs[0].blinding,
+        outputUTXOs[1].blinding,
+    ];
+    // Derive nullifiers for input UTXOs
+    const inputNullifiers = [
+        deriveNullifier(inputUTXOs[0], inputUTXOs[0].pathIndex, inputUTXOs[0].privateKey),
+        deriveNullifier(inputUTXOs[1], inputUTXOs[1].pathIndex, inputUTXOs[1].privateKey),
+    ];
+    return {
+        root,
+        publicAmount,
+        extDataHash,
+        mintAddress,
+        inputNullifiers,
+        outputCommitments: [outputUTXOs[0].commitment, outputUTXOs[1].commitment],
+        inAmount,
+        inPubkey,
+        inBlinding,
+        inPathIndex,
+        inPathElements,
+        inPrivateKey,
+        outAmount,
+        outPubkey,
+        outBlinding,
+    };
+}

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

@@ -0,0 +1,70 @@
+import { PublicKey } from "@solana/web3.js";
+/**
+ * External data that gets hashed into ext_data_hash.
+ * These are public parameters that affect financial flows.
+ */
+export type ExtData = {
+    /** Who receives withdrawal (for withdrawals) */
+    recipient: PublicKey;
+    /** Who submits tx and gets fee */
+    relayer: PublicKey;
+    /** Fee to relayer in lamports/token units */
+    fee: bigint;
+    /** Refund to user in lamports/token units (for gas compensation) */
+    refund: bigint;
+    /** Claimant key committed into the proof */
+    claimant: PublicKey;
+};
+/**
+ * Transaction circuit inputs (8 public inputs, many private inputs).
+ * This structure is used to prepare inputs for the snarkjs prover.
+ */
+export type TransactionCircuitInputs = {
+    /** Merkle root of UTXO tree */
+    root: Uint8Array;
+    /** Net deposit/withdrawal amount (positive = deposit, negative = withdrawal) */
+    publicAmount: bigint;
+    /** Hash of external data (recipient, relayer, fee, refund) */
+    extDataHash: Uint8Array;
+    /** Token mint address */
+    mintAddress: PublicKey;
+    /** Nullifiers for the two input UTXOs */
+    inputNullifiers: [Uint8Array, Uint8Array];
+    /** Commitments for the two output UTXOs */
+    outputCommitments: [Uint8Array, Uint8Array];
+    inAmount: [bigint, bigint];
+    inPubkey: [bigint, bigint];
+    inBlinding: [bigint, bigint];
+    inPathIndex: [number, number];
+    inPathElements: [bigint[], bigint[]];
+    inPrivateKey: [bigint, bigint];
+    outAmount: [bigint, bigint];
+    outPubkey: [bigint, bigint];
+    outBlinding: [bigint, bigint];
+};
+/**
+ * Proof structure matching the on-chain TransactionProof struct.
+ * Total size: 256 bytes (64 + 128 + 64)
+ */
+export type TransactionProofStruct = {
+    /** G1 point A (64 bytes) */
+    proofA: number[];
+    /** G2 point B (128 bytes) */
+    proofB: number[];
+    /** G1 point C (64 bytes) */
+    proofC: number[];
+};
+/**
+ * Shape of a Groth16 proof produced by snarkjs.
+ */
+export type RawProof = {
+    pi_a: [string, string, string];
+    pi_b: [[string, string], [string, string], [string, string]];
+    pi_c: [string, string, string];
+    protocol: string;
+    curve: string;
+};
+/**
+ * Proof builder function type - takes circuit inputs and returns a raw snarkjs proof.
+ */
+export type TransactionProofBuilder = (inputs: TransactionCircuitInputs) => Promise<RawProof>;

package/dist/esm/proofs/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/prover.d.ts

@@ -1,4 +1,5 @@
-import { TransactionProofBuilder, RawProof } from "./proof.js";
+import type { TransactionProofBuilder, RawProof } from "./proofs/types.js";
+import { type SwapProofBuilder } from "./proofs/swap.js";
 /**
  * Circuit artifact paths required by snarkjs.
  *
@@ -41,6 +42,8 @@ export interface CircuitArtifacts {
  * ```
  */
 export declare function createTransactionProver(artifacts: CircuitArtifacts): TransactionProofBuilder;
+/** Create a proof builder for the current `swap.circom` witness shape. */
+export declare function createSwapProver(artifacts: CircuitArtifacts): SwapProofBuilder;
 /**
  * Verify a Groth16 proof against public signals and a verification key.
  *

package/dist/esm/prover.js

@@ -1,4 +1,5 @@
-import { formatInputsForSnarkjs, } from "./proof.js";
+import { formatInputsForSnarkjs } from "./proofs/formatting.js";
+import { formatSwapInputsForSnarkjs, } from "./proofs/swap.js";
 /** Lazy-load snarkjs — works in both CJS and ESM contexts. */
 async function loadSnarkjs() {
     try {
@@ -43,6 +44,14 @@ export function createTransactionProver(artifacts) {
         return proof;
     };
 }
+/** Create a proof builder for the current `swap.circom` witness shape. */
+export function createSwapProver(artifacts) {
+    return async (inputs) => {
+        const snarkjs = await loadSnarkjs();
+        const { proof } = await snarkjs.groth16.fullProve(formatSwapInputsForSnarkjs(inputs), artifacts.wasmPath, artifacts.zkeyPath);
+        return proof;
+    };
+}
 /**
  * Verify a Groth16 proof against public signals and a verification key.
  *

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

@@ -0,0 +1,61 @@
+import type { ChallengeResponse, CheckUsernameResponse, DeleteUserDataResponse, MerkleRootResponse, MerkleTreeResponse, PreRegisterKeyResponse, PrivateSwapRequest, PrivateSwapResponse, PrivateTransferRequest, PrivateTransferResponse, QueryNotesRequest, QueryNotesResponse, RegisterRequest, RegisterResponse, RestoreRequest, RestoreResponse, RetryPolicy, SaveEncryptedNoteRequest, SaveEncryptedNoteResponse, VeiloPublicKeyResponse, VeiloRelayerConfig, WithdrawRequest, WithdrawResponse } from "./types.js";
+/**
+ * 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 transport;
+    private readonly relayerPubKey;
+    constructor(config: VeiloRelayerConfig, retry?: Partial<RetryPolicy>);
+    /** Update the auth token (e.g. after register/restore). */
+    setAuthToken(token: string): void;
+    private encryptPayload;
+    /** 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>;
+}

package/dist/esm/relayer/client.js

@@ -0,0 +1,144 @@
+import nacl from "tweetnacl";
+import { encryptForRelayer } from "./crypto.js";
+import { fromBase64, toBase64 } from "./encoding.js";
+import { RelayerHttpTransport } from "./transport.js";
+// =============================================================================
+// Relayer Client
+// =============================================================================
+/**
+ * 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 class VeiloRelayerClient {
+    constructor(config, retry) {
+        this.transport = new RelayerHttpTransport(config, retry);
+        this.relayerPubKey = fromBase64(config.relayerPublicKey);
+    }
+    /** Update the auth token (e.g. after register/restore). */
+    setAuthToken(token) {
+        this.transport.setAuthToken(token);
+    }
+    encryptPayload(data) {
+        return encryptForRelayer({
+            ...data,
+            timestamp: Date.now(),
+            nonce: toBase64(nacl.randomBytes(32)),
+        }, this.relayerPubKey);
+    }
+    // ---------------------------------------------------------------------------
+    // Auth
+    // ---------------------------------------------------------------------------
+    /** Request a signature challenge for wallet authentication. */
+    async getChallenge(walletPublicKey) {
+        return this.transport.request("POST", "/auth/challenge", {
+            body: { walletPublicKey },
+        });
+    }
+    /** Register a new account with a signed challenge. Returns a JWT auth token. */
+    async register(data) {
+        return this.transport.request("POST", "/auth/register", { body: data });
+    }
+    /** Restore an existing account using a signed challenge. Returns a JWT auth token. */
+    async restore(data) {
+        return this.transport.request("POST", "/auth/restore", { body: data });
+    }
+    /** Check whether a username is available for registration. */
+    async checkUsername(username) {
+        return this.transport.request("GET", `/auth/checkUsername?username=${encodeURIComponent(username)}`);
+    }
+    /** Look up a user's Veilo public key by username or wallet public key. */
+    async getVeiloPublicKey(params) {
+        const query = "username" in params && params.username
+            ? `username=${encodeURIComponent(params.username)}`
+            : `publicKey=${encodeURIComponent(params.publicKey)}`;
+        return this.transport.request("GET", `/auth/veiloPublicKey?${query}`);
+    }
+    /**
+     * Provision (or retrieve) the Veilo spend key paired with a Solana address.
+     * Public and idempotent; the response contains public key material only.
+     */
+    async preRegisterKey(solanaAddress) {
+        return this.transport.request("POST", "/auth/pre-register-key", {
+            body: { solanaAddress },
+        });
+    }
+    // ---------------------------------------------------------------------------
+    // Notes
+    // ---------------------------------------------------------------------------
+    /** Save an encrypted note to the relayer's database. */
+    async saveEncryptedNote(data) {
+        return this.transport.request("POST", "/notes/save", { body: data });
+    }
+    /** Query encrypted notes for the authenticated user. Requires auth token. */
+    async queryEncryptedNotes(params = {}) {
+        return this.transport.request("POST", "/notes/query", {
+            body: params,
+            authenticated: true,
+        });
+    }
+    /** Delete all stored data for the authenticated user. Requires auth token. */
+    async deleteUserData() {
+        return this.transport.request("POST", "/notes/delete", { authenticated: true });
+    }
+    // ---------------------------------------------------------------------------
+    // Merkle
+    // ---------------------------------------------------------------------------
+    /** Fetch the current Merkle root for a pool, optionally filtered by mint and tree ID. */
+    async getMerkleRoot(mintAddress, treeId) {
+        const params = new URLSearchParams();
+        if (mintAddress)
+            params.append("mintAddress", mintAddress);
+        if (treeId !== undefined)
+            params.append("treeId", treeId.toString());
+        const qs = params.toString();
+        return this.transport.request("GET", `/merkle/root${qs ? `?${qs}` : ""}`);
+    }
+    /** Fetch the full Merkle tree (all leaves) for a pool. */
+    async getMerkleTree(mintAddress, treeId) {
+        const params = new URLSearchParams();
+        if (mintAddress)
+            params.append("mintAddress", mintAddress);
+        if (treeId !== undefined)
+            params.append("treeId", treeId.toString());
+        const qs = params.toString();
+        return this.transport.request("GET", `/merkle/tree${qs ? `?${qs}` : ""}`);
+    }
+    // ---------------------------------------------------------------------------
+    // Transact (encrypted payloads)
+    // ---------------------------------------------------------------------------
+    /** Submit an encrypted withdrawal request to the relayer. Not retried on failure. */
+    async submitWithdraw(data) {
+        const encryptedPayload = this.encryptPayload(data);
+        return this.transport.request("POST", "/transact/withdraw", {
+            body: { encryptedPayload },
+            retryable: false,
+        });
+    }
+    /** Submit an encrypted private transfer request. Not retried on failure. */
+    async submitPrivateTransfer(data) {
+        const encryptedPayload = this.encryptPayload(data);
+        return this.transport.request("POST", "/transact/private-transfer", {
+            body: { encryptedPayload },
+            retryable: false,
+        });
+    }
+    /** Submit an encrypted private swap request. Not retried on failure. */
+    async submitPrivateSwap(data) {
+        const encryptedPayload = this.encryptPayload(data);
+        return this.transport.request("POST", "/transact/private-swap", {
+            body: { encryptedPayload },
+            retryable: false,
+        });
+    }
+}