bulk-keychain-wasm 0.1.0 → 0.1.3

package/bulk_keychain_wasm.d.ts

@@ -1,102 +1,237 @@
 /* tslint:disable */
 /* eslint-disable */
 
+/**
+ * WASM wrapper for Keypair
+ */
 export class WasmKeypair {
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Create from raw bytes (32-byte secret or 64-byte full keypair)
-   */
-  static fromBytes(bytes: Uint8Array): WasmKeypair;
-  /**
-   * Get the secret key as bytes (32 bytes)
-   */
-  secretKey(): Uint8Array;
-  /**
-   * Create from base58-encoded secret key or full keypair
-   */
-  static fromBase58(s: string): WasmKeypair;
-  /**
-   * Generate a new random keypair
-   */
-  constructor();
-  /**
-   * Get the full keypair as bytes (64 bytes)
-   */
-  toBytes(): Uint8Array;
-  /**
-   * Get the full keypair as base58 (64 bytes)
-   */
-  toBase58(): string;
-  /**
-   * Get the public key as base58 string
-   */
-  readonly pubkey: string;
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Create from base58-encoded secret key or full keypair
+     */
+    static fromBase58(s: string): WasmKeypair;
+    /**
+     * Create from raw bytes (32-byte secret or 64-byte full keypair)
+     */
+    static fromBytes(bytes: Uint8Array): WasmKeypair;
+    /**
+     * Generate a new random keypair
+     */
+    constructor();
+    /**
+     * Get the secret key as bytes (32 bytes)
+     */
+    secretKey(): Uint8Array;
+    /**
+     * Get the full keypair as base58 (64 bytes)
+     */
+    toBase58(): string;
+    /**
+     * Get the full keypair as bytes (64 bytes)
+     */
+    toBytes(): Uint8Array;
+    /**
+     * Get the public key as base58 string
+     */
+    readonly pubkey: string;
+}
+
+/**
+ * Prepared message for external wallet signing
+ *
+ * This contains everything needed to sign with an external wallet
+ * and then finalize into a SignedTransaction.
+ */
+export class WasmPreparedMessage {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Finalize with a signature (base58 string)
+     *
+     * Call this after your wallet signs the messageBytes.
+     */
+    finalize(signature: string): any;
+    /**
+     * Finalize with signature bytes (Uint8Array)
+     */
+    finalizeBytes(signature: Uint8Array): any;
+    /**
+     * Get the account public key (base58)
+     */
+    readonly account: string;
+    /**
+     * Get the action JSON
+     */
+    readonly action: any;
+    /**
+     * Get message as base58 string
+     */
+    readonly messageBase58: string;
+    /**
+     * Get message as base64 string
+     */
+    readonly messageBase64: string;
+    /**
+     * Get the raw message bytes to sign (Uint8Array)
+     */
+    readonly messageBytes: Uint8Array;
+    /**
+     * Get message as hex string
+     */
+    readonly messageHex: string;
+    /**
+     * Get the nonce
+     */
+    readonly nonce: number;
+    /**
+     * Get the pre-computed order ID
+     */
+    readonly orderId: string;
+    /**
+     * Get the signer public key (base58)
+     */
+    readonly signer: string;
 }
 
