n3-sdk 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -2,24 +2,20 @@ import * as viem from 'viem';
 import { PublicClient, WalletClient, Account } from 'viem';
 
 type N3Env = {
-    /** GraphQL HTTP endpoint, e.g. https://api.example.com/graphql */
+    /** GraphQL HTTP endpoint (for info/state). */
     gqlUrl: string;
-    /** WS endpoint, e.g. wss://api.example.com/ws */
+    /** WebSocket endpoint (for live fanout). */
     wsUrl: string;
-    /** Hex ed25519 public key used by the gateway allowlist (lower/upper, 0x ok) */
-    pubkeyHex?: string;
-    /** Optional signer for nonces; if omitted, provide secretKey instead. */
-    signer?: (msg: Uint8Array) => Promise<Uint8Array>;
-    /** Optional ed25519 secret key (32 or 64 bytes). */
-    secretKey?: Uint8Array;
-    /** Custom fetch (Node <18 or special envs). Defaults to global fetch. */
-    fetchFn?: typeof fetch;
-    /** Optional nonce factory; defaults to ISO timestamp with random suffix. */
-    makeNonce?: () => string;
-    /** OPTIONAL OVERRIDES (if you don’t use default /exchange and /info): */
-    baseUrl?: string;
-    exchangePath?: string;
-    infoPath?: string;
+    /** Private pool contract on your chain. */
+    pool: `0x${string}`;
+    /** Domain params used by your circuits. */
+    chainIdDec: number;
+    domainDec: number;
+    /** Indexer + (optional) proof server. */
+    indexerUrl: string;
+    proofUrl?: string;
+    rpcUrl?: string;
+    treeDepth?: number;
 };
 
 /** GraphQL types aligned with your gateway schema */
@@ -560,7 +556,29 @@ declare class NoteStore {
     private withTxn;
 }
 
