Support Optimism in Set.js (#96)

* Support Optimism in Set.js

* Use Polygon's Coingecko tokenlist instead of constructing a manual mapping

* Tweak tests to use new Polygon coingecko endpoint

* Use Optimism explorer's API endpoint instead of provider gas price

Author: williamsfu99

package.json

@@ -1,6 +1,6 @@
 {
     "name": "set.js",
-    "version": "0.4.4",
+    "version": "0.4.5",
     "description": "A javascript library for interacting with the Set Protocol v2",
     "keywords": [
         "set.js",

src/api/utils/coingecko.ts

@@ -16,18 +16,14 @@
 
 'use strict';
 
-const pageResults = require('graph-results-pager');
-
 import axios from 'axios';
 import Assertions from '../../assertions';
 
 import {
   CoinGeckoCoinPrices,
   CoinGeckoTokenData,
-  SushiswapTokenData,
   CoinGeckoTokenMap,
   CoinPricesParams,
-  PolygonMappedTokenData
 } from '../../types';
 
 /**
@@ -95,14 +91,8 @@ export class CoinGeckoDataService {
   async fetchTokenList(): Promise<CoinGeckoTokenData[]> {
     if (this.tokenList !== undefined) return this.tokenList;
 
-    switch (this.chainId) {
-      case 1:
-        this.tokenList = await this.fetchEthereumTokenList();
-        break;
-      case 137:
-        this.tokenList = await this.fetchPolygonTokenList();
-        break;
-    }
+    const url = this.getCoingeckoUrl();
+    this.tokenList = await this.fetchCoingeckoTokenList(url);
     this.tokenMap = this.convertTokenListToAddressMap(this.tokenList);
 
     return this.tokenList!;
@@ -135,107 +125,22 @@ export class CoinGeckoDataService {
   private getPlatform(): string {
     switch (this.chainId) {
       case 1: return 'ethereum';
+      case 10: return 'optimistic-ethereum';
       case 137: return 'polygon-pos';
       default: return '';
     }
   }
 
-  private async fetchEthereumTokenList(): Promise<CoinGeckoTokenData[]> {
-    const url = 'https://tokens.coingecko.com/uniswap/all.json';
-    const response = await axios.get(url);
-    return response.data.tokens;
-  }
-
-  private async fetchPolygonTokenList(): Promise<CoinGeckoTokenData[]> {
-    const coingeckoEthereumTokens = await this.fetchEthereumTokenList();
-    const polygonMappedTokens = await this.fetchPolygonMappedTokenList();
-    const sushiPolygonTokenList = await this.fetchSushiPolygonTokenList();
-    const quickswapPolygonTokenList = await this.fetchQuickswapPolygonTokenList();
-
-    for (const token of sushiPolygonTokenList) {
-      const quickswapToken = quickswapPolygonTokenList.find(t => t.address.toLowerCase() === token.address);
-
-      if (quickswapToken) {
-        token.logoURI = quickswapToken.logoURI;
-        continue;
-      }
-
-      const ethereumAddress = polygonMappedTokens[token.address];
-
-      if (ethereumAddress !== undefined) {
-        const ethereumToken = coingeckoEthereumTokens.find(t => t.address.toLowerCase() === ethereumAddress);
-
-        if (ethereumToken) {
-          token.logoURI = ethereumToken.logoURI;
-        }
-      }
-    }
-
-    return sushiPolygonTokenList;
-  }
-
-  private async fetchSushiPolygonTokenList() {
-    let tokens: SushiswapTokenData[] = [];
-    const url = 'https://api.thegraph.com/subgraphs/name/sushiswap/matic-exchange';
-    const properties = [
-      'id',
-      'symbol',
-      'name',
-      'decimals',
-      'volumeUSD',
-    ];
-
-    const response = await pageResults({
-      api: url,
-      query: {
-        entity: 'tokens',
-        properties: properties,
-      },
-    });
-
-    for (const token of response) {
-      tokens.push({
-        chainId: 137,
-        address: token.id,
-        symbol: token.symbol,
-        name: token.name,
-        decimals: parseInt(token.decimals),
-        volumeUSD: parseFloat(token.volumeUSD),
-      });
-    }
-
-    // Sort by volume and filter out untraded tokens
-    tokens.sort((a, b) => b.volumeUSD - a.volumeUSD);
-    tokens = tokens.filter(t => t.volumeUSD > 0);
-
-    return tokens;
-  }
-
-  private async fetchPolygonMappedTokenList() {
-    const tokens: PolygonMappedTokenData = {};
-    const url = 'https://api.thegraph.com/subgraphs/name/maticnetwork/mainnet-root-subgraphs';
-    const properties = ['id', 'rootToken', 'childToken'];
-
-    const response = await pageResults({
-      api: url,
-      query: {
-        entity: 'tokenMappings',
-        properties: properties,
-      },
-    });
-
-    for (const tokenMapping of response) {
-      tokens[tokenMapping.childToken.toLowerCase()] = tokenMapping.rootToken.toLowerCase();
+  private getCoingeckoUrl(): string {
+    switch (this.chainId) {
+      case 1: return 'https://tokens.coingecko.com/uniswap/all.json';
+      case 10: return 'https://tokens.coingecko.com/optimistic-ethereum/all.json';
+      case 137: return 'https://tokens.coingecko.com/polygon-pos/all.json';
     }
-
-    return tokens;
   }
 
-  private async fetchQuickswapPolygonTokenList(): Promise<CoinGeckoTokenData[]> {
-    const url = 'https://raw.githubusercontent.com/sameepsi/' +
-                'quickswap-default-token-list/master/src/tokens/mainnet.json';
-
-    const data = (await axios.get(url)).data;
-    return data;
+  private async fetchCoingeckoTokenList(url: string): Promise<CoinGeckoTokenData[]> {
+    const response = await axios.get(url);
+    return response.data.tokens;
   }
 }

src/api/utils/gasOracle.ts

@@ -55,6 +55,7 @@ export class GasOracleService {
 
     switch (this.chainId) {
       case 1: return this.getEthereumGasPrice(speed);
+      case 10: return this.getOptimismGasPrice();
       case 137: return this.getPolygonGasPrice(speed);
 
       // This case should never run because chainId is validated
@@ -75,6 +76,14 @@ export class GasOracleService {
     }
   }
 
+  private async getOptimismGasPrice(): Promise<number> {
+    const url = 'https://api-optimistic.etherscan.io/api?module=proxy&action=eth_gasPrice';
+    const data = (await axios.get(url)).data;
+    const price = Number(data.result);
+
+    return price;
+  }
+
   private async getPolygonGasPrice(speed: GasOracleSpeed): Promise<number> {
     const url = 'https://gasstation-mainnet.matic.network';
     const data = (await axios.get(url)).data;

src/api/utils/tradeQuoter.ts

@@ -338,6 +338,7 @@ export class TradeQuoter {
   private chainCurrencyAddress(chainId: number): Address {
     switch (chainId) {
       case 1:   return '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2'; // WETH
+      case 10:  return '0x4200000000000000000000000000000000000006'; // Optimism WETH
       case 137: return '0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270'; // WMATIC
       default: throw new Error(`chainId: ${chainId} is not supported`);
     }

src/api/utils/zeroex.ts

@@ -114,6 +114,7 @@ export class ZeroExTradeQuoter {
   private getHostForChain(chainId: number) {
     switch (chainId) {
       case 1: return 'https://api.0x.org';
+      case 10: return 'https://optimism.api.0x.org';
       case 137: return 'https://polygon.api.0x.org';
     }
   }

src/assertions/CommonAssertions.ts

@@ -123,7 +123,7 @@ export class CommonAssertions {
   }
 
   public isSupportedChainId(chainId: number) {
-    const validChainIds = [1, 137];
+    const validChainIds = [1, 10, 137];
 
     if ( !validChainIds.includes(chainId)) {
       throw new Error(`Unsupported chainId: ${chainId}. Must be one of ${validChainIds}`);

src/types/utils.ts

@@ -21,10 +21,6 @@ export type CoinGeckoTokenData = {
   logoURI?: string,
 };
 
-export type SushiswapTokenData = CoinGeckoTokenData & {
-  volumeUSD: number
-};
-
 export type CoinGeckoTokenMap = {
   [key: string]: CoinGeckoTokenData
 };
@@ -34,10 +30,6 @@ export type CoinPricesParams = {
   vsCurrencies: string[]
 };
 
-export type PolygonMappedTokenData = {
-  [key: string]: string,
-};
-
 export type QuoteOptions = {
   fromToken: Address,
   toToken: Address,

test/api/TradeAPI.spec.ts

@@ -15,7 +15,6 @@
 */
 
 import axios from 'axios';
-const pageResults = require('graph-results-pager');
 
 import { ethers, ContractTransaction } from 'ethers';
 import { BigNumber } from 'ethers/lib/ethers';
@@ -57,14 +56,6 @@ axios.get.mockImplementation(val => {
     case fixture.coinGeckoTokenRequestPoly: return fixture.coinGeckoTokenResponsePoly;
     case fixture.coinGeckoPricesRequestEth: return fixture.coinGeckoPricesResponseEth;
     case fixture.coinGeckoPricesRequestPoly: return fixture.coinGeckoPricesResponsePoly;
-    case fixture.quickswapRequestPoly: return fixture.quickswapResponsePoly;
-  }
-});
-
-pageResults.mockImplementation(val => {
-  switch (val.api) {
-    case fixture.sushiSubgraphRequestPoly: return fixture.sushiSubgraphResponsePoly;
-    case fixture.maticMappingSubgraphRequestPoly: return fixture.maticMappingSubgraphResponsePoly;
   }
 });
 
@@ -360,7 +351,7 @@ describe('TradeAPI', () => {
 
       it('should fetch correct token data for network', async() => {
         const tokenData = await subject();
-        await expect(tokenData).to.deep.equal(fixture.fetchTokenListResponsePoly);
+        await expect(tokenData).to.deep.equal(fixture.coinGeckoTokenResponsePoly.data.tokens);
       });
     });
 
@@ -402,7 +393,7 @@ describe('TradeAPI', () => {
 
     describe('when the chain is polygon (137)', () => {
       beforeEach(async () => {
-        subjectChainId = 1;
+        subjectChainId = 137;
         provider.getNetwork = jest.fn(() => Promise.resolve(<unknown>{ chainId: subjectChainId } as Network ));
         subjectCoinGecko = new CoinGeckoDataService(subjectChainId);
         subjectTokenList = await tradeAPI.fetchTokenListAsync();

test/api/TradeQuoter.spec.ts

@@ -23,7 +23,6 @@ import TradeModuleWrapper from '@src/wrappers/set-protocol-v2/TradeModuleWrapper
 import { TradeQuoter, CoinGeckoDataService } from '@src/api/utils';
 import { tradeQuoteFixtures as fixture } from '../fixtures/tradeQuote';
 import { expect } from '@test/utils/chai';
-const pageResults = require('graph-results-pager');
 
 const provider = new ethers.providers.JsonRpcProvider('http://localhost:8545');
 
@@ -57,14 +56,6 @@ axios.get.mockImplementation(val => {
     case fixture.coinGeckoTokenRequestPoly: return fixture.coinGeckoTokenResponsePoly;
     case fixture.coinGeckoPricesRequestEth: return fixture.coinGeckoPricesResponseEth;
     case fixture.coinGeckoPricesRequestPoly: return fixture.coinGeckoPricesResponsePoly;
-    case fixture.quickswapRequestPoly: return fixture.quickswapResponsePoly;
-  }
-});
-
-pageResults.mockImplementation(val => {
-  switch (val.api) {
-    case fixture.sushiSubgraphRequestPoly: return fixture.sushiSubgraphResponsePoly;
-    case fixture.maticMappingSubgraphRequestPoly: return fixture.maticMappingSubgraphResponsePoly;
   }
 });