[Feature] RecordScanner client (#1100)

* added RecordScanner class as an implementation of the RecordProvider interface

* added unit tests for RecordScanner

* added RecordScanner tests for findRecords and findRecord

* added checkStatus method and its unit test to the RecordScanner object

* corrected url for RecordScanner status request

* [Feature] Domain separators (#1105)

* Create domain separator in function in wasm

* Give domain separator camelCase name

* Add Record Scanner domain separator to SDK constants

* added UUID computation to RecordScanner so theres no need to register each time a client spins up

* removed account field from RecordScanner

* added RecordScanner integration tests

* corrected outdated client ip for CI

* added .spec to record scanner integration test filename

---------

Co-authored-by: Mike Turner <[email protected]>

Author: alexpitsikoulis

create-leo-app/template-node/index.js

@@ -63,7 +63,7 @@ async function remoteProgramExecution(programName, functionName, inputs) {
     const keyProvider = new AleoKeyProvider();
     keyProvider.useCache(true);
 
-    const programManager = new ProgramManager("http://34.168.156.3:3030", keyProvider);
+    const programManager = new ProgramManager("http://34.169.215.4:3030", keyProvider);
 
     const tx = await programManager.buildExecutionTransaction(
         {

sdk/src/browser.ts

@@ -52,6 +52,7 @@ 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() {
@@ -126,6 +127,7 @@ export {
     PUBLIC_TRANSFER,
     PUBLIC_TRANSFER_AS_SIGNER,
     PUBLIC_TO_PRIVATE_TRANSFER,
+    RECORD_DOMAIN,
     VALID_TRANSFER_TYPES,
 } from "./constants.js";
 
@@ -177,6 +179,7 @@ export {
     RecordsFilter,
     RecordsResponseFilter,
     RecordProvider,
+    RecordScanner,
     RecordSearchParams,
     SolutionJSON,
     SolutionsJSON,

sdk/src/constants.ts

@@ -111,3 +111,5 @@ export const PUBLIC_TO_PRIVATE_TRANSFER = new Set([
     "transfer_public_to_private",
     "transferPublicToPrivate",
 ]);
+
+export const RECORD_DOMAIN = "RecordScannerV0";

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

@@ -5,6 +5,7 @@
  * @example
  * const recordsResponseFilter: RecordsResponseFilter = {
  *     block_height: true,
+ *     block_timestamp: true,
  *     checksum: true,
  *     commitment: true,
  *     record_ciphertext: true,
@@ -14,17 +15,20 @@
  *     owner: true,
  *     program_name: true,
  *     record_name: true,
+ *     sender_ciphertext: true,
  *     transaction_id: true,
  *     transition_id: true,
  *     transaction_index: true,
  *     transition_index: true,
  * }
  */
 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;

sdk/src/models/record-scanner/registrationResponse.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 

sdk/src/models/record-scanner/statusResponse.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;
+}