@provablehq/sdk 0.9.10 → 0.9.11

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

@@ -121,10 +121,10 @@ interface ExecuteAuthorizationOptions {
 interface ProvingRequestOptions {
     programName: string;
     functionName: string;
-    baseFee: number;
     priorityFee: number;
     privateFee: boolean;
     inputs: string[];
+    baseFee?: number;
     recordSearchParams?: RecordSearchParams;
     feeRecord?: string | RecordPlaintext;
     privateKey?: PrivateKey;
@@ -134,6 +134,24 @@ interface ProvingRequestOptions {
     unchecked?: boolean;
     edition?: number;
 }
+/**
+ * Fee estimate options.
+ *
+ * @property {string} programName - The name of the program containing the function to estimate the fee for.
+ * @property {string} functionName - The name of the function to execute within the program to estimate the fee for.
+ * @property {string} [program] - Program source code to use for the fee estimate.
+ * @property {ProgramImports} [imports] - Programs that the program imports.
+ * @property {number} [edition] - Edition of the program to estimate the fee for.
+ * @property {Authorization} authorization - An authorization to estimate the fee for.
+ */
+interface FeeEstimateOptions {
+    programName: string;
+    functionName?: string;
+    program?: string | Program;
+    imports?: ProgramImports;
+    edition?: number;
+    authorization?: Authorization;
+}
 /**
  * The ProgramManager class is used to execute and deploy programs on the Aleo network and create value transfers.
  */
@@ -333,53 +351,65 @@ declare class ProgramManager {
      * @returns {Promise<Transaction>} - A promise that resolves to the transaction or an error.
      *
      * @example
-     * /// Import the mainnet version of the sdk.
-     * import { AleoKeyProvider, ProgramManager, NetworkRecordProvider } from "@provablehq/sdk/mainnet.js";
+     * import { AleoKeyProvider, PrivateKey, initThreadPool, ProgramManager } from "@provablehq/sdk";
      *
-     * // Create a new NetworkClient, KeyProvider, and RecordProvider.
+     * await initThreadPool();
+     *
+     * // Create a new KeyProvider.
      * const keyProvider = new AleoKeyProvider();
      * keyProvider.useCache(true);
      *
-     * // Initialize a program manager with the key provider to automatically fetch keys for executions
+     * // 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);
      *
      * // Build the `Authorization`.
+     * const privateKey = new PrivateKey(); // Change this to a private key that has an aleo credit balance.
      * const authorization = await programManager.buildAuthorization({
-     *   programName: "credits.aleo",
-     *   functionName: "transfer_public",
-     *   inputs: [
-     *     "aleo1vwls2ete8dk8uu2kmkmzumd7q38fvshrht8hlc0a5362uq8ftgyqnm3w08",
-     *     "10000000u64",
-     *   ],
+     *     programName: "credits.aleo",
+     *     functionName: "transfer_public",
+     *     privateKey,
+     *     inputs: [
+     *         "aleo1vwls2ete8dk8uu2kmkmzumd7q38fvshrht8hlc0a5362uq8ftgyqnm3w08",
+     *         "10000000u64",
+     *     ],
      * });
      *
+     * console.log("Getting execution id");
+     *
      * // Derive the execution ID and base fee.
      * const executionId = authorization.toExecutionId().toString();
      *
+     * console.log("Estimating fee");
+     *
      * // Get the base fee in microcredits.
-     * const baseFeeMicrocredits = ProgramManager.estimateFeeForAuthorization(authorization, "credits.aleo");
-     * const baseFeeCredits = baseFeeMicrocredits/1000000;
+     * const baseFeeMicrocredits = await programManager.estimateFeeForAuthorization(authorization, "credits.aleo");
+     * const baseFeeCredits = Number(baseFeeMicrocredits)/1000000;
+     *
+     * console.log("Building fee authorization");
      *
      * // Build a credits.aleo/fee_public `Authorization`.
      * const feeAuthorization = await programManager.buildFeeAuthorization({
-     *   deploymentOrExecutionId: executionId,
-     *   baseFeeCredits,
+     *     deploymentOrExecutionId: executionId,
+     *     baseFeeCredits,
+     *     privateKey
      * });
      *
-     * // Build and execute the transaction
+     * console.log("Executing authorizations");
+     *
+     * // Build and execute the transaction.
      * const tx = await programManager.buildTransactionFromAuthorization({
-     *   programName: "hello_hello.aleo",
-     *   authorization,
-     *   feeAuthorization,
+     *     programName: "credits.aleo",
+     *     authorization,
+     *     feeAuthorization,
      * });
      *
-     * // Submit the transaction to the network
+     * // Submit the transaction to the network.
      * await programManager.networkClient.submitTransaction(tx.toString());
      *
-     * // Verify the transaction was successful
+     * // Verify the transaction was successful.
      * setTimeout(async () => {
-     *  const transaction = await programManager.networkClient.getTransaction(tx.id());
-     *  assert(transaction.id() === tx.id());
+     *     const transaction = await programManager.networkClient.getTransaction(tx.id());
+     *     console.log(transaction);
      * }, 10000);
      */
     buildTransactionFromAuthorization(options: ExecuteAuthorizationOptions): Promise<Transaction>;
@@ -463,7 +493,6 @@ declare class ProgramManager {
      * const provingRequest = await programManager.provingRequest({
      *   programName: "credits.aleo",
      *   functionName: "transfer_public",
-     *   baseFee: 100000,
      *   priorityFee: 0,
      *   privateFee: false,
      *   inputs: [
@@ -1151,15 +1180,6 @@ declare class ProgramManager {
      * assert(isValid);
      */
     verifyExecution(executionResponse: ExecutionResponse, blockHeight: number, imports?: ImportedPrograms, importedVerifyingKeys?: ImportedVerifyingKeys): boolean;
-    /**
-     * Set the inclusion key bytes.
-     *
-     * @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
-     *
-
     /**
      * Create a program object from a program's source code
      *
@@ -1179,6 +1199,86 @@ declare class ProgramManager {
      * @param {string} program The program source code
      */
     verifyProgram(program: string): boolean;
+    /**
+     * Estimate the execution fee for an authorization.
+     *
+     * @param {FeeEstimateOptions} options Options for fee estimate.
+     *
+     * @example
+     * import { AleoKeyProvider, PrivateKey, initThreadPool, ProgramManager } from "@provablehq/sdk";
+     *
+     * await initThreadPool();
+     *
+     * // Create a new KeyProvider.
+     * const keyProvider = new AleoKeyProvider();
+     * 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);
+     *
+     * // Build the `Authorization`.
+     * const privateKey = new PrivateKey(); // Change this to a private key that has an aleo credit balance.
+     * const authorization = await programManager.buildAuthorization({
+     *     programName: "credits.aleo",
+     *     functionName: "transfer_public",
+     *     privateKey,
+     *     inputs: [
+     *         "aleo1vwls2ete8dk8uu2kmkmzumd7q38fvshrht8hlc0a5362uq8ftgyqnm3w08",
+     *         "10000000u64",
+     *     ],
+     * });
+     *
+     * console.log("Getting execution id");
+     *
+     * // Derive the execution ID and base fee.
+     * const executionId = authorization.toExecutionId().toString();
+     *
+     * console.log("Estimating fee");
+     *
+     * // Get the base fee in microcredits.
+     * const baseFeeMicrocredits = await programManager.estimateFeeForAuthorization({
+     *      authorization,
+     *      programName: "credits.aleo"
+     * });
+     * const baseFeeCredits = Number(baseFeeMicrocredits)/1000000;
+     *
+     * console.log("Building fee authorization");
+     *
+     * // Build a credits.aleo/fee_public `Authorization`.
+     * const feeAuthorization = await programManager.buildFeeAuthorization({
+     *     deploymentOrExecutionId: executionId,
+     *     baseFeeCredits,
+     *     privateKey
+     * });
+     */
+    estimateFeeForAuthorization(options: FeeEstimateOptions): Promise<bigint>;
+    /**
+     * Estimate the execution fee for an Aleo function.
+     *
+     * @param {FeeEstimateOptions} options Options for the fee estimate.
+     *
+     * @returns {Promise<bigint>} Execution fee in microcredits for the authorization.
+     *
+     * @example
+     * import { AleoKeyProvider, PrivateKey, initThreadPool, ProgramManager } from "@provablehq/sdk";
+     *
+     * // 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);
+     *
+     * // Get the base fee in microcredits.
+     * const baseFeeMicrocredits = await programManager.estimateExecutionFee({programName: "credits.aleo"});
+     * const baseFeeCredits = Number(baseFeeMicrocredits)/1000000;
+     *
+     * console.log("Building fee authorization");
+     *
+     * // Build a credits.aleo/fee_public `Authorization`.
+     * const baseFeeMicrocredits = await programManager.estimateFeeForAuthorization({
+     *      programName: "credits.aleo",
+     *      functionName: "transfer_public",
+     * });
+     * const baseFeeCredits = Number(baseFeeMicrocredits)/1000000;
+     */
+    estimateExecutionFee(options: FeeEstimateOptions): Promise<bigint>;
     getCreditsRecord(amount: number, nonces: string[], record?: RecordPlaintext | string, params?: RecordSearchParams): Promise<OwnedRecord>;
 }
 export { ProgramManager, AuthorizationOptions, FeeAuthorizationOptions, ExecuteOptions, ProvingRequestOptions };

package/dist/testnet/browser.js

@@ -425,7 +425,12 @@ async function post(url, options) {
     options.method = "POST";
     const response = await fetch(url, options);
     if (!response.ok) {
-        throw new Error(response.status + " could not post URL " + url);
+        const error = await response.text();
+        let message = `${response.status} error received from ${url}`;
+        if (error) {
+            message = `${error}`;
+        }
+        throw new Error(message);
     }
     return response;
 }
@@ -492,7 +497,7 @@ class AleoNetworkClient {
         else {
             this.headers = {
                 // This is replaced by the actual version by a Rollup plugin
-                "X-Aleo-SDK-Version": "0.9.10",
+                "X-Aleo-SDK-Version": "0.9.11",
                 "X-Aleo-environment": environment(),
             };
         }
@@ -1807,7 +1812,7 @@ class AleoNetworkClient {
             }
         }
         catch (error) {
-            throw new Error(`Error posting transaction: No response received: ${error.message}`);
+            throw new Error(`Error posting transaction: ${error}`);
         }
     }
     /**
@@ -4206,53 +4211,65 @@ class ProgramManager {
      * @returns {Promise<Transaction>} - A promise that resolves to the transaction or an error.
      *
      * @example
-     * /// Import the mainnet version of the sdk.
-     * import { AleoKeyProvider, ProgramManager, NetworkRecordProvider } from "@provablehq/sdk/mainnet.js";
+     * import { AleoKeyProvider, PrivateKey, initThreadPool, ProgramManager } from "@provablehq/sdk";
      *
-     * // Create a new NetworkClient, KeyProvider, and RecordProvider.
+     * await initThreadPool();
+     *
+     * // Create a new KeyProvider.
      * const keyProvider = new AleoKeyProvider();
      * keyProvider.useCache(true);
      *
-     * // Initialize a program manager with the key provider to automatically fetch keys for executions
+     * // 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);
      *
      * // Build the `Authorization`.
+     * const privateKey = new PrivateKey(); // Change this to a private key that has an aleo credit balance.
      * const authorization = await programManager.buildAuthorization({
-     *   programName: "credits.aleo",
-     *   functionName: "transfer_public",
-     *   inputs: [
-     *     "aleo1vwls2ete8dk8uu2kmkmzumd7q38fvshrht8hlc0a5362uq8ftgyqnm3w08",
-     *     "10000000u64",
-     *   ],
+     *     programName: "credits.aleo",
+     *     functionName: "transfer_public",
+     *     privateKey,
+     *     inputs: [
+     *         "aleo1vwls2ete8dk8uu2kmkmzumd7q38fvshrht8hlc0a5362uq8ftgyqnm3w08",
+     *         "10000000u64",
+     *     ],
      * });
      *
+     * console.log("Getting execution id");
+     *
      * // Derive the execution ID and base fee.
      * const executionId = authorization.toExecutionId().toString();
      *
+     * console.log("Estimating fee");
+     *
      * // Get the base fee in microcredits.
-     * const baseFeeMicrocredits = ProgramManager.estimateFeeForAuthorization(authorization, "credits.aleo");
-     * const baseFeeCredits = baseFeeMicrocredits/1000000;
+     * const baseFeeMicrocredits = await programManager.estimateFeeForAuthorization(authorization, "credits.aleo");
+     * const baseFeeCredits = Number(baseFeeMicrocredits)/1000000;
+     *
+     * console.log("Building fee authorization");
      *
      * // Build a credits.aleo/fee_public `Authorization`.
      * const feeAuthorization = await programManager.buildFeeAuthorization({
-     *   deploymentOrExecutionId: executionId,
-     *   baseFeeCredits,
+     *     deploymentOrExecutionId: executionId,
+     *     baseFeeCredits,
+     *     privateKey
      * });
      *
-     * // Build and execute the transaction
+     * console.log("Executing authorizations");
+     *
+     * // Build and execute the transaction.
      * const tx = await programManager.buildTransactionFromAuthorization({
-     *   programName: "hello_hello.aleo",
-     *   authorization,
-     *   feeAuthorization,
+     *     programName: "credits.aleo",
+     *     authorization,
+     *     feeAuthorization,
      * });
      *
-     * // Submit the transaction to the network
+     * // Submit the transaction to the network.
      * await programManager.networkClient.submitTransaction(tx.toString());
      *
-     * // Verify the transaction was successful
+     * // Verify the transaction was successful.
      * setTimeout(async () => {
-     *  const transaction = await programManager.networkClient.getTransaction(tx.id());
-     *  assert(transaction.id() === tx.id());
+     *     const transaction = await programManager.networkClient.getTransaction(tx.id());
+     *     console.log(transaction);
      * }, 10000);
      */
     async buildTransactionFromAuthorization(options) {
@@ -4299,6 +4316,7 @@ class ProgramManager {
             }
         }
         // Resolve the program imports if they exist.
+        console.log("Resolving program imports");
         const numberOfImports = Program.fromString(program).getImports().length;
         if (numberOfImports > 0 && !imports) {
             try {
@@ -4310,6 +4328,7 @@ class ProgramManager {
         }
         // If the offline query exists, add the inclusion key.
         if (offlineQuery && !this.inclusionKeysLoaded) {
+            console.log("Loading inclusion keys for offline proving.");
             try {
                 const inclusionKeys = await this.keyProvider.inclusionKeys();
                 ProgramManager$1.loadInclusionProver(inclusionKeys[0]);
@@ -4321,6 +4340,7 @@ class ProgramManager {
             }
         }
         // Build an execution transaction from the authorization.
+        console.log("Executing authorizations");
         return await ProgramManager$1.executeAuthorization(authorization, feeAuthorization, program, provingKey, verifyingKey, feeProvingKey, feeVerifyingKey, imports, this.host, offlineQuery);
     }
     /**
@@ -4511,7 +4531,6 @@ class ProgramManager {
      * const provingRequest = await programManager.provingRequest({
      *   programName: "credits.aleo",
      *   functionName: "transfer_public",
-     *   baseFee: 100000,
      *   priorityFee: 0,
      *   privateFee: false,
      *   inputs: [
@@ -4523,8 +4542,9 @@ class ProgramManager {
      */
     async provingRequest(options) {
         // Destructure the options object to access the parameters.
-        const { functionName, baseFee, priorityFee, privateFee, inputs, recordSearchParams, broadcast = false, unchecked = false, } = options;
+        const { functionName, priorityFee, privateFee, inputs, recordSearchParams, broadcast = false, unchecked = false, } = options;
         const privateKey = options.privateKey;
+        const baseFee = options.baseFee ? options.baseFee : 0;
         let program = options.programSource;
         let programName = options.programName;
         let feeRecord = options.feeRecord;
@@ -5719,15 +5739,6 @@ class ProgramManager {
             return false;
         }
     }
-    /**
-     * Set the inclusion key bytes.
-     *
-     * @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
-     *
-
     /**
      * Create a program object from a program's source code
      *
@@ -5759,6 +5770,109 @@ class ProgramManager {
             return false;
         }
     }
+    /**
+     * Estimate the execution fee for an authorization.
+     *
+     * @param {FeeEstimateOptions} options Options for fee estimate.
+     *
+     * @example
+     * import { AleoKeyProvider, PrivateKey, initThreadPool, ProgramManager } from "@provablehq/sdk";
+     *
+     * await initThreadPool();
+     *
+     * // Create a new KeyProvider.
+     * const keyProvider = new AleoKeyProvider();
+     * 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);
+     *
+     * // Build the `Authorization`.
+     * const privateKey = new PrivateKey(); // Change this to a private key that has an aleo credit balance.
+     * const authorization = await programManager.buildAuthorization({
+     *     programName: "credits.aleo",
+     *     functionName: "transfer_public",
+     *     privateKey,
+     *     inputs: [
+     *         "aleo1vwls2ete8dk8uu2kmkmzumd7q38fvshrht8hlc0a5362uq8ftgyqnm3w08",
+     *         "10000000u64",
+     *     ],
+     * });
+     *
+     * console.log("Getting execution id");
+     *
+     * // Derive the execution ID and base fee.
+     * const executionId = authorization.toExecutionId().toString();
+     *
+     * console.log("Estimating fee");
+     *
+     * // Get the base fee in microcredits.
+     * const baseFeeMicrocredits = await programManager.estimateFeeForAuthorization({
+     *      authorization,
+     *      programName: "credits.aleo"
+     * });
+     * const baseFeeCredits = Number(baseFeeMicrocredits)/1000000;
+     *
+     * console.log("Building fee authorization");
+     *
+     * // Build a credits.aleo/fee_public `Authorization`.
+     * const feeAuthorization = await programManager.buildFeeAuthorization({
+     *     deploymentOrExecutionId: executionId,
+     *     baseFeeCredits,
+     *     privateKey
+     * });
+     */
+    async estimateFeeForAuthorization(options) {
+        const { authorization, programName, program, imports, edition } = options;
+        if (!authorization) {
+            throw new Error("Authorization must be provided if estimating fee for Authorization.");
+        }
+        const programSource = program ? program.toString() : await this.networkClient.getProgram(programName, edition);
+        const programImports = imports ? imports : await this.networkClient.getProgramImports(programSource);
+        console.log(JSON.stringify(programImports));
+        if (Object.keys(programImports)) {
+            return ProgramManager$1.estimateFeeForAuthorization(authorization, programSource, programImports, edition);
+        }
+        return ProgramManager$1.estimateFeeForAuthorization(authorization, programSource, imports, edition);
+    }
+    /**
+     * Estimate the execution fee for an Aleo function.
+     *
+     * @param {FeeEstimateOptions} options Options for the fee estimate.
+     *
+     * @returns {Promise<bigint>} Execution fee in microcredits for the authorization.
+     *
+     * @example
+     * import { AleoKeyProvider, PrivateKey, initThreadPool, ProgramManager } from "@provablehq/sdk";
+     *
+     * // 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);
+     *
+     * // Get the base fee in microcredits.
+     * const baseFeeMicrocredits = await programManager.estimateExecutionFee({programName: "credits.aleo"});
+     * const baseFeeCredits = Number(baseFeeMicrocredits)/1000000;
+     *
+     * console.log("Building fee authorization");
+     *
+     * // Build a credits.aleo/fee_public `Authorization`.
+     * const baseFeeMicrocredits = await programManager.estimateFeeForAuthorization({
+     *      programName: "credits.aleo",
+     *      functionName: "transfer_public",
+     * });
+     * const baseFeeCredits = Number(baseFeeMicrocredits)/1000000;
+     */
+    async estimateExecutionFee(options) {
+        const { functionName, programName, program, imports, edition } = options;
+        if (!functionName) {
+            throw new Error("Function name must be specified when estimating fee.");
+        }
+        const programSource = program ? program.toString() : await this.networkClient.getProgram(programName, edition);
+        const programImports = imports ? imports : await this.networkClient.getProgramImports(programSource);
+        if (Object.keys(programImports)) {
+            return ProgramManager$1.estimateExecutionFee(programSource, functionName, programImports, edition);
+        }
+        return ProgramManager$1.estimateExecutionFee(programSource, functionName, imports, edition);
+    }
     // Internal utility function for getting a credits.aleo record
     async getCreditsRecord(amount, nonces, record, params) {
         try {