@provablehq/wasm 0.10.4 → 0.10.5-rc.1

package/dist/mainnet/aleo_wasm.d.ts

@@ -3,17 +3,17 @@
 export function runRayonThread(receiver: number): void;
 export function initThreadPool(url: URL, num_threads: number): Promise<void>;
 /**
- * Verify a SNARK proof against a verifying key and public inputs.
+ * Verify a batch SNARK proof against multiple verifying keys and their corresponding public inputs.
  *
- * This function verifies a proof produced by an Aleo program that may not be deployed on chain.
- * It directly invokes the Varuna proof verification from snarkVM.
+ * This function verifies a batch proof produced by Aleo programs that may not be deployed on chain.
+ * Each verifying key is paired with one or more sets of public inputs (instances).
  *
- * @param {VerifyingKey} verifying_key The verifying key for the circuit
- * @param {Array<string>} inputs Array of field element strings representing public inputs (e.g. ["1field", "2field"])
- * @param {Proof} proof The proof to verify
- * @returns {boolean} True if the proof is valid, false otherwise
+ * @param {Array<string>} verifying_keys Array of verifying key strings, one per circuit
+ * @param {Array<Array<Array<string>>>} inputs 3D array of field element strings [circuit_idx][instance_idx][field_idx]
+ * @param {Proof} proof The batch proof to verify
+ * @returns {boolean} True if the batch proof is valid, false otherwise
  */
-export function snarkVerify(verifying_key: VerifyingKey, inputs: Array<any>, proof: Proof): boolean;
+export function snarkVerifyBatch(verifying_keys: Array<any>, inputs: Array<any>, proof: Proof): boolean;
 /**
  * Verify an execution. Executions with multiple transitions must have the program source code and
  * verifying keys of imported functions supplied from outside to correctly verify. Also, this does
@@ -29,17 +29,17 @@ export function snarkVerify(verifying_key: VerifyingKey, inputs: Array<any>, pro
  */
 export function verifyFunctionExecution(execution: Execution, verifying_key: VerifyingKey, program: Program, function_id: string, imports: object | null | undefined, imported_verifying_keys: object | null | undefined, block_height: number): boolean;
 /**
- * Verify a batch SNARK proof against multiple verifying keys and their corresponding public inputs.
+ * Verify a SNARK proof against a verifying key and public inputs.
  *
- * This function verifies a batch proof produced by Aleo programs that may not be deployed on chain.
- * Each verifying key is paired with one or more sets of public inputs (instances).
+ * This function verifies a proof produced by an Aleo program that may not be deployed on chain.
+ * It directly invokes the Varuna proof verification from snarkVM.
  *
- * @param {Array<string>} verifying_keys Array of verifying key strings, one per circuit
- * @param {Array<Array<Array<string>>>} inputs 3D array of field element strings [circuit_idx][instance_idx][field_idx]
- * @param {Proof} proof The batch proof to verify
- * @returns {boolean} True if the batch proof is valid, false otherwise
+ * @param {VerifyingKey} verifying_key The verifying key for the circuit
+ * @param {Array<string>} inputs Array of field element strings representing public inputs (e.g. ["1field", "2field"])
+ * @param {Proof} proof The proof to verify
+ * @returns {boolean} True if the proof is valid, false otherwise
  */
-export function snarkVerifyBatch(verifying_keys: Array<any>, inputs: Array<any>, proof: Proof): boolean;
+export function snarkVerify(verifying_key: VerifyingKey, inputs: Array<any>, proof: Proof): boolean;
 export function stringToField(string: string): Field;
 /**
  * Set test consensus version heights for testing.
@@ -570,6 +570,25 @@ export class Boolean {
    */
   toString(): string;
 }
