@provablehq/sdk 0.9.11 → 0.9.12

package/dist/mainnet/browser.d.ts

@@ -9,6 +9,7 @@ import { EncryptedRecord } from "./models/record-provider/encryptedRecord.js";
 import { ExecutionJSON, FeeExecutionJSON } from "./models/execution/executionJSON.js";
 import { ExecutionObject, FeeExecutionObject } from "./models/execution/executionObject.js";
 import { FinalizeJSON } from "./models/finalizeJSON.js";
+import { FunctionInput } from "./models/functionInput";
 import { FunctionObject } from "./models/functionObject.js";
 import { ImportedVerifyingKeys, ImportedPrograms } from "./models/imports.js";
 import { InputJSON } from "./models/input/inputJSON.js";
@@ -44,4 +45,4 @@ export { logAndThrow } from "./utils.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, getOrInitConsensusVersionTestHeights, 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, RECORD_DOMAIN, VALID_TRANSFER_TYPES, } from "./constants.js";
-export { Account, AleoKeyProvider, AleoKeyProviderParams, AleoKeyProviderInitParams, AleoNetworkClient, BlockJSON, BlockHeightSearch, CachedKeyPair, ConfirmedTransactionJSON, DeploymentJSON, DeploymentObject, EncryptedRecord, ExecutionJSON, ExecutionObject, FeeExecutionJSON, FeeExecutionObject, FinalizeJSON, FunctionObject, FunctionKeyPair, FunctionKeyProvider, Header, ImportedPrograms, ImportedVerifyingKeys, InputJSON, InputObject, KeySearchParams, Metadata, NetworkRecordProvider, OfflineKeyProvider, OfflineSearchParams, OutputJSON, OutputObject, OwnedFilter, OwnedRecord, OwnerJSON, PartialSolutionJSON, PlaintextArray, PlaintextLiteral, PlaintextObject, PlaintextStruct, ProgramImports, ProvingRequestJSON, ProvingResponse, RatificationJSON, RecordsFilter, RecordsResponseFilter, RecordProvider, RecordScanner, RecordSearchParams, SealanceMerkleTree, SolutionJSON, SolutionsJSON, TransactionJSON, TransactionObject, TransitionJSON, TransitionObject, VerifyingKeys, };
+export { Account, AleoKeyProvider, AleoKeyProviderParams, AleoKeyProviderInitParams, AleoNetworkClient, BlockJSON, BlockHeightSearch, CachedKeyPair, ConfirmedTransactionJSON, DeploymentJSON, DeploymentObject, EncryptedRecord, ExecutionJSON, ExecutionObject, FeeExecutionJSON, FeeExecutionObject, FinalizeJSON, FunctionInput, FunctionObject, FunctionKeyPair, FunctionKeyProvider, Header, ImportedPrograms, ImportedVerifyingKeys, InputJSON, InputObject, KeySearchParams, Metadata, NetworkRecordProvider, OfflineKeyProvider, OfflineSearchParams, OutputJSON, OutputObject, OwnedFilter, OwnedRecord, OwnerJSON, PartialSolutionJSON, PlaintextArray, PlaintextLiteral, PlaintextObject, PlaintextStruct, ProgramImports, ProvingRequestJSON, ProvingResponse, RatificationJSON, RecordsFilter, RecordsResponseFilter, RecordProvider, RecordScanner, RecordSearchParams, SealanceMerkleTree, SolutionJSON, SolutionsJSON, TransactionJSON, TransactionObject, TransitionJSON, TransitionObject, VerifyingKeys, };

package/dist/mainnet/browser.js

@@ -497,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.11",
+                "X-Aleo-SDK-Version": "0.9.12",
                 "X-Aleo-environment": environment(),
             };
         }
@@ -2306,7 +2306,7 @@ class AleoKeyProvider {
                 const verifying_key = key.verifyingKey();
                 const proving_key = await this.fetchProvingKey(key.prover, key.locator);
                 if (this.cacheOption) {
-                    this.cache.set(CREDITS_PROGRAM_KEYS.bond_public.locator, [proving_key.toBytes(), verifying_key.toBytes()]);
+                    this.cache.set(CREDITS_PROGRAM_KEYS.getKey(key.name).locator, [proving_key.toBytes(), verifying_key.toBytes()]);
                 }
                 return [proving_key, verifying_key];
             }
