@provablehq/sdk 0.9.8 → 0.9.9

package/dist/mainnet/browser.d.ts

@@ -5,6 +5,7 @@ import { BlockJSON, Header, Metadata } from "./models/blockJSON.js";
 import { ConfirmedTransactionJSON } from "./models/confirmed_transaction.js";
 import { DeploymentJSON, VerifyingKeys } from "./models/deployment/deploymentJSON.js";
 import { DeploymentObject } from "./models/deployment/deploymentObject.js";
+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";
@@ -14,6 +15,8 @@ import { InputJSON } from "./models/input/inputJSON.js";
 import { InputObject } from "./models/input/inputObject.js";
 import { OutputJSON } from "./models/output/outputJSON.js";
 import { OutputObject } from "./models/output/outputObject.js";
+import { OwnedFilter } from "./models/record-scanner/ownedFilter.js";
+import { OwnedRecord } from "./models/record-provider/ownedRecord.js";
 import { OwnerJSON } from "./models/owner/ownerJSON.js";
 import { PlaintextArray } from "./models/plaintext/array.js";
 import { PlaintextLiteral } from "./models/plaintext/literal.js";
@@ -22,6 +25,9 @@ import { PlaintextStruct } from "./models/plaintext/struct.js";
 import { ProvingRequestJSON } from "./models/provingRequest.js";
 import { ProvingResponse } from "./models/provingResponse.js";
 import { RatificationJSON } from "./models/ratification.js";
+import { RecordsFilter } from "./models/record-scanner/recordsFilter.js";
+import { RecordsResponseFilter } from "./models/record-scanner/recordsResponseFilter.js";
+import { RecordSearchParams } from "./models/record-provider/recordSearchParams.js";
 import { SolutionsJSON, SolutionJSON, PartialSolutionJSON } from "./models/solution.js";
 import { TransactionJSON } from "./models/transaction/transactionJSON.js";
 import { TransactionObject } from "./models/transaction/transactionObject.js";
@@ -29,11 +35,11 @@ import { TransitionJSON } from "./models/transition/transitionJSON.js";
 import { TransitionObject } from "./models/transition/transitionObject.js";
 import { AleoKeyProvider, AleoKeyProviderParams, AleoKeyProviderInitParams, CachedKeyPair, FunctionKeyPair, FunctionKeyProvider, KeySearchParams } from "./function-key-provider.js";
 import { OfflineKeyProvider, OfflineSearchParams } from "./offline-key-provider.js";
-import { BlockHeightSearch, NetworkRecordProvider, RecordProvider, RecordSearchParams } from "./record-provider.js";
+import { BlockHeightSearch, NetworkRecordProvider, RecordProvider } from "./record-provider.js";
 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, 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, };
+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, RecordSearchParams, SolutionJSON, SolutionsJSON, TransactionJSON, TransactionObject, TransitionJSON, TransitionObject, VerifyingKeys, };

package/dist/mainnet/browser.js

@@ -1,5 +1,5 @@
 import 'core-js/proposals/json-parse-with-source.js';