+/**
+ * A query implementation that delegates state fetching to JS callback functions.
+ *
+ * Instead of making direct HTTP calls via reqwest, each QueryTrait method
+ * calls a JS function that returns a Promise. The JS side handles the actual
+ * network request through the configured transport.
+ */
+export class CallbackQuery {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new CallbackQuery with JS callback functions.
+   *
+   * @param {Function} get_state_root A function that returns Promise<string> (the state root)
+   * @param {Function} get_state_paths A function that takes string[] (commitments) and returns Promise<string[]> (state paths)
+   * @param {Function} get_block_height A function that returns Promise<number> (the block height)
+   */
+  constructor(get_state_root: Function, get_state_paths: Function, get_block_height: Function);
+}
 /**
  * SnarkVM Ciphertext object. A Ciphertext represents an symmetrically encrypted plaintext. This
  * object provides decryption methods to recover the plaintext from the ciphertext (given the
@@ -3078,7 +3097,7 @@ export class ProgramManager {
    * @param fee_verifying_key (optional) Provide a verifying key to use for the fee execution
    * @returns {Transaction} Transaction object
    */
-  static buildJoinTransaction(private_key: PrivateKey, record_1: RecordPlaintext, record_2: RecordPlaintext, priority_fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, join_proving_key?: ProvingKey | null, join_verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null): Promise<Transaction>;
+  static buildJoinTransaction(private_key: PrivateKey, record_1: RecordPlaintext, record_2: RecordPlaintext, priority_fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, join_proving_key?: ProvingKey | null, join_verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, query?: QueryOption | null): Promise<Transaction>;
   /**
    * Split an Aleo credits record into two separate records. This function does not require a fee.
    *
@@ -3091,7 +3110,7 @@ export class ProgramManager {
    * @param split_verifying_key (optional) Provide a verifying key to use for the split function
    * @returns {Transaction} Transaction object
    */
-  static buildSplitTransaction(private_key: PrivateKey, split_amount: number, amount_record: RecordPlaintext, url?: string | null, split_proving_key?: ProvingKey | null, split_verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null): Promise<Transaction>;
+  static buildSplitTransaction(private_key: PrivateKey, split_amount: number, amount_record: RecordPlaintext, url?: string | null, split_proving_key?: ProvingKey | null, split_verifying_key?: VerifyingKey | null, query?: QueryOption | null): Promise<Transaction>;
   /**
    * Deploy an Aleo program without synthesizing keys and generating certificates.
    * Intended for use with Leo Devnode.
@@ -3244,7 +3263,7 @@ export class ProgramManager {
    * @param url The url to get the inclusion proving information from.
    * @param offline_query Optional offline query object if building a Transaction offline.
    */
-  static executeAuthorization(authorization: Authorization, fee_authorization: Authorization | null | undefined, program: string, proving_key?: ProvingKey | null, verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, imports?: object | null, url?: string | null, offline_query?: OfflineQuery | null): Promise<Transaction>;
+  static executeAuthorization(authorization: Authorization, fee_authorization: Authorization | null | undefined, program: string, proving_key?: ProvingKey | null, verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, imports?: object | null, url?: string | null, query?: QueryOption | null): Promise<Transaction>;
   /**
    * Estimate Fee for Aleo function execution. Note if "cache" is set to true, the proving and
    * verifying keys will be stored in the ProgramManager's memory and used for subsequent
@@ -3279,7 +3298,24 @@ export class ProgramManager {
    * @param {ProvingKey | undefined} proving_key (optional) Provide a verifying key to use for the function execution
    * @param {VerifyingKey | undefined} verifying_key (optional) Provide a verifying key to use for the function execution
    */
