veilix-sdk 0.2.3 → 0.3.1

package/dist/{VeilixSDK-DL7hvWhB.d.ts → VeilixSDK-BLZZ5yVj.d.ts}

@@ -1,4 +1,4 @@
-import { PublicKey, Keypair, Connection, TransactionInstruction, VersionedTransaction, Transaction } from '@solana/web3.js';
+import { Connection, PublicKey, Keypair, TransactionInstruction, VersionedTransaction, Transaction } from '@solana/web3.js';
 import { Buffer as Buffer$1 } from 'buffer';
 import { MerkleTree } from 'fixed-merkle-tree';
 import { OracleJob } from '@switchboard-xyz/common';
@@ -6,6 +6,86 @@ import { Program } from '@coral-xyz/anchor';
 import { Wallet } from '@coral-xyz/anchor/dist/cjs/provider';
 import { C as CircuitPaths } from './constants-C-u6nmCv.js';
 
+type Network = "mainnet" | "devnet";
+declare const MAINNET_TOKEN_MINTS: {
+    readonly Veilix: "GAFN64LvtCBoc5BHncVn3JEJGpq42rUzQjPmvMK2UhZH";
+    readonly Bitcoin: "3NZ9JMVBmGAqocybic2c7LQCJScmgsAZ6vQqTDzcqmJh";
+    readonly Ethereum: "7vfCXTUXx5WJV5JADk17DUJ4ksgau7utNKj4b963voxs";
+    readonly USDC: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v";
+};
+type TokenSymbol = keyof typeof MAINNET_TOKEN_MINTS;
+declare const TOKEN_DECIMALS: {
+    readonly Solana: 9;
+    readonly Veilix: 9;
+    readonly Ethereum: 8;
+    readonly Bitcoin: 8;
+    readonly USDC: 6;
+};
+type TokenDecimalsSymbol = keyof typeof TOKEN_DECIMALS;
+
+type Relayer = {
+    isValid: true;
+    label: string;
+    url: string;
+    key: number;
+    value: string;
+    fee: unknown;
+    recentActivities: unknown;
+    userPubkey: unknown;
+    workers: unknown;
+    totalFeeEarningsSol: unknown;
+    totalWithdrawCount: unknown;
+    stakedAmount: unknown;
+    volume24hSol: unknown;
+    volume7dSol: unknown;
+};
+
+interface VeilixSdkInitOptions {
+    /** Wallet for Anchor provider transactions. */
+    wallet: Wallet;
+    /**
+     * Solana JSON-RPC endpoint (Node/scripts). Omit when passing {@link connection}
+     * from `@solana/wallet-adapter-react` (`useConnection()`).
+     */
+    rpcEndpoint?: string;
+    /** Existing connection (e.g. `useConnection()` in React). */
+    connection?: Connection;
+    /**
+     * Cluster override when the RPC URL does not contain `devnet` / `mainnet` hints
+     * (common with private RPC providers).
+     */
+    network: Network;
+    /**
+     * Base URL/path for withdraw circuit artifacts in the browser.
+     * Defaults to `/node_modules/<pkg>/dist/circuits/` on localhost and the
+     * pinned, SHA-256-verified jsDelivr CDN in production (domain-independent).
+     * Set this to self-host instead, e.g. `"/circuits/"` (verified, with CDN fallback)
+     * or `"https://cdn.example.com/veilix/circuits/"`.
+     */
+    circuitPathsBase?: string;
+    /** Indexer base URL override (defaults to the Veilix indexer of {@link network}). */
+    indexerUrl?: string;
+    /** Address-risk API base URL override. */
+    riskApiUrl?: string;
+}
+interface VeilixSdkRuntimeConfig {
+    rpcEndpoint: string;
+    /** Cluster inferred from {@link rpcEndpoint}. */
+    network: Network;
+    programId: string;
+    indexerUrl: string;
+    riskApiUrl: string;
+    /** Active relayers for {@link network}, loaded at SDK initialization. */
+    relayers: Relayer[];
+    connection: Connection;
+    wallet: Wallet;
+    program: Program;
+    /** Set by {@link VeilixSDK.getEncryptionKey}; required for on-chain note backup. */
+    encryptKey?: Uint8Array;
+    /** Resolved withdraw circuit wasm/zkey URLs for browser proof generation. */
+    circuitPaths?: CircuitPaths;
+}
+
 type VeilixMerkleTree = MerkleTree;
 /** Rebuild an asset tree from its leaves (commitments in index order). */
 declare function buildMerkleTree(leaves: Array<bigint | string>): VeilixMerkleTree;