+/**
+ * WASM wrapper for Signer
+ */
 export class WasmSigner {
-  free(): void;
-  [Symbol.dispose](): void;
-  /**
-   * Sign multiple orders atomically in ONE transaction
-   */
-  signGroup(orders: any, nonce?: number | null): any;
-  /**
-   * @deprecated Use sign(), signAll(), or signGroup() instead
-   */
-  signOrder(orders: any, nonce?: number | null): any;
-  /**
-   * Create a signer from base58-encoded secret key
-   */
-  static fromBase58(s: string): WasmSigner;
-  /**
-   * Sign a faucet request (testnet only)
-   */
-  signFaucet(nonce?: number | null): any;
-  /**
-   * Sign agent wallet creation/deletion
-   */
-  signAgentWallet(agent_pubkey: string, _delete: boolean, nonce?: number | null): any;
-  /**
-   * @deprecated Use signAll() instead
-   */
-  signOrdersBatch(batches: any, base_nonce?: number | null): any;
-  /**
-   * Sign user settings update
-   */
-  signUserSettings(settings: any, nonce?: number | null): any;
-  /**
-   * Create a signer with nonce management
-   */
-  static withNonceManager(keypair: WasmKeypair, strategy: string): WasmSigner;
-  /**
-   * Create a new signer from a keypair
-   */
-  constructor(keypair: WasmKeypair);
-  /**
-   * Sign a single order/cancel/cancelAll
-   */
-  sign(order: any, nonce?: number | null): any;
-  /**
-   * Sign multiple orders - each becomes its own transaction (parallel)
-   */
-  signAll(orders: any, base_nonce?: number | null): any;
-  /**
-   * Get the signer's public key
-   */
-  readonly pubkey: string;
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Create a signer from base58-encoded secret key
+     */
+    static fromBase58(s: string): WasmSigner;
+    /**
+     * Create a new signer from a keypair
+     */
+    constructor(keypair: WasmKeypair);
+    /**
+     * Sign a single order/cancel/cancelAll
+     */
+    sign(order: any, nonce?: number | null): any;
+    /**
+     * Sign agent wallet creation/deletion
+     */
+    signAgentWallet(agent_pubkey: string, _delete: boolean, nonce?: number | null): any;
+    /**
+     * Sign multiple orders - each becomes its own transaction (parallel)
+     */
+    signAll(orders: any, base_nonce?: number | null): any;
+    /**
+     * Sign a faucet request (testnet only)
+     */
+    signFaucet(nonce?: number | null): any;
+    /**
+     * Sign multiple orders atomically in ONE transaction
+     */
+    signGroup(orders: any, nonce?: number | null): any;
+    /**
+     * @deprecated Use sign(), signAll(), or signGroup() instead
+     */
+    signOrder(orders: any, nonce?: number | null): any;
+    /**
+     * @deprecated Use signAll() instead
+     */
+    signOrdersBatch(batches: any, base_nonce?: number | null): any;
+    /**
+     * Sign user settings update
+     */
+    signUserSettings(settings: any, nonce?: number | null): any;
+    /**
+     * Create a signer with nonce management
+     */
+    static withNonceManager(keypair: WasmKeypair, strategy: string): WasmSigner;
+    /**
+     * Get the signer's public key
+     */
+    readonly pubkey: string;
 }
 
+/**
+ * Compute order ID from wincode bytes
+ *
+ * This computes SHA256(wincode_bytes), which matches BULK's server-side
+ * order ID generation. Useful if you're serializing transactions yourself.
+ */
+export function computeOrderId(wincode_bytes: Uint8Array): string;
+
 /**
  * Get current timestamp in milliseconds
  */
 export function currentTimestamp(): number;
 
+/**
+ * Finalize a prepared message with a signature
+ *
+ * Alternative to calling prepared.finalize() - useful if you have
+ * the prepared message as a plain object.
+ */
+export function finalizeTransaction(prepared: any, signature: string): any;
+
 /**
  * Initialize the WASM module
  */
 export function init(): void;
 
