@provablehq/sdk 0.8.2 → 0.8.4

package/dist/testnet/network-client.d.ts

@@ -21,7 +21,8 @@ interface AleoNetworkClientOptions {
  * const localNetworkClient = new AleoNetworkClient("http://localhost:3030");
  *
  * // Connection to a public beacon node
- * const publicnetworkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+ * const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);
+ * const publicnetworkClient = new AleoNetworkClient("http://localhost:3030", undefined, account);
  */
 declare class AleoNetworkClient {
     host: string;
@@ -69,29 +70,51 @@ declare class AleoNetworkClient {
      */
     fetchRaw(url?: string): Promise<string>;
     /**
-     * Attempts to find unspent records in the Aleo blockchain for a specified private key.
+     * Attempt to find records in the Aleo blockchain.
+     *
      * @param {number} startHeight - The height at which to start searching for unspent records
      * @param {number} endHeight - The height at which to stop searching for unspent records
-     * @param {string | PrivateKey} privateKey - The private key to use to find unspent records
+     * @param {boolean} unspent - Whether to search for unspent records only
+     * @param {string[]} programs - The program(s) to search for unspent records in
      * @param {number[]} amounts - The amounts (in microcredits) to search for (eg. [100, 200, 3000])
      * @param {number} maxMicrocredits - The maximum number of microcredits to search for
      * @param {string[]} nonces - The nonces of already found records to exclude from the search
+     * @param {string | PrivateKey} privateKey - An optional private key to use to find unspent records.
      *
      * @example
-     * // Find all unspent records
-     * const privateKey = "[PRIVATE_KEY]";
-     * const records = networkClient.findUnspentRecords(0, undefined, privateKey);
+     * // Find specific amounts
+     * const startHeight = 500000;
+     * const amounts = [600000, 1000000];
+     * const records = networkClient.findRecords(startHeight, undefined, true, ["credits.aleo"] amounts);
+     *
+     * // Find specific amounts with a maximum number of cumulative microcredits
+     * const maxMicrocredits = 100000;
+     * const records = networkClient.findRecords(startHeight, undefined, true, ["credits.aleo"] undefined, maxMicrocredits);
+     */
+    findRecords(startHeight: number, endHeight: number | undefined, unspent?: boolean, programs?: string[], amounts?: number[] | undefined, maxMicrocredits?: number | undefined, nonces?: string[] | undefined, privateKey?: string | PrivateKey | undefined): Promise<Array<RecordPlaintext>>;
+    /**
+     * Attempts to find unspent records in the Aleo blockchain.
+     *
+     * @param {number} startHeight - The height at which to start searching for unspent records
+     * @param {number} endHeight - The height at which to stop searching for unspent records
+     * @param {string[]} programs - The program(s) to search for unspent records in
+     * @param {number[]} amounts - The amounts (in microcredits) to search for (eg. [100, 200, 3000])
+     * @param {number} maxMicrocredits - The maximum number of microcredits to search for
+     * @param {string[]} nonces - The nonces of already found records to exclude from the search
+     * @param {string | PrivateKey} privateKey - An optional private key to use to find unspent records.
      *
+     * @example
      * // Find specific amounts
      * const startHeight = 500000;
+     * const endHeight = 550000;
      * const amounts = [600000, 1000000];
-     * const records = networkClient.findUnspentRecords(startHeight, undefined, privateKey, amounts);
+     * const records = networkClient.findUnspentRecords(startHeight, endHeight, ["credits.aleo"], amounts);
      *
      * // Find specific amounts with a maximum number of cumulative microcredits
      * const maxMicrocredits = 100000;
-     * const records = networkClient.findUnspentRecords(startHeight, undefined, privateKey, undefined, maxMicrocredits);
+     * const records = networkClient.findUnspentRecords(startHeight, undefined, ["credits.aleo"], undefined, maxMicrocredits);
      */
-    findUnspentRecords(startHeight: number, endHeight: number | undefined, privateKey: string | PrivateKey | undefined, amounts: number[] | undefined, maxMicrocredits?: number | undefined, nonces?: string[] | undefined): Promise<Array<RecordPlaintext>>;
+    findUnspentRecords(startHeight: number, endHeight: number | undefined, programs?: string[], amounts?: number[] | undefined, maxMicrocredits?: number | undefined, nonces?: string[] | undefined, privateKey?: string | PrivateKey | undefined): Promise<Array<RecordPlaintext>>;
     /**
      * Returns the contents of the block at the specified block height.
      *
@@ -129,7 +152,7 @@ declare class AleoNetworkClient {
      * @param {Program | string} program
      * @returns {TransactionJSON}
      */
-    getDeploymentTransactioObjectnForProgram(program: Program | string): Promise<Transaction>;
+    getDeploymentTransactionObjectForProgram(program: Program | string): Promise<Transaction>;
     /**
      * Returns the contents of the latest block.
      *
@@ -224,7 +247,15 @@ declare class AleoNetworkClient {
      * @param {string} programId - The program ID to get the mappings of (e.g. "credits.aleo")
      * @example
      * const mappings = networkClient.getProgramMappingNames("credits.aleo");
-     * const expectedMappings = ["account"];
+     * const expectedMappings = [
+     *   "committee",
+     *   "delegated",
+     *   "metadata",
+     *   "bonded",
+     *   "unbonding",
+     *   "account",
+     *   "withdraw"
+     * ];
      * assert.deepStrictEqual(mappings, expectedMappings);
      */
     getProgramMappingNames(programId: string): Promise<Array<string>>;
@@ -354,5 +385,12 @@ declare class AleoNetworkClient {
      * @param {string} solution The string representation of the solution desired to be submitted to the network.
      */
     submitSolution(solution: string): Promise<string>;
+    /**
+     * Await a transaction to be confirmed on the Aleo network.
+     *
+     * @param {string} solution The string representation of the solution desired to be submitted to the network.
+     */
+    waitForTransactionConfirmation(transactionId: string, checkInterval?: number, // Poll every 2 seconds
+    timeout?: number): Promise<Transaction>;
 }
 export { AleoNetworkClient, AleoNetworkClientOptions, ProgramImports };

package/dist/testnet/node.js

@@ -1,7 +1,7 @@
 import './node-polyfill.js';
 export { Account, BlockHeightSearch, NetworkRecordProvider, OfflineKeyProvider, OfflineSearchParams, createAleoWorker, initializeWasm } from './browser.js';
-export { A as AleoKeyProvider, a as AleoKeyProviderParams, b as AleoNetworkClient, C as CREDITS_PROGRAM_KEYS, K as KEY_STORE, d as PRIVATE_TO_PUBLIC_TRANSFER, c as PRIVATE_TRANSFER, e as PRIVATE_TRANSFER_TYPES, h as PUBLIC_TO_PRIVATE_TRANSFER, f as PUBLIC_TRANSFER, g as PUBLIC_TRANSFER_AS_SIGNER, P as ProgramManager, V as VALID_TRANSFER_TYPES, l as logAndThrow } from './program-manager-DQZd0G79.js';
-export { Address, Ciphertext, ExecutionResponse, Field, Execution as FunctionExecution, Group, OfflineQuery, Plaintext, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager as ProgramManagerBase, ProvingKey, RecordCiphertext, RecordPlaintext, Scalar, Signature, Transaction, Transition, VerifyingKey, ViewKey, initThreadPool, verifyFunctionExecution } from '@provablehq/wasm/testnet.js';
+export { A as AleoKeyProvider, a as AleoKeyProviderParams, b as AleoNetworkClient, C as CREDITS_PROGRAM_KEYS, K as KEY_STORE, d as PRIVATE_TO_PUBLIC_TRANSFER, c as PRIVATE_TRANSFER, e as PRIVATE_TRANSFER_TYPES, h as PUBLIC_TO_PRIVATE_TRANSFER, f as PUBLIC_TRANSFER, g as PUBLIC_TRANSFER_AS_SIGNER, P as ProgramManager, V as VALID_TRANSFER_TYPES, l as logAndThrow } from './program-manager-B2GtLTAh.js';
+export { Address, Ciphertext, ComputeKey, ExecutionResponse, Field, Execution as FunctionExecution, Group, OfflineQuery, Plaintext, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager as ProgramManagerBase, ProvingKey, RecordCiphertext, RecordPlaintext, Scalar, Signature, Transaction, Transition, VerifyingKey, ViewKey, initThreadPool, verifyFunctionExecution } from '@provablehq/wasm/testnet.js';
 import 'core-js/proposals/json-parse-with-source.js';
 import 'node:crypto';
 import 'node:fs';

package/dist/testnet/{program-manager-DQZd0G79.js → program-manager-B2GtLTAh.js}

@@ -41,7 +41,8 @@ async function post(url, options) {
  * const localNetworkClient = new AleoNetworkClient("http://localhost:3030");
  *
  * // Connection to a public beacon node
- * const publicnetworkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+ * const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);
+ * const publicnetworkClient = new AleoNetworkClient("http://localhost:3030", undefined, account);
  */
 class AleoNetworkClient {
     host;
@@ -55,7 +56,7 @@ class AleoNetworkClient {
         else {
             this.headers = {
                 // This is replaced by the actual version by a Rollup plugin
-                "X-Aleo-SDK-Version": "0.8.2",
+                "X-Aleo-SDK-Version": "0.8.4",
             };
         }
     }
@@ -121,29 +122,28 @@ class AleoNetworkClient {
         }
     }
     /**
-     * Attempts to find unspent records in the Aleo blockchain for a specified private key.
+     * Attempt to find records in the Aleo blockchain.
+     *
      * @param {number} startHeight - The height at which to start searching for unspent records
      * @param {number} endHeight - The height at which to stop searching for unspent records
-     * @param {string | PrivateKey} privateKey - The private key to use to find unspent records
+     * @param {boolean} unspent - Whether to search for unspent records only
+     * @param {string[]} programs - The program(s) to search for unspent records in
      * @param {number[]} amounts - The amounts (in microcredits) to search for (eg. [100, 200, 3000])
      * @param {number} maxMicrocredits - The maximum number of microcredits to search for
      * @param {string[]} nonces - The nonces of already found records to exclude from the search
+     * @param {string | PrivateKey} privateKey - An optional private key to use to find unspent records.
      *
      * @example
-     * // Find all unspent records
-     * const privateKey = "[PRIVATE_KEY]";
-     * const records = networkClient.findUnspentRecords(0, undefined, privateKey);
-     *
      * // Find specific amounts
      * const startHeight = 500000;
      * const amounts = [600000, 1000000];
-     * const records = networkClient.findUnspentRecords(startHeight, undefined, privateKey, amounts);
+     * const records = networkClient.findRecords(startHeight, undefined, true, ["credits.aleo"] amounts);
      *
      * // Find specific amounts with a maximum number of cumulative microcredits
      * const maxMicrocredits = 100000;
-     * const records = networkClient.findUnspentRecords(startHeight, undefined, privateKey, undefined, maxMicrocredits);
+     * const records = networkClient.findRecords(startHeight, undefined, true, ["credits.aleo"] undefined, maxMicrocredits);
      */
-    async findUnspentRecords(startHeight, endHeight, privateKey, amounts, maxMicrocredits, nonces) {
+    async findRecords(startHeight, endHeight, unspent = false, programs, amounts, maxMicrocredits, nonces, privateKey) {
         nonces = nonces || [];
         // Ensure start height is not negative
         if (startHeight < 0) {
@@ -222,9 +222,11 @@ class AleoNetworkClient {
                                 if (transaction.execution && !(typeof transaction.execution.transitions == "undefined")) {
                                     for (let k = 0; k < transaction.execution.transitions.length; k++) {
                                         const transition = transaction.execution.transitions[k];
-                                        // Only search for unspent records in credits.aleo (for now)
-                                        if (transition.program !== "credits.aleo") {
-                                            continue;
+                                        // Only search for unspent records in the specified programs.
+                                        if (!(typeof programs === "undefined")) {
+                                            if (!programs.includes(transition.program)) {
+                                                continue;
+                                            }
                                         }
                                         if (!(typeof transition.outputs == "undefined")) {
                                             for (let l = 0; l < transition.outputs.length; l++) {
@@ -242,15 +244,35 @@ class AleoNetworkClient {
                                                             if (nonces.includes(nonce)) {
                                                                 continue;
                                                             }
-                                                            // Otherwise record the nonce that has been found
-                                                            const serialNumber = recordPlaintext.serialNumberString(resolvedPrivateKey, "credits.aleo", "credits");
-                                                            // Attempt to see if the serial number is spent
-                                                            try {
-                                                                await this.getTransitionId(serialNumber);
+                                                            if (unspent) {
+                                                                // Otherwise record the nonce that has been found
+                                                                const serialNumber = recordPlaintext.serialNumberString(resolvedPrivateKey, "credits.aleo", "credits");
+                                                                // Attempt to see if the serial number is spent
+                                                                try {
+                                                                    await this.getTransitionId(serialNumber);
+                                                                    continue;
+                                                                }
+                                                                catch (error) {
+                                                                    console.log("Found unspent record!");
+                                                                }
+                                                            }
+                                                            // Add the record to the list of records if the user did not specify amounts.
+                                                            if (!amounts) {
+                                                                records.push(recordPlaintext);
+                                                                // If the user specified a maximum number of microcredits, check if the search has found enough
+                                                                if (typeof maxMicrocredits === "number") {
+                                                                    totalRecordValue += recordPlaintext.microcredits();
+                                                                    // Exit if the search has found the amount specified
+                                                                    if (totalRecordValue >= BigInt(maxMicrocredits)) {
+                                                                        return records;
+                                                                    }
+                                                                }
                                                             }
-                                                            catch (error) {
-                                                                // If it's not found, add it to the list of unspent records
-                                                                if (!amounts) {
+                                                            // If the user specified a list of amounts, check if the search has found them
+                                                            if (!(typeof amounts === "undefined") && amounts.length > 0) {
+                                                                let amounts_found = 0;
+                                                                if (recordPlaintext.microcredits() > amounts[amounts_found]) {
+                                                                    amounts_found += 1;
                                                                     records.push(recordPlaintext);
                                                                     // If the user specified a maximum number of microcredits, check if the search has found enough
                                                                     if (typeof maxMicrocredits === "number") {
@@ -260,24 +282,8 @@ class AleoNetworkClient {
                                                                             return records;
                                                                         }
                                                                     }
-                                                                }
-                                                                // If the user specified a list of amounts, check if the search has found them
-                                                                if (!(typeof amounts === "undefined") && amounts.length > 0) {
-                                                                    let amounts_found = 0;
-                                                                    if (recordPlaintext.microcredits() > amounts[amounts_found]) {
-                                                                        amounts_found += 1;
-                                                                        records.push(recordPlaintext);
-                                                                        // If the user specified a maximum number of microcredits, check if the search has found enough
-                                                                        if (typeof maxMicrocredits === "number") {
-                                                                            totalRecordValue += recordPlaintext.microcredits();
-                                                                            // Exit if the search has found the amount specified
-                                                                            if (totalRecordValue >= BigInt(maxMicrocredits)) {
-                                                                                return records;
-                                                                            }
-                                                                        }
-                                                                        if (records.length >= amounts.length) {
-                                                                            return records;
-                                                                        }
+                                                                    if (records.length >= amounts.length) {
+                                                                        return records;
                                                                     }
                                                                 }
                                                             }
@@ -308,6 +314,31 @@ class AleoNetworkClient {
         }
         return records;
     }
+    /**
+     * Attempts to find unspent records in the Aleo blockchain.
+     *
+     * @param {number} startHeight - The height at which to start searching for unspent records
+     * @param {number} endHeight - The height at which to stop searching for unspent records
+     * @param {string[]} programs - The program(s) to search for unspent records in
+     * @param {number[]} amounts - The amounts (in microcredits) to search for (eg. [100, 200, 3000])
+     * @param {number} maxMicrocredits - The maximum number of microcredits to search for
+     * @param {string[]} nonces - The nonces of already found records to exclude from the search
+     * @param {string | PrivateKey} privateKey - An optional private key to use to find unspent records.
+     *
+     * @example
+     * // Find specific amounts
+     * const startHeight = 500000;
+     * const endHeight = 550000;
+     * const amounts = [600000, 1000000];
+     * const records = networkClient.findUnspentRecords(startHeight, endHeight, ["credits.aleo"], amounts);
+     *
+     * // Find specific amounts with a maximum number of cumulative microcredits
+     * const maxMicrocredits = 100000;
+     * const records = networkClient.findUnspentRecords(startHeight, undefined, ["credits.aleo"], undefined, maxMicrocredits);
+     */
+    async findUnspentRecords(startHeight, endHeight, programs, amounts, maxMicrocredits, nonces, privateKey) {
+        return await this.findRecords(startHeight, endHeight, true, programs, amounts, maxMicrocredits, nonces, privateKey);
+    }
     /**
      * Returns the contents of the block at the specified block height.
      *
@@ -380,7 +411,7 @@ class AleoNetworkClient {
      * @param {Program | string} program
      * @returns {TransactionJSON}
      */
-    async getDeploymentTransactioObjectnForProgram(program) {
+    async getDeploymentTransactionObjectForProgram(program) {
         try {
             const transaction_id = await this.getDeploymentTransactionIDForProgram(program);
             return await this.getTransactionObject(transaction_id);
@@ -557,7 +588,15 @@ class AleoNetworkClient {
      * @param {string} programId - The program ID to get the mappings of (e.g. "credits.aleo")
      * @example
      * const mappings = networkClient.getProgramMappingNames("credits.aleo");
-     * const expectedMappings = ["account"];
+     * const expectedMappings = [
+     *   "committee",
+     *   "delegated",
+     *   "metadata",
+     *   "bonded",
+     *   "unbonding",
+     *   "account",
+     *   "withdraw"
+     * ];
      * assert.deepStrictEqual(mappings, expectedMappings);
      */
     async getProgramMappingNames(programId) {
@@ -793,6 +832,32 @@ class AleoNetworkClient {
             throw new Error(`Error posting transaction: No response received: ${error.message}`);
         }
     }
+    /**
+     * Await a transaction to be confirmed on the Aleo network.
+     *
+     * @param {string} solution The string representation of the solution desired to be submitted to the network.
+     */
+    async waitForTransactionConfirmation(transactionId, checkInterval = 2000, // Poll every 2 seconds
+    timeout = 45000 // Timeout after 45 seconds
+    ) {
+        const startTime = Date.now();
+        return new Promise((resolve, reject) => {
+            const interval = setInterval(async () => {
+                try {
+                    // Replace with actual Aleo transaction lookup API
+                    const transaction = await this.getTransactionObject(transactionId);
+                    resolve(transaction);
+                    if (Date.now() - startTime > timeout) {
+                        clearInterval(interval);
+                        reject(new Error("Transaction confirmation timed out"));
+                    }
+                }
+                catch (error) {
+                    console.error("Error checking transaction:", error);
+                }
+            }, checkInterval);
+        });
+    }
 }
 
 const KEY_STORE = Metadata.baseUrl();
@@ -2366,4 +2431,4 @@ function validateTransferType(transferType) {
 }
 
 export { AleoKeyProvider as A, CREDITS_PROGRAM_KEYS as C, KEY_STORE as K, ProgramManager as P, VALID_TRANSFER_TYPES as V, AleoKeyProviderParams as a, AleoNetworkClient as b, PRIVATE_TRANSFER as c, PRIVATE_TO_PUBLIC_TRANSFER as d, PRIVATE_TRANSFER_TYPES as e, PUBLIC_TRANSFER as f, PUBLIC_TRANSFER_AS_SIGNER as g, PUBLIC_TO_PRIVATE_TRANSFER as h, logAndThrow as l };
-//# sourceMappingURL=program-manager-DQZd0G79.js.map
+//# sourceMappingURL=program-manager-B2GtLTAh.js.map