arc-sdk-test 0.0.1 → 0.0.3

package/dist/ArcaneSDK-dPZCBtDG.d.cts

@@ -0,0 +1,360 @@
+import { PublicKey, Keypair, Connection, TransactionInstruction, Transaction } from '@solana/web3.js';
+import { OracleJob } from '@switchboard-xyz/common';
+import { Program } from '@coral-xyz/anchor';
+import { Wallet } from '@coral-xyz/anchor/dist/cjs/provider';
+
+type IndexerAsset = string | {
+    mint?: string;
+    asset?: string;
+} | null;
+
+/** Frontend wallet adapter or backend {@link Keypair}. */
+type EncryptKeyWallet = Keypair | {
+    signMessage: (message: Uint8Array) => Promise<Uint8Array> | Uint8Array;
+};
+type BuildDepositTxParams = {
+    senderPublicKey: PublicKey | string;
+    /** Supported token mint address for the active cluster (native SOL or SPL mint). */
+    tokenMint: PublicKey | string;
+    depositAmount: number | string;
+    onChainBackup?: boolean;
+    computeUnitPrice?: number;
+};
+type FetchWalletBalanceOptions = {
+    includeDeposits?: boolean;
+    indexerAsset?: IndexerAsset;
+};
+type BuildRelayPayloadParams = {
+    args: unknown[];
+    proofHex: string;
+    denomination: number | bigint | string;
+    withdrawAddress: unknown;
+    relayerPubkey: unknown;
+    mint?: unknown;
+};
+type RelayPayload = Record<string, unknown>;
+
+type DepositParams = {
+    nullifier: string;
+    secret: string;
+    amount: string;
+    commitment: string;
+    nullifierHash: string;
+    mint: string | null;
+};
+type GenerateDepositParamsResult = {
+    params: DepositParams;
+    note: string;
+};
+type GenerateWithdrawProofOptions = {
+    /** Override WASM path/URL (required when the SDK is bundled for the browser). */
+    circuitWasmPath?: string;
+    /** Override zkey path/URL (required when the SDK is bundled for the browser). */
+    circuitZkeyPath?: string;
+};
+
+type Network = "mainnet" | "devnet";
+declare const MAINNET_TOKEN_MINTS: {
+    readonly Arcane: "3jSL5nnnYcRLmTqFmwvY1Mikh42fQsT7p7NvXPYzanon";
+    readonly Bitcoin: "3NZ9JMVBmGAqocybic2c7LQCJScmgsAZ6vQqTDzcqmJh";
+    readonly Ethereum: "7vfCXTUXx5WJV5JADk17DUJ4ksgau7utNKj4b963voxs";
+    readonly USDC: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v";
+};
+type TokenSymbol = keyof typeof MAINNET_TOKEN_MINTS;
+declare const TOKEN_DECIMALS: {
+    readonly Solana: 9;
+    readonly Arcane: 9;
+    readonly Ethereum: 8;
+    readonly Bitcoin: 8;
+    readonly USDC: 6;
+};
+type TokenDecimalsSymbol = keyof typeof TOKEN_DECIMALS;
+/** Supported deposit denominations per token (same on mainnet and devnet). */
+declare const DEPOSIT_AMOUNTS: {
+    readonly Solana: readonly [0.1, 1, 5, 10, 50, 100, 500];
+    readonly Arcane: readonly [1, 10, 50, 100, 500, 1000, 10000, 100000, 1000000];
+    readonly Bitcoin: readonly [0.01, 0.05, 0.1, 0.5, 1, 5];
+    readonly Ethereum: readonly [0.1, 1, 10, 50, 100, 500];
+    readonly USDC: readonly [1, 10, 50, 100, 1000, 10000, 100000, 1000000];
+};
+type DepositTokenSymbol = keyof typeof DEPOSIT_AMOUNTS;
+
+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 ArcaneSdkInitOptions {
+    /** Range API key (frontend: VITE_RANGE_API_KEY). */
+    rangeApiKey: string;
+    /** 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;
+}
+interface ArcaneSdkRuntimeConfig {
+    rangeApiKey: string;
+    rpcEndpoint: string;
+    /** Cluster inferred from {@link rpcEndpoint}. */
+    network: Network;
+    programId: string;
+    /** Active relayers for {@link network}, loaded at SDK initialization. */
+    relayers: Relayer[];
+    connection: Connection;
+    wallet: Wallet;
+    program: Program;
+    /** Set by {@link ArcaneSDK.getEncryptionKey}; required for on-chain note backup. */
+    encryptKey?: Uint8Array;
+}
+
+/** Withdraw circuit artifact filenames (published under `arc-sdk-test/circuits/`). */
+declare const WITHDRAW_CIRCUIT_WASM = "withdraw.wasm";
+declare const WITHDRAW_CIRCUIT_ZKEY = "withdraw.zkey";
+type CircuitPaths = {
+    wasm: string;
+    zkey: string;
+};
+
+type WithdrawParams = {
+    /** Secret note from the original deposit. */
+    note: string;
+    /** Withdrawal recipient public key. */
+    recipient: PublicKey | string;
+};
+type WithdrawResult = {
+    txHash: string;
+    jobId: string;
+    relayer: Relayer;
+};
+
+type QuoteRelayer = {
+    url: string;
+    [key: string]: unknown;
+};
+type QuoteTransaction = Record<string, unknown>;
+type QuoteSplit = {
+    denomination: number;
+    totalRelayerFee: number;
+    relayer: QuoteRelayer;
+    transaction: QuoteTransaction;
+};
+type Quote = {
+    amount: number;
+    transactionCount: number;
+    recipientAmount: number;
+    totalRelayerFee: number;
+    etaSeconds: number;
+    splits: QuoteSplit[];
+    platformFee?: number;
+};
+type GetQuoteResponse = {
+    success: boolean;
+    quote: Quote;
+};
+type GetQuoteParams = {
+    amount: number | string;
+    amountLamports: number | string | bigint;
+    recipient: PublicKey | string;
+    /** Indexer asset label (default `SOL`). */
+    asset?: string;
+    /** Cluster for the quote (default active SDK network). */
+    network?: Network;
+};
+/** Fetch a withdraw quote from the indexer. Requires SDK init or an active instance context. */
+declare function getQuote(params: GetQuoteParams): Promise<GetQuoteResponse>;
+
+type ResolvedNoteAsset = {
+    key: string;
+    tokenName: TokenDecimalsSymbol;
+    unit: string;
+    multiplier: bigint;
+    mint: string | null;
+    poolAmounts: readonly number[];
+    decimals: number;
+};
+
+type ArcaneTransferItem = {
+    mint: PublicKey;
+    /** Human-readable token amount (e.g. `"1.5"` SOL). */
+    amount: string;
+    recipient: PublicKey;
+};
+type ArcaneTransferDepositFailure = {
+    amount: string;
+    mint: string;
+    recipient: string;
+};
+type ArcaneTransferWithdrawFailure = {
+    note: string;
+    recipient: string;
+};
+type ArcaneTransferResult = {
+    error: boolean;
+    depositFailed: ArcaneTransferDepositFailure[];
+    withdrawFailed: ArcaneTransferWithdrawFailure[];
+};
+
+/**
+ * Arcane SDK client. Create one instance per configuration (network, RPC, API keys).
+ *
+ * @example
+ * ```js
+ * const { ArcaneSDK } = require('arc-sdk-test');
+ * const sdk = await ArcaneSDK.create({
+ *   rangeApiKey: process.env.RANGE_API_KEY,
+ *   rpcEndpoint: 'https://api.devnet.solana.com',
+ *   wallet,
+ * });
+ * console.log(sdk.config.relayers);
+ * ```
+ *
+ * @example React (wallet-adapter)
+ * ```tsx
+ * import { useArcaneSdk } from 'arc-sdk-test/react';
+ *
+ * function MyComponent() {
+ *   const sdk = useArcaneSdk({ rangeApiKey: import.meta.env.VITE_RANGE_API_KEY });
+ *   if (!sdk) return null;
+ *   // ...
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { ArcaneSDK } from 'arc-sdk-test';
+ * const sdk = await ArcaneSDK.create({ rangeApiKey, rpcEndpoint, wallet });
+ * await sdk.getEncryptionKey(wallet);
+ * await sdk.buildDepositTx({ senderPublicKey: wallet.publicKey, tokenMint: NATIVE_MINT, depositAmount: 1, onChainBackup: true });
+ * ```
+ */
+declare class ArcaneSDK {
+    static readonly VERSION = "0.0.1";
+    readonly config: ArcaneSdkRuntimeConfig;
+    private constructor();
+    /** Create an SDK instance (loads relayers for the inferred network). */
+    static create(options: ArcaneSdkInitOptions): Promise<ArcaneSDK>;
+    private run;
+    private runAsync;
+    getConfig(): ArcaneSdkRuntimeConfig;
+    getRangeApiKey(): string;
+    getRpcEndpoint(): string;
+    getNetwork(): Network;
+    getProgramIdString(): string;
+    /** Encryption key derived by {@link getEncryptionKey}; undefined until set. */
+    get encryptKey(): Uint8Array | undefined;
+    /** Relayers loaded at initialization; use {@link fetchRelayers} to refresh. */
+    get relayers(): Relayer[];
+    getIndexerUrl(): string;
+    getRiskApiUrl(): string;
+    getTokenMints(): {
+        Solana: string;
+        Arcane: "3jSL5nnnYcRLmTqFmwvY1Mikh42fQsT7p7NvXPYzanon" | "ARCxcL6oX2pd4bKmUxhdoARaaHdKU6TJrTTthPANPQtQ";
+        Bitcoin: "" | "3NZ9JMVBmGAqocybic2c7LQCJScmgsAZ6vQqTDzcqmJh";
+        Ethereum: "" | "7vfCXTUXx5WJV5JADk17DUJ4ksgau7utNKj4b963voxs";
+        USDC: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" | "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU";
+    };
+    getArcaneTokenMint(): string;
+    getTokenMint(symbol: TokenSymbol): string;
+    getDepositAmounts(symbol: DepositTokenSymbol): readonly number[];
+    getTokenDecimals(symbol: TokenDecimalsSymbol): number;
+    resolveCircuitPaths(base?: string): CircuitPaths;
+    getRangeRiskScoreJob(address: string): OracleJob;
+    getOracleQuote(payer: Keypair | PublicKey, addressToCheck: string): Promise<{
+        queueAccount: PublicKey;
+        sigVerifyIx: TransactionInstruction;
+    }>;
+    getProgramId(): PublicKey;
+    getPoolPDA(denominationLamports: number | bigint): [PublicKey, number];
+    getTokenPoolPDA(mint: PublicKey | string, denominationSmallestUnits: number | bigint): [PublicKey, number];
+    getTreasuryPDA(): [PublicKey, number];
+    getCommitmentPDA(commitmentBigInt: bigint | number | string): [PublicKey, number];
+    getNullifierPDA(nullifierHashBigInt: bigint | number | string): [PublicKey, number];
+    getNetworkStatePDA(): [PublicKey, number];
+    buildDepositTx(params: BuildDepositTxParams): Promise<{
+        tx: Transaction;
+        note: string;
+    }>;
+    /**
+     * Withdraw to `recipient` using a secret `note`.
+     * Relayer is chosen at random from {@link config.relayers}.
+     */
+    withdraw(params: WithdrawParams): Promise<WithdrawResult>;
+    /**
+     * Private transfer: deposit into the pool (split by supported denominations),
+     * then withdraw each successful note to the recipient.
+     *
+     * Requires {@link getEncryptionKey} before calling (deposits use on-chain backup).
+     */
+    arcaneTransfer(items: ArcaneTransferItem[]): Promise<ArcaneTransferResult>;
+    /** Validate a withdraw recipient against the risk API. */
+    assertWithdrawRecipientAllowed(address: string): Promise<void>;
+    /** Resolve the token asset encoded in a secret note. */
+    resolveNoteAsset(amount: string, mint?: string | null, tokenNameHint?: TokenDecimalsSymbol): ResolvedNoteAsset;
+    fetchPlatformFee(): Promise<string>;
+    /** Fetch a withdraw quote from the indexer. */
+    getQuote(params: GetQuoteParams): Promise<GetQuoteResponse>;
+    fetchCommitments(denomination: number | bigint | string, indexerAsset?: IndexerAsset): Promise<unknown>;
+    validateNullifier(nullifierHash: string, indexerAsset?: IndexerAsset): Promise<unknown>;
+    fetchTxStatus(commitmentHex: string, nullifierHashHex: string, indexerAsset?: IndexerAsset): Promise<unknown>;
+    fetchDepositCountByCommitment(commitment: string, denomination: number | bigint | string, indexerAsset?: IndexerAsset): Promise<unknown>;
+    fetchWalletBalance(wallet: string, options?: FetchWalletBalanceOptions): Promise<unknown>;
+    /** Re-fetch relayers from the indexer and update {@link config.relayers}. */
+    fetchRelayers(): Promise<Relayer[]>;
+    fetchLatestTransactions(type?: string, indexerAsset?: IndexerAsset): Promise<unknown>;
+    fetchTxCounts(type?: string, indexerAsset?: IndexerAsset): Promise<unknown>;
+    normalizePubkeyString(value: unknown): string;
+    buildRelayPayload(params: BuildRelayPayloadParams): RelayPayload;
+    submitToRelayer(relayerUrl: string, payload: RelayPayload): Promise<unknown>;
+    pollRelayerJob(relayerUrl: string, jobId: string, maxWaitMs?: number): Promise<unknown>;
+    /**
+     * Derives the note encryption key from a wallet signature and stores it on
+     * {@link config.encryptKey}. Required before {@link buildDepositTx} with
+     * `onChainBackup: true`.
+     *
+     * Accepts a frontend wallet adapter (`signMessage`) or a backend {@link Keypair}.
+     */
+    getEncryptionKey(wallet: EncryptKeyWallet): Promise<Uint8Array>;
+    encryptData(key: Uint8Array, plaintext: string): Uint8Array<ArrayBufferLike>;
+    decryptData(key: Uint8Array, combined: Uint8Array): string;
+    generateRandomFieldElement(): bigint;
+    createCommitment(nullifier: bigint | number | string, secret: bigint | number | string): bigint;
+    createNullifierHash(nullifier: bigint | number | string): bigint;
+    generateDepositParams(amountLamports: bigint | number | string, mint?: string | null): GenerateDepositParamsResult;
+    parseSecretNote(note: string): Record<string, string>;
+    publicKeyToFieldElement(publicKeyBytes: Uint8Array | number[]): bigint;
+    amountToFieldElement(amount: bigint | number | string): bigint;
+    generateMerkleProof(depositParams: Record<string, unknown>, leaves: unknown[]): unknown;
+    generateWithdrawProof(depositParams: Record<string, unknown>, leaves: unknown[], recipient: PublicKey | string, relayer: PublicKey | string, fee: bigint | number | string, refund: bigint | number | string, options?: GenerateWithdrawProofOptions): Promise<unknown>;
+    convertProofToBytes(proof: unknown): Promise<number[] | Uint8Array<ArrayBufferLike>>;
+    to32ByteBuffer(bigInt: bigint | number | string): Uint8Array<ArrayBufferLike>;
+    toFixedHex(value: bigint | number | string, length?: number): string;
+    toFieldElementHex(value: bigint | number | string): string;
+    formatNoteForDisplay(note: string, segmentLen?: number): string;
+    appendIndexerAsset(params: URLSearchParams, indexerAsset?: IndexerAsset): void;
+    /** Program ID for a cluster without an SDK instance. */
+    static getProgramIdForNetwork(network: Network): string;
+}
+
+export { ArcaneSDK as A, type BuildDepositTxParams as B, type CircuitPaths as C, type DepositTokenSymbol as D, type EncryptKeyWallet as E, type FetchWalletBalanceOptions as F, type GenerateDepositParamsResult as G, type IndexerAsset as I, type Network as N, type Quote as Q, type RelayPayload as R, type TokenDecimalsSymbol as T, WITHDRAW_CIRCUIT_WASM as W, type ArcaneSdkInitOptions as a, type ArcaneSdkRuntimeConfig as b, type ArcaneTransferDepositFailure as c, type ArcaneTransferItem as d, type ArcaneTransferResult as e, type ArcaneTransferWithdrawFailure as f, type BuildRelayPayloadParams as g, type GenerateWithdrawProofOptions as h, type GetQuoteParams as i, type GetQuoteResponse as j, type QuoteRelayer as k, type QuoteSplit as l, type QuoteTransaction as m, type Relayer as n, type ResolvedNoteAsset as o, type TokenSymbol as p, WITHDRAW_CIRCUIT_ZKEY as q, type WithdrawParams as r, type WithdrawResult as s, getQuote as t };