add an example for illustration of a proposed extension

Uniswap · Sep 23, 2021 · 19da466 · 19da466
1 parent ea6683c
commit 19da466
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 0 deletions.
diff --git a/test/__snapshots__/tokenlist.schema.test.ts.snap b/test/__snapshots__/tokenlist.schema.test.ts.snap
@@ -402,6 +402,8 @@ Array [
 ]
 `;
 
+exports[`schema cross chain extensions example 1`] = `null`;
+
 exports[`schema empty list fails 1`] = `
 Array [
   Object {

diff --git a/test/schema/example-crosschain.tokenlist.json b/test/schema/example-crosschain.tokenlist.json
@@ -0,0 +1,73 @@
+{
+  "name": "Cross chain",
+  "logoURI": "ipfs://QmUSNbwUxUYNMvMksKypkgWs8unSm8dX2GjCPBVGZ7GGMr",
+  "keywords": [
+    "audited",
+    "verified",
+    "special tokens"
+  ],
+  "timestamp": "2020-06-12T00:00:00+00:00",
+  "tokens": [
+    {
+      "chainId": 1,
+      "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+      "symbol": "USDC",
+      "name": "USD Coin",
+      "decimals": 6,
+      "logoURI": "ipfs://QmXfzKRvjZz3u5JRgC4v5mGVbm9ahrUiB4DgzHBsnWbTMM",
+      "extensions": {
+        "bridgeInfo": {
+          "10": {
+            "tokenAddress": "0x7F5c764cBc14f9669B88837ca1490cCa17c31607",
+            "originBridgeAddress": "0x99C9fc46f92E8a1c0deC1b1747d010903E884bE1",
+            "destBridgeAddress": "0x4200000000000000000000000000000000000010"
+          },
+          "42161": {
+            "tokenAddress": "0xFF970A61A04b1cA14834A43f5dE4533eBDDB5CC8",
+            "originBridgeAddress": "0xcEe284F754E854890e311e3280b767F80797180d",
+            "destBridgeAddress": "0x5288c571fd7ad117bea99bf60fe0846c4e84f933"
+          }
+        }
+      }
+    },
+    {
+      "chainId": 10,
+      "address": "0x7F5c764cBc14f9669B88837ca1490cCa17c31607",
+      "symbol": "USDC",
+      "name": "USD Coin",
+      "decimals": 6,
+      "logoURI": "ipfs://QmXfzKRvjZz3u5JRgC4v5mGVbm9ahrUiB4DgzHBsnWbTMM",
+      "extensions": {
+        "bridgeInfo": {
+          "1": {
+            "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+            "originBridgeAddress": "0x4200000000000000000000000000000000000010",
+            "destBridgeAddress": "0x99C9fc46f92E8a1c0deC1b1747d010903E884bE1"
+          }
+        }
+      }
+    },
+    {
+      "chainId": 42161,
+      "address": "0xFF970A61A04b1cA14834A43f5dE4533eBDDB5CC8",
+      "symbol": "USDC",
+      "name": "USD Coin",
+      "decimals": 6,
+      "logoURI": "ipfs://QmXfzKRvjZz3u5JRgC4v5mGVbm9ahrUiB4DgzHBsnWbTMM",
+      "extensions": {
+        "bridgeInfo": {
+          "1": {
+            "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+            "originBridgeAddress": "0x5288c571fd7ad117bea99bf60fe0846c4e84f933",
+            "destBridgeAddress": "0xcEe284F754E854890e311e3280b767F80797180d"
+          }
+        }
+      }
+    }
+  ],
+  "version": {
+    "major": 1,
+    "minor": 0,
+    "patch": 0
+  }
+}
diff --git a/test/tokenlist.schema.test.ts b/test/tokenlist.schema.test.ts
@@ -21,6 +21,7 @@ import extensionsInvalid from './schema/extensions-invalid.tokenlist.json';
 import extensionsValidObject from './schema/extensions-valid-object.tokenlist.json';
 import extensionsInvalidObjectTooDeep from './schema/extensions-invalid-object-too-deep.tokenlist.json';
 import tokenSymbolWithPeriod from './schema/tokenwithperiodsymbol.tokenlist.json';
+import crossChainExtensions from './schema/example-crosschain.tokenlist.json';
 import addFormats from 'ajv-formats';
 
 const ajv = new Ajv({ allErrors: true });
@@ -111,6 +112,10 @@ describe('schema', () => {
     checkSchema(tokenSymbolWithPeriod, true);
   });
 
+  it('cross chain extensions example', () => {
+    checkSchema(crossChainExtensions, true);
+  });
+
   it('allows up to 10k tokens', () => {
     const exampleListWith10kTokens = {
       ...exampleList,