Merge pull request #110 from EdgeApp/matthew/midgard-tcy

Add Midgard plugin for TCY rates

Author: peachbits

src/config.ts

@@ -1,5 +1,12 @@
 import { makeConfig } from 'cleaner-config'
-import { asArray, asNumber, asObject, asOptional, asString } from 'cleaners'
+import {
+  asArray,
+  asMaybe,
+  asNumber,
+  asObject,
+  asOptional,
+  asString
+} from 'cleaners'
 
 // Customization:
 
@@ -54,6 +61,9 @@ const providerDefaults = {
   wazirx: {
     uri: 'https://api.wazirx.com'
   },
+  midgard: {
+    uri: 'https://midgard.ninerealms.com'
+  },
   coinmonitor: {
     uri: 'http://ar.coinmonitor.info'
   }
@@ -111,46 +121,85 @@ export const asConfig = asObject({
   ]),
   ratesServerAddress: asOptional(asString, RATES_SERVER_ADDRESS),
   slackWebhookUrl: asOptional(asString, SLACK_WEBHOOK_URL),
-  providers: asOptional(
+  providers: asMaybe(
     asObject({
-      coincap: asObject({
-        uri: asString
-      }),
-      currencyConverter: asObject({
-        uri: asString,
-        apiKey: asString
-      }),
-      coinMarketCapCurrent: asObject({
-        uri: asString,
-        apiKey: asString
-      }),
-      coinMarketCapHistorical: asObject({
-        uri: asString,
-        apiKey: asString
-      }),
-      openExchangeRates: asObject({
-        uri: asString,
-        apiKey: asString
-      }),
-      coinstore: asObject({
-        uri: asString
-      }),
-      coingecko: asObject({
-        uri: asString
-      }),
-      coingeckopro: asObject({
-        uri: asString,
-        apiKey: asString
-      }),
-      compound: asObject({
-        uri: asString
-      }),
-      wazirx: asObject({
-        uri: asString
-      }),
-      coinmonitor: asObject({
-        uri: asString
-      })
+      coincap: asMaybe(
+        asObject({
+          uri: asString
+        }),
+        providerDefaults.coincap
+      ),
+      currencyConverter: asMaybe(
+        asObject({
+          uri: asString,
+          apiKey: asString
+        }),
+        providerDefaults.currencyConverter
+      ),
+      coinMarketCapCurrent: asMaybe(
+        asObject({
+          uri: asString,
+          apiKey: asString
+        }),
+        providerDefaults.coinMarketCapCurrent
+      ),
+      coinMarketCapHistorical: asMaybe(
+        asObject({
+          uri: asString,
+          apiKey: asString
+        }),
+        providerDefaults.coinMarketCapHistorical
+      ),
+      openExchangeRates: asMaybe(
+        asObject({
+          uri: asString,
+          apiKey: asString
+        }),
+        providerDefaults.openExchangeRates
+      ),
+      coinstore: asMaybe(
+        asObject({
+          uri: asString
+        }),
+        providerDefaults.coinstore
+      ),
+      coingecko: asMaybe(
+        asObject({
+          uri: asString
+        }),
+        providerDefaults.coingecko
+      ),
+      coingeckopro: asMaybe(
+        asObject({
+          uri: asString,
+          apiKey: asString
+        }),
+        providerDefaults.coingeckopro
+      ),
+      compound: asMaybe(
+        asObject({
+          uri: asString
+        }),
+        providerDefaults.compound
+      ),
+      wazirx: asMaybe(
+        asObject({
+          uri: asString
+        }),
+        providerDefaults.wazirx
+      ),
+      midgard: asMaybe(
+        asObject({
+          uri: asString
+        }),
+        providerDefaults.midgard
+      ),
+      coinmonitor: asMaybe(
+        asObject({
+          uri: asString
+        }),
+        providerDefaults.coinmonitor
+      )
     }),
     providerDefaults
   ),

src/providers/midgard.ts

@@ -0,0 +1,64 @@
+import { asObject, asString } from 'cleaners'
+import fetch from 'node-fetch'
+
+import { config } from '../config'
+import { NewRates, RateMap, ReturnRate } from '../rates'
+import { logger } from '../utils/utils'
+
+const { uri } = config.providers.midgard
+// https://midgard.ninerealms.com/v2/pool/THOR.TCY
+const asMidgardTcyResponse = asObject({
+  // annualPercentageRate: '10.261585964326816',
+  // asset: 'THOR.TCY',
+  // assetDepth: '223863906811412',
+  // assetPrice: '0.18381873155332273',
+  assetPriceUSD: asString
+  // earnings: '4004966054359',
+  // earningsAnnualAsPercentOfDepth: '2.537405194396682',
+  // liquidityUnits: '30164031604896',
+  // lpLuvi: 'NaN',
+  // nativeDecimal: '8',
+  // poolAPY: '10.261585964326816',
+  // runeDepth: '41150379390645',
+  // saversAPR: '0',
+  // saversDepth: '0',
+  // saversUnits: '0',
+  // status: 'available',
+  // synthSupply: '0',
+  // synthUnits: '0',
+  // totalCollateral: '0',
+  // totalDebtTor: '0',
+  // units: '30164031604896',
+  // volume24h: '128829051343702'
+})
+
+const midgardRateMap = (
+  results: ReturnType<typeof asMidgardTcyResponse>
+): RateMap => ({ 'TCY_iso:USD': results.assetPriceUSD })
+
+const midgard = async (
+  requestedRates: ReturnRate[],
+  currentTime: string
+): Promise<NewRates> => {
+  const rates = { [currentTime]: {} }
+
+  // This is a TCY-only provider so we can check to exit early
+  if (requestedRates.find(req => req.currency_pair === 'TCY_iso:USD') == null)
+    return rates
+
+  // Query
+  try {
+    const response = await fetch(`${uri}/v2/pool/THOR.TCY`)
+    if (response.status !== 200) {
+      throw new Error(response.statusText)
+    }
+    const json = asMidgardTcyResponse(await response.json())
+    rates[currentTime] = midgardRateMap(json)
+  } catch (e) {
+    logger(`No midgard TCY pool quote`, e)
+  }
+
+  return rates
+}
+
+export { midgard }

src/rates.ts

@@ -24,6 +24,7 @@ import {
   fallbackConstantRates,
   zeroRates
 } from './providers/hardcodedProviders'
+import { midgard } from './providers/midgard'
 import { openExchangeRates } from './providers/openExchangeRates'
 import { wazirx } from './providers/wazirx'
 import {
@@ -135,6 +136,7 @@ const getRatesFromProviders = async (
     coinmonitor,
     wazirx,
     coinstore,
+    midgard,
     coingecko,
     coincap,
     coinMarketCap,

src/utils/currencyCodeMaps.json

@@ -69,6 +69,7 @@
     "USD.st_iso:USD": "1"
   },
   "coinMarketCap": {
+    "TCY": "36449",
     "ZANO": "4691",
     "LLD": "35872",
     "SUI": "20947",
@@ -407,6 +408,7 @@
     "RNDR": "render-token"
   },
   "coingecko": {
+    "TCY": "tcy",
     "ZANO": "zano",
     "SUI": "sui",
     "SPX": "spx6900",
@@ -851,7 +853,8 @@
     "SUI",
     "AXL",
     "USDC-M",
-    "ZANO"
+    "ZANO",
+    "TCY"
   ],
   "fiatCurrencyCodes": [
     "iso:ALL",