use format keyword for timestamp and uri

baselm · Jun 12, 2020 · 0f6d7e1 · 0f6d7e1
1 parent b978e17
commit 0f6d7e1
Show file tree

Hide file tree

Showing 13 changed files with 141 additions and 32 deletions.
diff --git a/src/tokenlist.schema.json b/src/tokenlist.schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://uniswap.org/tokenlist.schema.json",
-  "title": "Uniswap Token Lists",
+  "title": "Uniswap Token List",
   "description": "Schema for lists of tokens compatible with the Uniswap Interface",
   "$ref": "#/definitions/TokenList",
   "definitions": {
@@ -73,7 +73,7 @@
         },
         "address": {
           "type": "string",
-          "description": "The address of the token on the given chain ID",
+          "description": "The address of the token on the specified chain ID",
           "pattern": "^0x[a-fA-F0-9]{40}$"
         },
         "decimals": {
@@ -96,10 +96,10 @@
           "minLength": 1,
           "maxLength": 20
         },
-        "logoUrl": {
+        "logoURI": {
           "type": "string",
-          "description": "A URL to the token logo asset; if not set, interface will attempt to find a logo based on the address",
-          "pattern": "^(https|ipfs|ipns)://.+$"
+          "description": "A URI to the token logo asset; if not set, interface will attempt to find a logo based on the address",
+          "format": "uri"
         },
         "tags": {
           "type": "array",
@@ -126,9 +126,9 @@
           "pattern": "^[\\w\\s]+$"
         },
         "timestamp": {
-          "type": "integer",
-          "description": "The epoch seconds timestamp of the list version; must be after June 11, 2020",
-          "minimum": 1591833600
+          "type": "string",
+          "format": "date-time",
+          "description": "The update timestamp of the list version; i.e. when this version was created"
         },
         "version": {
           "$ref": "#/definitions/Version"

diff --git a/src/types.ts b/src/types.ts
@@ -4,7 +4,7 @@ export interface TokenInfo {
   name?: string;
   decimals?: number;
   symbol?: string;
-  logoUrl?: string;
+  logoURI?: string;
   tagIds?: string[];
 }
 

diff --git a/test/__snapshots__/tokenlist.schema.test.ts.snap b/test/__snapshots__/tokenlist.schema.test.ts.snap
@@ -90,6 +90,34 @@ Array [
 ]
 `;
 
+exports[`schema invalid logo URI 1`] = `
+Array [
+  Object {
+    "dataPath": ".tokens[0].logoURI",
+    "keyword": "format",
+    "message": "should match format \\"uri\\"",
+    "params": Object {
+      "format": "uri",
+    },
+    "schemaPath": "#/properties/logoURI/format",
+  },
+]
+`;
+
+exports[`schema invalid timestamp 1`] = `
+Array [
+  Object {
+    "dataPath": ".timestamp",
+    "keyword": "format",
+    "message": "should match format \\"date-time\\"",
+    "params": Object {
+      "format": "date-time",
+    },
+    "schemaPath": "#/properties/timestamp/format",
+  },
+]
+`;
+
 exports[`schema requires name, timestamp, version, tokens 1`] = `
 Array [
   Object {

diff --git a/test/testschemas/bigwords.tokenlist.json b/test/testschemas/bigwords.tokenlist.json
@@ -9,14 +9,14 @@
       "description": "blah blah"
     }
   },
-  "timestamp": 1591897594,
+  "timestamp": "2018-11-13T20:20:39+00:00",
   "tokens": [
     {
       "name": "blah blah blah blah blah blah blah",
       "address": "0x0000000000000000000000000000000000000000",
       "chainId": 1,
       "decimals": 18,
-      "logoUrl": "https://test",
+      "logoURI": "https://test",
       "symbol": "abc",
       "tags": [
         "coin"

diff --git a/test/testschemas/empty.tokenlist.json b/test/testschemas/empty.tokenlist.json
@@ -9,7 +9,7 @@
       "description": "blah blah"
     }
   },
-  "timestamp": 1591897594,
+  "timestamp": "2018-11-13T20:20:39+00:00",
   "tokens": [
   ],
   "version": {

diff --git a/test/testschemas/example.tokenlist.json b/test/testschemas/example.tokenlist.json
@@ -1,25 +1,41 @@
 {
-  "name": "My Example List",
+  "name": "My Token List",
   "keywords": [
-    "abc"
+    "audited",
+    "verified"
   ],
   "tags": {
-    "coin": {
+    "stablecoin": {
       "name": "Stablecoin",
-      "description": "blah blah"
+      "description": "Tokens that are fixed to an external asset"
+    },
+    "compound": {
+      "name": "Compound Finance",
+      "description": "Tokens that earn interest on compound.finance"
     }
   },
-  "timestamp": 1591897594,
+  "timestamp": "2020-06-12T00:00:00+00:00",
   "tokens": [
     {
-      "name": "blah",
-      "address": "0x0000000000000000000000000000000000000000",
       "chainId": 1,
-      "decimals": 18,
-      "logoUrl": "https://test",
-      "symbol": "abc",
+      "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+      "symbol": "USDC",
+      "name": "USD Coin",
+      "decimals": 6,
+      "logoURI": "ipfs://QmXfzKRvjZz3u5JRgC4v5mGVbm9ahrUiB4DgzHBsnWbTMM",
       "tags": [
-        "coin"
+        "stablecoin"
+      ]
+    },
+    {
+      "chainId": 1,
+      "address": "0x39AA39c021dfbaE8faC545936693aC917d5E7563",
+      "symbol": "cUSDC",
+      "name": "Compound USD Coin",
+      "decimals": 8,
+      "logoURI": "ipfs://QmUSNbwUxUYNMvMksKypkgWs8unSm8dX2GjCPBVGZ7GGMr",
+      "tags": [
+        "compound"
       ]
     }
   ],

diff --git a/test/testschemas/invalidlogouri.tokenlist.json b/test/testschemas/invalidlogouri.tokenlist.json
@@ -0,0 +1,24 @@
+{
+  "name": "My Token List",
+  "keywords": [
+  ],
+  "timestamp": "2020-06-12T00:00:00+00:00",
+  "tokens": [
+    {
+      "chainId": 1,
+      "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+      "symbol": "USDC",
+      "name": "USD Coin",
+      "decimals": 6,
+      "logoURI": "hello",
+      "tags": [
+        "stablecoin"
+      ]
+    }
+  ],
+  "version": {
+    "major": 0,
+    "minor": 0,
+    "patch": 1
+  }
+}
diff --git a/test/testschemas/invalidtimestamp.tokenlist.json b/test/testschemas/invalidtimestamp.tokenlist.json
@@ -0,0 +1,31 @@
+{
+  "name": "My Example List",
+  "keywords": [
+    "abc"
+  ],
+  "tags": {
+    "coin": {
+      "name": "Stablecoin",
+      "description": "blah blah"
+    }
+  },
+  "timestamp": "abc",
+  "tokens": [
+    {
+      "name": "blah",
+      "address": "0x0000000000000000000000000000000000000000",
+      "chainId": 1,
+      "decimals": 18,
+      "logoURI": "https://test",
+      "symbol": "abc",
+      "tags": [
+        "coin"
+      ]
+    }
+  ],
+  "version": {
+    "major": 0,
+    "minor": 0,
+    "patch": 1
+  }
+}
diff --git a/test/testschemas/invalidtokenaddress.tokenlist.json b/test/testschemas/invalidtokenaddress.tokenlist.json
@@ -9,14 +9,14 @@
       "description": "blah blah"
     }
   },
-  "timestamp": 1591897594,
+  "timestamp": "2018-11-13T20:20:39+00:00",
   "tokens": [
     {
       "name": "blah blah ",
       "address": "0x00000000000000000000000000000000000000_0",
       "chainId": 1,
       "decimals": 18,
-      "logoUrl": "https://test",
+      "logoURI": "https://test",
       "symbol": "abc",
       "tags": [
         "coin"

diff --git a/test/testschemas/invalidversion.1.tokenlist.json b/test/testschemas/invalidversion.1.tokenlist.json
@@ -9,14 +9,14 @@
       "description": "blah blah"
     }
   },
-  "timestamp": 1591897594,
+  "timestamp": "2018-11-13T20:20:39+00:00",
   "tokens": [
     {
       "name": "blah blah ",
       "address": "0x0000000000000000000000000000000000000000",
       "chainId": 1,
       "decimals": 18,
-      "logoUrl": "https://test",
+      "logoURI": "https://test",
       "symbol": "abc",
       "tags": [
         "coin"

diff --git a/test/testschemas/invalidversion.2.tokenlist.json b/test/testschemas/invalidversion.2.tokenlist.json
@@ -9,14 +9,14 @@
       "description": "blah blah"
     }
   },
-  "timestamp": 1591897594,
+  "timestamp": "2018-11-13T20:20:39+00:00",
   "tokens": [
     {
       "name": "blah blah ",
       "address": "0x0000000000000000000000000000000000000000",
       "chainId": 1,
       "decimals": 18,
-      "logoUrl": "https://test",
+      "logoURI": "https://test",
       "symbol": "abc",
       "tags": [
         "coin"

diff --git a/test/testschemas/invalidversion.3.tokenlist.json b/test/testschemas/invalidversion.3.tokenlist.json
@@ -9,14 +9,14 @@
       "description": "blah blah"
     }
   },
-  "timestamp": 1591897594,
+  "timestamp": "2018-11-13T20:20:39+00:00",
   "tokens": [
     {
       "name": "blah blah ",
       "address": "0x0000000000000000000000000000000000000000",
       "chainId": 1,
       "decimals": 18,
-      "logoUrl": "https://test",
+      "logoURI": "https://test",
       "symbol": "abc",
       "tags": [
         "coin"

diff --git a/test/tokenlist.schema.test.ts b/test/tokenlist.schema.test.ts
@@ -4,11 +4,13 @@ import exampleList from './testschemas/example.tokenlist.json';
 import emptyList from './testschemas/empty.tokenlist.json';
 import bigWords from './testschemas/bigwords.tokenlist.json';
 import invalidTokenAddress from './testschemas/invalidtokenaddress.tokenlist.json';
+import invalidTimestamp from './testschemas/invalidtimestamp.tokenlist.json';
+import invalidLogoURI from './testschemas/invalidlogouri.tokenlist.json';
 import invalidVersion1 from './testschemas/invalidversion.1.tokenlist.json';
 import invalidVersion2 from './testschemas/invalidversion.2.tokenlist.json';
 import invalidVersion3 from './testschemas/invalidversion.3.tokenlist.json';
 
-const ajv = new Ajv({ allErrors: true });
+const ajv = new Ajv({ allErrors: true, format: 'full' });
 const validator = ajv.compile(schema);
 
 describe('schema', () => {
@@ -41,6 +43,14 @@ describe('schema', () => {
     checkSchema(invalidTokenAddress, false);
   });
 
+  it('invalid timestamp', () => {
+    checkSchema(invalidTimestamp, false);
+  });
+
+  it('invalid logo URI', () => {
+    checkSchema(invalidLogoURI, false);
+  });
+
   it('checks version', () => {
     checkSchema(invalidVersion1, false);
     checkSchema(invalidVersion2, false);