@provablehq/sdk 0.9.10 → 0.9.12

package/dist/testnet/models/functionInput.d.ts

@@ -0,0 +1,7 @@
+export interface FunctionInput {
+    type: string;
+    visibility: string;
+    record?: string;
+    register?: string;
+    members?: FunctionInput[];
+}

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

@@ -5,7 +5,6 @@ import { RecordProvider } from "./record-provider.js";
 import { RecordSearchParams } from "./models/record-provider/recordSearchParams.js";
 import { FunctionKeyPair, FunctionKeyProvider, KeySearchParams } from "./function-key-provider.js";
 import { Authorization, ExecutionResponse, OfflineQuery, RecordPlaintext, PrivateKey, Program, ProvingKey, ProvingRequest, VerifyingKey, Transaction } from "./wasm.js";
-import { OwnedRecord } from "./models/record-provider/ownedRecord.js";
 /**
  * Represents the options for executing a transaction in the Aleo network.
  * This interface is used to specify the parameters required for building and submitting an execution transaction.
@@ -121,10 +120,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 +133,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.
  */
@@ -195,6 +212,25 @@ declare class ProgramManager {
      * programManager.setHeader('Accept-Language', 'en-US');
      */
     setHeader(headerName: string, value: string): void;
+    /**
+     * Set the inclusion prover into the wasm memory. This should be done prior to any execution of a function with a
+     * private record.
+     *
+     * @param {ProvingKey} [provingKey]
+     *
+     * @example
+     * import { ProgramManager, AleoKeyProvider } from "@provablehq/sdk/mainnet.js";
+     *
+     * const keyProvider = new AleoKeyProvider();
+     * keyProvider.useCache(true);
+     *
+     * // Create a ProgramManager
+     * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider);
+     *
+     * // Set the inclusion keys.
+     * programManager.setInclusionProver();
+     */
+    setInclusionProver(provingKey?: ProvingKey): Promise<void>;
     /**
      * Remove a header from the `AleoNetworkClient`s header map
      *
@@ -333,53 +369,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 +511,6 @@ declare class ProgramManager {
      * const provingRequest = await programManager.provingRequest({
      *   programName: "credits.aleo",
      *   functionName: "transfer_public",
-     *   baseFee: 100000,
      *   priorityFee: 0,
      *   privateFee: false,
      *   inputs: [
@@ -1151,15 +1198,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 +1217,86 @@ declare class ProgramManager {
      * @param {string} program The program source code
      */
     verifyProgram(program: string): boolean;
-    getCreditsRecord(amount: number, nonces: string[], record?: RecordPlaintext | string, params?: RecordSearchParams): Promise<OwnedRecord>;
+    /**
+     * 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<RecordPlaintext>;
 }
 export { ProgramManager, AuthorizationOptions, FeeAuthorizationOptions, ExecuteOptions, ProvingRequestOptions };

package/package.json

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