@provablehq/sdk 0.9.6 → 0.9.8

package/dist/mainnet/browser.js

@@ -1,5 +1,5 @@
 import 'core-js/proposals/json-parse-with-source.js';
-import { ViewKey, ComputeKey, Address, PrivateKeyCiphertext, PrivateKey, RecordCiphertext, EncryptionToolkit, Group, Program, Plaintext, Transaction, Metadata, VerifyingKey, ProvingKey, ProgramManager as ProgramManager$1, RecordPlaintext, verifyFunctionExecution } from '@provablehq/wasm/mainnet.js';
+import { ViewKey, ComputeKey, Address, PrivateKeyCiphertext, PrivateKey, RecordCiphertext, EncryptionToolkit, Group, Program, Plaintext, Transaction, ProvingRequest, Metadata, VerifyingKey, ProvingKey, ProgramManager as ProgramManager$1, RecordPlaintext, verifyFunctionExecution } from '@provablehq/wasm/mainnet.js';
 export { Address, Authorization, BHP1024, BHP256, BHP512, BHP768, Boolean, Ciphertext, ComputeKey, EncryptionToolkit, ExecutionRequest, ExecutionResponse, Field, Execution as FunctionExecution, GraphKey, Group, I128, I16, I32, I64, I8, OfflineQuery, Pedersen128, Pedersen64, Plaintext, Poseidon2, Poseidon4, Poseidon8, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager as ProgramManagerBase, ProvingKey, ProvingRequest, RecordCiphertext, RecordPlaintext, Scalar, Signature, Transaction, Transition, U128, U16, U32, U64, U8, VerifyingKey, ViewKey, initThreadPool, verifyFunctionExecution } from '@provablehq/wasm/mainnet.js';
 
 /**
@@ -478,18 +478,20 @@ class AleoNetworkClient {
     headers;
     account;
     ctx;
+    verboseErrors;
     network;
     constructor(host, options) {
         this.host = host + "/mainnet";
         this.network = "mainnet";
         this.ctx = {};
+        this.verboseErrors = true;
         if (options && options.headers) {
             this.headers = options.headers;
         }
         else {
             this.headers = {
                 // This is replaced by the actual version by a Rollup plugin
-                "X-Aleo-SDK-Version": "0.9.6",
+                "X-Aleo-SDK-Version": "0.9.8",
                 "X-Aleo-environment": environment(),
             };
         }
@@ -521,7 +523,6 @@ class AleoNetworkClient {
      * Set a new host for the networkClient
      *
      * @param {string} host The address of a node hosting the Aleo API
-     * @param host
      *
      * @example
      * import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
@@ -535,6 +536,22 @@ class AleoNetworkClient {
     setHost(host) {
         this.host = host + "/mainnet";
     }
+    /**
+     * Set verbose errors to true or false for the `AleoNetworkClient`. When set to true, if `submitTransaction` fails, the failure responses will report descriptive information as to why the transaction failed.
+     *
+     * @param {boolean} verboseErrors Set verbose error mode to true or false for the AleoNetworkClient.
+     * @example
+     * import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
+     *
+     * // Create a networkClient
+     * const networkClient = new AleoNetworkClient();
+     *
+     * // Set debug mode to true
+     * networkClient.setVerboseTransactionErrors(true);
+     **/
+    setVerboseErrors(verboseErrors) {
+        this.verboseErrors = verboseErrors;
+    }
     /**
      * Set a header in the `AleoNetworkClient`s header map
      *
@@ -1773,7 +1790,8 @@ class AleoNetworkClient {
             ? transaction.toString()
             : transaction;
         try {
-            const response = await retryWithBackoff(() => this._sendPost(this.host + "/transaction/broadcast", {
+            const endpoint = this.verboseErrors ? "transaction/broadcast?check_transaction=true" : "transaction/broadcast";
+            const response = await retryWithBackoff(() => this._sendPost(`${this.host}/${endpoint}`, {
                 body: transactionString,
                 headers: Object.assign({}, { ...this.headers, "X-ALEO-METHOD": "submitTransaction" }, {
                     "Content-Type": "application/json",
@@ -1817,6 +1835,40 @@ class AleoNetworkClient {
             throw new Error(`Error posting solution: No response received: ${error.message}`);
         }
     }
+    /**
+     * Submit a `ProvingRequest` to a remote proving service for delegated proving. If the broadcast flag of the `ProvingRequest` is set to `true` the remote service will attempt to broadcast the result `Transaction` on behalf of the requestor.
+     *
+     * @param {DelegatedProvingParams} options - The optional parameters required to submit a proving request.
+     * @returns {Promise<ProvingResponse>} The ProvingResponse containing the transaction result and the result of the broadcast if the `broadcast` flag was set to `true`.
+     */
+    async submitProvingRequest(options) {
+        const proverUri = options.url ?? this.host;
+        const provingRequestString = options.provingRequest instanceof ProvingRequest
+            ? options.provingRequest.toString()
+            : options.provingRequest;
+        // Build headers with proper auth fallback
+        const headers = {
+            ...this.headers,
+            "X-ALEO-METHOD": "submitProvingRequest",
+            "Content-Type": "application/json"
+        };
+        // Add auth header based on what's available
+        if (options.apiKey) {
+            headers["X-Provable-API-Key"] = options.apiKey;
+        }
+        try {
+            const response = await retryWithBackoff(() => post(`${proverUri}/prove`, {
+                body: provingRequestString,
+                headers
+            }));
+            const responseText = await response.text();
+            return parseJSON(responseText);
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+            throw new Error(`Failed to submit proving request: ${errorMessage}`);
+        }
+    }
     /**
      * Await a submitted transaction to be confirmed or rejected on the Aleo network.
      *
@@ -3282,7 +3334,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for deployments
      * const program = "program hello_hello.aleo;\n\nfunction hello:\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";
@@ -3386,7 +3438,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider.
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for deployments
      * const program = "program hello_hello.aleo;\n\nfunction hello:\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";
@@ -3433,7 +3485,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider.
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for executions
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -3459,11 +3511,12 @@ class ProgramManager {
      */
     async buildExecutionTransaction(options) {
         // Destructure the options object to access the parameters
-        const { programName, functionName, priorityFee, privateFee, inputs, recordSearchParams, keySearchParams, privateKey, offlineQuery, } = options;
+        const { functionName, priorityFee, privateFee, inputs, recordSearchParams, keySearchParams, privateKey, offlineQuery, } = options;
         let feeRecord = options.feeRecord;
         let provingKey = options.provingKey;
         let verifyingKey = options.verifyingKey;
         let program = options.program;
+        let programName = options.programName;
         let imports = options.imports;
         let edition = options.edition;
         // Ensure the function exists on the network
@@ -3478,6 +3531,10 @@ class ProgramManager {
         else if (program instanceof Program) {
             program = program.toString();
         }
+        // Get the program name if it is not provided in the parameters.
+        if (programName === undefined) {
+            programName = Program.fromString(program).id();
+        }
         if (edition == undefined) {
             try {
                 edition = await this.networkClient.getLatestProgramEdition(programName);
@@ -3551,7 +3608,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider.
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a ProgramManager with the key and record providers.
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -3568,9 +3625,10 @@ class ProgramManager {
      */
     async buildAuthorization(options) {
         // Destructure the options object to access the parameters.
-        const { programName, functionName, inputs, } = options;
+        const { functionName, inputs, } = options;
         const privateKey = options.privateKey;
         let program = options.programSource;
+        let programName = options.programName;
         let imports = options.programImports;
         let edition = options.edition;
         // Ensure the function exists on the network.
@@ -3585,6 +3643,10 @@ class ProgramManager {
         else if (program instanceof Program) {
             program = program.toString();
         }
+        // Get the program name if it is not provided in the parameters.
+        if (programName === undefined) {
+            programName = Program.fromString(program).id();
+        }
         // Get the private key from the account if it is not provided in the parameters.
         let executionPrivateKey = privateKey;
         if (typeof privateKey === "undefined" &&
@@ -3629,7 +3691,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider.
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a ProgramManager with the key and record providers.
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -3646,9 +3708,10 @@ class ProgramManager {
      */
     async buildAuthorizationUnchecked(options) {
         // Destructure the options object to access the parameters.
-        const { programName, functionName, inputs, } = options;
+        const { functionName, inputs, } = options;
         const privateKey = options.privateKey;
         let program = options.programSource;
+        let programName = options.programName;
         let imports = options.programImports;
         let edition = options.edition;
         // Ensure the function exists on the network.
@@ -3663,6 +3726,10 @@ class ProgramManager {
         else if (program instanceof Program) {
             program = program.toString();
         }
+        // Get the program name if it is not provided in the parameters.
+        if (programName === undefined) {
+            programName = Program.fromString(program).id();
+        }
         // Get the private key from the account if it is not provided in the parameters.
         let executionPrivateKey = privateKey;
         if (typeof privateKey === "undefined" &&
@@ -3707,7 +3774,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider.
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a ProgramManager with the key and record providers.
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -3728,9 +3795,10 @@ class ProgramManager {
      */
     async provingRequest(options) {
         // Destructure the options object to access the parameters.
-        const { programName, functionName, baseFee, priorityFee, privateFee, inputs, recordSearchParams, broadcast = false, unchecked = false, } = options;
+        const { functionName, baseFee, priorityFee, privateFee, inputs, recordSearchParams, broadcast = false, unchecked = false, } = options;
         const privateKey = options.privateKey;
         let program = options.programSource;
+        let programName = options.programName;
         let feeRecord = options.feeRecord;
         let imports = options.programImports;
         let edition = options.edition;
@@ -3746,6 +3814,10 @@ class ProgramManager {
         else if (program instanceof Program) {
             program = program.toString();
         }
+        // Get the program name if it is not provided in the parameters.
+        if (programName === undefined) {
+            programName = Program.fromString(program).id();
+        }
         if (edition == undefined) {
             try {
                 edition = await this.networkClient.getLatestProgramEdition(programName);
@@ -3799,7 +3871,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider.
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a ProgramManager with the key and record providers.
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -3846,7 +3918,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider using official Aleo record, key, and network providers
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for executions
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -3960,7 +4032,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for executions
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -4048,7 +4120,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for executions
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -4151,7 +4223,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for executions
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -4229,7 +4301,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for executions
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -4262,7 +4334,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for executions
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -4300,7 +4372,7 @@ class ProgramManager {
      * // Create a new NetworkClient, KeyProvider, and RecordProvider
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for executions
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
@@ -4343,7 +4415,7 @@ class ProgramManager {
      *
      * // Create a keyProvider to handle key management
      * const keyProvider = new AleoKeyProvider();
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Create a new ProgramManager with the key that will be used to bond credits
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -4398,7 +4470,7 @@ class ProgramManager {
      *
      * // Create a keyProvider to handle key management
      * const keyProvider = new AleoKeyProvider();
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Create a new ProgramManager with the key that will be used to bond credits
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -4444,7 +4516,7 @@ class ProgramManager {
      *
      * // Create a keyProvider to handle key management
      * const keyProvider = new AleoKeyProvider();
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Create a new ProgramManager with the key that will be used to bond credits
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -4502,7 +4574,7 @@ class ProgramManager {
      *
      * // Create a keyProvider to handle key management
      * const keyProvider = new AleoKeyProvider();
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Create a new ProgramManager with the key that will be used to bond credits
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -4547,7 +4619,7 @@ class ProgramManager {
      *
      * // Create a keyProvider to handle key management.
      * const keyProvider = new AleoKeyProvider();
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Create a new ProgramManager with the key that will be used to unbond credits.
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -4599,7 +4671,7 @@ class ProgramManager {
      *
      * // Create a keyProvider to handle key management
      * const keyProvider = new AleoKeyProvider();
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Create a new ProgramManager with the key that will be used to bond credits
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -4643,7 +4715,7 @@ class ProgramManager {
      *
      * // Create a keyProvider to handle key management
      * const keyProvider = new AleoKeyProvider();
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Create a new ProgramManager with the key that will be used to claim unbonded credits.
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -4692,7 +4764,7 @@ class ProgramManager {
      *
      * // Create a keyProvider to handle key management
      * const keyProvider = new AleoKeyProvider();
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Create a new ProgramManager with the key that will be used to bond credits
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -4744,7 +4816,7 @@ class ProgramManager {
      *
      * // Create a keyProvider to handle key management
      * const keyProvider = new AleoKeyProvider();
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Create a new ProgramManager with the key that will be used to bond credits
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);
@@ -4799,7 +4871,7 @@ class ProgramManager {
      *
      * // Create a keyProvider to handle key management
      * const keyProvider = new AleoKeyProvider();
-     * keyProvider.useCache = true;
+     * keyProvider.useCache(true);
      *
      * // Create a new ProgramManager with the key that will be used to bond credits
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, undefined);