@chainlink/external-adapter-framework 0.0.15 → 0.0.17

package/src/examples/coingecko/src/cryptoUtils.ts

@@ -1,88 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios'
-import { PRO_API_ENDPOINT, DEFAULT_API_ENDPOINT } from './config'
-import { AdapterConfig } from '../../../config'
-import { makeLogger } from '../../../util/logger'
-
-type Overrides = Record<string, Record<string, string>>
-
-export interface AdapterRequestParams {
-  coinid?: string
-  base?: string
-  quote: string
-  overrides?: Overrides
-}
-
-export interface ProviderRequestBody {
-  ids: string
-  vs_currencies: string
-  include_market_cap?: boolean
-  include_24hr_vol?: boolean
-}
-
-export interface ProviderResponseBody {
-  [base: string]: {
-    [quote: string]: number
-  }
-}
-
-interface ResultEntry {
-  value: number
-  params: {
-    quote: string
-    base?: string
-    coinid?: string
-    overrides?: Overrides
-  }
-}
-
-interface ResultEntryWithoutOverrides {
-  value: number
-  params: {
-    quote: string
-    base?: string
-    coinid?: string
-  }
-}
-
-export const buildBatchedRequestBody = (
-  params: AdapterRequestParams[],
-  config: AdapterConfig,
-): AxiosRequestConfig<ProviderRequestBody> => {
-  return {
-    baseURL: config.API_KEY ? PRO_API_ENDPOINT : DEFAULT_API_ENDPOINT,
-    url: '/simple/price',
-    method: 'GET',
-    params: {
-      ids: [...new Set(params.map((p) => p.coinid ?? p.base))].join(','),
-      vs_currencies: [...new Set(params.map((p) => p.quote))].join(','),
-      x_cg_pro_api_key: config.API_KEY,
-    },
-  }
-}
-
-const logger = makeLogger('CoinGecko Crypto Batched')
-
-export const constructEntry = (
-  res: AxiosResponse<ProviderResponseBody>,
-  requestPayload: AdapterRequestParams,
-  resultPath: string,
-): ResultEntryWithoutOverrides | undefined => {
-  const coinId = requestPayload.coinid ?? (requestPayload.base as string)
-  const dataForCoin = res.data[coinId]
-  const dataForQuote = dataForCoin ? dataForCoin[resultPath] : undefined
-  if (!dataForQuote) {
-    logger.warn(`Data for "${requestPayload.quote}" not found for token "${coinId}".`)
-    return
-  }
-  const entry = {
-    params: requestPayload,
-    value: dataForQuote,
-  } as ResultEntry
-  if (requestPayload.coinid) {
-    entry.params.coinid = requestPayload.coinid
-  } else {
-    entry.params.base = requestPayload.base
-  }
-  delete entry.params.overrides
-  return entry
-}

package/src/examples/coingecko/src/endpoint/coins.ts

@@ -1,54 +0,0 @@
-import { AxiosResponse, AxiosRequestConfig } from 'axios'
-import { AdapterConfig } from '../../../../config'
-import { AdapterEndpoint } from '../../../../../src/adapter'
-import { RestTransport } from '../../../../../src/transports'
-import { AdapterRequest, AdapterResponse } from '../../../../../src/util'
-import { InputParameters } from '../../../../../src/validation'
-import { DEFAULT_API_ENDPOINT, PRO_API_ENDPOINT, customSettings } from '../config'
-
-export const inputParameters: InputParameters = {}
-
-export interface AdapterRequestParams {
-  id: string
-}
-
-export interface CoinsResponse {
-  id: string
-  symbol: string
-  name: string
-}
-
-const restEndpointTransport = new RestTransport({
-  prepareRequest: (
-    _: AdapterRequest<AdapterRequestParams>,
-    config: AdapterConfig<typeof customSettings>,
-  ): AxiosRequestConfig<CoinsResponse> => {
-    const baseURL = config.API_KEY ? PRO_API_ENDPOINT : DEFAULT_API_ENDPOINT
-    const params = config.API_KEY ? { x_cg_pro_api_key: config.API_KEY } : undefined
-    return {
-      baseURL,
-      url: '/coins/list',
-      method: 'GET',
-      params,
-    }
-  },
-  parseResponse: (
-    req: AdapterRequest<AdapterRequestParams>,
-    res: AxiosResponse<CoinsResponse[]>,
-  ): AdapterResponse<CoinsResponse[]> => {
-    return {
-      data: res.data,
-      statusCode: 200,
-      result: res.data,
-    }
-  },
-  options: {
-    coalescing: true,
-  },
-})
-
-export const endpoint: AdapterEndpoint = {
-  name: 'coins',
-  transport: restEndpointTransport,
-  inputParameters,
-}

