@provablehq/sdk 0.9.8 → 0.9.9

package/dist/mainnet/record-provider.d.ts

@@ -1,13 +1,9 @@
-import { RecordPlaintext } from "./wasm.js";
 import { Account } from "./account.js";
 import { AleoNetworkClient } from "./network-client.js";
-/**
- * Interface for record search parameters. This allows for arbitrary search parameters to be passed to record provider
- * implementations.
- */
-interface RecordSearchParams {
-    [key: string]: any;
-}
+import { EncryptedRecord } from "./models/record-provider/encryptedRecord.js";
+import { OwnedRecord } from "./models/record-provider/ownedRecord.js";
+import { RecordSearchParams } from "./models/record-provider/recordSearchParams.js";
+import { RecordsResponseFilter } from "./models/record-scanner/recordsResponseFilter.js";
 /**
  * Interface for a record provider. A record provider is used to find records for use in deployment and execution
  * transactions on the Aleo Network. A default implementation is provided by the NetworkRecordProvider class. However,
@@ -15,61 +11,80 @@ interface RecordSearchParams {
  * implementing this interface.
  */
 interface RecordProvider {
-    account: Account;
     /**
-     * Find a credits.aleo record with a given number of microcredits from the chosen provider
+     * The account used to search for records.
+     */
+    account?: Account;
+    /**
+     * Find encrypted records from the chosen provider.
+     *
+     * @param {RecordSearchParams} recordsFilter The filter used to find the records.
+     * @param {RecordsResponseFilter} responseFilter The filter used to filter the response.
+     * @returns {Promise<EncryptedRecord[]>} The encrypted records.
+    */
+    encryptedRecords(recordsFilter: RecordSearchParams, responseFilter?: RecordsResponseFilter): Promise<EncryptedRecord[]>;
+    /**
+     * Check if a list of serial numbers exist in the chosen provider.
      *
-     * @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 they are not found again
-     * @param {RecordSearchParams} searchParameters Additional parameters to search for
-     * @returns {Promise<RecordPlaintext>} The record if found, otherwise an error
+     * @param {string[]} serialNumbers The serial numbers to check.
+     * @returns {Promise<Record<string, boolean>>} Map of Aleo Record serial numbers and whether they appeared in any inputs on chain. If boolean corresponding to the Serial Number has a true value, that Record is considered spent by the Aleo Network.
+     */
+    checkSerialNumbers(serialNumbers: string[]): Promise<Record<string, boolean>>;
+    /**
+     * Check if a list of tags exist in the chosen provider.
+     *
+     * @param {string[]} tags The tags to check.
+     * @returns {Promise<Record<string, boolean>>} Map of Aleo Record tags and whether they appeared in any inputs on chain. If boolean corresponding to the tag has a true value, that Record is considered spent by the Aleo Network.
+     */
+    checkTags(tags: string[]): Promise<Record<string, boolean>>;
+    /**
+     * Find a credits.aleo record with a given number of microcredits from the chosen provider.
+     *
+     * @param {number} microcredits The number of microcredits to search for.
+     * @param {RecordSearchParams} searchParameters Additional parameters to search for.
+     * @returns {Promise<OwnedRecord>} The record if one is found.
      *
      * @example
      * // A class implementing record provider can be used to find a record 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, its nonce should be added to the nonces array so that it is not
      * // found again if a subsequent search is performed
-     * const record2 = await recordProvider.findCreditsRecord(5000, true, [record.nonce()]);
+     * const record2 = await recordProvider.findCreditsRecord(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);
      */
-    findCreditsRecord(microcredits: number, unspent: boolean, nonces?: string[], searchParameters?: RecordSearchParams): Promise<RecordPlaintext>;
+    findCreditsRecord(microcredits: number, searchParameters: RecordSearchParams): Promise<OwnedRecord>;
     /**
      * Find a list of credit.aleo records with a given number of microcredits from the chosen provider
      *
-     * @param {number} microcreditAmounts A list of separate microcredit amounts to search for (e.g. [5000, 100000])
-     * @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[]>} A list of records with a value greater or equal to the amounts specified if such records exist, otherwise an error
+     * @param {number[]} microcreditAmounts A list of separate microcredit amounts to search for (e.g. [5000, 100000]).
+     * @param {RecordSearchParams} searchParameters Additional parameters to search for.
+     * @returns {Promise<OwnedRecord[]>} A list of records with a value greater or equal to the amounts specified if such records exist, otherwise an error.
      *
      * @example
      * // A class implementing record provider can be used to find a record with a given number of microcredits
-     * const records = await recordProvider.findCreditsRecords([5000, 5000], true, []);
+     * const records = await recordProvider.findCreditsRecords([5000, 5000], { unspent: true, nonces: [] });
      *
      * // When a record is found but not yet used, it's nonce should be added to the nonces array so that it is not
      * // found again if a subsequent search is performed
      * const nonces = [];
      * records.forEach(record => { nonces.push(record.nonce()) });
-     * const records2 = await recordProvider.findCreditsRecord(5000, true, nonces);
+     * const records2 = await recordProvider.findCreditsRecord(5000, { unspent: true, nonces });
      *
      * // 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);
      */
-    findCreditsRecords(microcreditAmounts: number[], unspent: boolean, nonces?: string[], searchParameters?: RecordSearchParams): Promise<RecordPlaintext[]>;
+    findCreditsRecords(microcreditAmounts: number[], searchParameters: RecordSearchParams): Promise<OwnedRecord[]>;
     /**
      * Find an arbitrary record
-     * @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 {RecordSearchParams} searchParameters Additional parameters to search for.
+     * @returns {Promise<OwnedRecord>} The record if found, otherwise an error.
      *
      * @example
      * // The RecordSearchParams interface can be used to create parameters for custom record searches which can then
@@ -82,28 +97,40 @@ interface RecordProvider {
      *     amount: number;
      *     program: string;
      *     recordName: string;
-     *     constructor(startHeight: number, endHeight: number, credits: number, maxRecords: number, programName: string, recordName: string) {
+     *     nonces: string[];
+     *     unspent: boolean;
+     *     constructor(
+     *         startHeight: number,
+     *         endHeight: number,
+     *         credits: number,
+     *         maxRecords: number,
+     *         programName: string,
+     *         recordName: string,
+     *         nonces: string[],
+     *         unspent: boolean
+     *     ) {
      *         this.startHeight = startHeight;
      *         this.endHeight = endHeight;
      *         this.amount = amount;
      *         this.program = programName;
      *         this.recordName = recordName;
+     *         this.nonces = nonces;
+     *         this.unspent = unspent;
      *     }
      * }
      *
-     * const params = new CustomRecordSearch(0, 100, 5000, "credits.aleo", "credits");
+     * const params = new CustomRecordSearch(0, 100, 5000, "credits.aleo", "credits", [], true);
      *
-     * const record = await recordProvider.findRecord(true, [], params);
+     * const record = await recordProvider.findRecord(params);
      */
-    findRecord(unspent: boolean, nonces?: string[], searchParameters?: RecordSearchParams): Promise<RecordPlaintext>;
+    findRecord(searchParameters: RecordSearchParams): Promise<OwnedRecord>;
     /**
      * Find multiple records from arbitrary programs
      *
-     * @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 {RecordSearchParams} searchParameters Additional parameters to search for.
+     * @returns {Promise<OwnedRecord[]>} The records if found, otherwise an error.
      *
+     * @example
      * // The RecordSearchParams interface can be used to create parameters for custom record searches which can then
      * // be passed to the record provider. An example of how this would be done for the credits.aleo program is shown
      * // below.
@@ -111,24 +138,35 @@ interface RecordProvider {
      * class CustomRecordSearch implements RecordSearchParams {
      *     startHeight: number;
      *     endHeight: number;
-     *     amount: number;
-     *     maxRecords: number;
-     *     programName: string;
+     *     credits: number;
+     *     program: string;
      *     recordName: string;
-     *     constructor(startHeight: number, endHeight: number, credits: number, maxRecords: number, programName: string, recordName: string) {
+     *     nonces: string[];
+     *     unspent: boolean;
+     *     constructor(
+     *         startHeight: number,
+     *         endHeight: number,
+     *         credits: number,
+     *         maxRecords: number,
+     *         programName: string,
+     *         recordName: string,
+     *         nonces: string[],
+     *         unspent: boolean
+     *     ) {
      *         this.startHeight = startHeight;
      *         this.endHeight = endHeight;
-     *         this.amount = amount;
-     *         this.maxRecords = maxRecords;
-     *         this.programName = programName;
+     *         this.credits = credits;
+     *         this.program = programName;
      *         this.recordName = recordName;
+     *         this.nonces = nonces;
+     *         this.unspent = unspent;
      *     }
      * }
      *
      * const params = new CustomRecordSearch(0, 100, 5000, 2, "credits.aleo", "credits");
      * const records = await recordProvider.findRecord(true, [], params);
      */
-    findRecords(unspent: boolean, nonces?: string[], searchParameters?: RecordSearchParams): Promise<RecordPlaintext[]>;
+    findRecords(searchParameters: RecordSearchParams): Promise<OwnedRecord[]>;
 }
 /**
  * A record provider implementation that uses the official Aleo API to find records for usage in program execution and
@@ -141,17 +179,15 @@ declare class NetworkRecordProvider implements RecordProvider {
     /**
      * 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: Account): void;
     /**
      * 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
@@ -160,11 +196,11 @@ declare class NetworkRecordProvider implements RecordProvider {
      * 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
@@ -172,15 +208,13 @@ declare class NetworkRecordProvider implements RecordProvider {
      * programManager.transfer(1, "aleo166q6ww6688cug7qxwe7nhctjpymydwzy2h7rscfmatqmfwnjvggqcad0at", "public", 0.5);
      *
      * */
