updated encryptedRecords function to mirror changes made to the endpoint in RSS

Author: alexpitsikoulis

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

@@ -4,23 +4,35 @@
  * 
  * @example
  * const recordsResponseFilter: RecordsResponseFilter = {
- *     program: true,
- *     record: true,
- *     function: true,
- *     transition: true,
- *     blockHeight: true,
+ *     block_height: true,
+ *     checksum: true,
+ *     commitment: true,
+ *     record_ciphertext: true,
+ *     function_name: true,
+ *     nonce: true,
+ *     output_index: true,
+ *     owner: true,
+ *     program_name: true,
+ *     record_name: true,
  *     transaction_id: true,
  *     transition_id: true,
- *     ioIndex: true,
+ *     transaction_index: true,
+ *     transition_index: true,
  * }
  */
 export type RecordsResponseFilter = {
-    program: boolean;
-    record: boolean;
-    function: boolean;
-    transition: boolean;
-    blockHeight: boolean;
-    transaction_id: boolean;
-    transition_id: boolean;
-    ioIndex: boolean;
+    blockHeight?: boolean;
+    checksum?: boolean;
+    commitment?: boolean;
+    record_ciphertext?: boolean;
+    function_name?: boolean;
+    nonce?: boolean;
+    output_index?: boolean;
+    owner?: boolean;
+    program_name?: boolean;
+    record_name?: boolean;
+    transaction_id?: boolean;
+    transition_id?: boolean;
+    transaction_index?: boolean;
+    transition_index?: boolean;
 }

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

@@ -24,12 +24,13 @@ import { RecordsResponseFilter } from "../record-provider/recordsResponseFilter"
  * }
  */
 export interface RecordsFilter extends RecordSearchParams {
-    start: number;
+    commitments?: string[];
+    response?: RecordsResponseFilter;
+    start?: number;
     end?: number;
     program?: string;
     records?: string[];
     functions?: string[];
     results_per_page?: number;
     page?: number;
-    response?: RecordsResponseFilter;
 }

sdk/src/record-scanner.ts

@@ -17,25 +17,26 @@ import { RegistrationRequest } from "./models/record-scanner/registrationRequest
  * 
  * const recordScanner = new RecordScanner("https://record-scanner.aleo.org");
  * recordScanner.setAccount(account);
- * await recordScanner.register(0);
+ * const uuid = await recordScanner.register(0);
  * 
  * const filter = {
- *     start: 0,
- *     end: 100,
- *     program: "credits.aleo",
- *     records: ["credits"],
+ *     uuid,
+ *     filter: {
+ *         program: "credits.aleo",
+ *         records: ["credits"],
+ *     },
+ *     responseFilter: {
+ *         program: true,
+ *         record: true,
+ *         function: true,
+ *         transition: true,
+ *         block_height: true,
+ *         transaction_id: true,
+ *     },
+ *     unspent: true,
  * };
  * 
- * const responseFilter = {
- *     program: true,
- *     record: true,
- *     function: true,
- *     transition: true,
- *     block_height: true,
- *     transaction_id: true,
- * };
- * 
- * const records = await recordScanner.findRecords({ filter, responseFilter });
+ * const records = await recordScanner.findRecords(filter);
  */
 class RecordScanner implements RecordProvider {
     account?: Account;
@@ -94,16 +95,16 @@ class RecordScanner implements RecordProvider {
     /**
      * Get encrypted records from the record scanner service.
      * 
-     * @param {RecordsFilter} recordsFilter The filter to use to find the records.
-     * @param {RecordsResponseFilter} responseFilter The filter to use to filter the response.
+     * @param {RecordsFilter} recordsFilter The filter to use to find the records and filter the response.
      * @returns {Promise<EncryptedRecord[]>} The encrypted records.
      */
-    async encryptedRecords(recordsFilter: RecordsFilter, responseFilter: RecordsResponseFilter): Promise<EncryptedRecord[]> {
+    async encryptedRecords(recordsFilter: RecordsFilter): Promise<EncryptedRecord[]> {
         try {
             const response = await this.request(
-                new Request(`${this.url}/records/encrypted?${this.buildQueryString(recordsFilter, responseFilter)}`, {
-                    method: "GET",
+                new Request(`${this.url}/records/encrypted`, {
+                    method: "POST",
                     headers: { "Content-Type": "application/json" },
+                    body: JSON.stringify(recordsFilter),
                 }),
             );