+/**
+ * Prepare agent wallet creation for external signing
+ *
+ * @param agentPubkey - The agent wallet public key to authorize
+ * @param delete - Whether to delete (true) or add (false) the agent
+ * @param options - { account: string, signer?: string, nonce?: number }
+ */
+export function prepareAgentWallet(agent_pubkey: string, _delete: boolean, options: any): WasmPreparedMessage;
+
+/**
+ * Prepare multiple orders - each becomes its own transaction (parallel)
+ *
+ * @param orders - Array of orders to prepare
+ * @param options - { account: string, signer?: string, nonce?: number }
+ * @returns Array of PreparedMessage
+ */
+export function prepareAll(orders: any, options: any): WasmPreparedMessage[];
+
+/**
+ * Prepare faucet request for external signing
+ *
+ * @param options - { account: string, signer?: string, nonce?: number }
+ */
+export function prepareFaucet(options: any): WasmPreparedMessage;
+
+/**
+ * Prepare multiple orders as ONE atomic transaction
+ *
+ * Use for bracket orders (entry + stop loss + take profit).
+ *
+ * @param orders - Array of orders for the atomic transaction
+ * @param options - { account: string, signer?: string, nonce?: number }
+ * @returns Single PreparedMessage containing all orders
+ */
+export function prepareGroup(orders: any, options: any): WasmPreparedMessage;
+
+/**
+ * Prepare a single order for external wallet signing
+ *
+ * Use this when you don't have access to the private key and need
+ * to sign with an external wallet (like Phantom, Privy, etc).
+ *
+ * @param order - The order to prepare
+ * @param options - { account: string, signer?: string, nonce?: number }
+ * @returns PreparedMessage with messageBytes to sign
+ *
+ * @example
+ * ```typescript
+ * const prepared = prepareOrder(order, { account: myPubkey });
+ * const signature = await wallet.signMessage(prepared.messageBytes);
+ * const signed = prepared.finalize(signature);
+ * ```
+ */
+export function prepareOrder(order: any, options: any): WasmPreparedMessage;
+
 /**
  * Generate a random hash (for client order IDs)
  */