package/src/examples/coingecko/src/endpoint/crypto-marketcap.ts

@@ -1,66 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios'
-import { AdapterEndpoint, AdapterContext } from '../../../../adapter'
-import { BatchWarmingTransport } from '../../../../transports/batch-warming'
-import { ProviderResult } from '../../../../util'
-import { InputParameters } from '../../../../validation'
-import { baseInputParameters } from '../../../../validation/input-params'
-import {
-  AdapterRequestParams,
-  ProviderRequestBody,
-  buildBatchedRequestBody,
-  constructEntry,
-  ProviderResponseBody,
-} from '../cryptoUtils'
-
-export const inputParameters: InputParameters = {
-  overrides: baseInputParameters['overrides'],
-  coinid: {
-    description: 'The CoinGecko id or to query',
-    required: false,
-  },
-  base: {
-    aliases: ['from', 'coin'],
-    description: 'The symbol of symbols of the currency to query',
-    required: false,
-  },
-  quote: {
-    aliases: ['to', 'market'],
-    description: 'The symbol of the currency to convert to',
-    required: true,
-  },
-}
-
-const batchEndpointTransport = new BatchWarmingTransport({
-  prepareRequest: (
-    params: AdapterRequestParams[],
-    context: AdapterContext,
-  ): AxiosRequestConfig<ProviderRequestBody> => {
-    const requestBody = buildBatchedRequestBody(params, context.adapterConfig)
-    requestBody.params.include_market_cap = true
-    return requestBody
-  },
-  parseResponse: (
-    params: AdapterRequestParams[],
-    res: AxiosResponse<ProviderResponseBody>,
-  ): ProviderResult<AdapterRequestParams>[] => {
-    const entries = [] as ProviderResult<AdapterRequestParams>[]
-    for (const requestPayload of params) {
-      const entry = constructEntry(
-        res,
-        requestPayload,
-        `${requestPayload.quote.toLowerCase()}_market_cap`,
-      )
-      if (entry) {
-        entries.push(entry)
-      }
-    }
-    return entries
-  },
-})
-
-export const endpoint: AdapterEndpoint = {
-  name: 'marketcap',
-  aliases: ['crypto-marketcap'],
-  transport: batchEndpointTransport,
-  inputParameters,
-}

package/src/examples/coingecko/src/endpoint/crypto-volume.ts

@@ -1,66 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios'
-import { AdapterEndpoint, AdapterContext } from '../../../../adapter'
-import { BatchWarmingTransport } from '../../../../transports/batch-warming'
-import { ProviderResult } from '../../../../util'
-import { InputParameters } from '../../../../validation'
-import { baseInputParameters } from '../../../../validation/input-params'
-import {
-  AdapterRequestParams,
-  ProviderRequestBody,
-  buildBatchedRequestBody,
-  constructEntry,
-  ProviderResponseBody,
-} from '../cryptoUtils'
-
-export const inputParameters: InputParameters = {
-  overrides: baseInputParameters['overrides'],
-  coinid: {
-    description: 'The CoinGecko id or to query',
-    required: false,
-  },
-  base: {
-    aliases: ['from', 'coin'],
-    description: 'The symbol of symbols of the currency to query',
-    required: false,
-  },
-  quote: {
-    aliases: ['to', 'market'],
-    description: 'The symbol of the currency to convert to',
-    required: true,
-  },
-}
-
-const batchEndpointTransport = new BatchWarmingTransport({
-  prepareRequest: (
-    params: AdapterRequestParams[],
-    context: AdapterContext,
-  ): AxiosRequestConfig<ProviderRequestBody> => {
-    const requestBody = buildBatchedRequestBody(params, context.adapterConfig)
-    requestBody.params.include_24hr_vol = true
-    return requestBody
-  },
-  parseResponse: (
-    params: AdapterRequestParams[],
-    res: AxiosResponse<ProviderResponseBody>,
-  ): ProviderResult<AdapterRequestParams>[] => {
-    const entries = [] as ProviderResult<AdapterRequestParams>[]
-    for (const requestPayload of params) {
-      const entry = constructEntry(
-        res,
-        requestPayload,
-        `${requestPayload.quote.toLowerCase()}_24h_vol`,
-      )
-      if (entry) {
-        entries.push(entry)
-      }
-    }
-    return entries
-  },
-})
-
-export const endpoint: AdapterEndpoint = {
-  name: 'volume',
-  aliases: ['crypto-volume'],
-  transport: batchEndpointTransport,
-  inputParameters,
-}