@@ -97,7 +177,7 @@ declare function extDataHash(ext: ExtData): Promise<bigint>;
  * `tree` is required when spending notes; deposits only need a `root` from the
  * on-chain root history.
  */
-declare function proveTransaction({ tree, root, nextIndex, inputs, outputs, ext, circuit, }: {
+declare function proveTransaction({ tree, root, nextIndex, inputs, outputs, ext, extDataHashOverride, circuit, }: {
     tree?: VeilixMerkleTree;
     root?: bigint;
     /** Leaf index the first output will get (defaults to the tree size). */
@@ -105,6 +185,11 @@ declare function proveTransaction({ tree, root, nextIndex, inputs, outputs, ext,
     inputs?: Utxo[];
     outputs?: Utxo[];
     ext: ExtData;
+    /**
+     * Bind the proof to this hash instead of `extDataHash(ext)` (private swap). `ext`
+     * still supplies the mint, `extAmount` and the encrypted outputs.
+     */
+    extDataHashOverride?: bigint;
     circuit: CircuitArtifactPaths;
 }): Promise<ProvedTransaction>;
 
@@ -135,8 +220,14 @@ declare function parseSecretNote(note: string): ParsedNote;
  * The mint is implied by the tree the output is appended to.
  */
 declare function encryptNoteOutput(key: Uint8Array, utxo: Utxo): Uint8Array;
-/** Returns the note if `encryptedOutput` was sealed with `key`, otherwise `null`. */
-declare function decryptNoteOutput(key: Uint8Array, encryptedOutput: Uint8Array, mint: PublicKey | null, index: number): Utxo | null;
+/** `encryptedNote` of a private swap: key and blinding of the asset-B note, no amount. */
+declare function encryptSwapNoteOutput(key: Uint8Array, keypair: VeilixKeypair, blinding: bigint): Uint8Array;
+/**
+ * Returns the note if `encryptedOutput` was sealed with `key`, otherwise `null`.
+ * A swap output needs `onchainAmount` (the leaf's indexed amount); callers must
+ * still check the result against the leaf commitment.
+ */
+declare function decryptNoteOutput(key: Uint8Array, encryptedOutput: Uint8Array, mint: PublicKey | null, index: number, onchainAmount?: bigint | null): Utxo | null;
 /** Truncate each note segment for display. */
 declare function formatNoteForDisplay(note: string, segmentLen?: number): string;
 
@@ -186,6 +277,8 @@ type BuildDepositTxParams = {
     computeUnitLimit?: number;
     /** Shared, already verified circuit artifacts (see `prepareCircuitArtifacts`). */
     circuitArtifacts?: PreparedCircuitArtifacts;
+    /** Seals `onChainBackup`. Defaults to this SDK instance's key. */
+    encryptKey?: Uint8Array;
 };
 /** Body of the relayer `POST /relay` (also one item of indexer `POST /submit`). */
 type RelayPayload = {
@@ -242,6 +335,8 @@ type IndexedLeaf = {
     commitment: string;
     /** `0x`-prefixed hex (may be `"0x"` when empty). Present when requested. */
     encryptedOutput?: string;
+    /** Swap output leaves: note amount set on-chain (not inside `encryptedOutput`). */
+    amountRaw?: string;
 };
 type TreeState = {
     asset: string;
@@ -257,7 +352,7 @@ type TreeState = {
     synced: boolean;
 };
 type SpentIn = {
-    kind: "Deposit" | "Withdraw";
+    kind: "Deposit" | "Withdraw" | "Swap" | "onchain";
     signature: string;
     asset?: string;
     [key: string]: unknown;
@@ -367,86 +462,6 @@ type ScanOwnedNotesOptions = {
     includeSpent?: boolean;
 };
 
-type Network = "mainnet" | "devnet";
-declare const MAINNET_TOKEN_MINTS: {
-    readonly Veilix: "GAFN64LvtCBoc5BHncVn3JEJGpq42rUzQjPmvMK2UhZH";
-    readonly Bitcoin: "3NZ9JMVBmGAqocybic2c7LQCJScmgsAZ6vQqTDzcqmJh";
-    readonly Ethereum: "7vfCXTUXx5WJV5JADk17DUJ4ksgau7utNKj4b963voxs";
-    readonly USDC: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v";
-};
-type TokenSymbol = keyof typeof MAINNET_TOKEN_MINTS;
-declare const TOKEN_DECIMALS: {
-    readonly Solana: 9;
-    readonly Veilix: 9;
-    readonly Ethereum: 8;
-    readonly Bitcoin: 8;
-    readonly USDC: 6;
-};
-type TokenDecimalsSymbol = keyof typeof TOKEN_DECIMALS;
-
-type Relayer = {
-    isValid: true;
-    label: string;
-    url: string;
-    key: number;
-    value: string;
-    fee: unknown;
-    recentActivities: unknown;
-    userPubkey: unknown;
-    workers: unknown;
-    totalFeeEarningsSol: unknown;
-    totalWithdrawCount: unknown;
-    stakedAmount: unknown;
-    volume24hSol: unknown;
-    volume7dSol: unknown;
-};
-
-interface VeilixSdkInitOptions {
-    /** Wallet for Anchor provider transactions. */
-    wallet: Wallet;
-    /**
-     * Solana JSON-RPC endpoint (Node/scripts). Omit when passing {@link connection}
-     * from `@solana/wallet-adapter-react` (`useConnection()`).
-     */
-    rpcEndpoint?: string;
-    /** Existing connection (e.g. `useConnection()` in React). */
-    connection?: Connection;
-    /**
-     * Cluster override when the RPC URL does not contain `devnet` / `mainnet` hints
-     * (common with private RPC providers).
-     */
-    network: Network;
-    /**
-     * Base URL/path for withdraw circuit artifacts in the browser.
-     * Defaults to `/node_modules/<pkg>/dist/circuits/` on localhost and the
-     * pinned, SHA-256-verified jsDelivr CDN in production (domain-independent).
-     * Set this to self-host instead, e.g. `"/circuits/"` (verified, with CDN fallback)
-     * or `"https://cdn.example.com/veilix/circuits/"`.
-     */
-    circuitPathsBase?: string;
-    /** Indexer base URL override (defaults to the Veilix indexer of {@link network}). */
-    indexerUrl?: string;
-    /** Address-risk API base URL override. */
-    riskApiUrl?: string;
-}
-interface VeilixSdkRuntimeConfig {
-    rpcEndpoint: string;
-    /** Cluster inferred from {@link rpcEndpoint}. */
-    network: Network;
-    programId: string;
-    indexerUrl: string;
-    riskApiUrl: string;
-    /** Active relayers for {@link network}, loaded at SDK initialization. */
-    relayers: Relayer[];
-    connection: Connection;
-    wallet: Wallet;
-    program: Program;
-    /** Set by {@link VeilixSDK.getEncryptionKey}; required for on-chain note backup. */
-    encryptKey?: Uint8Array;
-    /** Resolved withdraw circuit wasm/zkey URLs for browser proof generation. */
-    circuitPaths?: CircuitPaths;
-}
-
 type WithdrawParams = {
     /** Secret note to spend. */
     note: string;
@@ -554,6 +569,106 @@ type GetQuoteParams = {
 /** Fetch a withdraw quote (relayer + platform fees) from the indexer. */
 declare function getQuote(params: GetQuoteParams): Promise<GetQuoteResponse>;
 
+type MintInput = PublicKey | string | null | undefined;
+type SwapQuote = {
+    /** Tree mints, `null` for SOL. */
+    mintIn: string | null;
+    mintOut: string | null;
+    /** Base units of `mintIn` spent from the note (fee included). */
+    amountIn: string;
+    /** Relayer + platform fee, taken from `amountIn` in asset A. */
+    fee: string;
+    /** `amountIn - fee`, sold on the DEX. */
+    swapIn: string;
+    /** Expected output in base units of `mintOut`, computed by the SDK from the pool on-chain. */
+    amountOut: string;
+    /** Output lost to the trade size versus the pool's spot price (0..1). */
+    priceImpact: number;
+    dexProgram: string;
+    pool: string;
+    dexFeePercent: number;
+    /** Relayer reward account the quote is for. */
+    relayer: string;
+    relayerUrl: string;
+};
+type GetSwapQuoteParams = {
+    mintIn: MintInput;
+    mintOut: MintInput;
+    /** Base units of `mintIn` to spend (fee included). */
+    amountIn: bigint | number | string;
+    relayerUrl?: string;
+};
+type SwapParams = {
+    /** Secret note of asset A to spend. */
+    note: string;
+    /** Asset B tree mint (`null` / omitted for SOL). */
+    mintOut?: MintInput;
+    /** Base units of asset A to swap, fee included. Defaults to the full note. */
+    amount?: bigint | number | string;
+    /** Max price movement accepted, in basis points (default 100 = 1%). */
+    slippageBps?: number;
+    relayerUrl?: string;
+};
+type SwapRelayPayload = {
+    proof: string;
+    root: string;
+    inputNullifiers: [string, string];
+    outputCommitments: [string, string];
+    mintIn?: string;
+    mintOut?: string;
+    amountIn: string;
+    fee: string;
+    minAmountOut: string;
+    outPubkey: string;
+    outBlinding: string;
+    relayer: string;
+    encryptedOutput1: string;
+    encryptedOutput2: string;
+    encryptedNote: string;
+};
+type SwapRelayBundle = {
+    payload: SwapRelayPayload;
+    relayerUrl: string;
+    quote: SwapQuote;
+    amountIn: bigint;
+    fee: bigint;
+    minAmountOut: bigint;
+    /** Change of asset A (save it like any other note). */
+    changeNote: string | null;
+    /**
+     * Secret of the asset-B note, needed to spend it. The amount is only known once the
+     * swap lands; with an encryption key the note is also recoverable by scanning.
+     */
+    output: {
+        mint: string | null;
+        privKey: string;
+        blinding: string;
+    };
+    nullifiers: string[];
+};
+type BuildSwapPayloadOptions = {
+    circuitArtifacts?: PreparedCircuitArtifacts;
+    tree?: VeilixMerkleTree;
+};
+type SwapResult = {
+    txHash: string;
+    status: "success" | "failed";
+    error?: string;
+    /** The asset-B note. Save it: it is the only way to spend the swapped funds. */
+    outputNote: string | null;
+    changeNote: string | null;
+    amountIn: string;
+    fee: string;
+    amountOut: string | null;
+    minAmountOut: string;
+};
+/** Note of the asset-B side once the swap has landed. Checks it against the chain. */
+declare function swapOutputNote(output: SwapRelayBundle["output"], result: {
+    amountOut: string;
+    outputIndex: number;
+    outputCommitment: string;
+}): string;
+
 type ResolvedNoteAsset = {
     key: string;
     tokenName: TokenDecimalsSymbol;
@@ -642,7 +757,7 @@ declare class VeilixSDK {
     getRiskApiUrl(): string;
     getTokenMints(): {
         Solana: string;
-        Veilix: "GAFN64LvtCBoc5BHncVn3JEJGpq42rUzQjPmvMK2UhZH";
+        Veilix: "GAFN64LvtCBoc5BHncVn3JEJGpq42rUzQjPmvMK2UhZH" | "Gmo636w21RBZX9ySVtPYcuYP6f1E5bdW5eBYhvK1bc8J";
         Bitcoin: "" | "3NZ9JMVBmGAqocybic2c7LQCJScmgsAZ6vQqTDzcqmJh";
         Ethereum: "" | "7vfCXTUXx5WJV5JADk17DUJ4ksgau7utNKj4b963voxs";
         USDC: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" | "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU";
@@ -691,6 +806,20 @@ declare class VeilixSDK {
     /** Prove a withdrawal without submitting it (see {@link submitWithdrawPayload}). */
     buildWithdrawPayload(params: WithdrawParams, options?: BuildWithdrawPayloadOptions): Promise<WithdrawRelayBundle>;
     submitWithdrawPayload(bundle: WithdrawRelayBundle): Promise<WithdrawResult>;
+    /** Fee and expected output of swapping `amountIn` of `mintIn` into `mintOut`. */
+    getSwapQuote(params: GetSwapQuoteParams): Promise<{
+        quote: SwapQuote;
+        relayer: Relayer;
+    }>;
+    /**
+     * Swap a note of asset A into a new shielded note of asset B (`mintOut`, `null` for
+     * SOL) through a relayer and an allowlisted DEX. Funds never leave the pool
+     * unshielded. Returns the asset-B note and any asset-A change note.
+     */
+    swap(params: SwapParams): Promise<SwapResult>;
+    /** Prove a swap without submitting it (see {@link submitSwapPayload}). */
+    buildSwapPayload(params: SwapParams, options?: BuildSwapPayloadOptions): Promise<SwapRelayBundle>;
+    submitSwapPayload(bundle: SwapRelayBundle): Promise<SwapResult>;
     /**
      * Private transfer: deposit one note per item, then withdraw each note in full
      * to its recipient through the indexer submission queue.
@@ -778,4 +907,4 @@ declare class VeilixSDK {
     static getProgramIdForNetwork(network: Network): string;
 }
 
-export { decodeNote as $, VeilixSDK as A, type BuildDepositTxParams as B, type CommitmentStatus as C, type VeilixSdkInitOptions as D, type EncryptKeyWallet as E, type FetchWalletBalanceOptions as F, type GenerateDepositParamsResult as G, type VeilixSdkRuntimeConfig as H, type IndexedLeaf as I, type VeilixTransferDepositFailure as J, type VeilixTransferItem as K, type VeilixTransferOptions as L, type VeilixTransferResult as M, NOTE_PREFIX as N, type VeilixTransferWithdrawFailure as O, type ParsedNote as P, type Quote as Q, type RelayPayload as R, type ScanOwnedNotesOptions as S, type TokenDecimalsSymbol as T, Utxo as U, VeilixKeypair as V, type WithdrawParams as W, type WithdrawRelayBundle as X, type WithdrawResult as Y, type WithdrawStatus as Z, buildMerkleTree as _, type BuildRelayPayloadParams as a, decryptData as a0, decryptNoteOutput as a1, encodeNote as a2, encryptData as a3, encryptNoteOutput as a4, extDataHash as a5, formatNoteForDisplay as a6, getQuote as a7, isLegacyNote as a8, mintToField as a9, parseSecretNote as aa, prepareCircuitArtifacts as ab, proveTransaction as ac, type BuildWithdrawPayloadOptions as b, type ExtData as c, type GetQuoteParams as d, type GetQuoteResponse as e, type IndexerAsset as f, type Network as g, type NoteStatus as h, type NullifierStatus as i, type PlatformFeeWallet as j, type PoolTransaction as k, type PreparedCircuitArtifacts as l, type ProvedTransaction as m, type QuoteRelayer as n, type QuoteTransaction as o, type Relayer as p, type RelayerJob as q, type ResolvedNoteAsset as r, type Submission as s, type SubmissionItem as t, type TokenSymbol as u, type TransactionProof as v, type TreeAccountState as w, type TreeState as x, type TxStatus as y, type VeilixMerkleTree as z };
+export { type VeilixTransferResult as $, type SwapResult as A, type BuildDepositTxParams as B, type CommitmentStatus as C, type TokenSymbol as D, type EncryptKeyWallet as E, type FetchWalletBalanceOptions as F, type GenerateDepositParamsResult as G, type TransactionProof as H, type IndexedLeaf as I, type TreeAccountState as J, type TreeState as K, type TxStatus as L, type VeilixMerkleTree as M, type Network as N, VeilixSDK as O, type ParsedNote as P, type Quote as Q, type RelayPayload as R, type ScanOwnedNotesOptions as S, type TokenDecimalsSymbol as T, Utxo as U, VeilixKeypair as V, type VeilixSdkInitOptions as W, type VeilixSdkRuntimeConfig as X, type VeilixTransferDepositFailure as Y, type VeilixTransferItem as Z, type VeilixTransferOptions as _, type BuildRelayPayloadParams as a, type VeilixTransferWithdrawFailure as a0, type WithdrawParams as a1, type WithdrawRelayBundle as a2, type WithdrawResult as a3, type WithdrawStatus as a4, buildMerkleTree as a5, decodeNote as a6, decryptData as a7, decryptNoteOutput as a8, encodeNote as a9, encryptData as aa, encryptNoteOutput as ab, encryptSwapNoteOutput as ac, extDataHash as ad, formatNoteForDisplay as ae, getQuote as af, isLegacyNote as ag, mintToField as ah, parseSecretNote as ai, prepareCircuitArtifacts as aj, proveTransaction as ak, swapOutputNote as al, type BuildSwapPayloadOptions as b, type BuildWithdrawPayloadOptions as c, type ExtData as d, type GetQuoteParams as e, type GetQuoteResponse as f, type GetSwapQuoteParams as g, type IndexerAsset as h, NOTE_PREFIX as i, type NoteStatus as j, type NullifierStatus as k, type PlatformFeeWallet as l, type PoolTransaction as m, type PreparedCircuitArtifacts as n, type ProvedTransaction as o, type QuoteRelayer as p, type QuoteTransaction as q, type Relayer as r, type RelayerJob as s, type ResolvedNoteAsset as t, type Submission as u, type SubmissionItem as v, type SwapParams as w, type SwapQuote as x, type SwapRelayBundle as y, type SwapRelayPayload as z };