@provablehq/sdk 0.9.7 → 0.10.0-rc

package/dist/mainnet/network-client.d.ts

@@ -34,6 +34,7 @@ declare class AleoNetworkClient {
     ctx: {
         [key: string]: string;
     };
+    debugMode: boolean;
     readonly network: string;
     constructor(host: string, options?: AleoNetworkClientOptions);
     /**
@@ -71,6 +72,21 @@ declare class AleoNetworkClient {
      * networkClient.setHost("http://api.explorer.provable.com/v1");
      */
     setHost(host: string): void;
+    /**
+     * Set debug mode for the networkClient. When this mode is enabled, if Aleo network nodes report failures after
+     * calling the `submitTransaction` method, nodes will report debug information as to why the transaction failed.
+     *
+     * @param {boolean} debugMode Set debug mode for the networkClient.
+     * @example
+     * import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
+     *
+     * // Create a networkClient
+     * const networkClient = new AleoNetworkClient();
+     *
+     * // Set debug mode to true
+     * networkClient.setDebugMode(true);
+     **/
+    setDebugMode(debugMode: boolean): void;
     /**
      * Set a header in the `AleoNetworkClient`s header map
      *

package/dist/testnet/browser.js

@@ -478,18 +478,20 @@ class AleoNetworkClient {
     headers;
     account;
     ctx;
+    debugMode;
     network;
     constructor(host, options) {
         this.host = host + "/testnet";
         this.network = "testnet";
         this.ctx = {};
+        this.debugMode = 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.7",
+                "X-Aleo-SDK-Version": "0.10.0-rc",
                 "X-Aleo-environment": environment(),
             };
         }
@@ -535,6 +537,23 @@ class AleoNetworkClient {
     setHost(host) {
         this.host = host + "/testnet";
     }
+    /**
+     * Set debug mode for the networkClient. When this mode is enabled, if Aleo network nodes report failures after
+     * calling the `submitTransaction` method, nodes will report debug information as to why the transaction failed.
+     *
+     * @param {boolean} debugMode Set debug mode for the networkClient.
+     * @example
+     * import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
+     *
+     * // Create a networkClient
+     * const networkClient = new AleoNetworkClient();
+     *
+     * // Set debug mode to true
+     * networkClient.setDebugMode(true);
+     **/
+    setDebugMode(debugMode) {
+        this.debugMode = debugMode;
+    }
     /**
      * Set a header in the `AleoNetworkClient`s header map
      *
@@ -1773,7 +1792,8 @@ class AleoNetworkClient {
             ? transaction.toString()
             : transaction;
         try {
-            const response = await retryWithBackoff(() => this._sendPost(this.host + "/transaction/broadcast", {
+            const endpoint = this.debugMode ? "transaction/broadcast?debug=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",
@@ -3490,11 +3510,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
@@ -3509,6 +3530,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);
@@ -3599,9 +3624,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.
@@ -3616,6 +3642,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" &&
@@ -3677,9 +3707,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.
@@ -3694,6 +3725,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" &&
@@ -3759,9 +3794,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;
@@ -3777,6 +3813,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);