@provablehq/sdk 0.9.4-offline-rc → 0.9.5

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, 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, 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-offline-rc",
+                "X-Aleo-SDK-Version": "0.9.5",
                 "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,42 @@ 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": "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": "getProgram" };
-            return await this.fetchData("/program/" + programId);
+            this.ctx = { "X-ALEO-METHOD": "getLatestProgramEdition" };
+            return await this.fetchData("/program/" + programId + "/latest_edition");
         }
         catch (error) {
             throw new Error(`Error fetching program ${programId}: ${error}`);
@@ -1214,8 +1256,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 +1276,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 +1322,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 +1426,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 +1458,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 = {};
@@ -2250,22 +2302,6 @@ class AleoKeyProvider {
             throw new Error("Invalid visibility type");
         }
     }
-    /**
-     * Returns the proving and verifying keys for the transfer_public function.
-     *
-     * @returns {Promise<FunctionKeyPair>} Proving and verifying keys for the transfer_public function
-     */
-    async transferPublicKeys() {
-        return await this.fetchCreditsKeys(CREDITS_PROGRAM_KEYS.transfer_public);
-    }
-    /**
-     * Returns the proving and verifying keys for the inclusion proof.
-     *
-     * @returns {Promise<FunctionKeyPair>} Proving and verifying keys for the inclusion proof.
-     */
-    async inclusionKeys() {
-        return await this.fetchCreditsKeys(CREDITS_PROGRAM_KEYS.inclusion);
-    }
     /**
      * Returns the proving and verifying keys for the join function in the credits.aleo program
      *
@@ -2682,15 +2718,6 @@ class OfflineKeyProvider {
         return this.functionKeys(OfflineSearchParams.feePublicKeyParams());
     }
     ;
-    /**
-     * Get the inclusion prover keys from. The keys must be cached prior to calling this method for it to work.
-     *
-     * @returns {Promise<FunctionKeyPair>} Proving and verifying keys for the inclusion prover
-     */
-    inclusionKeys() {
-        return this.functionKeys(OfflineSearchParams.inclusionKeyParams());
-    }
-    ;
     /**
      * Get join function keys from the credits.aleo program. The keys must be cached prior to calling this
      * method for it to work.
@@ -2823,21 +2850,6 @@ class OfflineKeyProvider {
             throw new Error("Attempted to insert invalid proving keys for fee_public");
         }
     }
-    /**
-     * Insert the proving and verifying keys for the inclusion prover into the cache. Only the proving key needs
-     * to be inserted, the verifying key is automatically inserted by the SDK. This function will automatically check
-     * that the keys match the expected checksum for the inclusion prover.
-     *
-     * @param provingKey
-     */
-    insertInclusionKeys(provingKey) {
-        if (provingKey.isInclusionProver()) {
-            this.cache.set(CREDITS_PROGRAM_KEYS.inclusion.locator, [provingKey.toBytes(), VerifyingKey.inclusionVerifier().toBytes()]);
-        }
-        else {
-            throw new Error("Attempted to insert invalid proving keys for the inclusion prover");
-        }
-    }
     /**
      * Insert the proving and verifying keys for the join function into the cache. Only the proving key needs
      * to be inserted, the verifying key is automatically inserted by the SDK. This function will automatically check
@@ -3162,7 +3174,6 @@ class ProgramManager {
     host;
     networkClient;
     recordProvider;
-    inclusionKeysLoaded = false;
     /** Create a new instance of the ProgramManager
      *
      * @param { string | undefined } host A host uri running the official Aleo API
@@ -3513,17 +3524,6 @@ 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 (offlineQuery && !this.inclusionKeysLoaded) {
-            try {
-                const inclusionKeys = await this.keyProvider.inclusionKeys();
-                ProgramManager$1.loadInclusionProver(inclusionKeys[0]);
-                this.inclusionKeysLoaded = true;
-                console.log("Successfully loaded inclusion key");
-            }
-            catch {
-                logAndThrow(`Inclusion key bytes not loaded, please ensure the program manager is initialized with a KeyProvider that includes the inclusion key.`);
-            }
-        }
         // Build an execution transaction
         return await ProgramManager$1.buildExecutionTransaction(executionPrivateKey, program, functionName, inputs, priorityFee, feeRecord, this.host, imports, provingKey, verifyingKey, feeProvingKey, feeVerifyingKey, offlineQuery);
     }
@@ -3985,18 +3985,6 @@ class ProgramManager {
         catch (e) {
             logAndThrow("Records provided are not valid. Please ensure they are valid plaintext records.");
         }
-        // Load the inclusion prover offline.
-        if (offlineQuery && !this.inclusionKeysLoaded) {
-            try {
-                const inclusionKeys = await this.keyProvider.inclusionKeys();
-                ProgramManager$1.loadInclusionProver(inclusionKeys[0]);
-                this.inclusionKeysLoaded = true;
-                console.log("Successfully loaded inclusion key");
-            }
-            catch {
-                logAndThrow(`Inclusion key bytes not loaded, please ensure the program manager is initialized with a KeyProvider that includes the inclusion key.`);
-            }
-        }
         // Build an execution transaction and submit it to the network
         const tx = await ProgramManager$1.buildJoinTransaction(executionPrivateKey, recordOne, recordTwo, priorityFee, feeRecord, this.host, joinProvingKey, joinVerifyingKey, feeProvingKey, feeVerifyingKey, offlineQuery);
         // Check if the account has sufficient credits to pay for the transaction
@@ -4061,18 +4049,6 @@ class ProgramManager {
         catch (e) {
             logAndThrow("Record provided is not valid. Please ensure it is a valid plaintext record.");
         }
-        // Load the inclusion prover offline.
-        if (offlineQuery && !this.inclusionKeysLoaded) {
-            try {
-                const inclusionKeys = await this.keyProvider.inclusionKeys();
-                ProgramManager$1.loadInclusionProver(inclusionKeys[0]);
-                this.inclusionKeysLoaded = true;
-                console.log("Successfully loaded inclusion key");
-            }
-            catch {
-                logAndThrow(`Inclusion key bytes not loaded, please ensure the program manager is initialized with a KeyProvider that includes the inclusion key.`);
-            }
-        }
         // Build an execution transaction and submit it to the network
         const tx = await ProgramManager$1.buildSplitTransaction(executionPrivateKey, splitAmount, amountRecord, this.host, splitProvingKey, splitVerifyingKey, offlineQuery);
         return await this.networkClient.submitTransaction(tx);
@@ -4192,20 +4168,6 @@ class ProgramManager {
         catch (e) {
             logAndThrow(`Error finding fee record. Record finder response: '${e.message}'. Please ensure you're connected to a valid Aleo network and a record with enough balance exists.`);
         }
-        // Load the inclusion prover offline.
-        if (offlineQuery && !this.inclusionKeysLoaded) {
-            const inclusionKeys = await this.keyProvider.inclusionKeys();
-            ProgramManager$1.loadInclusionProver(inclusionKeys[0]);
-            try {
-                const inclusionKeys = await this.keyProvider.inclusionKeys();
-                ProgramManager$1.loadInclusionProver(inclusionKeys[0]);
-                this.inclusionKeysLoaded = true;
-                console.log("Successfully loaded inclusion key");
-            }
-            catch {
-                logAndThrow(`Inclusion key bytes not loaded, please ensure the program manager is initialized with a KeyProvider that includes the inclusion key.`);
-            }
-        }
         // Build an execution transaction
         return await ProgramManager$1.buildTransferTransaction(executionPrivateKey, amount, recipient, transferType, amountRecord, priorityFee, feeRecord, this.host, transferProvingKey, transferVerifyingKey, feeProvingKey, feeVerifyingKey, offlineQuery);
     }
@@ -4376,7 +4338,6 @@ class ProgramManager {
             privateFee,
             inputs,
             keySearchParams,
-            program,
             ...additionalOptions,
         };
         return await this.buildExecutionTransaction(executeOptions);
@@ -4480,7 +4441,6 @@ class ProgramManager {
             privateFee,
             inputs,
             keySearchParams,
-            program,
             ...additionalOptions,
         };
         return await this.buildExecutionTransaction(executeOptions);
@@ -4575,7 +4535,6 @@ class ProgramManager {
             privateFee,
             inputs,
             keySearchParams,
-            program,
             ...additionalOptions,
         };
         return this.buildExecutionTransaction(executeOptions);
@@ -4673,7 +4632,6 @@ class ProgramManager {
             privateFee,
             inputs,
             keySearchParams,
-            program,
             ...additionalOptions,
         };
         // Check if the account has sufficient credits to pay for the transaction
@@ -4767,7 +4725,7 @@ class ProgramManager {
             proverUri: CREDITS_PROGRAM_KEYS.set_validator_state.prover,
             verifierUri: CREDITS_PROGRAM_KEYS.set_validator_state.verifier,
             cacheKey: "credits.aleo/set_validator_state",
-        }), program = this.creditsProgram(), ...additionalOptions } = options;
+        }), ...additionalOptions } = options;
         const executeOptions = {
             programName,
             functionName,
@@ -4775,7 +4733,6 @@ class ProgramManager {
             privateFee,
             inputs,
             keySearchParams,
-            program,
             ...additionalOptions,
         };
         return await this.buildExecutionTransaction(executeOptions);
@@ -4878,15 +4835,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
      *