@chainlink/external-adapter-framework 0.0.6 → 0.0.7

package/src/config/index.ts

@@ -1,501 +0,0 @@
-// Import { getRandomRequiredEnv, getRandomEnv, getEnv } from '../util'
-
-export const BaseSettings = {
-  // V2 compat
-  // TODO: Remove non used in v3 ones
-  // API_ENDPOINT: {
-  //   type: 'string',
-  // },
-  API_KEY: {
-    description: 'Default setting for an EA key',
-    type: 'string',
-  },
-  // API_TIMEOUT: {
-  //   type: 'number',
-  //   default: 30000,
-  // },
-  // API_VERBOSE: {
-  //   type: 'boolean',
-  // },
-  BASE_URL: {
-    description: 'Starting path for the EA handler endpoint',
-    type: 'string',
-    default: '/',
-  },
-  // CACHE_ENABLED: {
-  //   type: 'boolean',
-  //   default: true,
-  // },
-  // CACHE_KEY_GROUP: {
-  //   type: 'string',
-  // },
-  CACHE_MAX_AGE: {
-    description: 'Maximum amount of time (in ms) that a response will stay cached',
-    type: 'number',
-    default: 90000,
-  },
-  // CACHE_MAX_ITEMS: {
-  //   type: 'number',
-  //   default: 1000,
-  // },
-  // CACHE_MIN_AGE: {
-  //   type: 'number',
-  //   default: 30000,
-  // },
-  // CACHE_REDIS_CONNECTION_TIMEOUT: {
-  //   type: 'number',
-  //   default: 15000,
-  // },
-  CACHE_REDIS_HOST: {
-    description: 'Hostname for the Redis instance to be used',
-    type: 'string',
-    default: '127.0.0.1',
-  },
-  // CACHE_REDIS_MAX_QUEUED_ITEMS: {
-  //   type: 'number',
-  //   default: 100,
-  // },
-  // CACHE_REDIS_MAX_RECONNECT_COOLDOWN: {
-  //   type: 'number',
-  //   default: 3000,
-  // },
-  // CACHE_REDIS_PASSWORD: {
-  //   type: 'string',
-  // },
-  // CACHE_REDIS_PATH: {
-  //   type: 'string',
-  // },
-  CACHE_REDIS_PORT: {
-    description: 'Port for the Redis instance to be used',
-    type: 'number',
-    default: 6379,
-  },
-  // CACHE_REDIS_TIMEOUT: {
-  //   type: 'number',
-  //   default: 500,
-  // },
-  // CACHE_REDIS_URL: {
-  //   type: 'string',
-  // },
-  CACHE_TYPE: {
-    description: 'The type of cache to use throughout the EA',
-    type: 'enum',
-    default: 'local',
-    options: ['local', 'redis'],
-  },
-  // CACHE_UPDATE_AGE_ON_GET: {
-  //   type: 'boolean',
-  //   default: false,
-  // },
-  CORRELATION_ID_ENABLED: {
-    description: 'Flag to enable correlation IDs for sent requests in logging',
-    type: 'boolean',
-    default: true,
-  },
-  // DEBUG: {
-  //   type: 'boolean',
-  // },
-  // DEFAULT_WS_HEARTBEAT_INTERVAL: {
-  //   type: 'number',
-  //   default: 30000,
-  // },
-  EA_PORT: {
-    description:
-      'Port through which the EA will listen for REST requests (if mode is set to "reader" or "reader-writer")',
-    type: 'number',
-    default: 8080,
-  },
-  // ENV_ADAPTER_URL: {
-  //   type: 'string',
-  // },
-  // ERROR_CAPACITY: {
-  //   type: 'number',
-  // },
-  EXPERIMENTAL_METRICS_ENABLED: {
-    description:
-      'Flag to specify whether or not to collect metrics. Used as fallback for METRICS_ENABLED',
-    type: 'boolean',
-    default: true,
-  },
-  // LEGACY_ENV_ADAPTER_URL: {
-  //   type: 'string',
-  // },
-  LOG_LEVEL: {
-    description: 'Minimum level required for logs to be output',
-    type: 'string',
-    default: 'info',
-  },
-  METRICS_ENABLED: {
-    description: 'Flag to specify whether or not to startup the metrics server',
-    type: 'boolean',
-    default: true,
-  },
-  METRICS_NAME: {
-    description: 'Metrics name',
-    type: 'string',
-  },
-  METRICS_PORT: {
-    description: 'Port metrics will be exposed to',
-    type: 'number',
-    default: 9080,
-  },
-  METRICS_USE_BASE_URL: {
-    description: 'Flag to specify whether or not to prepend the BASE_URL to the metrics endpoint',
-    type: 'boolean',
-  },
-  RATE_LIMIT_API_TIER: {
-    description:
-      'Rate limiting tier to use from the available options for the adapter. If not present, the adapter will run using the first tier on the list.',
-    type: 'string',
-  },
-  // RATE_LIMIT_CAPACITY_MINUTE: {
-  //   type: 'number',
-  // },
-  // RATE_LIMIT_CAPACITY_SECOND: {
-  //   type: 'number',
-  // },
-  // RATE_LIMIT_CAPACITY: {
-  //   type: 'number',
-  // },
-  // RATE_LIMIT_ENABLED: {
-  //   type: 'boolean',
-  //   default: true,
-  // },
-  // RECORD: {
-  //   type: 'boolean',
-  // },
-  // REQUEST_COALESCING_ENABLED: {
-  //   type: 'boolean',
-  // },
-  // REQUEST_COALESCING_ENTROPY_MAX: {
-  //   type: 'number',
-  //   default: 0,
-  // },
-  // REQUEST_COALESCING_INTERVAL_COEFFICIENT: {
-  //   type: 'number',
-  //   default: 2,
-  // },
-  // REQUEST_COALESCING_INTERVAL_MAX: {
-  //   type: 'number',
-  //   default: 1000,
-  // },
-  // REQUEST_COALESCING_INTERVAL: {
-  //   type: 'number',
-  //   default: 100,
-  // },
-  // REQUEST_COALESCING_MAX_RETRIES: {
-  //   type: 'number',
-  //   default: 5,
-  // },
-  // RETRY: {
-  //   type: 'boolean',
-  //   default: 1,
-  // },
-  // SERVER_RATE_LIMIT_MAX: {
-  //   type: 'number',
-  //   default: 250,
-  // },
-  // SERVER_SLOW_DOWN_AFTER_FACTOR: {
-  //   type: 'number',
-  //   default: 0.8,
-  // },
-  // SERVER_SLOW_DOWN_DELAY_MS: {
-  //   type: 'number',
-  //   default: 500,
-  // },
-  // TIMEOUT: {
-  //   type: 'number',
-  // },
-  // WARMUP_ENABLED: {
-  //   type: 'boolean',
-  //   default: true,
-  // },
-  // WARMUP_INTERVAL: {
-  //   type: 'number',
-  // },
-  WARMUP_SUBSCRIPTION_TTL: {
-    type: 'number',
-    description: '',
-    default: 10000,
-  },
-  // WARMUP_UNHEALTHY_THRESHOLD: {
-  //   type: 'number',
-  //   default: 3,
-  // },
-  // WS_API_ENDPOINT: {
-  //   type: 'string',
-  // },
-  // WS_API_KEY: {
-  //   type: 'string',
-  // },
-  // WS_CONNECTION_KEY: {
-  //   type: 'string',
-  //   default: 1,
-  // },
-  // WS_CONNECTION_LIMIT: {
-  //   type: 'number',
-  //   default: 1,
-  // },
-  // WS_CONNECTION_RETRY_DELAY: {
-  //   type: 'number',
-  //   default: 1000,
-  // },
-  // WS_CONNECTION_RETRY_LIMIT: {
-  //   type: 'number',
-  //   default: 3,
-  // },
-  // WS_CONNECTION_TTL: {
-  //   type: 'number',
-  //   default: 70000,
-  // },
-  // WS_ENABLED: {
-  //   type: 'boolean',
-  //   default: false,
-  // },
-  // WS_SUBSCRIPTION_LIMIT: {
-  //   type: 'number',
-  //   default: 10,
-  // },
-  // WS_SUBSCRIPTION_PRIORITY_LIST: {
-  //   type: 'string',
-  // },
-  // WS_SUBSCRIPTION_TTL: {
-  //   type: 'number',
-  //   default: 120000,
-  // },
-  // WS_SUBSCRIPTION_UNRESPONSIVE_TTL: {
-  //   type: 'number',
-  //   default: false,
-  // },
-  // WS_TIME_UNTIL_HANDLE_NEXT_MESSAGE_OVERRIDE: {
-  //   type: 'number',
-  // },
-
-  // V3
-  CACHE_POLLING_MAX_RETRIES: {
-    description:
-      'Max amount of times to attempt to find EA response in the cache after the Transport has been set up',
-    type: 'number',
-    default: 10,
-  },
-  CACHE_POLLING_SLEEP_MS: {
-    description:
-      'The number of ms to sleep between each retry to fetch the EA response in the cache',
-    type: 'number',
-    default: 200,
-  },
-  DEFAULT_CACHE_KEY: {
-    description: 'Default key to be used when one cannot be determined from request parameters',
-    type: 'string',
-    default: 'DEFAULT_CACHE_KEY',
-  },
-  EA_HOST: {
-    description:
-      'Host this EA will listen for REST requests on (if mode is set to "reader" or "reader-writer")',
-    type: 'string',
-    default: '::',
-  },
-  EA_MODE: {
-    description:
-      'Port this EA will listen for REST requests on (if mode is set to "reader" or "reader-writer")',
-    type: 'enum',
-    default: 'reader-writer',
-    options: ['reader', 'writer', 'reader-writer'],
-  },
-  REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES: {
-    description:
-      'Maximum amount of times the Rest Transport will attempt to set up a request when blocked by the rate limiter',
-    type: 'number',
-    default: 3,
-  },
-  REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES: {
-    description:
-      'Time that the Rest Transport will wait between retries when blocked by the rate limiter',
-    type: 'number',
-    default: 400,
-  },
-  // CACHE_KEY_IGNORED_PROPS : {
-  //   description: 'Properties to ignore when generating a feed ID for requests',
-  //   type: 'string'
-  // }
-} as const
-
-export const buildAdapterConfig = <
-  CustomSettings extends CustomSettingsType<CustomSettings> = EmptySettings,
->({
-  overrides = {} as Partial<BaseAdapterConfig>,
-  customSettings = {} as SettingsMap,
-}): AdapterConfig<CustomSettings> => {
-  const validationErrors = [] as string[]
-  const vars = {} as Record<string, SettingValueType | undefined>
-
-  // Iterate base adapter env vars
-  for (const [key, config] of Object.entries(BaseSettings) as Array<
-    [keyof BaseAdapterConfig, Setting]
-  >) {
-    const value = getEnv(key as string, config) ?? overrides?.[key] ?? config.default
-    vars[key] = value
-  }
-
-  // Iterate custom vars
-  for (const [key, config] of Object.entries(customSettings) as Array<[string, Setting]>) {
-    if ((BaseSettings as Record<string, unknown>)[key as string]) {
-      throw new Error(
-        `Custom env var "${key}" declared, but a base framework env var with that name already exists.`,
-      )
-    }
-
-    const value = getEnv(key as string, config) ?? config.default
-
-    // Check if a required setting has been provided
-    if (config.required && value === null) {
-      validationErrors.push(`${key}: Value is required, but none was provided`)
-    } else if (config.validate) {
-      // Cast validate to unknown because TS can't select one of multiple variants of the validate function signature
-      const validationRes = (
-        config.validate as unknown as (value?: SettingValueType) => ValidationErrorMessage
-      )(value)
-      if (validationRes) {
-        validationErrors.push(`${key}: ${validationRes}`)
-      }
-    }
-    vars[key] = value
-  }
-
-  if (validationErrors.length > 0) {
-    throw new Error(
-      `Validation failed for the following variables:\n ${validationErrors.join('\n')}`,
-    )
-  }
-
-  return vars as AdapterConfig<CustomSettings>
-}
-
-const getEnv = (name: string, config: Setting): SettingValueType | null => {
-  const value = process.env[name]
-  if (!value) {
-    return null
-  }
-
-  switch (config.type) {
-    case 'string':
-      return value
-    case 'number':
-      return parseInt(value)
-    case 'boolean':
-      return value === 'true'
-    case 'enum':
-      if (!config.options?.includes(value)) {
-        throw new Error(
-          `Env var "${name}" has value "${value}" which is not included in the valid options (${config.options})`,
-        )
-      }
-      return value
-  }
-}
-
-type SettingValueType = string | number | boolean
-type SettingType<C extends Setting> = C['type'] extends 'string'
-  ? string
-  : C['type'] extends 'number'
-  ? number
-  : C['type'] extends 'boolean'
-  ? boolean
-  : C['type'] extends 'enum'
-  ? C['options'] extends readonly string[]
-    ? C['options'][number]
-    : never
-  : never
-type BaseSettingsType = typeof BaseSettings
-export type Setting =
-  | {
-      type: 'string'
-      description: string
-      options?: never
-      default?: string
-      validate?: (value?: string) => ValidationErrorMessage
-      required?: false
-    }
-  | {
-      type: 'string'
-      description: string
-      options?: never
-      default?: string
-      validate?: (value: string) => ValidationErrorMessage
-      required: true
-    }
-  | {
-      type: 'number'
-      description: string
-      options?: never
-      default?: number
-      validate?: (value?: number) => ValidationErrorMessage
-      required?: false
-    }
-  | {
-      type: 'number'
-      description: string
-      options?: never
-      default?: number
-      validate?: (value: number) => ValidationErrorMessage
-      required: true
-    }
-  | {
-      type: 'boolean'
-      description: string
-      options?: never
-      default?: boolean
-      validate?: (value?: boolean) => ValidationErrorMessage
-      required?: false
-    }
-  | {
-      type: 'boolean'
-      description: string
-      options?: never
-      default?: boolean
-      validate?: (value: boolean) => ValidationErrorMessage
-      required: true
-    }
-  | {
-      type: 'enum'
-      description: string
-      default?: string
-      options: readonly string[]
-      validate?: (value?: string) => ValidationErrorMessage
-      required?: false
-    }
-  | {
-      type: 'enum'
-      description: string
-      default?: string
-      options: readonly string[]
-      validate?: (value: string) => ValidationErrorMessage
-      required: true
-    }
-
-export type AdapterConfigFromSettings<T extends SettingsMap> = {
-  -readonly [K in keyof T as T[K] extends {
-    default: SettingValueType
-  }
-    ? K
-    : T[K]['required'] extends true
-    ? K
-    : never]: SettingType<T[K]>
-} & {
-  -readonly [K in keyof T as T[K] extends {
-    default: SettingValueType
-  }
-    ? never
-    : T[K]['required'] extends true
-    ? never
-    : K]?: SettingType<T[K]> | undefined
-}
-
-export type BaseAdapterConfig = AdapterConfigFromSettings<BaseSettingsType>
-export type AdapterConfig<T extends CustomSettingsType<T> = SettingsMap> =
-  AdapterConfigFromSettings<T> & BaseAdapterConfig
-
-export type CustomSettingsType<T = SettingsMap> = Record<keyof T, Setting>
-export type EmptySettings = Record<string, never>
-export type SettingsMap = Record<string, Setting>
-export type ValidationErrorMessage = string | undefined

