Cowswap 332/quote metadata (#22)

* Added quote metadata types * Added quote metadata to json schema * Added unit tests validating quote metadata * Reformated file with prettier (did not have it setup before) * Bumping default app version to 0.2.0
cowprotocol · May 25, 2022 · 47527e5 · 47527e5
1 parent 78cb266
commit 47527e5
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 6 deletions.
diff --git a/src/api/metadata/index.ts b/src/api/metadata/index.ts
@@ -6,7 +6,7 @@ import { AppDataDoc, MetadataDoc } from './types'
 import { CowError } from '../../utils/common'
 
 const DEFAULT_APP_CODE = 'CowSwap'
-const DEFAULT_APP_VERSION = '0.1.0'
+const DEFAULT_APP_VERSION = '0.2.0'
 
 export class MetadataApi {
   context: Context

diff --git a/src/api/metadata/metadata.spec.ts b/src/api/metadata/metadata.spec.ts
@@ -12,7 +12,7 @@ const HTTP_STATUS_OK = 200
 const HTTP_STATUS_INTERNAL_ERROR = 500
 
 const DEFAULT_APP_DATA_DOC = {
-  version: '0.1.0',
+  version: '0.2.0',
   appCode: 'CowSwap',
   metadata: {},
 }

diff --git a/src/api/metadata/types.ts b/src/api/metadata/types.ts
@@ -6,8 +6,15 @@ export interface ReferralMetadata extends Metadata {
   address: string
 }
 
+export interface QuoteMetadata extends Metadata {
+  id?: string
+  sellAmount: string
+  buyAmount: string
+}
+
 export type MetadataDoc = {
   referrer?: ReferralMetadata
+  quote?: QuoteMetadata
 }
 
 export type AppDataDoc = {

diff --git a/src/schemas/appData.schema.json b/src/schemas/appData.schema.json
@@ -30,6 +30,9 @@
       "properties": {
         "referrer": {
           "$ref": "#/definitions/kindMetadata/referrer"
+        },
+        "quote": {
+          "$ref": "#/definitions/kindMetadata/quote"
         }
       }
     }
@@ -49,6 +52,13 @@
       "examples": ["0xb6BAd41ae76A11D10f7b0E664C5007b908bC77C9"],
       "type": "string"
     },
+    "bigNumber": {
+      "$id": "#/definitions/bigNumber",
+      "pattern": "\\d+",
+      "title": "BigNumber",
+      "examples": ["90741097240912730913, 0, 75891372"],
+      "type": "string"
+    },
     "kindMetadata": {
       "referrer": {
         "$id": "#/definitions/referrer",
@@ -64,6 +74,28 @@
             "title": "Referrer address"
           }
         }
+      },
+      "quote": {
+        "$id": "#/definitions/quote",
+        "required": ["sellAmount", "buyAmount"],
+        "title": "Quote",
+        "type": "object",
+        "properties": {
+          "id": {
+            "$id": "#/definitions/quote/id",
+            "title": "Quote id",
+            "examples": ["XA23443543534FF"],
+            "type": "string"
+          },
+          "sellAmount": {
+            "$ref": "#/definitions/bigNumber",
+            "title": "Quote sell amount"
+          },
+          "buyAmount": {
+            "$ref": "#/definitions/bigNumber",
+            "title": "Quote buy amount"
+          }
+        }
       }
     }
   }

diff --git a/src/utils/appData.spec.ts b/src/utils/appData.spec.ts
@@ -5,17 +5,19 @@ const VALID_RESULT = {
   result: true,
 }
 
+const BASE_DOCUMENT = {
+  version: '0.1.0',
+  metadata: {},
+}
+
 const INVALID_CID_LENGTH = 'Incorrect length'
 
 beforeEach(() => {
   fetchMock.dontMock()
 })
 
 test('Valid minimal document', async () => {
-  const validation = await validateAppDataDocument({
-    version: '0.1.0',
-    metadata: {},
-  })
+  const validation = await validateAppDataDocument(BASE_DOCUMENT)
   expect(validation).toEqual(VALID_RESULT)
 })
 
@@ -112,3 +114,31 @@ test('Valid IPFS appData from CID', async () => {
 
   expect(validation).toEqual(VALID_RESULT)
 })
+
+test('Valid: quote metadata - minimal', async () => {
+  const document = { ...BASE_DOCUMENT, metadata: { quote: { sellAmount: '1', buyAmount: '1' } } }
+  const validation = await validateAppDataDocument(document)
+
+  expect(validation).toEqual(VALID_RESULT)
+})
+
+test('Valid: quote metadata - with all fields', async () => {
+  const document = { ...BASE_DOCUMENT, metadata: { quote: { sellAmount: '1', buyAmount: '1', id: 'S09D8ZFAX' } } }
+  const validation = await validateAppDataDocument(document)
+
+  expect(validation).toEqual(VALID_RESULT)
+})
+
+test('Invalid: quote metadata - missing fields', async () => {
+  const document = { ...BASE_DOCUMENT, metadata: { quote: {} } }
+  const validation = await validateAppDataDocument(document)
+
+  expect(validation.result).toBeFalsy()
+})
+
+test('Invalid: quote metadata - wrong type', async () => {
+  const document = { ...BASE_DOCUMENT, metadata: { quote: { sellAmount: 312, buyAmount: '0xbab3' } } }
+  const validation = await validateAppDataDocument(document)
+
+  expect(validation.result).toBeFalsy()
+})