-declare function submitOrder(params: SubmitOrderIntentParams): Promise<string | null>;
+/** Optional extra behavior for order publishing */
+type SubmitOrderOptions = {
+    /**
+     * If true, the SDK will:
+     *  - pin the head/root from the indexer
+     *  - recompute each note commit
+     *  - fetch Merkle proofs
+     *  - fold back to root (sanity)
+     *  - attach `pathElements` / `pathIndex` to spendNotes
+     *
+     * Defaults to false (for backwards compat).
+     */
+    attachProofs?: boolean;
+};
+/**
+ * Core order publisher.
+ * If `opts.attachProofs` is true, will enrich spendNotes with Merkle membership proofs.
+ */
+declare function submitOrder(params: SubmitOrderIntentParams, opts?: SubmitOrderOptions): Promise<string | null>;
+/**
+ * Convenience: build spend notes from a NoteStore (with optional partials), then publish.
+ * If `opts.attachProofs` is true, will enrich the *selected* spend notes with proofs.
+ */
 declare function submitOrderAuto(params: SubmitOrderIntentParams & {
     store: NoteStore;
     spend: {
@@ -568,7 +586,7 @@ declare function submitOrderAuto(params: SubmitOrderIntentParams & {
         amount: bigint;
     };
     allowPartial?: boolean;
-}): Promise<string | null>;
+}, opts?: SubmitOrderOptions): Promise<string | null>;
 
 type WDOut = {
     assetId: bigint;
@@ -655,6 +673,7 @@ type index_CancelTarget = CancelTarget;
 type index_ModifyOrder = ModifyOrder;
 type index_ModifyOrderIntentParams = ModifyOrderIntentParams;
 type index_ModifyTarget = ModifyTarget;
+type index_SubmitOrderOptions = SubmitOrderOptions;
 declare const index_batchCancel: typeof batchCancel;
 declare const index_batchModify: typeof batchModify;
 declare const index_batchOrders: typeof batchOrders;
@@ -667,7 +686,7 @@ declare const index_submitOrderAuto: typeof submitOrderAuto;
 declare const index_withdraw: typeof withdraw;
 declare const index_withdrawAuto: typeof withdrawAuto;
 declare namespace index {
-  export { type index_BatchCancelOrderIntentParams as BatchCancelOrderIntentParams, type index_BatchModifyItem as BatchModifyItem, type index_BatchModifyOrderIntentParams as BatchModifyOrderIntentParams, type index_CancelOrderIntentParams as CancelOrderIntentParams, type index_CancelTarget as CancelTarget, type index_ModifyOrder as ModifyOrder, type index_ModifyOrderIntentParams as ModifyOrderIntentParams, type index_ModifyTarget as ModifyTarget, index_batchCancel as batchCancel, index_batchModify as batchModify, index_batchOrders as batchOrders, index_cancel as cancel, index_depositERC20 as depositERC20, index_depositHYPE as depositHYPE, index_modify as modify, index_submitOrder as submitOrder, index_submitOrderAuto as submitOrderAuto, index_withdraw as withdraw, index_withdrawAuto as withdrawAuto };
+  export { type index_BatchCancelOrderIntentParams as BatchCancelOrderIntentParams, type index_BatchModifyItem as BatchModifyItem, type index_BatchModifyOrderIntentParams as BatchModifyOrderIntentParams, type index_CancelOrderIntentParams as CancelOrderIntentParams, type index_CancelTarget as CancelTarget, type index_ModifyOrder as ModifyOrder, type index_ModifyOrderIntentParams as ModifyOrderIntentParams, type index_ModifyTarget as ModifyTarget, type index_SubmitOrderOptions as SubmitOrderOptions, index_batchCancel as batchCancel, index_batchModify as batchModify, index_batchOrders as batchOrders, index_cancel as cancel, index_depositERC20 as depositERC20, index_depositHYPE as depositHYPE, index_modify as modify, index_submitOrder as submitOrder, index_submitOrderAuto as submitOrderAuto, index_withdraw as withdraw, index_withdrawAuto as withdrawAuto };
 }
 
 type Chain = {
@@ -718,18 +737,30 @@ type SubsAPI = {
     trades: ReturnType<typeof makeTrades>;
     batches: ReturnType<typeof makeBatches>;
 };
+/**
+ * Exchange facade: we pre-bind env and auto-inject default clients if caller
+ * doesn't pass them. Callers can still override by passing { clients }.
+ */
 type ExAPI = {
-    order: typeof submitOrder;
-    orderAuto: typeof submitOrderAuto;
+    order: (p: Parameters<typeof submitOrder>[0]) => ReturnType<typeof submitOrder>;
+    orderAuto: (p: Parameters<typeof submitOrderAuto>[0]) => ReturnType<typeof submitOrderAuto>;
     modify: typeof modify;
     cancel: typeof cancel;
     batchOrder: typeof batchOrders;
     batchModify: typeof batchModify;
     batchCancel: typeof batchCancel;
-    withdraw: typeof withdraw;
-    withdrawAuto: typeof withdrawAuto;
-    depositHYPE: typeof depositHYPE;
-    depositERC20: typeof depositERC20;
+    withdraw: (p: Parameters<typeof withdraw>[0] & {
+        clients?: N3Clients;
+    }) => ReturnType<typeof withdraw>;
+    withdrawAuto: (p: Parameters<typeof withdrawAuto>[0] & {
+        clients?: N3Clients;
+    }) => ReturnType<typeof withdrawAuto>;
+    depositHYPE: (p: Parameters<typeof depositHYPE>[0] & {
+        clients?: N3Clients;
+    }) => ReturnType<typeof depositHYPE>;
+    depositERC20: (p: Parameters<typeof depositERC20>[0] & {
+        clients?: N3Clients;
+    }) => ReturnType<typeof depositERC20>;
 };
 declare class N3SDK {
     readonly env: N3Env;
@@ -737,10 +768,26 @@ declare class N3SDK {
     readonly info: InfoAPI;
     /** WebSocket fanout (live streams) */
     readonly subscriptions: SubsAPI;
-    /** Hyperliquid-aligned exchange actions */
+    /** Exchange actions (env-bound; auto inject default clients if missing) */
     readonly exchange: ExAPI;
-    constructor(env: N3Env);
-    startReceiverSync(store: NoteStore, clients: N3Clients, fromBlock?: number | bigint): () => void;
+    /** Optional default clients (set at construction or via setter). */
+    private _defaultClients;
+    /** Optional server-only public client if env.rpcUrl is provided. */
+    private _serverPublicClient;
+    constructor(env: N3Env, opts?: {
+        defaultClients?: N3Clients | null;
+    });
+    /** Prefer this instead of touching private fields. */
+    setDefaultClients(c: N3Clients | null): void;
+    /** Retrieve default clients (throws if not set). */
+    getClientsOrThrow(): N3Clients;
+    /**
+     * Optional: start background receiver sync (Merkle confirmations & NF tracking).
+     * If `clients` not passed, it will try server public client from `env.rpcUrl`,
+     * but you should usually pass a full N3Clients bundle (with account/wallet)
+     * when you also need to mark nullifiers, etc.
+     */
+    startReceiverSync(store: NoteStore, clients?: N3Clients, fromBlock?: number | bigint): () => void;
 }
 
 export { type AssetId, index as Exchange, index$2 as Info, type N3Clients, type N3Env, N3SDK, NoteStore, NoteStore as NoteStoreT, Receiver, index$1 as Subscription, type TopicName, Topics, N3SDK as default, toReceiverFromBlock, toViemFromBlock };