-  static executeFunctionOffline(private_key: PrivateKey, program: string, _function: string, inputs: Array<any>, prove_execution: boolean, cache: boolean, imports?: object | null, proving_key?: ProvingKey | null, verifying_key?: VerifyingKey | null, url?: string | null, offline_query?: OfflineQuery | null, edition?: number | null): Promise<ExecutionResponse>;
+  static executeFunctionOffline(private_key: PrivateKey, program: string, _function: string, inputs: Array<any>, prove_execution: boolean, cache: boolean, imports?: object | null, proving_key?: ProvingKey | null, verifying_key?: VerifyingKey | null, url?: string | null, query?: QueryOption | null, edition?: number | null): Promise<ExecutionResponse>;
+  /**
+   * Compute the query requirements for a function execution without making
+   * any network calls. Returns the commitments that need state paths and
+   * whether the function has dynamic record inputs.
+   *
+   * This enables the JS layer to pre-fetch state data via its configured
+   * transport and construct an OfflineQuery, so that the subsequent WASM
+   * execution call never makes its own network requests.
+   *
+   * @param {string} program The source code of the program
+   * @param {string} function_name The name of the function to execute
+   * @param {Array} inputs The inputs to the function
+   * @param {PrivateKey} private_key The private key (used to derive the view key for commitment computation)
+   * @param {RecordPlaintext | undefined} fee_record Optional fee record to include in commitment computation
+   * @returns {Object} An object with { commitments: string[], hasDynamicInputs: boolean }
+   */
+  static computeQueryRequirements(program: string, function_name: string, inputs: Array<any>, private_key: PrivateKey, fee_record?: RecordPlaintext | null): any;
   /**
    * Estimate Fee for an Authorization.
    *
@@ -3319,7 +3355,7 @@ export class ProgramManager {
    * @param edition The edition of the program to execute. Defaults to the latest found on the network, or 1 if the program does not exist on the network.
    * @returns {Transaction}
    */
-  static buildExecutionTransaction(private_key: PrivateKey, program: string, _function: string, inputs: Array<any>, priority_fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, imports?: object | null, proving_key?: ProvingKey | null, verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null, edition?: number | null): Promise<Transaction>;
+  static buildExecutionTransaction(private_key: PrivateKey, program: string, _function: string, inputs: Array<any>, priority_fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, imports?: object | null, proving_key?: ProvingKey | null, verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, query?: QueryOption | null, edition?: number | null): Promise<Transaction>;
   /**
    * Send credits from one Aleo account to another
    *
@@ -3337,7 +3373,7 @@ export class ProgramManager {
    * @param fee_verifying_key (optional) Provide a verifying key to use for the fee execution
    * @returns {Transaction}
    */
-  static buildTransferTransaction(private_key: PrivateKey, amount_credits: number, recipient: string, transfer_type: string, amount_record: RecordPlaintext | null | undefined, priority_fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, transfer_proving_key?: ProvingKey | null, transfer_verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null): Promise<Transaction>;
+  static buildTransferTransaction(private_key: PrivateKey, amount_credits: number, recipient: string, transfer_type: string, amount_record: RecordPlaintext | null | undefined, priority_fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, transfer_proving_key?: ProvingKey | null, transfer_verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, query?: QueryOption | null): Promise<Transaction>;
   /**
    * Create an `Authorization` for `credits.aleo/fee_public` or `credits.aleo/fee_private`.
    * This object requires an associated execution or deployment ID. This can be gained from
@@ -3665,6 +3701,27 @@ export class ProvingRequest {
    */
   toString(): string;
 }
+/**
+ * A unified query type that wraps either an OfflineQuery (pre-fetched state)
+ * or a CallbackQuery (on-demand JS transport delegation).
+ *
+ * Construct from JavaScript using the static factory methods:
+ * - `QueryOption.offlineQuery(offlineQuery)` for pre-fetched state
+ * - `QueryOption.callbackQuery(callbackQuery)` for on-demand JS callbacks
+ */
+export class QueryOption {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a QueryOption from an OfflineQuery.
+   */
+  static offlineQuery(query: OfflineQuery): QueryOption;
+  /**
+   * Create a QueryOption from a CallbackQuery.
+   */
+  static callbackQuery(query: CallbackQuery): QueryOption;
+}
 /**
  * Encrypted Aleo record
  */