@provablehq/sdk 0.8.8 → 0.9.1

package/dist/testnet/program-manager.d.ts

@@ -1,5 +1,6 @@
 import { Account } from "./account";
-import { AleoNetworkClient, ProgramImports } from "./network-client";
+import { AleoNetworkClient, AleoNetworkClientOptions, ProgramImports } from "./network-client";
+import { ImportedPrograms, ImportedVerifyingKeys } from "./models/imports";
 import { RecordProvider, RecordSearchParams } from "./record-provider";
 import { FunctionKeyPair, FunctionKeyProvider, KeySearchParams } from "./function-key-provider";
 import { ExecutionResponse, OfflineQuery, RecordPlaintext, PrivateKey, Program, ProvingKey, VerifyingKey, Transaction } from "./wasm";
@@ -53,7 +54,7 @@ declare class ProgramManager {
      * @param { FunctionKeyProvider | undefined } keyProvider A key provider that implements {@link FunctionKeyProvider} interface
      * @param { RecordProvider | undefined } recordProvider A record provider that implements {@link RecordProvider} interface
      */
-    constructor(host?: string | undefined, keyProvider?: FunctionKeyProvider | undefined, recordProvider?: RecordProvider | undefined);
+    constructor(host?: string | undefined, keyProvider?: FunctionKeyProvider | undefined, recordProvider?: RecordProvider | undefined, networkClientOptions?: AleoNetworkClientOptions | undefined);
     /**
      * Check if the fee is sufficient to pay for the transaction
      */
@@ -82,6 +83,37 @@ declare class ProgramManager {
      * @param {RecordProvider} recordProvider
      */
     setRecordProvider(recordProvider: RecordProvider): void;
+    /**
+     * Set a header in the `AleoNetworkClient`s header map
+     *
+     * @param {string} headerName The name of the header to set
+     * @param {string} value The header value
+     *
+     * @example
+     * import { ProgramManager } from "@provablehq/sdk/mainnet.js";
+     *
+     * // Create a ProgramManager
+     * const programManager = new ProgramManager("https://api.explorer.provable.com/v1");
+     *
+     * // Set the value of the `Accept-Language` header to `en-US`
+     * programManager.setHeader('Accept-Language', 'en-US');
+     */
+    setHeader(headerName: string, value: string): void;
+    /**
+     * Remove a header from the `AleoNetworkClient`s header map
+     *
+     * @param {string} headerName The name of the header to be removed
+     *
+     * @example
+     * import { ProgramManager } from "@provablehq/sdk/mainnet.js";
+     *
+     * // Create a ProgramManager
+     * const programManager = new ProgramManager("https://api.explorer.provable.com/v1");
+     *
+     * // Remove the default `X-Aleo-SDK-Version` header
+     * programManager.removeHeader('X-Aleo-SDK-Version');
+     */
+    removeHeader(headerName: string): void;
     /**
      * Builds a deployment transaction for submission to the Aleo network.
      *
@@ -806,12 +838,38 @@ declare class ProgramManager {
      */
     setValidatorState(validator_state: boolean, options?: Partial<ExecuteOptions>): Promise<string>;
     /**
-     * Verify a proof of execution from an offline execution
+     * Verify a proof from an offline execution. This is useful when it is desired to do offchain proving and verification.
      *
-     * @param {executionResponse} executionResponse
+     * @param {executionResponse} executionResponse The response from an offline function execution (via the `programManager.run` method)
+     * @param {ImportedPrograms} imports The imported programs used in the execution. Specified as { "programName": "programSourceCode", ... }
+     * @param {ImportedVerifyingKeys} importedVerifyingKeys The verifying keys in the execution. Specified as { "programName": [["functionName", "verifyingKey"], ...], ... }
      * @returns {boolean} True if the proof is valid, false otherwise
+     *
+     * @example
+     * /// Import the mainnet version of the sdk used to build executions.
+     * import { Account, ProgramManager } from "@provablehq/sdk/mainnet.js";
+     *
+     * /// Create the source for two programs.
+     * const program = "import add_it_up.aleo; \n\n program mul_add.aleo;\n\nfunction mul_and_add:\n    input r0 as u32.public;\n    input r1 as u32.private;\n    mul r0 r1 into r2;\n call add_it_up.aleo/add_it r1 r2 into r3;  output r3 as u32.private;\n";
+     * const program_import = "program add_it_up.aleo;\n\nfunction add_it:\n    input r0 as u32.public;\n    input r1 as u32.private;\n    add r0 r1 into r2;\n    output r2 as u32.private;\n";
+     * const programManager = new ProgramManager(undefined, undefined, undefined);
+     *
+     * /// Create a temporary account for the execution of the program
+     * const account = Account.fromCipherText(process.env.ciphertext, process.env.password);
+     * programManager.setAccount(account);
+     *
+     * /// Get the response and ensure that the program executed correctly
+     * const executionResponse = await programManager.run(program, "mul_and_add", ["5u32", "5u32"], true);
+     *
+     * /// Construct the imports and verifying keys
+     * const imports = { "add_it_up.aleo": program_import };
+     * const importedVerifyingKeys = { "add_it_up.aleo": [["add_it", "verifyingKey1..."]] };
+     *
+     * /// Verify the execution.
+     * const isValid = programManager.verifyExecution(executionResponse, imports, importedVerifyingKeys);
+     * assert(isValid);
      */
-    verifyExecution(executionResponse: ExecutionResponse): boolean;
+    verifyExecution(executionResponse: ExecutionResponse, imports?: ImportedPrograms, importedVerifyingKeys?: ImportedVerifyingKeys): boolean;
     /**
      * Create a program object from a program's source code
      *

package/dist/testnet/utils.d.ts

@@ -1,4 +1,14 @@
+export declare function environment(): "chrome" | "firefox" | "safari" | "edge" | "opera" | "browser" | "node" | "unknown";
 export declare function logAndThrow(message: string): never;
 export declare function parseJSON(json: string): any;
 export declare function get(url: URL | string, options?: RequestInit): Promise<Response>;
 export declare function post(url: URL | string, options: RequestInit): Promise<Response>;
+type RetryOptions = {
+    maxAttempts?: number;
+    baseDelay?: number;
+    jitter?: number;
+    retryOnStatus?: number[];
+    shouldRetry?: (err: any) => boolean;
+};
+export declare function retryWithBackoff<T>(fn: () => Promise<T>, { maxAttempts, baseDelay, jitter, retryOnStatus, shouldRetry, }?: RetryOptions): Promise<T>;
+export {};

package/dist/testnet/worker.js

@@ -1,6 +1,6 @@
 import 'core-js/proposals/json-parse-with-source.js';
 import { initThreadPool, PrivateKey, verifyFunctionExecution } from '@provablehq/wasm/testnet.js';
-import { A as AleoKeyProvider, P as ProgramManager, a as AleoKeyProviderParams } from './program-manager-BuK9g9xJ.js';
+import { P as ProgramManager, A as AleoKeyProvider, a as AleoKeyProviderParams } from './program-manager-BTHjM8b7.js';
 import { expose } from 'comlink';
 
 await initThreadPool();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@provablehq/sdk",
-  "version": "0.8.8",
+  "version": "0.9.1",
   "description": "A Software Development Kit (SDK) for Zero-Knowledge Transactions",
   "collaborators": [
     "The Provable Team"
@@ -47,7 +47,7 @@
   },
   "homepage": "https://github.com/ProvableHQ/sdk#readme",
   "dependencies": {
-    "@provablehq/wasm": "^0.8.8",
+    "@provablehq/wasm": "^0.9.1",
     "comlink": "^4.4.2",
     "core-js": "^3.40.0",
     "mime": "^4.0.6",