@@ -115,61 +250,81 @@ export function validatePubkey(s: string): boolean;
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
 export interface InitOutput {
-  readonly memory: WebAssembly.Memory;
-  readonly __wbg_wasmkeypair_free: (a: number, b: number) => void;
-  readonly __wbg_wasmsigner_free: (a: number, b: number) => void;
-  readonly currentTimestamp: () => number;
-  readonly randomHash: () => [number, number];
-  readonly validateHash: (a: number, b: number) => number;
-  readonly validatePubkey: (a: number, b: number) => number;
-  readonly wasmkeypair_fromBase58: (a: number, b: number) => [number, number, number];
-  readonly wasmkeypair_fromBytes: (a: number, b: number) => [number, number, number];
-  readonly wasmkeypair_new: () => number;
-  readonly wasmkeypair_pubkey: (a: number) => [number, number];
-  readonly wasmkeypair_secretKey: (a: number) => [number, number];
-  readonly wasmkeypair_toBase58: (a: number) => [number, number];
-  readonly wasmkeypair_toBytes: (a: number) => [number, number];
-  readonly wasmsigner_fromBase58: (a: number, b: number) => [number, number, number];
-  readonly wasmsigner_new: (a: number) => number;
-  readonly wasmsigner_pubkey: (a: number) => [number, number];
-  readonly wasmsigner_sign: (a: number, b: any, c: number, d: number) => [number, number, number];
-  readonly wasmsigner_signAgentWallet: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
-  readonly wasmsigner_signAll: (a: number, b: any, c: number, d: number) => [number, number, number];
-  readonly wasmsigner_signFaucet: (a: number, b: number, c: number) => [number, number, number];
-  readonly wasmsigner_signGroup: (a: number, b: any, c: number, d: number) => [number, number, number];
-  readonly wasmsigner_signOrdersBatch: (a: number, b: any, c: number, d: number) => [number, number, number];
-  readonly wasmsigner_signUserSettings: (a: number, b: any, c: number, d: number) => [number, number, number];
-  readonly wasmsigner_withNonceManager: (a: number, b: number, c: number) => [number, number, number];
-  readonly init: () => void;
-  readonly wasmsigner_signOrder: (a: number, b: any, c: number, d: number) => [number, number, number];
-  readonly __wbindgen_malloc: (a: number, b: number) => number;
-  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
-  readonly __wbindgen_exn_store: (a: number) => void;
-  readonly __externref_table_alloc: () => number;
-  readonly __wbindgen_externrefs: WebAssembly.Table;
-  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
-  readonly __externref_table_dealloc: (a: number) => void;
-  readonly __wbindgen_start: () => void;
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_wasmkeypair_free: (a: number, b: number) => void;
+    readonly __wbg_wasmpreparedmessage_free: (a: number, b: number) => void;
+    readonly __wbg_wasmsigner_free: (a: number, b: number) => void;
+    readonly computeOrderId: (a: number, b: number) => [number, number];
+    readonly currentTimestamp: () => number;
+    readonly finalizeTransaction: (a: any, b: number, c: number) => [number, number, number];
+    readonly prepareAgentWallet: (a: number, b: number, c: number, d: any) => [number, number, number];
+    readonly prepareAll: (a: any, b: any) => [number, number, number, number];
+    readonly prepareFaucet: (a: any) => [number, number, number];
+    readonly prepareGroup: (a: any, b: any) => [number, number, number];
+    readonly prepareOrder: (a: any, b: any) => [number, number, number];
+    readonly randomHash: () => [number, number];
+    readonly validateHash: (a: number, b: number) => number;
+    readonly validatePubkey: (a: number, b: number) => number;
+    readonly wasmkeypair_fromBase58: (a: number, b: number) => [number, number, number];
+    readonly wasmkeypair_fromBytes: (a: number, b: number) => [number, number, number];
+    readonly wasmkeypair_new: () => number;
+    readonly wasmkeypair_pubkey: (a: number) => [number, number];
+    readonly wasmkeypair_secretKey: (a: number) => [number, number];
+    readonly wasmkeypair_toBase58: (a: number) => [number, number];
+    readonly wasmkeypair_toBytes: (a: number) => [number, number];
+    readonly wasmpreparedmessage_account: (a: number) => [number, number];
+    readonly wasmpreparedmessage_action: (a: number) => any;
+    readonly wasmpreparedmessage_finalize: (a: number, b: number, c: number) => any;
+    readonly wasmpreparedmessage_finalizeBytes: (a: number, b: number, c: number) => any;
+    readonly wasmpreparedmessage_messageBase58: (a: number) => [number, number];
+    readonly wasmpreparedmessage_messageBase64: (a: number) => [number, number];
+    readonly wasmpreparedmessage_messageBytes: (a: number) => [number, number];
+    readonly wasmpreparedmessage_messageHex: (a: number) => [number, number];
+    readonly wasmpreparedmessage_nonce: (a: number) => number;
+    readonly wasmpreparedmessage_orderId: (a: number) => [number, number];
+    readonly wasmpreparedmessage_signer: (a: number) => [number, number];
+    readonly wasmsigner_fromBase58: (a: number, b: number) => [number, number, number];
+    readonly wasmsigner_new: (a: number) => number;
+    readonly wasmsigner_pubkey: (a: number) => [number, number];
+    readonly wasmsigner_sign: (a: number, b: any, c: number, d: number) => [number, number, number];
+    readonly wasmsigner_signAgentWallet: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
+    readonly wasmsigner_signAll: (a: number, b: any, c: number, d: number) => [number, number, number];
+    readonly wasmsigner_signFaucet: (a: number, b: number, c: number) => [number, number, number];
+    readonly wasmsigner_signGroup: (a: number, b: any, c: number, d: number) => [number, number, number];
+    readonly wasmsigner_signOrdersBatch: (a: number, b: any, c: number, d: number) => [number, number, number];
+    readonly wasmsigner_signUserSettings: (a: number, b: any, c: number, d: number) => [number, number, number];
+    readonly wasmsigner_withNonceManager: (a: number, b: number, c: number) => [number, number, number];
+    readonly init: () => void;
+    readonly wasmsigner_signOrder: (a: number, b: any, c: number, d: number) => [number, number, number];
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __externref_drop_slice: (a: number, b: number) => void;
+    readonly __wbindgen_start: () => void;
 }
 
 export type SyncInitInput = BufferSource | WebAssembly.Module;
 
 /**
-* Instantiates the given `module`, which can either be bytes or
-* a precompiled `WebAssembly.Module`.
-*
-* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
-*
-* @returns {InitOutput}
-*/
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
 export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
 
 /**
-* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
-* for everything else, calls `WebAssembly.instantiate` directly.
-*
-* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
-*
-* @returns {Promise<InitOutput>}
-*/
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
 export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;