Raindrops1-Playground

README.md

@@ -29,19 +29,36 @@ This package does not include code for token list validation. You can easily do
 for ease of use.
 
 ```typescript
-import Ajv from 'ajv';
-import { schema } from '@uniswap/token-lists'
 
-const ajv = new Ajv({ allErrors: true });
-const validate = ajv.compile(schema);
+import { schema } from '@uniswap/token-lists'
+import Ajv from 'ajv'
+import addFormats from 'ajv-formats'
+import fetch from 'node-fetch'
+
+const ARBITRUM_LIST = 'https://bridge.arbitrum.io/token-list-42161.json'
+
+async function validate() {
+  const ajv = new Ajv({ allErrors: true, verbose: true })
+  addFormats(ajv)
+  const validator = ajv.compile(schema);
+  const response = await fetch(ARBITRUM_LIST)
+  const data = await response.json()
+  const valid = validator(data)
+  if (valid) {
+    return valid
+  }
+  if (validator.errors) {
+    throw validator.errors.map(error => {
+      delete error.data
+      return error
+    })
+  }
+}
 
-const response = await fetch('https://bridge.arbitrum.io/token-list-42161.json')
-const listData = await response.json()
+validate()
+  .then(console.log("Valid List."))
+  .catch(console.error)
 
-const valid = validate(listData)
-if (!valid) {
-  // oh no!
-}
 ```
 
 ## Authoring token lists

package.json

@@ -6,7 +6,7 @@
     "url": "https://uniswap.org"
   },
   "description": "📚 The Token Lists specification",
-  "version": "1.0.0-beta.27",
+  "version": "1.0.0-beta.28",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

src/types.ts

@@ -1,3 +1,5 @@
+type ExtensionValue = string | number | boolean | null;
+
 export interface TokenInfo {
   readonly chainId: number;
   readonly address: string;
@@ -7,7 +9,7 @@ export interface TokenInfo {
   readonly logoURI?: string;
   readonly tags?: string[];
   readonly extensions?: {
-    readonly [key: string]: string | number | boolean | null;
+    readonly [key: string]: { [key: string]: ExtensionValue } | ExtensionValue;
   };
 }