@provablehq/sdk 0.9.9 → 0.9.10-testnet-rc

package/dist/testnet/constants.d.ts

@@ -32,3 +32,4 @@ export declare const PRIVATE_TO_PUBLIC_TRANSFER: Set<string>;
 export declare const PUBLIC_TRANSFER: Set<string>;
 export declare const PUBLIC_TRANSFER_AS_SIGNER: Set<string>;
 export declare const PUBLIC_TO_PRIVATE_TRANSFER: Set<string>;
+export declare const RECORD_DOMAIN = "RecordScannerV0";

package/dist/testnet/function-key-provider.d.ts

@@ -146,6 +146,12 @@ interface FunctionKeyProvider {
      * @returns {Promise<FunctionKeyPair>} Proving and verifying keys for the join function
      */
     feePublicKeys(): Promise<FunctionKeyPair>;
+    /**
+     * Get keys for the inclusion proof.
+     *
+     * @returns {Promise<FunctionKeyPair>} Proving and verifying keys for the join function
+     */
+    inclusionKeys(): Promise<FunctionKeyPair>;
     /**
      * Get join function keys from the credits.aleo program
      *
@@ -314,6 +320,18 @@ declare class AleoKeyProvider implements FunctionKeyProvider {
      * const [transferPublicProvingKey, transferPublicVerifyingKey] = await keyProvider.transferKeys("public");
      */
     transferKeys(visibility: string): Promise<FunctionKeyPair>;
+    /**
+     * Returns the proving and verifying keys for the transfer_public function.
+     *
+     * @returns {Promise<FunctionKeyPair>} Proving and verifying keys for the transfer_public function
+     */
+    transferPublicKeys(): Promise<FunctionKeyPair>;
+    /**
+     * Returns the proving and verifying keys for the inclusion proof.
+     *
+     * @returns {Promise<FunctionKeyPair>} Proving and verifying keys for the inclusion proof.
+     */
+    inclusionKeys(): Promise<FunctionKeyPair>;
     /**
      * Returns the proving and verifying keys for the join function in the credits.aleo program
      *

package/dist/testnet/models/record-scanner/recordsResponseFilter.d.ts

@@ -5,6 +5,7 @@
  * @example
  * const recordsResponseFilter: RecordsResponseFilter = {
  *     block_height: true,
+ *     block_timestamp: true,
  *     checksum: true,
  *     commitment: true,
  *     record_ciphertext: true,
@@ -14,6 +15,7 @@
  *     owner: true,
  *     program_name: true,
  *     record_name: true,
+ *     sender_ciphertext: true,
  *     transaction_id: true,
  *     transition_id: true,
  *     transaction_index: true,
@@ -21,10 +23,12 @@
  * }
  */
 export type RecordsResponseFilter = {
-    blockHeight?: boolean;
+    block_height?: boolean;
+    block_timestamp?: boolean;
     checksum?: boolean;
     commitment?: boolean;
     record_ciphertext?: boolean;
+    sender_ciphertext?: boolean;
     function_name?: boolean;
     nonce?: boolean;
     output_index?: boolean;

package/dist/testnet/models/record-scanner/registrationResponse.d.ts

@@ -1,5 +1,5 @@
 /**
- * RegistrationResponse is a type that represents a response from a record scanning service.
+ * RegistrationResponse is a type that represents a response from a record scanning service's registration endpoint.
  *
  * @example
  * const registrationResponse: RegistrationResponse = {
@@ -8,7 +8,7 @@
  *     status: "pending",
  * }
  */
-interface RegistrationResponse {
+export interface RegistrationResponse {
     uuid: string;
     job_id?: string;
     status?: string;

package/dist/testnet/models/record-scanner/statusResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * StatusResponse is a type that represents a response from a record scanning service's status endpoint.
+ *
+ * @example
+ * const statusResponse: StatusResponse = {
+ *     synced: true,
+ *     percentage: 100,
+ * }
+ */
+export interface StatusResponse {
+    synced: boolean;
+    percentage: number;
+}

package/dist/testnet/node.js

@@ -1,6 +1,6 @@
 import './node-polyfill.js';
-export { Account, AleoKeyProvider, AleoKeyProviderParams, AleoNetworkClient, BlockHeightSearch, CREDITS_PROGRAM_KEYS, KEY_STORE, NetworkRecordProvider, OfflineKeyProvider, OfflineSearchParams, PRIVATE_TO_PUBLIC_TRANSFER, PRIVATE_TRANSFER, PRIVATE_TRANSFER_TYPES, PUBLIC_TO_PRIVATE_TRANSFER, PUBLIC_TRANSFER, PUBLIC_TRANSFER_AS_SIGNER, ProgramManager, VALID_TRANSFER_TYPES, initializeWasm, logAndThrow } from './browser.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/testnet.js';
+export { Account, AleoKeyProvider, AleoKeyProviderParams, AleoNetworkClient, BlockHeightSearch, CREDITS_PROGRAM_KEYS, KEY_STORE, NetworkRecordProvider, OfflineKeyProvider, OfflineSearchParams, PRIVATE_TO_PUBLIC_TRANSFER, PRIVATE_TRANSFER, PRIVATE_TRANSFER_TYPES, PUBLIC_TO_PRIVATE_TRANSFER, PUBLIC_TRANSFER, PUBLIC_TRANSFER_AS_SIGNER, ProgramManager, RECORD_DOMAIN, RecordScanner, VALID_TRANSFER_TYPES, initializeWasm, logAndThrow } from './browser.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, getOrInitConsensusVersionTestHeights, 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/offline-key-provider.d.ts

@@ -212,6 +212,12 @@ declare class OfflineKeyProvider implements FunctionKeyProvider {
      * @returns {Promise<FunctionKeyPair>} Proving and verifying keys for the join function
      */
     feePublicKeys(): Promise<FunctionKeyPair>;
+    /**
+     * Get the inclusion prover keys from. The keys must be cached prior to calling this method for it to work.
+     *
+     * @returns {Promise<FunctionKeyPair>} Proving and verifying keys for the inclusion prover
+     */
+    inclusionKeys(): Promise<FunctionKeyPair>;
     /**
      * Get join function keys from the credits.aleo program. The keys must be cached prior to calling this
      * method for it to work.
@@ -287,6 +293,14 @@ declare class OfflineKeyProvider implements FunctionKeyProvider {
      * @param provingKey
      */
     insertFeePublicKeys(provingKey: ProvingKey): void;
+    /**
+     * Insert the proving and verifying keys for the inclusion prover into the cache. Only the proving key needs
+     * to be inserted, the verifying key is automatically inserted by the SDK. This function will automatically check
+     * that the keys match the expected checksum for the inclusion prover.
+     *
+     * @param provingKey
+     */
+    insertInclusionKeys(provingKey: ProvingKey): void;
     /**
      * Insert the proving and verifying keys for the join function into the cache. Only the proving key needs
      * to be inserted, the verifying key is automatically inserted by the SDK. This function will automatically check

package/dist/testnet/program-manager.d.ts

@@ -120,6 +120,7 @@ declare class ProgramManager {
     host: string;
     networkClient: AleoNetworkClient;
     recordProvider: RecordProvider | undefined;
+    inclusionKeysLoaded: boolean;
     /** Create a new instance of the ProgramManager
      *
      * @param { string | undefined } host A host uri running the official Aleo API
@@ -1068,6 +1069,15 @@ declare class ProgramManager {
      * assert(isValid);
      */
     verifyExecution(executionResponse: ExecutionResponse, blockHeight: number, imports?: ImportedPrograms, importedVerifyingKeys?: ImportedVerifyingKeys): boolean;
+    /**
+     * Set the inclusion key bytes.
+     *
+     * @param {executionResponse} executionResponse The response from an offline function execution (via the `programManager.run` method)
+     * @param {ImportedPrograms} imports The imported programs used in the execution. Specified as { "programName": "programSourceCode", ... }
+     * @param {ImportedVerifyingKeys} importedVerifyingKeys The verifying keys in the execution. Specified as { "programName": [["functionName", "verifyingKey"], ...], ... }
+     * @returns {boolean} True if the proof is valid, false otherwise
+     *
+
     /**
      * Create a program object from a program's source code
      *

package/dist/testnet/record-scanner.d.ts

@@ -0,0 +1,151 @@
+import { EncryptedRecord } from "./models/record-provider/encryptedRecord";
+import { OwnedFilter } from "./models/record-scanner/ownedFilter";
+import { OwnedRecord } from "./models/record-provider/ownedRecord";
+import { RecordProvider } from "./record-provider";
+import { Field, ViewKey } from "./wasm";
+import { RecordsFilter } from "./models/record-scanner/recordsFilter";
+import { RegistrationResponse } from "./models/record-scanner/registrationResponse";
+import { StatusResponse } from "./models/record-scanner/statusResponse";
+type RecordScannerOptions = {
+    url: string;
+    apiKey?: string | {
+        header: string;
+        value: string;
+    };
+};
+/**
+ * RecordScanner is a RecordProvider implementation that uses the record scanner service to find records.
+ *
+ * @example
+ * const account = new Account({ privateKey: 'APrivateKey1...' });
+ *
+ * const recordScanner = new RecordScanner({ url: "https://record-scanner.aleo.org" });
+ * recordScanner.setAccount(account);
+ * recordScanner.setApiKey("your-api-key");
+ * const uuid = await recordScanner.register(0);
+ *
+ * const filter = {
+ *     uuid,
+ *     filter: {
+ *         program: "credits.aleo",
+ *         records: ["credits"],
+ *     },
+ *     responseFilter: {
+ *         commitment: true,
+ *         owner: true,
+ *         tag: true,
+ *         tag?: boolean;
+ *         sender: true,
+ *         spent: true,
+ *         record_ciphertext: true,
+ *         block_height: true;
+ *         block_timestamp: true;
+ *         output_index: true;
+ *         record_name: true;
+ *         function_name: true;
+ *         program_name: true;
+ *         transition_id: true;
+ *         transaction_id: true;
+ *         transaction_index: true;
+ *         transition_index: true;
+ *     },
+ *     unspent: true,
+ * };
+ *
+ * const records = await recordScanner.findRecords(filter);
+ */
+declare class RecordScanner implements RecordProvider {
+    readonly url: string;
+    private apiKey?;
+    private uuid?;
+    constructor(options: RecordScannerOptions);
+    /**
+     * Set the API key to use for the record scanner.
+     *
+     * @param {string} apiKey The API key to use for the record scanner.
+     */
+    setApiKey(apiKey: string | {
+        header: string;
+        value: string;
+    }): Promise<void>;
+    /**
+     * Set the UUID to use for the record scanner.
+     *
+     * @param {Field} uuid The UUID to use for the record scanner.
+     */
+    setUuid(uuidOrViewKey: Field | ViewKey): Promise<void>;
+    /**
+     * Register the account with the record scanner service.
+     *
+     * @param {number} startBlock The block height to start scanning from.
+     * @returns {Promise<RegistrationResponse>} The response from the record scanner service.
+     */
+    register(viewKey: ViewKey, startBlock: number): Promise<RegistrationResponse>;
+    /**
+     * Get encrypted records from the record scanner service.
+     *
+     * @param {RecordsFilter} recordsFilter The filter to use to find the records and filter the response.
+     * @returns {Promise<EncryptedRecord[]>} The encrypted records.
+     */
+    encryptedRecords(recordsFilter: RecordsFilter): Promise<EncryptedRecord[]>;
+    /**
+     * Check if a list of serial numbers exist in the record scanner service.
+     *
+     * @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 record scanner service.
+     *
+     * @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>>;
+    /**
+     * Check the status of a record scanner indexing job.
+     *
+     * @param {string} jobId The job id to check.
+     * @returns {Promise<StatusResponse>} The status of the job.
+     */
+    checkStatus(): Promise<StatusResponse>;
+    /**
+     * Find a record in the record scanner service.
+     *
+     * @param {OwnedFilter} searchParameters The filter to use to find the record.
+     * @returns {Promise<OwnedRecord>} The record.
+     */
+    findRecord(searchParameters: OwnedFilter): Promise<OwnedRecord>;
+    /**
+     * Find records in the record scanner service.
+     *
+     * @param {OwnedFilter} filter The filter to use to find the records.
+     * @returns {Promise<OwnedRecord[]>} The records.
+     */
+    findRecords(filter: OwnedFilter): Promise<OwnedRecord[]>;
+    /**
+     * Find a credits record in the record scanner service.
+     *
+     * @param {number} microcredits The amount of microcredits to find.
+     * @param {OwnedFilter} searchParameters The filter to use to find the record.
+     * @returns {Promise<OwnedRecord>} The record.
+     */
+    findCreditsRecord(microcredits: number, searchParameters: OwnedFilter): Promise<OwnedRecord>;
+    /**
+     * Find credits records using a record scanning service.
+     *
+     * @param {number[]} microcreditAmounts The amounts of microcredits to find.
+     * @param {OwnedFilter} searchParameters The filter to use to find the records.
+     * @returns {Promise<OwnedRecord[]>} The records
+     */
+    findCreditsRecords(microcreditAmounts: number[], searchParameters: OwnedFilter): Promise<OwnedRecord[]>;
+    /**
+     * Wrapper function to make a request to the record scanner service and handle any errors.
+     *
+     * @param {Request} req The request to make.
+     * @returns {Promise<Response>} The response.
+     */
+    private request;
+    computeUUID(vk: ViewKey): Field;
+}
+export { RecordScanner };

package/dist/testnet/wasm.d.ts

@@ -1 +1 @@
-export { Address, Authorization, Boolean, BHP256, BHP512, BHP768, BHP1024, Ciphertext, ComputeKey, EncryptionToolkit, ExecutionRequest, Execution, ExecutionResponse, Field, GraphKey, Group, I8, I16, I32, I64, I128, OfflineQuery, Metadata, Pedersen64, Pedersen128, Plaintext, Poseidon2, Poseidon4, Poseidon8, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager, ProvingKey, ProvingRequest, RecordCiphertext, RecordPlaintext, Scalar, Signature, Transaction, Transition, U8, U16, U32, U64, U128, VerifyingKey, ViewKey, initThreadPool, verifyFunctionExecution, } from "@provablehq/wasm/testnet.js";
+export { Address, Authorization, Boolean, BHP256, BHP512, BHP768, BHP1024, Ciphertext, ComputeKey, EncryptionToolkit, ExecutionRequest, Execution, ExecutionResponse, Field, GraphKey, Group, I8, I16, I32, I64, I128, OfflineQuery, Metadata, Pedersen64, Pedersen128, Plaintext, Poseidon2, Poseidon4, Poseidon8, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager, ProvingKey, ProvingRequest, RecordCiphertext, RecordPlaintext, Scalar, Signature, Transaction, Transition, U8, U16, U32, U64, U128, VerifyingKey, ViewKey, initThreadPool, getOrInitConsensusVersionTestHeights, verifyFunctionExecution, } from "@provablehq/wasm/testnet.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@provablehq/sdk",
-  "version": "0.9.9",
+  "version": "0.9.10-testnet-rc",
   "description": "A Software Development Kit (SDK) for Zero-Knowledge Transactions",
   "collaborators": [
     "The Provable Team"
@@ -30,7 +30,7 @@
   ],
   "scripts": {
     "build": "rimraf dist && rollup -c rollup.config.js",
-    "test": "rimraf tmp && rollup -c rollup.test.js && mocha tmp/**/*.test.js --timeout 60000"
+    "test": "rimraf tmp && rollup -c rollup.test.js && mocha tmp/**/*.test.js --timeout 60000 && RUN_SKIPPED=true mocha tmp/**/wasm.test.js --timeout 60000 --grep Consensus"
   },
   "repository": {
     "type": "git",
@@ -47,7 +47,7 @@
   },
   "homepage": "https://github.com/ProvableHQ/sdk#readme",
   "dependencies": {
-    "@provablehq/wasm": "^0.9.9",
+    "@provablehq/wasm": "^0.9.10-testnet-rc",
     "comlink": "^4.4.2",
     "core-js": "^3.40.0",
     "mime": "^4.0.6",