package/src/examples/coingecko/src/endpoint/crypto.ts

@@ -1,63 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios'
-import { AdapterEndpoint, AdapterContext } from '../../../../adapter'
-import { BatchWarmingTransport } from '../../../../transports/batch-warming'
-import { ProviderResult } from '../../../../util'
-import { InputParameters } from '../../../../validation'
-import { baseInputParameters } from '../../../../validation/input-params'
-import {
-  AdapterRequestParams,
-  ProviderRequestBody,
-  buildBatchedRequestBody,
-  constructEntry,
-  ProviderResponseBody,
-} from '../cryptoUtils'
-
-export const inputParameters: InputParameters = {
-  overrides: baseInputParameters['overrides'],
-  coinid: {
-    description: 'The CoinGecko id or to query',
-    required: false,
-  },
-  base: {
-    aliases: ['from', 'coin'],
-    description: 'The symbol of symbols of the currency to query',
-    required: false,
-  },
-  quote: {
-    aliases: ['to', 'market'],
-    description: 'The symbol of the currency to convert to',
-    required: true,
-  },
-}
-
-const batchEndpointTransport = new BatchWarmingTransport({
-  prepareRequest: (
-    params: AdapterRequestParams[],
-    context: AdapterContext,
-  ): AxiosRequestConfig<ProviderRequestBody> => {
-    return buildBatchedRequestBody(params, context.adapterConfig)
-  },
-  parseResponse: (
-    params: AdapterRequestParams[],
-    res: AxiosResponse<ProviderResponseBody>,
-  ): ProviderResult<AdapterRequestParams>[] => {
-    const entries = [] as ProviderResult<AdapterRequestParams>[]
-    for (const requestPayload of params) {
-      const entry = constructEntry(res, requestPayload, requestPayload.quote.toLowerCase())
-      // NOTE: the `entries` array is going to be shorter than the `params` array if one of the params has a bad token.
-      // Is that okay?  I did this to avoid caching an invalid value for transient DP issues.  Just want to make
-      // sure this works within the core framework
-      if (entry) {
-        entries.push(entry)
-      }
-    }
-    return entries
-  },
-})
-
-export const endpoint: AdapterEndpoint = {
-  name: 'crypto',
-  aliases: ['crypto-batched', 'batched', 'batch'],
-  transport: batchEndpointTransport,
-  inputParameters,
-}

package/src/examples/coingecko/src/endpoint/dominance.ts

@@ -1,40 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios'
-import { AdapterEndpoint, AdapterContext } from '../../../../adapter'
-import { BatchWarmingTransport } from '../../../../transports/batch-warming'
-import { ProviderResult } from '../../../../util'
-import {
-  buildGlobalRequestBody,
-  AdapterRequestParams,
-  ProviderResponseBody,
-  constructEntry,
-  inputParameters,
-} from '../globalUtils'
-
-const batchEndpointTransport = new BatchWarmingTransport({
-  prepareRequest: (
-    params: AdapterRequestParams[],
-    context: AdapterContext,
-  ): AxiosRequestConfig<never> => {
-    return buildGlobalRequestBody(context.adapterConfig)
-  },
-  parseResponse: (
-    params: AdapterRequestParams[],
-    res: AxiosResponse<ProviderResponseBody>,
-  ): ProviderResult<AdapterRequestParams>[] => {
-    const entries = [] as ProviderResult<AdapterRequestParams>[]
-    for (const requestPayload of params) {
-      const entry = constructEntry(res, requestPayload, 'market_cap_percentage')
-      if (entry) {
-        entries.push(entry)
-      }
-    }
-    return entries
-  },
-})
-
-export const endpoint: AdapterEndpoint = {
-  name: 'dominance',
-  aliases: ['market_cap_percentage'],
-  transport: batchEndpointTransport,
-  inputParameters,
-}

package/src/examples/coingecko/src/endpoint/global-marketcap.ts