-import { ViewKey, ComputeKey, Address, PrivateKeyCiphertext, PrivateKey, RecordCiphertext, EncryptionToolkit, Group, Program, Plaintext, Transaction, ProvingRequest, Metadata, VerifyingKey, ProvingKey, ProgramManager as ProgramManager$1, RecordPlaintext, verifyFunctionExecution } from '@provablehq/wasm/mainnet.js';
+import { ViewKey, ComputeKey, Address, PrivateKeyCiphertext, PrivateKey, RecordCiphertext, EncryptionToolkit, Group, Program, Plaintext, Transaction, ProvingRequest, Metadata, VerifyingKey, ProvingKey, RecordPlaintext, ProgramManager as ProgramManager$1, 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';
 
 /**
@@ -491,7 +491,7 @@ class AleoNetworkClient {
         else {
             this.headers = {
                 // This is replaced by the actual version by a Rollup plugin
-                "X-Aleo-SDK-Version": "0.9.8",
+                "X-Aleo-SDK-Version": "0.9.9",
                 "X-Aleo-environment": environment(),
             };
         }
@@ -3032,7 +3032,7 @@ class NetworkRecordProvider {
     /**
      * Set the account used to search for records
      *
-     * @param {Account} account The account to use for searching for records
+     * @param {Account} account The account used to use for searching for records.
      */
     setAccount(account) {
         this.account = account;
@@ -3040,11 +3040,9 @@ class NetworkRecordProvider {
     /**
      * Find a list of credit records with a given number of microcredits by via the official Aleo API
      *
-     * @param {number[]} microcredits The number of microcredits to search for
-     * @param {boolean} unspent Whether or not the record is unspent
-     * @param {string[]} nonces Nonces of records already found so that they are not found again
-     * @param {RecordSearchParams} searchParameters Additional parameters to search for
-     * @returns {Promise<RecordPlaintext>} The record if found, otherwise an error
+     * @param {number[]} microcredits The number of microcredits to search for.
+     * @param {RecordSearchParams} searchParameters Additional parameters to search for.
+     * @returns {Promise<OwnedRecord[]>} The records if found, otherwise an error.
      *
      * @example
      * // Create a new NetworkRecordProvider
@@ -3053,11 +3051,11 @@ class NetworkRecordProvider {
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
      *
      * // The record provider can be used to find records with a given number of microcredits
-     * const record = await recordProvider.findCreditsRecord(5000, true, []);
+     * const record = await recordProvider.findCreditsRecord(5000, { unspent: true, nonces: [] });
      *
      * // When a record is found but not yet used, it's nonce should be added to the nonces parameter so that it is not
      * // found again if a subsequent search is performed
-     * const records = await recordProvider.findCreditsRecords(5000, true, [record.nonce()]);
+     * const records = await recordProvider.findCreditsRecords(5000, { unspent: true, nonces: [record.nonce()] });
      *
      * // When the program manager is initialized with the record provider it will be used to find automatically find
      * // fee records and amount records for value transfers so that they do not need to be specified manually
@@ -3065,7 +3063,7 @@ class NetworkRecordProvider {
      * programManager.transfer(1, "aleo166q6ww6688cug7qxwe7nhctjpymydwzy2h7rscfmatqmfwnjvggqcad0at", "public", 0.5);
      *
      * */
-    async findCreditsRecords(microcredits, unspent, nonces, searchParameters) {
+    async findCreditsRecords(microcredits, searchParameters) {
         let startHeight = 0;
         let endHeight = 0;
         let maxAmount = undefined;
@@ -3082,9 +3080,6 @@ class NetworkRecordProvider {
             if ("maxAmount" in searchParameters && typeof searchParameters["maxAmount"] == "number") {
                 maxAmount = searchParameters["maxAmount"];
             }
-            if ("unspent" in searchParameters && typeof searchParameters["unspent"] == "boolean") {
-                unspent = searchParameters["unspent"];
-            }
         }
         // If the end height is not specified, use the current block height
         if (endHeight == 0) {
@@ -3095,16 +3090,20 @@ class NetworkRecordProvider {
         if (startHeight >= endHeight) {
             logAndThrow("Start height must be less than end height");
         }
-        return await this.networkClient.findRecords(startHeight, endHeight, unspent, ["credits.aleo"], microcredits, maxAmount, nonces, this.account.privateKey());
+        const recordsPts = await this.networkClient.findRecords(startHeight, endHeight, searchParameters.unspent, ["credits.aleo"], microcredits, maxAmount, searchParameters.nonces, this.account.privateKey());
+        return recordsPts.map((record) => ({
+            owner: record.owner().toString(),
+            programName: 'credits.aleo',
+            recordName: 'credits',
+            recordPlaintext: record.toString(),
+        }));
     }
     /**
      * Find a credit record with a given number of microcredits by via the official Aleo API
      *
-     * @param {number} microcredits The number of microcredits to search for
-     * @param {boolean} unspent Whether or not the record is unspent
-     * @param {string[]} nonces Nonces of records already found so that they are not found again
-     * @param {RecordSearchParams} searchParameters Additional parameters to search for
-     * @returns {Promise<RecordPlaintext>} The record if found, otherwise an error
+     * @param {number} microcredits The number of microcredits to search for.
+     * @param {RecordSearchParams} searchParameters Additional parameters to search for.
+     * @returns {Promise<OwnedRecord>} The record if found, otherwise an error.
      *
      * @example
      * // Create a new NetworkRecordProvider
@@ -3113,21 +3112,21 @@ class NetworkRecordProvider {
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
      *
      * // The record provider can be used to find records with a given number of microcredits
-     * const record = await recordProvider.findCreditsRecord(5000, true, []);
+     * const record = await recordProvider.findCreditsRecord(5000, { unspent: true, nonces: [] });
      *
      * // When a record is found but not yet used, it's nonce should be added to the nonces parameter so that it is not
      * // found again if a subsequent search is performed
-     * const records = await recordProvider.findCreditsRecords(5000, true, [record.nonce()]);
+     * const records = await recordProvider.findCreditsRecords(5000, { unspent: true, nonces: [record.nonce()] });
      *
      * // When the program manager is initialized with the record provider it will be used to find automatically find
      * // fee records and amount records for value transfers so that they do not need to be specified manually
      * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
      * programManager.transfer(1, "aleo166q6ww6688cug7qxwe7nhctjpymydwzy2h7rscfmatqmfwnjvggqcad0at", "public", 0.5);
      */
-    async findCreditsRecord(microcredits, unspent, nonces, searchParameters) {
+    async findCreditsRecord(microcredits, searchParameters) {
         let records = null;
         try {
-            records = await this.findCreditsRecords([microcredits], unspent, nonces, searchParameters);
+            records = await this.findCreditsRecords([microcredits], searchParameters);
         }
         catch (e) {
             console.log("No records found with error:", e);
@@ -3141,13 +3140,24 @@ class NetworkRecordProvider {
     /**
      * Find an arbitrary record. WARNING: This function is not implemented yet and will throw an error.
      */
-    async findRecord(unspent, nonces, searchParameters) {
-        throw new Error("Not implemented");
+    async findRecord(searchParameters) {
+        let records;
+        try {
+            records = await this.findRecords(searchParameters);
+        }
+        catch (e) {
+            console.log("No records found with error:", e);
+        }
+        if (records && records.length > 0) {
+            return records[0];
+        }
+        console.error("Record not found with error:", records);
+        throw new Error("Record not found");
     }
     /**
      * Find multiple records from a specified program.
      */
-    async findRecords(unspent, nonces, searchParameters) {
+    async findRecords(searchParameters) {
         let startHeight = 0;
         let endHeight = 0;
         let amounts = undefined;
@@ -3166,29 +3176,35 @@ class NetworkRecordProvider {
             if ("maxAmount" in searchParameters && typeof searchParameters["maxAmount"] == "number") {
                 maxAmount = searchParameters["maxAmount"];
             }
-            if ("nonces" in searchParameters && Array.isArray(searchParameters["nonces"]) && searchParameters["nonces"].every((item) => typeof item === "string")) {
-                nonces = searchParameters["nonces"];
-            }
             if ("program" in searchParameters && typeof searchParameters["program"] == "string") {
                 programs = [searchParameters["program"]];
             }
             if ("programs" in searchParameters && Array.isArray(searchParameters["programs"]) && searchParameters["programs"].every((item) => typeof item === "string")) {
                 programs = searchParameters["programs"];
             }
-            if ("unspent" in searchParameters && typeof searchParameters["unspent"] == "boolean") {
-                unspent = searchParameters["unspent"];
-            }
         }
-        // If the end height is not specified, use the current block height
+        // If the end height is not specified, use the current block height.
         if (endHeight == 0) {
             const end = await this.networkClient.getLatestHeight();
             endHeight = end;
         }
-        // If the start height is greater than the end height, throw an error
+        // If the start height is greater than the end height, throw an error.
         if (startHeight >= endHeight) {
             logAndThrow("Start height must be less than end height");
         }
-        return await this.networkClient.findRecords(startHeight, endHeight, unspent, programs, amounts, maxAmount, nonces, this.account.privateKey());
+        const recordPts = await this.networkClient.findRecords(startHeight, endHeight, searchParameters.unspent, programs, amounts, maxAmount, searchParameters.nonces, this.account.privateKey());
+        return recordPts.map((record) => ({
+            record_plaintext: record.toString(),
+        }));
+    }
+    async encryptedRecords(recordsFilter, responseFilter) {
+        throw new Error("Not implemented");
+    }
+    async checkSerialNumbers(serialNumbers) {
+        throw new Error("Not implemented");
+    }
+    async checkTags(tags) {
+        throw new Error("Not implemented");
     }
 }
 /**
@@ -3206,15 +3222,17 @@ class NetworkRecordProvider {
  *
  * // The record provider can be used to find records with a given number of microcredits and the block height search
  * // can be used to find records within a given block height range
- * const record = await recordProvider.findCreditsRecord(5000, true, [], params);
+ * const record = await recordProvider.findCreditsRecord(5000, { unspent: true, nonces: [], ...params });
  *
  */
 class BlockHeightSearch {
     startHeight;
     endHeight;
-    constructor(startHeight, endHeight) {
+    unspent;
+    constructor(startHeight, endHeight, unspent) {
         this.startHeight = startHeight;
         this.endHeight = endHeight;
+        this.unspent = !!unspent;
     }
 }
 
@@ -3392,7 +3410,7 @@ class ProgramManager {
         // Get the fee record from the account if it is not provided in the parameters
         try {
             feeRecord = privateFee
-                ? (await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams))
+                ? RecordPlaintext.fromString((await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams)).record_plaintext ?? '')
                 : undefined;
         }
         catch (e) {
@@ -3556,7 +3574,7 @@ class ProgramManager {
         // Get the fee record from the account if it is not provided in the parameters
         try {
             feeRecord = privateFee
-                ? (await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams))
+                ? RecordPlaintext.fromString((await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams)).record_plaintext ?? '')
                 : undefined;
         }
         catch (e) {
@@ -3839,7 +3857,7 @@ class ProgramManager {
         // Get the fee record from the account if it is not provided in the parameters.
         try {
             feeRecord = privateFee
-                ? (await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams))
+                ? RecordPlaintext.fromString((await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams)).record_plaintext ?? '')
                 : undefined;
         }
         catch (e) {
@@ -4078,7 +4096,7 @@ class ProgramManager {
         // Get the fee record from the account if it is not provided in the parameters
         try {
             feeRecord = privateFee
-                ? (await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams))
+                ? RecordPlaintext.fromString((await this.getCreditsRecord(priorityFee, [], feeRecord, recordSearchParams)).record_plaintext ?? '')
                 : undefined;
         }
         catch (e) {
@@ -4268,14 +4286,14 @@ 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 = (await this.getCreditsRecord(priorityFee, [], amountRecord, recordSearchParams));
+                amountRecord = RecordPlaintext.fromString((await this.getCreditsRecord(priorityFee, [], amountRecord, recordSearchParams)).record_plaintext ?? '');
                 nonces.push(amountRecord.nonce());
             }
             else {
                 amountRecord = undefined;
             }
             feeRecord = privateFee
-                ? (await this.getCreditsRecord(priorityFee, nonces, feeRecord, recordSearchParams))
+                ? RecordPlaintext.fromString((await this.getCreditsRecord(priorityFee, nonces, feeRecord, recordSearchParams)).record_plaintext ?? '')
                 : undefined;
         }
         catch (e) {
@@ -4982,14 +5000,22 @@ 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(record);
+            // return record instanceof RecordPlaintext
+            //     ? record
+            //     : RecordPlaintext.fromString(<string>record);
+            if (record && record instanceof RecordPlaintext) {
+                record = record.toString();
+            }
+            return ({
+                recordPlaintext: record,
+                programName: 'credits.aleo',
+                recordName: 'credits',
+            });
         }
         catch (e) {
             try {
                 const recordProvider = this.recordProvider;
-                return (await recordProvider.findCreditsRecord(amount, true, nonces, params));
+                return await recordProvider.findCreditsRecord(amount, { ...params, unspent: true, nonces });
             }
             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.`);