removed concrete record scanner impl

Author: alexpitsikoulis

sdk/src/browser.ts

@@ -27,7 +27,7 @@ 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-provider/recordsResponseFilter.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";
@@ -52,7 +52,6 @@ import {
     NetworkRecordProvider,
     RecordProvider,
 } from "./record-provider.js";
-import { RecordScanner } from "./record-scanner.js";
 
 // @TODO: This function is no longer needed, remove it.
 async function initializeWasm() {
@@ -178,7 +177,6 @@ export {
     RecordsFilter,
     RecordsResponseFilter,
     RecordProvider,
-    RecordScanner,
     RecordSearchParams,
     SolutionJSON,
     SolutionsJSON,

sdk/src/models/record-provider/encryptedRecord.ts

@@ -1,16 +1,18 @@
 /**
- * Encrypted Record found on chain. This type provides the record ciphertext and metadata from the ledger that such as the record's name, the program/function that produced it, etc.
+ * Encrypted Record found on chain. This type provides the record ciphertext and metadata from the ledger such as the record's name, the program/function that produced it, etc.
  * 
  * @property {string} commitment - The commitment of the record.
  * @property {string | undefined} checksum - The checksum of the record.
  * @property {number | undefined} block_height - The block height of the record.
+ * @property {number | undefined} block_timestamp - The block timestamp of the record.
  * @property {string | undefined} program_name - The name of the program that produced the record.
  * @property {string | undefined} function_name - The name of the function that produced the record.
  * @property {number | undefined} output_index - The output index of the record.
  * @property {string | undefined} owner - The owner of the record.
  * @property {string | undefined} record_ciphertext - The ciphertext of the record.
  * @property {string | undefined} record_name - The name of the record.
  * @property {string | undefined} record_nonce - The nonce of the record.
+ * @property {string | undefined} sender_ciphertext - The ciphertext of the sender.
  * @property {string | undefined} transaction_id - The ID of the transaction that produced the record.
  * @property {string | undefined} transition_id - The ID of the transition that produced the record.
  * @property {number | undefined} transaction_index - The index of the transaction that produced the record.
@@ -25,9 +27,10 @@
  *     function_name: "transfer_private",
  *     output_index: 0,
  *     owner: "ciphertext1qgqdetlfzk98jkm4e7sgqml66e3x2gpg5d6udkpw0g67z0tplkpmzrm6q5dyfd7xhgmhedvptxzwfhrtxaqn7n0hs0esge3lwg9s2zukqgzxd0cr",
- *     recordCiphertext: "record1qyqsqt43u9kp97svljyyup3v4jmppd0vgght9edvvmtxx6mxycsej8cwqsrxzmt0w4h8ggcqqgqspf8zqut2ycnap7f0uzz5ktu0cxscca96urtkg2aweuzn70787dsrpp6x76m9de0kjezrqqpqyqp3mn3xeh53lukvcy406amjf5g0ksl3saauzjk0j4ljtjqq6kqlqhdz05sw92zye96qym7kp83ra0eesgtwhaw37c85r499456se8ts28m90p6x2unwv9k97ct4w35x7unf0fshg6t0de0hyet3w45hyetyyvqqyqgq4t2wr9tmcrfha5tfz5j585ptvvslqe0f6sf29vytshhdh7ym05rpqct4w35x7unf0fjkghm4de6xjmprqqpqzqru6p7fef29vuz6smyqwcn3z7jhxtdgjdw5xv23ppxhpgnvu72fp8hz6fjt6gsdn8yxhzq7gpsah0rscwqrzxwl5e8aemkj5gt09y7q5506yrf",
+ *     record_ciphertext: "record1qyqsqt43u9kp97svljyyup3v4jmppd0vgght9edvvmtxx6mxycsej8cwqsrxzmt0w4h8ggcqqgqspf8zqut2ycnap7f0uzz5ktu0cxscca96urtkg2aweuzn70787dsrpp6x76m9de0kjezrqqpqyqp3mn3xeh53lukvcy406amjf5g0ksl3saauzjk0j4ljtjqq6kqlqhdz05sw92zye96qym7kp83ra0eesgtwhaw37c85r499456se8ts28m90p6x2unwv9k97ct4w35x7unf0fshg6t0de0hyet3w45hyetyyvqqyqgq4t2wr9tmcrfha5tfz5j585ptvvslqe0f6sf29vytshhdh7ym05rpqct4w35x7unf0fjkghm4de6xjmprqqpqzqru6p7fef29vuz6smyqwcn3z7jhxtdgjdw5xv23ppxhpgnvu72fp8hz6fjt6gsdn8yxhzq7gpsah0rscwqrzxwl5e8aemkj5gt09y7q5506yrf",
  *     record_name: "credits",
  *     record_nonce: "3077450429259593211617823051143573281856129402760267155982965992208217472983group",
+ *     sender_ciphertext: "1754131901135854615627743152473414463769543922079966020586765988138574911385field",
  *     transaction_id: "at1f8ueqxu3x49sckpc6jlg676tmxumddzer3fwe2l0dxwj4dqxygyqua4u2q",
  *     transition_id: "au17mm5v7sfwus6y40xsyc99d5rtsr4vsajdec6twdjzv0m458q85zspqdnka",
  *     transaction_index: 0,
@@ -38,6 +41,7 @@ export type EncryptedRecord = {
     commitment: string;
     checksum?: string;
     block_height?: number;
+    block_timestamp?: number;
     program_name?: string;
     function_name?: string;
     output_index?: number;

sdk/src/models/record-provider/ownedRecord.ts

@@ -1,5 +1,5 @@
 /**
- * Record owned by a registered view key. This type provides the record ciphertext, record plaintext and metadata from the ledger that such as the record's name, the program/function that produced it, etc.
+ * Record owned by a registered view key. This type provides the record ciphertext, record plaintext and metadata from the ledger such as the record's name, the program/function that produced it, etc.
  *
  * @property {number | undefined} block_height - Block height where the record was created.
  * @property {string | undefined} commitment - Commitment of the record.

sdk/src/models/record-scanner/ownedFilter.ts

@@ -1,6 +1,6 @@
 import { RecordSearchParams } from "../record-provider/recordSearchParams";
 import { RecordsFilter } from "./recordsFilter";
-import { RecordsResponseFilter } from "../record-provider/recordsResponseFilter";
+import { OwnedRecordsResponseFilter } from "./ownedRecordsResponseFilter";
 
 /**
  * OwnedFilter is an extension of RecordSearchParams that represents a filter for scanning owned records.
@@ -19,6 +19,6 @@ import { RecordsResponseFilter } from "../record-provider/recordsResponseFilter"
 export interface OwnedFilter extends RecordSearchParams {
     decrypt?: boolean;
     filter?: RecordsFilter;
-    responseFilter?: RecordsResponseFilter;
+    responseFilter?: OwnedRecordsResponseFilter;
     uuid?: string;
 }

sdk/src/models/record-scanner/ownedRecordsResponseFilter.ts

@@ -0,0 +1,42 @@
+/**
+ * OwnedRecordsResponseFilter is a type that represents a filter for the response from a record provider.
+ * A `true` value for a field in the filter will include that field in the response.
+ * 
+ * @example
+ * const ownedRecordsResponseFilter: OwnedRecordsResponseFilter = {
+ *     commitment: true,
+ *     owner: true,
+ *     tag: true,
+ *     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,
+ * }
+ */
+export interface OwnedRecordsResponseFilter {
+    commitment?: boolean;
+    owner?: boolean;
+    tag?: boolean;
+    sender?: boolean;
+    spent?: boolean;
+    record_ciphertext?: boolean;
+    block_height?: boolean;
+    block_timestamp?: boolean;
+    output_index?: boolean;
+    record_name?: boolean;
+    function_name?: boolean;
+    program_name?: boolean;
+    transition_id?: boolean;
+    transaction_id?: boolean;
+    transaction_index?: boolean;
+    transition_index?: boolean;
+}

sdk/src/models/record-scanner/recordsFilter.ts

@@ -1,5 +1,5 @@
 import { RecordSearchParams } from "../record-provider/recordSearchParams";
-import { RecordsResponseFilter } from "../record-provider/recordsResponseFilter";
+import { RecordsResponseFilter } from "./recordsResponseFilter";
 
 /**
  * RecordsFilter is an extension of RecordSearchParams that represents a filter for scanning encrypted or owned records.

sdk/src/models/record-provider/recordsResponseFilter.ts renamed to sdk/src/models/record-scanner/recordsResponseFilter.ts

@@ -0,0 +1,15 @@
+/**
+ * RegistrationResponse is a type that represents a response from a record scanning service.
+ * 
+ * @example
+ * const registrationResponse: RegistrationResponse = {
+ *     uuid: "5291249998620209321712738612705518874926462927543783711572375085855029172391field",
+ *     job_id: "3019177021147406178755252788128212930359855601860174268911518336835545087409field",
+ *     status: "pending",
+ * }
+ */
+interface RegistrationResponse {
+    uuid: string,
+    job_id?: string,
+    status?: string 
+ }

sdk/src/models/record-scanner/registrationResponse.ts

@@ -4,7 +4,7 @@ import { EncryptedRecord } from "./models/record-provider/encryptedRecord.js";
 import { logAndThrow } from "./utils.js";
 import { OwnedRecord } from "./models/record-provider/ownedRecord.js";
 import { RecordSearchParams } from "./models/record-provider/recordSearchParams.js";
-import { RecordsResponseFilter } from "./models/record-provider/recordsResponseFilter.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
@@ -25,26 +25,26 @@ interface RecordProvider {
      * @param {RecordsResponseFilter} responseFilter The filter used to filter the response.
      * @returns {Promise<EncryptedRecord[]>} The encrypted records.
     */
-    encryptedRecords(recordsFilter: RecordSearchParams, responseFilter: RecordsResponseFilter): Promise<EncryptedRecord[]>;
+    encryptedRecords(recordsFilter: RecordSearchParams, responseFilter?: RecordsResponseFilter): Promise<EncryptedRecord[]>;
 
     /**
-     * Check if a list of serial numbers exist in the chosen provider
+     * Check if a list of serial numbers exist in the chosen provider.
      *
      * @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
+     * 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
+     * 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.
@@ -383,7 +383,7 @@ class NetworkRecordProvider implements RecordProvider {
         }));
     }
 
-    async encryptedRecords(recordsFilter: RecordSearchParams, responseFilter: RecordsResponseFilter): Promise<EncryptedRecord[]> {
+    async encryptedRecords(recordsFilter: RecordSearchParams, responseFilter?: RecordsResponseFilter): Promise<EncryptedRecord[]> {
         throw new Error("Not implemented");
     }