@provablehq/sdk 0.9.4 → 0.9.6

package/dist/mainnet/browser.d.ts

@@ -33,7 +33,7 @@ import { BlockHeightSearch, NetworkRecordProvider, RecordProvider, RecordSearchP
 declare function initializeWasm(): Promise<void>;
 export { ProgramManager, ProvingRequestOptions, ExecuteOptions, FeeAuthorizationOptions, AuthorizationOptions } from "./program-manager.js";
 export { logAndThrow } from "./utils.js";
-export { Address, Authorization, Boolean, BHP256, BHP512, BHP768, BHP1024, Ciphertext, ComputeKey, Execution as FunctionExecution, ExecutionRequest, ExecutionResponse, EncryptionToolkit, Field, Group, OfflineQuery, Pedersen64, Pedersen128, Plaintext, Poseidon2, Poseidon4, Poseidon8, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager as ProgramManagerBase, ProvingKey, ProvingRequest, RecordCiphertext, RecordPlaintext, Signature, Scalar, Transaction, Transition, VerifyingKey, ViewKey, initThreadPool, verifyFunctionExecution, } from "./wasm.js";
+export { Address, Authorization, Boolean, BHP256, BHP512, BHP768, BHP1024, Ciphertext, ComputeKey, Execution as FunctionExecution, ExecutionRequest, ExecutionResponse, EncryptionToolkit, Field, GraphKey, Group, I8, I16, I32, I64, I128, OfflineQuery, Pedersen64, Pedersen128, Plaintext, Poseidon2, Poseidon4, Poseidon8, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager as ProgramManagerBase, ProvingKey, ProvingRequest, RecordCiphertext, RecordPlaintext, Signature, Scalar, Transaction, Transition, U8, U16, U32, U64, U128, VerifyingKey, ViewKey, initThreadPool, verifyFunctionExecution, } from "./wasm.js";
 export { initializeWasm };
 export { Key, CREDITS_PROGRAM_KEYS, KEY_STORE, PRIVATE_TRANSFER, PRIVATE_TO_PUBLIC_TRANSFER, PRIVATE_TRANSFER_TYPES, PUBLIC_TRANSFER, PUBLIC_TRANSFER_AS_SIGNER, PUBLIC_TO_PRIVATE_TRANSFER, VALID_TRANSFER_TYPES, } from "./constants.js";
 export { Account, AleoKeyProvider, AleoKeyProviderParams, AleoKeyProviderInitParams, AleoNetworkClient, BlockJSON, BlockHeightSearch, CachedKeyPair, ConfirmedTransactionJSON, DeploymentJSON, DeploymentObject, ExecutionJSON, ExecutionObject, FeeExecutionJSON, FeeExecutionObject, FinalizeJSON, FunctionObject, FunctionKeyPair, FunctionKeyProvider, Header, ImportedPrograms, ImportedVerifyingKeys, InputJSON, InputObject, KeySearchParams, Metadata, NetworkRecordProvider, OfflineKeyProvider, OfflineSearchParams, OutputJSON, OutputObject, OwnerJSON, PartialSolutionJSON, PlaintextArray, PlaintextLiteral, PlaintextObject, PlaintextStruct, ProgramImports, ProvingRequestJSON, ProvingResponse, RatificationJSON, RecordProvider, RecordSearchParams, SolutionJSON, SolutionsJSON, TransactionJSON, TransactionObject, TransitionJSON, TransitionObject, VerifyingKeys, };

package/dist/mainnet/browser.js

@@ -1,6 +1,6 @@
 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';
-export { Address, Authorization, BHP1024, BHP256, BHP512, BHP768, Boolean, Ciphertext, ComputeKey, EncryptionToolkit, ExecutionRequest, ExecutionResponse, Field, Execution as FunctionExecution, Group, OfflineQuery, Pedersen128, Pedersen64, Plaintext, Poseidon2, Poseidon4, Poseidon8, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager as ProgramManagerBase, ProvingKey, ProvingRequest, RecordCiphertext, RecordPlaintext, Scalar, Signature, Transaction, Transition, VerifyingKey, ViewKey, initThreadPool, 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';
 
 /**
  * Key Management class. Enables the creation of a new Aleo Account, importation of an existing account from
@@ -489,7 +489,7 @@ class AleoNetworkClient {
         else {
             this.headers = {
                 // This is replaced by the actual version by a Rollup plugin
-                "X-Aleo-SDK-Version": "0.9.4",
+                "X-Aleo-SDK-Version": "0.9.6",
                 "X-Aleo-environment": environment(),
             };
         }
@@ -1186,7 +1186,17 @@ class AleoNetworkClient {
     /**
      * Returns the source code of a program given a program ID.
      *
-     * @param {string} programId The program ID of a program deployed to the Aleo Network
+     * @param {string} programId The program ID of a program deployed to the Aleo Network.
+     * @param {number | undefined} edition The edition of the program to fetch. When this is undefined it will fetch the latest version.
+     * @returns {Promise<string>} The source code of the program.
+     *
+     * @example
+     * import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
+     *
+     * // Create a network client.
+     * const networkClient = new AleoNetworkClient("http://api.explorer.provable.com/v1", undefined);
+     *
+     * // Get the source code of a program.)
      * @returns {Promise<string>} Source code of the program
      *
      * @example
@@ -1199,10 +1209,43 @@ class AleoNetworkClient {
      * const expectedSource = "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"
      * assert.equal(program, expectedSource);
      */
-    async getProgram(programId) {
+    async getProgram(programId, edition) {
         try {
-            this.ctx = { "X-ALEO-METHOD": "getProgram" };
-            return await this.fetchData("/program/" + programId);
+            this.ctx = { "X-ALEO-METHOD": "getProgramVersion" };
+            if (typeof edition === "number") {
+                return await this.fetchData(`/program/${programId}/${edition}`);
+            }
+            else {
+                return await this.fetchData("/program/" + programId);
+            }
+        }
+        catch (error) {
+            throw new Error(`Error fetching program ${programId}: ${error}`);
+        }
+        finally {
+            this.ctx = {};
+        }
+    }
+    /**
+     * Returns the current program edition deployed on the Aleo network.
+     *
+     * @param {string} programId The program ID of a program deployed to the Aleo Network.
+     * @returns {Promise<number>} The edition of the program.
+     *
+     * @example
+     * import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
+     *
+     * // Create a network client.
+     * const networkClient = new AleoNetworkClient("http://api.explorer.provable.com/v1", undefined);
+     *
+     * const programVersion = networkClient.getLatestProgramEdition("hello_hello.aleo");
+     * assert.equal(programVersion, 1);
+     */
+    async getLatestProgramEdition(programId) {
+        try {
+            this.ctx = { "X-ALEO-METHOD": "getLatestProgramEdition" };
+            const raw = await this.fetchRaw("/program/" + programId + "/latest_edition");
+            return JSON.parse(raw);
         }
         catch (error) {
             throw new Error(`Error fetching program ${programId}: ${error}`);
@@ -1214,8 +1257,9 @@ class AleoNetworkClient {
     /**
      * Returns a program object from a program ID or program source code.
      *
-     * @param {string} inputProgram The program ID or program source code of a program deployed to the Aleo Network
-     * @returns {Promise<Program>} Source code of the program
+     * @param {string} inputProgram The program ID or program source code of a program deployed to the Aleo Network.
+     * @param {number | undefined} edition The edition of the program to fetch. When this is undefined it will fetch the latest version.
+     * @returns {Promise<Program>} Source code of the program.
      *
      * @example
      * import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
@@ -1233,18 +1277,13 @@ class AleoNetworkClient {
      * // Both program objects should be equal
      * assert(programObjectFromID.to_string() === programObjectFromSource.to_string());
      */
-    async getProgramObject(inputProgram) {
+    async getProgramObject(inputProgram, edition) {
         try {
             this.ctx = { "X-ALEO-METHOD": "getProgramObject" };
-            return Program.fromString(inputProgram);
+            return Program.fromString(await this.getProgram(inputProgram, edition));
         }
         catch (error) {
-            try {
-                return Program.fromString(await this.getProgram(inputProgram));
-            }
-            catch (error) {
-                throw new Error(`${inputProgram} is neither a program name or a valid program: ${error}`);
-            }
+            throw new Error(`${inputProgram} is neither a program name or a valid program: ${error}`);
         }
         finally {
             this.ctx = {};
@@ -1284,18 +1323,32 @@ class AleoNetworkClient {
         try {
             this.ctx = { "X-ALEO-METHOD": "getProgramImports" };
             const imports = {};
-            // Get the program object or fail if the program is not valid or does not exist
-            const program = inputProgram instanceof Program
-                ? inputProgram
-                : await this.getProgramObject(inputProgram);
+            // Normalize input to a Program object
+            let program;
+            if (inputProgram instanceof Program) {
+                program = inputProgram;
+            }
+            else {
+                try {
+                    program = Program.fromString(inputProgram);
+                }
+                catch {
+                    try {
+                        program = await this.getProgramObject(inputProgram);
+                    }
+                    catch (error2) {
+                        throw new Error(`${inputProgram} is neither a program name nor a valid program: ${error2}`);
+                    }
+                }
+            }
             // Get the list of programs that the program imports
             const importList = program.getImports();
-            // Recursively get any imports that the imported programs have in a depth first search order
+            // Recursively get any imports that the imported programs have in a depth-first search
             for (let i = 0; i < importList.length; i++) {
                 const import_id = importList[i];
                 if (!imports.hasOwnProperty(import_id)) {
-                    const programSource = (await this.getProgram(import_id));
-                    const nestedImports = (await this.getProgramImports(import_id));
+                    const programSource = await this.getProgram(import_id);
+                    const nestedImports = await this.getProgramImports(import_id);
                     for (const key in nestedImports) {
                         if (!imports.hasOwnProperty(key)) {
                             imports[key] = nestedImports[key];
@@ -1374,7 +1427,7 @@ class AleoNetworkClient {
             return await this.fetchData(`/program/${programId}/mappings`);
         }
         catch (error) {
-            throw new Error(`Error fetching mappings for program ${programId} - ensure the program exists on chain before trying again`);
+            throw new Error(`Error fetching mappings for program ${programId} - ensure the program exists on chain before trying again: ${error}`);
         }
         finally {
             this.ctx = {};
@@ -1406,7 +1459,7 @@ class AleoNetworkClient {
             return await this.fetchData(`/program/${programId}/mapping/${mappingName}/${keyString}`);
         }
         catch (error) {
-            throw new Error(`Error fetching value for key '${key}' in mapping '${mappingName}' in program '${programId}' - ensure the mapping exists and the key is correct`);
+            throw new Error(`Error fetching value for key '${key}' in mapping '${mappingName}' in program '${programId}' - ensure the mapping exists and the key is correct: ${error}`);
         }
         finally {
             this.ctx = {};
@@ -3412,6 +3465,7 @@ class ProgramManager {
         let verifyingKey = options.verifyingKey;
         let program = options.program;
         let imports = options.imports;
+        let edition = options.edition;
         // Ensure the function exists on the network
         if (program === undefined) {
             try {
@@ -3424,6 +3478,15 @@ class ProgramManager {
         else if (program instanceof Program) {
             program = program.toString();
         }
+        if (edition == undefined) {
+            try {
+                edition = await this.networkClient.getLatestProgramEdition(programName);
+            }
+            catch (e) {
+                console.warn(`Error finding edition for ${programName}. Network response: '${e.message}'. Assuming edition 1.`);
+                edition = 1;
+            }
+        }
         // Get the private key from the account if it is not provided in the parameters
         let executionPrivateKey = privateKey;
         if (typeof privateKey === "undefined" &&
@@ -3473,7 +3536,7 @@ class ProgramManager {
             }
         }
         // Build an execution transaction
-        return await ProgramManager$1.buildExecutionTransaction(executionPrivateKey, program, functionName, inputs, priorityFee, feeRecord, this.host, imports, provingKey, verifyingKey, feeProvingKey, feeVerifyingKey, offlineQuery);
+        return await ProgramManager$1.buildExecutionTransaction(executionPrivateKey, program, functionName, inputs, priorityFee, feeRecord, this.host, imports, provingKey, verifyingKey, feeProvingKey, feeVerifyingKey, offlineQuery, edition);
     }
     /**
      * Builds a SnarkVM `Authorization` for a specific function.
@@ -3509,6 +3572,7 @@ class ProgramManager {
         const privateKey = options.privateKey;
         let program = options.programSource;
         let imports = options.programImports;
+        let edition = options.edition;
         // Ensure the function exists on the network.
         if (program === undefined) {
             try {
@@ -3530,6 +3594,15 @@ class ProgramManager {
         if (typeof executionPrivateKey === "undefined") {
             throw "No private key provided and no private key set in the ProgramManager";
         }
+        if (edition == undefined) {
+            try {
+                edition = await this.networkClient.getLatestProgramEdition(programName);
+            }
+            catch (e) {
+                console.warn(`Error finding edition for ${programName}. Network response: '${e.message}'. Assuming edition 1.`);
+                edition = 1;
+            }
+        }
         // Resolve the program imports if they exist.
         const numberOfImports = Program.fromString(program).getImports().length;
         if (numberOfImports > 0 && !imports) {
@@ -3541,7 +3614,7 @@ class ProgramManager {
             }
         }
         // Build and return an `Authorization` for the desired function.
-        return await ProgramManager$1.authorize(executionPrivateKey, program, functionName, inputs, imports);
+        return await ProgramManager$1.authorize(executionPrivateKey, program, functionName, inputs, imports, edition);
     }
     /**
      * Builds a SnarkVM `Authorization` for a specific function without building a circuit first. This should be used when fast authorization generation is needed and the invoker is confident inputs are coorect.
@@ -3577,6 +3650,7 @@ class ProgramManager {
         const privateKey = options.privateKey;
         let program = options.programSource;
         let imports = options.programImports;
+        let edition = options.edition;
         // Ensure the function exists on the network.
         if (program === undefined) {
             try {
@@ -3608,8 +3682,17 @@ class ProgramManager {
                 logAndThrow(`Error finding program imports. Network response: '${e.message}'. Please ensure you're connected to a valid Aleo network and the program is deployed to the network.`);
             }
         }
+        if (edition == undefined) {
+            try {
+                edition = await this.networkClient.getLatestProgramEdition(programName);
+            }
+            catch (e) {
+                console.warn(`Error finding edition for ${programName}. Network response: '${e.message}'. Assuming edition 1.`);
+                edition = 1;
+            }
+        }
         // Build and return an `Authorization` for the desired function.
-        return await ProgramManager$1.buildAuthorizationUnchecked(executionPrivateKey, program, functionName, inputs, imports);
+        return await ProgramManager$1.buildAuthorizationUnchecked(executionPrivateKey, program, functionName, inputs, imports, edition);
     }
     /**
      * Builds a `ProvingRequest` for submission to a prover for execution.
@@ -3650,6 +3733,7 @@ class ProgramManager {
         let program = options.programSource;
         let feeRecord = options.feeRecord;
         let imports = options.programImports;
+        let edition = options.edition;
         // Ensure the function exists on the network.
         if (program === undefined) {
             try {
@@ -3662,6 +3746,15 @@ class ProgramManager {
         else if (program instanceof Program) {
             program = program.toString();
         }
+        if (edition == undefined) {
+            try {
+                edition = await this.networkClient.getLatestProgramEdition(programName);
+            }
+            catch (e) {
+                console.warn(`Error finding edition for ${programName}. Network response: '${e.message}'. Assuming edition 1.`);
+                edition = 1;
+            }
+        }
         // Get the private key from the account if it is not provided in the parameters.
         let executionPrivateKey = privateKey;
         if (typeof privateKey === "undefined" &&
@@ -3691,7 +3784,7 @@ class ProgramManager {
             }
         }
         // Build and return the `ProvingRequest`.
-        return await ProgramManager$1.buildProvingRequest(executionPrivateKey, program, functionName, inputs, baseFee, priorityFee, feeRecord, imports, broadcast, unchecked);
+        return await ProgramManager$1.buildProvingRequest(executionPrivateKey, program, functionName, inputs, baseFee, priorityFee, feeRecord, imports, broadcast, unchecked, edition);
     }
     /**
      * Builds a SnarkVM fee `Authorization` for `credits.aleo/fee_private` or `credits.aleo/fee_public`. If a record is provided `fee_private` will be executed, otherwise `fee_public` will be executed.
@@ -3822,7 +3915,7 @@ class ProgramManager {
      * const result = executionResponse.getOutputs();
      * assert(result === ["10u32"]);
      */
-    async run(program, function_name, inputs, proveExecution, imports, keySearchParams, provingKey, verifyingKey, privateKey, offlineQuery) {
+    async run(program, function_name, inputs, proveExecution, imports, keySearchParams, provingKey, verifyingKey, privateKey, offlineQuery, edition) {
         // Get the private key from the account if it is not provided in the parameters
         let executionPrivateKey = privateKey;
         if (typeof privateKey === "undefined" &&
@@ -3845,7 +3938,7 @@ class ProgramManager {
         console.log("Running program offline");
         console.log("Proving key: ", provingKey);
         console.log("Verifying key: ", verifyingKey);
-        return ProgramManager$1.executeFunctionOffline(executionPrivateKey, program, function_name, inputs, proveExecution, false, imports, provingKey, verifyingKey, this.host, offlineQuery);
+        return ProgramManager$1.executeFunctionOffline(executionPrivateKey, program, function_name, inputs, proveExecution, false, imports, provingKey, verifyingKey, this.host, offlineQuery, edition);
     }
     /**
      * Join two credits records into a single credits record