-    findCreditsRecords(microcredits: number[], unspent: boolean, nonces?: string[], searchParameters?: RecordSearchParams): Promise<RecordPlaintext[]>;
+    findCreditsRecords(microcredits: number[], searchParameters: RecordSearchParams): Promise<OwnedRecord[]>;
     /**
      * 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
@@ -189,26 +223,29 @@ declare class NetworkRecordProvider implements RecordProvider {
      * 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);
      */
-    findCreditsRecord(microcredits: number, unspent: boolean, nonces?: string[], searchParameters?: RecordSearchParams): Promise<RecordPlaintext>;
+    findCreditsRecord(microcredits: number, searchParameters: RecordSearchParams): Promise<OwnedRecord>;
     /**
      * Find an arbitrary record. WARNING: This function is not implemented yet and will throw an error.
      */
-    findRecord(unspent: boolean, nonces?: string[], searchParameters?: RecordSearchParams): Promise<RecordPlaintext>;
+    findRecord(searchParameters: RecordSearchParams): Promise<OwnedRecord>;
     /**
      * Find multiple records from a specified program.
      */
-    findRecords(unspent: boolean, nonces?: string[], searchParameters?: RecordSearchParams): Promise<RecordPlaintext[]>;
+    findRecords(searchParameters: RecordSearchParams): Promise<OwnedRecord[]>;
+    encryptedRecords(recordsFilter: RecordSearchParams, responseFilter?: RecordsResponseFilter): Promise<EncryptedRecord[]>;
+    checkSerialNumbers(serialNumbers: string[]): Promise<Record<string, boolean>>;
+    checkTags(tags: string[]): Promise<Record<string, boolean>>;
 }
 /**
  * BlockHeightSearch is a RecordSearchParams implementation that allows for searching for records within a given
@@ -225,12 +262,13 @@ declare class NetworkRecordProvider implements RecordProvider {
  *
  * // 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 });
  *
  */
 declare class BlockHeightSearch implements RecordSearchParams {
     startHeight: number;
     endHeight: number;
-    constructor(startHeight: number, endHeight: number);
+    unspent: boolean;
+    constructor(startHeight: number, endHeight: number, unspent?: boolean);
 }
-export { BlockHeightSearch, NetworkRecordProvider, RecordProvider, RecordSearchParams };
+export { BlockHeightSearch, NetworkRecordProvider, RecordProvider, };

package/dist/testnet/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, };