package/src/config/provider-limits.ts

@@ -1,130 +0,0 @@
-import { makeLogger } from '../util'
-
-export const DEFAULT_MINUTE_RATE_LIMIT = 60
-export const BURST_UNDEFINED_QUOTA_MULTIPLE = 2
-
-export const DEFAULT_WS_CONNECTIONS = 2
-export const DEFAULT_WS_SUBSCRIPTIONS = 10
-
-type RateLimitTimeFrame = 'rateLimit1s' | 'rateLimit1m' | 'rateLimit1h'
-
-type HTTPTier = {
-  rateLimit1s?: number
-  rateLimit1m?: number
-  rateLimit1h?: number
-  note?: string
-}
-
-type WSTier = {
-  connections: number
-  subscriptions: number
-}
-
-export interface Limits {
-  http: {
-    [tierName: string]: HTTPTier
-  }
-  ws: {
-    [tierName: string]: WSTier
-  }
-}
-
-interface ProviderRateLimit {
-  second: number
-  minute: number
-}
-
-const logger = makeLogger('ProviderLimits')
-
-export const getHTTPLimit = (
-  provider: string,
-  limits: Limits,
-  tier: string,
-  timeframe: RateLimitTimeFrame,
-): number => {
-  const providerLimit = getProviderLimits(provider, limits, tier, 'http')
-  return (providerLimit as HTTPTier)?.[timeframe] || 0
-}
-
-export const getRateLimit = (provider: string, limits: Limits, tier: string): ProviderRateLimit => {
-  const providerLimit = getProviderLimits(provider, limits, tier, 'http')
-  return calculateRateLimit(providerLimit as HTTPTier)
-}
-
-export const getWSLimits = (provider: string, limits: Limits, tier: string): WSTier => {
-  const providerLimit = getProviderLimits(provider, limits, tier, 'ws')
-  return calculateWSLimits(providerLimit as WSTier)
-}
-
-const getProviderLimits = (
-  provider: string,
-  limits: Limits,
-  tier: string,
-  protocol: 'ws' | 'http',
-): HTTPTier | WSTier | undefined => {
-  const providerConfig = parseLimits(limits)
-  if (!providerConfig) {
-    throw new Error(
-      `Rate Limit: Provider: "${provider}" doesn't match any provider spec in limits.json`,
-    )
-  }
-
-  const protocolConfig = providerConfig[protocol]
-  if (!protocolConfig) {
-    throw new Error(
-      `Rate Limit: "${provider}" doesn't have any configuration for ${protocol} in limits.json`,
-    )
-  }
-
-  let limitsConfig = protocolConfig[tier.toLowerCase()]
-
-  if (!limitsConfig) {
-    logger.debug(
-      `Rate Limit: "${provider} does not have tier ${tier} defined. Falling back to lowest tier"`,
-    )
-    limitsConfig = Object.values(protocolConfig)?.[0]
-  }
-
-  if (!limitsConfig) {
-    throw new Error(
-      `Rate Limit: Provider: "${provider}" has no tiers defined for ${protocol} in limits.json`,
-    )
-  }
-
-  return limitsConfig
-}
-
-const parseLimits = (limits: Limits): Limits => {
-  const _mapObject = (fn: any) => (o: any) => Object.fromEntries(Object.entries(o).map(fn))
-  const _formatProtocol = _mapObject((entry: any[]) => {
-    const [tierName, rest] = entry
-    return [tierName.toLowerCase(), { ...(rest as any) }]
-  })
-  const _formatProvider = (ls: Limits) => {
-    const http = _formatProtocol(ls.http)
-    const ws = _formatProtocol(ls?.ws)
-    return { http, ws }
-  }
-
-  return _formatProvider(limits)
-}
-
-const calculateWSLimits = (providerLimit: WSTier): WSTier => {
-  return {
-    connections: providerLimit.connections,
-    subscriptions: providerLimit.subscriptions,
-  }
-}
-
-const calculateRateLimit = (providerLimit: HTTPTier): ProviderRateLimit => {
-  let quota = providerLimit.rateLimit1m
-  if (!quota && providerLimit?.rateLimit1h) {
-    quota = providerLimit?.rateLimit1h / 60
-  } else if (!quota && providerLimit?.rateLimit1s) {
-    quota = providerLimit?.rateLimit1s * 60
-  }
-  return {
-    second: providerLimit?.rateLimit1s || ((quota as number) / 60) * BURST_UNDEFINED_QUOTA_MULTIPLE,
-    minute: quota as number,
-  }
-}

