test: update tests

iluxonchik · Dec 10, 2023 · 3df8b7a · 3df8b7a
1 parent 102e72b
commit 3df8b7a
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 6 deletions.
diff --git a/contracts/src/tests/api/ZKCoordinates.test.ts b/contracts/src/tests/api/ZKCoordinates.test.ts
@@ -1,4 +1,4 @@
-import { ZKCoordinate, ZKLatitude, ZKLongitude } from "../../api/api";
+import { ZKCoordinate, ZKLatitude, ZKLongitude } from "../../api/Models";
 
 describe('ZKCoordinate, ZKLatitude, and ZKLongitude Tests', () => {
     it('testZKCoordinateWithValidNumber', () => {
@@ -33,4 +33,23 @@ describe('ZKCoordinate, ZKLatitude, and ZKLongitude Tests', () => {
         const value = -190; // Invalid longitude value
         expect(() => new ZKLongitude(value)).toThrow();
     });
-});
+});/*
+    This contains the API for zkLocus. The API is designed to abstract away the underlying zero-knowledge circutiry logic, and focus
+    on providing a clear, concise and intuitive API for the end user. The API is designed adehering to the vision of zkLocus of allowing
+    for the sharing of optionally private geolocation data, that is extendable, customizable, and interoperable across the varioius
+    computational environments, such as blockchain (on-chain), off-chain, mobile, web and IoT.
+
+    The API's design levarages the recursive zkSNARKs architecture o zkLocus to its fullest extent. As such, the proofs are
+    naturally recursive and combinable with one another, just like in the low-level zkLocus API.
+
+    This API is designed specifically for TypeScript, and it's inspired by APIs in the Python ecosystem such as BeautifulSoup, where powerful
+    and complex functionality is abstracted away from the user, while exposing a clear and concise interface to the end user.
+*/
+// Utility Types
+export type numberType = number | string; // Represents the number type
+// Named Tuple Equivalent in TypeScript
+export interface RawCoordinates {
+    latitude: numberType;
+    longitude: numberType;
+}
+
diff --git a/contracts/src/tests/api/ZKGeoPoint.test.ts b/contracts/src/tests/api/ZKGeoPoint.test.ts
@@ -1,5 +1,4 @@
-import { Int64 } from "o1js";
-import { ZKGeoPoint, ZKLatitude, ZKLongitude } from "../../api/api";
+import { ZKGeoPoint, ZKLatitude, ZKLongitude } from "../../api/Models";
 import { GeoPoint } from "../../model/Geography";
 
 describe('ZKGeoPoint Class Tests', () => {

diff --git a/contracts/src/tests/api/ZKNumber.test.ts b/contracts/src/tests/api/ZKNumber.test.ts
@@ -1,5 +1,5 @@
 import { Int64 } from "o1js";
-import { ZKNumber } from "../../api/api";
+import { ZKNumber } from "../../api/Models";
 
 describe('ZKNumber Class Tests', () => {
     it('testZKNumberConstructionWithValueTypeNumber', () => {
@@ -34,3 +34,4 @@ describe('ZKNumber Class Tests', () => {
         expect(zkNumber.toZKValue()).toEqual(Int64.from(Math.round(value)));
     });
 });
+
diff --git a/contracts/src/tests/api/ZKThreePointPolygon.test.ts b/contracts/src/tests/api/ZKThreePointPolygon.test.ts
@@ -1,4 +1,5 @@
-import { ZKThreePointPolygon, ZKGeoPoint, ZKLatitude, ZKLongitude, RawCoordinates } from "../../api/api";
+import { RawCoordinates } from "../../api/Types";
+import { ZKThreePointPolygon, ZKGeoPoint, ZKLatitude, ZKLongitude } from "../../api/Models";
 import { ThreePointPolygon } from "../../model/Geography";
 
 describe('ZKThreePointPolygon Class Tests', () => {