@@ -3895,6 +3895,44 @@ class ProgramManager {
     setHeader(headerName, value) {
         this.networkClient.headers[headerName] = value;
     }
+    /**
+     * 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();
+     */
+    async setInclusionProver(provingKey) {
+        if (this.inclusionKeysLoaded) {
+            return;
+        }
+        try {
+            if (provingKey) {
+                ProgramManager$1.loadInclusionProver(provingKey);
+                this.inclusionKeysLoaded = true;
+            }
+            else {
+                const inclusionKeys = await this.keyProvider.inclusionKeys();
+                ProgramManager$1.loadInclusionProver(inclusionKeys[0]);
+                this.inclusionKeysLoaded = true;
+            }
+            return;
+        }
+        catch {
+            console.log("Setting the inclusion prover requires either a key provider to be configured for the ProgramManager OR to pass the inclusion prover directly");
+        }
+    }
     /**
      * Remove a header from the `AleoNetworkClient`s header map
      *
@@ -3987,9 +4025,23 @@ class ProgramManager {
         }
         // Get the fee record from the account if it is not provided in the parameters
         try {
-            feeRecord = privateFee
-                ? RecordPlaintext.fromString((await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams)).record_plaintext ?? '')
-                : undefined;
+            if (privateFee) {
+                let fee = priorityFee;
+                // If a private fee is specified, but no fee record is provided, estimate the fee and find a matching record.
+                if (!feeRecord) {
+                    console.log("Private fee specified, but no private fee record provided, estimating fee and finding a matching fee record.");
+                    const programString = programObject.toString();
+                    const imports = await this.networkClient.getProgramImports(programString);
+                    const baseFee = Number(ProgramManager$1.estimateDeploymentFee(programString, imports));
+                    fee = baseFee + priorityFee;
+                }
+                // Get a credits.aleo record for the fee.
+                feeRecord = await this.getCreditsRecord(fee, [], feeRecord, recordSearchParams);
+            }
+            else {
+                // If it's specified NOT to use a privateFee, use a public fee.
+                feeRecord = undefined;
+            }
         }
         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.`);
@@ -4115,21 +4167,35 @@ class ProgramManager {
         let programName = options.programName;
         let imports = options.imports;
         let edition = options.edition;
+        let programObject;
         // Ensure the function exists on the network
         if (program === undefined) {
             try {
-                program = (await this.networkClient.getProgram(programName));
+                programObject = await this.networkClient.getProgramObject(programName);
+                program = programObject.toString();
             }
             catch (e) {
                 logAndThrow(`Error finding ${programName}. Network response: '${e.message}'. Please ensure you're connected to a valid Aleo network the program is deployed to the network.`);
             }
         }
+        else if (typeof program == "string") {
+            try {
+                programObject = Program.fromString(program);
+            }
+            catch (e) {
+                logAndThrow(`Program sources passed for ${programName} were invalid: ${e}`);
+            }
+        }
         else if (program instanceof Program) {
+            programObject = program;
             program = program.toString();
         }
+        if (!(programObject instanceof Program)) {
+            logAndThrow(`Failed to validate program ${programName}`);
+        }
         // Get the program name if it is not provided in the parameters.
         if (programName === undefined) {
-            programName = Program.fromString(program).id();
+            programName = programObject.id();
         }
         if (edition == undefined) {
             try {
@@ -4149,15 +4215,6 @@ class ProgramManager {
         if (typeof executionPrivateKey === "undefined") {
             throw "No private key provided and no private key set in the ProgramManager";
         }
-        // Get the fee record from the account if it is not provided in the parameters
-        try {
-            feeRecord = privateFee
-                ? RecordPlaintext.fromString((await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams)).record_plaintext ?? '')
-                : undefined;
-        }
-        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.`);
-        }
         // Get the fee proving and verifying keys from the key provider
         let feeKeys;
         try {
@@ -4179,7 +4236,7 @@ class ProgramManager {
             }
         }
         // Resolve the program imports if they exist
-        const numberOfImports = Program.fromString(program).getImports().length;
+        const numberOfImports = programObject.getImports().length;
         if (numberOfImports > 0 && !imports) {
             try {
                 imports = (await this.networkClient.getProgramImports(programName));
@@ -4188,6 +4245,26 @@ 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.`);
             }
         }
+        // Get the fee record from the account if it is not provided in the parameters
+        try {
+            if (privateFee) {
+                let fee = priorityFee;
+                // If a fee record wasn't provided, estimate the fee that needs to be paid.
+                if (!feeRecord) {
+                    const baseFee = Number(await this.estimateExecutionFee({ programName, functionName, program, imports }));
+                    fee = baseFee + priorityFee;
+                }
+                // Get a credits.aleo record for the fee.
+                feeRecord = await this.getCreditsRecord(fee, [], feeRecord, recordSearchParams);
+            }
+            else {
+                // If it's specified NOT to use a privateFee, use a public fee.
+                feeRecord = undefined;
+            }
+        }
+        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.`);
+        }
         if (offlineQuery && !this.inclusionKeysLoaded) {
             try {
                 const inclusionKeys = await this.keyProvider.inclusionKeys();
@@ -4584,15 +4661,6 @@ class ProgramManager {
         if (typeof executionPrivateKey === "undefined") {
             throw "No private key provided and no private key set in the ProgramManager";
         }
-        // Get the fee record from the account if it is not provided in the parameters.
-        try {
-            feeRecord = privateFee
-                ? RecordPlaintext.fromString((await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams)).record_plaintext ?? '')
-                : undefined;
-        }
-        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.`);
-        }
         // Resolve the program imports if they exist.
         const numberOfImports = Program.fromString(program).getImports().length;
         if (numberOfImports > 0 && !imports) {
@@ -4603,6 +4671,26 @@ 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.`);
             }
         }
+        // Get the fee record from the account if it is not provided in the parameters
+        try {
+            if (privateFee) {
+                let fee = priorityFee;
+                // If a fee record wasn't provided, estimate the fee that needs to be paid.
+                if (!feeRecord) {
+                    const baseFee = Number(await this.estimateExecutionFee({ programName, functionName, program: program.toString(), imports }));
+                    fee = baseFee + priorityFee;
+                }
+                // Get a credits.aleo record for the fee.
+                feeRecord = await this.getCreditsRecord(fee, [], feeRecord, recordSearchParams);
+            }
+            else {
+                // If it's specified NOT to use a privateFee, use a public fee.
+                feeRecord = undefined;
+            }
+        }
+        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.`);
+        }
         // Build and return the `ProvingRequest`.
         return await ProgramManager$1.buildProvingRequest(executionPrivateKey, program, functionName, inputs, baseFee, priorityFee, feeRecord, imports, broadcast, unchecked, edition);
     }
@@ -4825,9 +4913,20 @@ class ProgramManager {
         const [joinProvingKey, joinVerifyingKey] = joinKeys;
         // Get the fee record from the account if it is not provided in the parameters
         try {
-            feeRecord = privateFee
-                ? RecordPlaintext.fromString((await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams)).record_plaintext ?? '')
-                : undefined;
+            if (privateFee) {
+                let fee = priorityFee;
+                // If a fee record wasn't provided, estimate the fee that needs to be paid.
+                if (!feeRecord) {
+                    const baseFee = Number(await this.estimateExecutionFee({ programName: "credits.aleo", functionName: "join" }));
+                    fee = baseFee + priorityFee;
+                }
+                // Get a credits.aleo record for the fee.
+                feeRecord = await this.getCreditsRecord(fee, [], feeRecord, recordSearchParams);
+            }
+            else {
+                // If it's specified NOT to use a privateFee, use a public fee.
+                feeRecord = undefined;
+            }
         }
         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.`);
@@ -5040,15 +5139,20 @@ class ProgramManager {
             const nonces = [];
             if (requiresAmountRecord(transferType)) {
                 // If the transfer type is private and requires an amount record, get it from the record provider
-                amountRecord = RecordPlaintext.fromString((await this.getCreditsRecord(priorityFee, [], amountRecord, recordSearchParams)).record_plaintext ?? '');
+                amountRecord = await this.getCreditsRecord(priorityFee, [], amountRecord, recordSearchParams);
                 nonces.push(amountRecord.nonce());
             }
             else {
                 amountRecord = undefined;
             }
-            feeRecord = privateFee
-                ? RecordPlaintext.fromString((await this.getCreditsRecord(priorityFee, nonces, feeRecord, recordSearchParams)).record_plaintext ?? '')
-                : undefined;
+            if (privateFee) {
+                // Get a credits.aleo record for the fee.
+                feeRecord = await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams);
+            }
+            else {
+                // If it's specified NOT to use a privateFee, use a public fee.
+                feeRecord = undefined;
+            }
         }
         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.`);
@@ -5875,26 +5979,29 @@ class ProgramManager {
     }
     // Internal utility function for getting a credits.aleo record
     async getCreditsRecord(amount, nonces, record, params) {
-        try {
-            // return record instanceof RecordPlaintext
-            //     ? record
-            //     : RecordPlaintext.fromString(<string>record);
-            if (record && record instanceof RecordPlaintext) {
-                record = record.toString();
+        if (record) {
+            try {
+                return record instanceof RecordPlaintext
+                    ? record : RecordPlaintext.fromString(record);
+            }
+            catch {
+                logAndThrow(`Record '${record}' could not be parsed, please ensure a valid credits.aleo record 
+                is passed prior to trying again`);
             }
-            return ({
-                recordPlaintext: record,
-                programName: 'credits.aleo',
-                recordName: 'credits',
-            });
         }
-        catch (e) {
+        else {
             try {
                 const recordProvider = this.recordProvider;
-                return await recordProvider.findCreditsRecord(amount, { ...params, unspent: true, nonces });
+                const record = await recordProvider.findCreditsRecord(amount, { ...params, unspent: true, nonces });
+                if (record.record_plaintext) {
+                    return RecordPlaintext.fromString(record.record_plaintext);
+                }
+                else {
+                    logAndThrow("Failed to deserialize record returned from record provider");
+                }
             }
             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.`);
+                logAndThrow(`Error finding fee record. Record finder response: '${e}'. Please ensure you're connected to a valid Aleo network and a record with enough balance exists.`);
             }
         }
     }