package/src/examples/coingecko/batch-warming.ts

@@ -1,79 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios'
-import { AdapterEndpoint } from '../../adapter'
-import { AdapterContext } from '../../transports'
-import { BatchWarmingTransport } from '../../transports/batch-warming'
-import { ProviderResult } from '../../util'
-import { InputParameters } from '../../validation'
-
-const DEFAULT_URL = 'https://pro-api.coingecko.com/api/v3'
-
-interface AdapterRequestParams {
-  base: string
-  quote: string
-}
-
-const inputParameters: InputParameters = {
-  coinid: {
-    description:
-      'The CoinGecko id or array of ids of the coin(s) to query (Note: because of current limitations to use a dummy base will need to be supplied)',
-    required: false,
-  },
-  base: {
-    aliases: ['from', 'coin'],
-    description: 'The symbol or array of symbols of the currency to query',
-    required: true,
-  },
-  quote: {
-    aliases: ['to', 'market'],
-    description: 'The symbol of the currency to convert to',
-    required: true,
-  },
-}
-interface ProviderRequestBody {
-  ids: string
-  vs_currencies: string
-}
-
-interface ProviderResponseBody {
-  [base: string]: {
-    [quote: string]: number
-  }
-}
-
-const batchEndpointTransport = new BatchWarmingTransport({
-  prepareRequest: (
-    params: AdapterRequestParams[],
-    context: AdapterContext,
-  ): AxiosRequestConfig<ProviderRequestBody> => {
-    return {
-      baseURL: DEFAULT_URL,
-      url: '/simple/price',
-      method: 'GET',
-      params: {
-        ids: [...new Set(params.map((p) => p.base))].join(','),
-        vs_currencies: [...new Set(params.map((p) => p.quote))].join(','),
-        x_cg_pro_api_key: context.adapterConfig.API_KEY,
-      },
-    }
-  },
-  parseResponse: (
-    res: AxiosResponse<ProviderResponseBody>,
-  ): ProviderResult<AdapterRequestParams>[] => {
-    const entries = [] as ProviderResult<AdapterRequestParams>[]
-    for (const [base, entry] of Object.entries(res.data)) {
-      for (const [quote, price] of Object.entries(entry)) {
-        entries.push({
-          params: { base, quote },
-          value: price,
-        })
-      }
-    }
-    return entries
-  },
-})
-
-export const batchEndpoint: AdapterEndpoint = {
-  name: 'batch',
-  transport: batchEndpointTransport,
-  inputParameters,
-}