@@ -1,40 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios'
-import { AdapterEndpoint, AdapterContext } from '../../../../adapter'
-import { BatchWarmingTransport } from '../../../../transports/batch-warming'
-import { ProviderResult } from '../../../../util'
-import {
-  buildGlobalRequestBody,
-  AdapterRequestParams,
-  ProviderResponseBody,
-  constructEntry,
-  inputParameters,
-} from '../globalUtils'
-
-const batchEndpointTransport = new BatchWarmingTransport({
-  prepareRequest: (
-    params: AdapterRequestParams[],
-    context: AdapterContext,
-  ): AxiosRequestConfig<never> => {
-    return buildGlobalRequestBody(context.adapterConfig)
-  },
-  parseResponse: (
-    params: AdapterRequestParams[],
-    res: AxiosResponse<ProviderResponseBody>,
-  ): ProviderResult<AdapterRequestParams>[] => {
-    const entries = [] as ProviderResult<AdapterRequestParams>[]
-    for (const requestPayload of params) {
-      const entry = constructEntry(res, requestPayload, 'total_market_cap')
-      if (entry) {
-        entries.push(entry)
-      }
-    }
-    return entries
-  },
-})
-
-export const endpoint: AdapterEndpoint = {
-  name: 'globalmarketcap',
-  aliases: ['total_market_cap'],
-  transport: batchEndpointTransport,
-  inputParameters,
-}

package/src/examples/coingecko/src/endpoint/index.ts

@@ -1,6 +0,0 @@
-export { endpoint as coins } from './coins'
-export { endpoint as crypto } from './crypto'
-export { endpoint as cryptoMarketcap } from './crypto-marketcap'
-export { endpoint as globalMarketcap } from './global-marketcap'
-export { endpoint as dominance } from './dominance'
-export { endpoint as cryptoVolume } from './crypto-volume'

package/src/examples/coingecko/src/globalUtils.ts

@@ -1,78 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios'
-import { PRO_API_ENDPOINT, DEFAULT_API_ENDPOINT } from './config'
-import { AdapterConfig } from '../../../config'
-import { makeLogger } from '../../../util/logger'
-import { InputParameters } from '../../../validation'
-
-const logger = makeLogger('CoinGecko Global Batched')
-
-export const inputParameters: InputParameters = {
-  market: {
-    aliases: ['to', 'quote'],
-    description: 'The ticker of the coin to query',
-    required: true,
-  },
-}
-
-export interface AdapterRequestParams {
-  market: string
-}
-
-export interface ProviderResponseBody {
-  data: {
-    active_cryptocurrencies: number
-    upcoming_icos: number
-    ongoing_icos: number
-    ended_icos: number
-    markets: number
-    total_market_cap: Record<string, number>
-    total_volume: Record<string, number>
-    market_cap_percentage: Record<string, number>
-    market_cap_change_percentage_24h_usd: number
-    updated_at: number
-  }
-}
-
-interface ResultEntry {
-  value: number
-  params: AdapterRequestParams
-}
-
-export const buildGlobalRequestBody = (config: AdapterConfig): AxiosRequestConfig<never> => {
-  const apiKey = {
-    x_cg_pro_api_key: config.API_KEY,
-  }
-  return {
-    baseURL: config.API_KEY ? PRO_API_ENDPOINT : DEFAULT_API_ENDPOINT,
-    url: '/global',
-    method: 'GET',
-    params: apiKey,
-  }
-}
-
-export const constructEntry = (
-  res: AxiosResponse<ProviderResponseBody>,
-  requestPayload: AdapterRequestParams,
-  resultPath: 'total_market_cap' | 'market_cap_percentage',
-): ResultEntry | undefined => {
-  const resultData = res.data.data
-  if (!resultData) {
-    logger.warn(`Data not found".`)
-    return
-  }
-  const totalMarketcapData = resultData[resultPath]
-  if (!totalMarketcapData) {
-    logger.warn(`Data for "${resultPath}" not found".`)
-    return
-  }
-  const result = totalMarketcapData[requestPayload.market.toLowerCase()]
-  if (!result) {
-    logger.warn(`Data for "${requestPayload.market}" not found".`)
-    return
-  }
-  const entry = {
-    params: requestPayload,
-    value: result,
-  } as ResultEntry
-  return entry
-}

package/src/examples/coingecko/src/index.ts

@@ -1,17 +0,0 @@
-import { Adapter } from '../../../../src/adapter'
-import overrides from './config/overrides.json'
-import {
-  coins,
-  crypto,
-  cryptoVolume,
-  cryptoMarketcap,
-  dominance,
-  globalMarketcap,
-} from './endpoint'
-
-export const adapter: Adapter = {
-  defaultEndpoint: 'crypto',
-  name: 'coingecko',
-  endpoints: [crypto, coins, cryptoMarketcap, cryptoVolume, dominance, globalMarketcap],
-  overrides: (overrides as Record<string, Record<string, string>>)['coingecko'],
-}