@chainlink/external-adapter-framework 0.0.14 → 0.0.15

package/docker-compose.yaml

@@ -0,0 +1,35 @@
+# Very basic stack to demonstrate horizontal scaling
+services:
+  redis:
+    image: redis
+    container_name: redis
+
+  coingecko-reader:
+    image: node:alpine
+    ports:
+      - 8080
+    deploy:
+      mode: replicated
+      replicas: 2
+    environment:
+      - DISABLE_BACKGROUND_EXECUTOR=true
+    volumes:
+      - ./:/home/node/app
+    command: node /home/node/app/dist/test.js
+
+  coingecko-writer:
+    image: node:alpine
+    volumes:
+      - ./:/home/node/app
+    environment:
+      - DISABLE_REST_API=true
+    command: node /home/node/app/dist/test.js
+
+  lb:
+    image: dockercloud/haproxy
+    links:
+      - coingecko-reader
+    ports:
+      - '80:80'
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock

package/env.sh

@@ -0,0 +1,54 @@
+#!/bin/bash
+export API_KEY=H49mG5VrVe7X9s8RJ1RhMw21W
+export PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
+MIIJKwIBAAKCAgEA0M45Kf922BFpP0iKeXRk3lFgQXQNBUV2+6hTxZZny+2eXs6c
+vMPOBOhBvCAC1INsp+ytgNLfkqC+i51YBASkA2mtwH3NhPqVwj8IJh32XY4bZ7Y8
+ZlvudFQP6CcoW6PLJEBTw6XDk9n0myvO0MfgszIjtwGTlDMTZggE5QXn9HtlGbZM
+mI5VOWJ1TwbjTSWCck5wqLflM7AUzRQ56SN+9WSiH+jY7HDthvYJqjc3ldu92JwF
+XdvTbm/fiYnwtu1S9aGmJggorMTBz1G03d9kVmShXZE38FN1ZFaDnsSCAco3Uvod
+fxZOyQ4hVjQVsLnZxl7ieCV2b7XPKEA5bqDknIKJlPxa+dW8bQbYtePBlmRc/Qiy
+TaXdoH7JIuCLbX8+mBlpDyu7Q/bebVRoYOTHBTyI6PODudc5GSSWvESuMxT4d40A
+5S9alHIHINrM9oZyZPzp2zbM3sfWeC57yRaVwnI2TiZ3EAfwYzApSmPPc9K0N2ap
+GdRDF/VVKnmF0z7NwBCIvhnOpkBeOAWtaKNpyH96+qdgf75lSP41rcapM5g3w04u
+uyK0E5lT5cOYdKh3UXJYrmj+oWuvUwwaPnrFBFQuy7OT6+koOMGcGkQu/RGeE5ln
+ZHiWiL+8jyvr6hsPbzAyjPk6RsDu+X3a4QxwKobd2qt40ODfgQGBE8G+eCMCAwEA
+AQKCAgEAiNXcWE110Hr4geRD+vvv7lFdxwcKUV4IbzsMSvwZ4WZC1taHmJyoskaS
+bXp84E+QMSvFOBr5MNnuhQgD2f5AjYv/tZm7yV1+LuGnsXMJNJ4gD4M5acrtJYbB
+Nd4TcJqSUZtmSVykIow+5EF9Mw0Jj+VXymJaGFCwcbjnnD6Wl30V8Bercn40E3sW
+bUeSRchDCC2nXqnEpm7J8utCWCpO1Pmx1T9+iNQolL0/8DBnWOm8K+tzCOM6V7Ew
+yK2A9h/osdfRTjMilLYMXJSq9oui8YrYxLyZ8ACBedPIRY95szqVrucB1XsE/nUo
+G5nebQYeVQVxXFMQnnyC2VndSUZfCZK9/C66M3K/kqcAnnkzJPKDukfk/EcQmGNk
+i3UbAfsRV/nrS18tlI5Xht2XPFgXY9eG15fq1xZ3s3I547imGo7gslm52quaQswx
+TzxCFJSfMWypnAWmYMC46HNkR1V9mLQHQ9vEgMlNZl92o/dSE5KT0gs/CpMbhhwr
+8vV/z5c/qoP44u0Mq4xT1znpveVoV8UuAEKpRZ9zYPg2pzF4gvT3DbvIquhxx1nw
+hH9uh/uZ4iQG24DhZteCP/dy8iII9T7oH4CzHTuopu76a2foguk+4gu07vAqWwYW
+VKUF/Al38Mt1/fRM811Olh1NN0c5yQgfdlRVbk/m4hCPQ8uPdcECggEBAO8wRCxn
+1QjG+PRGE0wIx2kOjWmLSZjbZKcNJp/wTiJBOy/4rxjpmEB9HhRkKGJhzbvVCsYJ
+cZ2uk/tSYmkMa2L5Uv4ObeDMOx66Zv11O0H1xNIQLAIobiLPYcdHZvf0PcVY5OwA
+GGvHf4G5VfDHsxVDc2CfH5u5VdQ6qw5x2nTrwE5VLnbU92YvErlnB38Ybml35mqL
+BQ/fxCzUTxZfv4ywAvxatFLM9a7PIxCQXiLzzT+0npA87pbqSjCQiy+6IvUBfLiY
+OUCUxFniXiMdN9Y+6ZHhwXPNEk6p0tDcrciJEFLHfMbc2Se4ambttDmF+CkQ+787
+xdzhC3JIKzaUnJsCggEBAN97RjKxQM9roj2dBZO7A1q4oIaG9Uq1amJHePbSWQzn
+4uON3HJT2pyU7AiX5DSM3iV86l5jeHNwSBy3vQ158YiWD3FttQDYy69CvUPJjU5u
+PHtHHmOTEXIdCiuFk1gujyHu43PH1rI5oQMGhoW8FR2gO6X+Zx80XrsFL/1D9fsT
+LRwXn7gOBHEi8Ntx8P2PVgwnhq3W7pPDlD8hhb4LxPuFEJTWA2t5D01ZBLJMWnX1
+BYJ8AkIEY3P8O9jfvVM52t0PCaQDUOkPOyMS9tcP2KElWYI/NplX+dAUIE76uXn2
+A0nQk9GwYRFMMBOj4QBOHs3PjOejYmQ3YlJX/0vv1xkCggEBALbXXKXdUZp+D30b
+vFCZPWZvu2X9FeuFerHAedA1cGT7HHWVUrRmjP5vJnlL/xsFzLFTMAMm4PU6qOCr
+n5LR7Z0hHnIbMZ9wP5lDwMrrvLq1VxmFRz73DQoLIaGmUW4mBLpBM+28PO7W9/+A
+X9PJtHoCr8YinZT63kN3/Z7zJZ3PQZgfwX8RWXWBcnzL540ebfitsTOsxdfWpC3o
+tfRSiSjQu9eQttu81eolaZaV5YAugq26MqPsEC7JNqFdPSjkzygfVOn/Y3ScxGQ5
+iOCqyy45tW7Q9oLBNsdvRjpnF2l+bT36RMX3uQCGFsBL4UM/x+4Mj4Ul+iDY31kj
+FfWJMRUCggEBAJrDWuy2FaTO7A7xE7CnvP3xh7FB+tKe6apfxqRfLS4j09s0HarK
+6USwWPjmfzHpL9oUNJXjGsIOytGgaHrRrPOiv9UUXVnVyNB5TmqIRKRA8P+KU8Av
+U9CLzcQv/8b8j0C3l6pRhRvtjtRyi2xHwPPASC5/DFjuwn+PaxlgHBOgxweCUKh8
+hJT41oWR1Ysy3SsToE/43UVVFu/VPjJLIkHwd3gq8TlXH8K31+nFuIuhgAxJ5qJj
+OaBT1/orj4f4M9oMlOeRKFINqy1x76ElpyaJn//z2NK+uxBfL7SiKxoLxWEz4XpA
+RChfc5fWUHYOo4RxrCmp2vR96kgOCo1C7dkCggEBALb/I1Q5HxX2DSgss1C0ujN9
+nT1Bg85nUJpEU9FwOKLBssNoEKRHWDVzs9re5JpIQV5zNX9UMxYWXNJfQCZNl5Wp
+UVMo4sE6exWNPwypaM2MQbVBRjIF803Nxj2RbVURz9OPwyDep0hos0JSSztITQC0
+lrJLIFijFP8okb/Adw9PgsFR2/Nx8iXD8nV+OgmILs1CtSYTMF/w0Nhi8VjYZnAw
+ls3sNONh81PzDECTz5/FBPDAZjQprKm+/VBvo1XakXMkXCZ3dwFIRy1N21RvEf04
+dCaQxmbSZDkfkjW23A+3UCdkIUn5NupO/0WTnh6J+KUgFE4tBSx8MVyPDQwq930=
+-----END RSA PRIVATE KEY-----"
+export API_ENDPOINT="https://olb.bankfrick.li/webapi/v2/"

package/env2.sh

@@ -0,0 +1,55 @@
+#!/bin/bash
+export API_KEY=pN4Fq2SPmKVyh74C68853KWjf
+export PASSWORD=TKJ5tDz6
+export PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
+MIIJKQIBAAKCAgEA5YRKFCHAnTxKZ/bPor8y6vtm2O/IMS2TqlXYQsZviK3J6tEW
+6t9RY4YkRVve+Ap2dqM7Pvco07HNQcpSOz4VzEscanEkfjHmyAry0S0OY/fjjIjr
+whgO/0NFnJemZE9r3eePIRl7sNzkbVwE7vi8BO6R6aCviH2PpmhjAu82e5SUwj9J
+JC/33t81iOeLgftL5oeTFmA2oz2U8NpLtcfiKoIpvsYE/ZP3Qradf3R2+O8rxdEu
+fUbcIKAd+Q2ML3I2nZQJl0mvcb+ZwhzAlyX9faRdclm7fYlpsa0bokx5Wb1F6FWu
+xkpq68fIAoaNyKIL2kmv2jSFSoKROjGqcss/oy3Y41x7Ny3lPf355ZUAKwNDOVAC
+fQnC7e6tgEw0gVuS9GD1fH2QbpWW4Q0Pnl2mLYKotKt14tsUrcar9x+b73ltLhtF
+ktSuSmMPIDXukg8K9zaLdDpkWurHke6AGexiuJCJ4SGaN6XDT37RSLq4Ai86jZKA
+O5b52h4qbJ6ujADDtPLKWKoBLnyBhx+3gZMXABhdj1QGquhVhds5Z//b0gtcmtFf
+Mb3i1QIRcxEwE1dRl1x1soMqOqBUacpLr3bGRevcDWVeoxiK/+xQb+KbxtamYTs3
+BMxNS5Kg7bcIEd7/m4TCc2qLz6wy7XNR2o6PrCdIetjz1KaNtOGHzw+uDvcCAwEA
+AQKCAgBwhbTTveBytdY8thIB1f8emPZJMPVStueIQOHvit2vgpRVnQDBUY7TXjZ2
+Ep5zuJ1veINZUU8gyjC5Knm6Nav2JnTd8m5TuB9Ov59f0dkWRbe3dIEw/R6NIuwD
+441d7FoTxqyzK40qnoEW5GA+0I9NU7ERewfTwMsmaFLyY1iwqZ1sxh4Tsbix+XiD
+kBEjPpJtiNYhyDXBPjXBByTLEB3ffUT+FJLpxxsYB/ObQvv4+zjYmL9UB+Nv01Ae
+g/fQYwxHoQY6t5NeDvNQ6Uu6TpPCf0yY/UkgOLgqtZWwshFkX5jgWPGAoYdd5Oo3
+4sOsM1XgRPQD5G/cobqVbzgDY4XkiqxtYOxNLSCdf98C3Lyo6MMRYGEYLyg0Pn3t
+1UbgXXoA04rvulXZXyNEKMuPoBYm+MWU0yHay7BXLEe1doowMyVmOTLIbLmXKDGE
+URyi10lNKTB4fyvbxxrargwkuEPPF9B9Hd93VAcLRsB8k+O8zFzTG76KoGWt1WvK
+UZTGv7TGl0ji60gPoRi/5rGuD9rVYYzEZPIOKlF62zF2ec5LKUiQ1ThWUKGNS6dD
+TP89wvdKZ8GrBCtB8iCTOgqXMtBYU5r6NWjMPEoGeQhDTY6MYyWQWnxk6RjrHvcb
+LZ1sx0bwg4zUUKmR1SYmvf030YlD29rlPfQUAX4Qb81431e/wQKCAQEA9ENU8LqF
+UyFGcFRwa05lgWEr3AQcrRrfxiCAE/m1PmSNEKCqvth1OJMDz6O4COcAhHff6ElP
+AvXmN3pOz3w/ZBZ+r8GjUtMi1AEADZPpC4QRRiWonuMMSPUd+1eohXqMkdVwNZIu
+JilUlrI0PzDs9V9Ef57wDnNCtoSLMqgVK45QogAmPi5Be5fF05Vzfn/S+R6O/khV
+BFJT64NLi5Cz2UuHN3BInzWs8tqDAwXOXlH+p5IHzGLdmAuP2v9nTQyY9+8CsEhR
+3VvRWD8357gXeOu76awTaaSvT7rwWcjY4AtO420Dzdxaw3OnlulidbHcPRdUcBtD
+ehRuvQSK6UJ/xwKCAQEA8IuQg3udVaDG5imihEIhwt4A/wJW/XCvXrKKr/5TauDw
+mYYc5siEaBXD3tkRoUUKGnCHDm5TtVs7JhgJHiM8SX939eOhPLZ9CYtPGRCLsYn0
+RuGZUZAKKqMgfVujCX19iecXhbTYcBPbyWqBx41jRq/+WUjrSvMPmIZASiNePasB
+9nDo+Wajb+pF4hpmac4gi8vCB8THyv83w2inCHw5BJsG92JdhOsIoCAcXoW3Qjp/
+jWrGmhvqPVhII1wkvl+BOhQZw1tubo65RT7e2wUiMrRKpX/rpxoZf1rfq82Rt8YS
+o0yLkQmhYPaBYMhaZ1rcakH4DA9yzfYMM/yTdBFXUQKCAQA2nAcVet3r4/iXjIlF
+tFVFQ7BGlDTFDskQxptb2+wFcv2GxiTmXgZ3C4dCmNvAQcT/2L0adalQhCFgLdwI
+z0Js4gqYyLX3AnU66K5WWsczZ+dkw26bdy978DEvzD1E+k0LHajkkTX4Gi1rM5Qy
+vIF9qjrqPWJ2GJbFr4RfYuy4vCySy23BYR4Kv7fewf78PR+xyn81on4/ZRiWAtiU
+71kGL7ifUF8sGRf9g5TezCGDPNmuJRvROhlIsO0MjSVPOI3KgIkdWE3VK332OMwK
+5kF5K1rrtyjv6X24WZb6u8ig7mZIukqrb6RrJiRFvQ/iOE2A6wJZvf6sAH1xjN5x
+oAhpAoIBAQDpJj1iU9SCBJ4ExOIy026p1Eie44OxjyFL5j4qq5XrCC/sfmNRBZXg
+1QfO3hMKf0J1shAV2rXkGJNSLwXXYkuy6Yw6lvHXSQIU2CRIpRLheFd+xHe46KYS
+AZ8iIkn6jtm5anYQMOOAbp8fsM4tv0s0Xq1nmRgGw2Sgb6+srG9R0ojKd1I5OlS7
+yxUFPJV7hEFjfpGIuiD1Dz7bdno/7TfO0PyFl6ARj0YC/lzA+VZRKSYsygvJn7kA
+0KrLKyqqIyO8SXNXOS3mlwvYpEGZhHZLMxkPJNgiVVfVax1VBqFwwNmb0juMzwrO
+Ut/AETIe76ColVx5RBgArbXSRcQeQhihAoIBAQChvOJsqHmOnfjnMDC0J5bfYf4R
+1pkVZmPL5mTx/02s3eb62VO+q7iEhvWL8LrXN64UuKrC6V4RbxZ0QuCeVSEyn6ux
+8wkU5XnTqD1bCoDrvhKClz8dAONQb5mSfI/WZGwpn1mwEpnMe7Ifz0caCgWpWn7t
+e4vwLxzLUiNGlLHo7QcOVjvDUQFz96idsY9hvG691QALGKpJEygjULYLvfMJYLtT
+v2B6WQcQX+n59njO+CrJbA8iKW4Ry7HfmHoqgB5JAd4m9qUKZhJ2G562lpVgrUFu
+8m3h6Kw/A9LftG+wkHrzOT+XJ1HDd5mXGaqq9s2NqIeptlLErTBfkWTd7m1z
+-----END RSA PRIVATE KEY-----"
+export BASE_URL="https://olbsandbox.bankfrick.li/webapi/v2/"

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chainlink/external-adapter-framework",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "main": "dist/index.js",
   "license": "MIT",
   "dependencies": {
@@ -9,6 +9,8 @@
     "ioredis": "^5.0.4",
     "pino": "^7.9.2",
     "prom-client": "13.2.0",
+    "supertest": "^6.2.4",
+    "ts-jest": "^28.0.7",
     "ts-node": "^10.9.1",
     "typescript": "^4.6.3",
     "ws": "^8.5.0"
@@ -20,12 +22,16 @@
     "test-debug": "LOG_LEVEL=trace DEBUG=true EA_PORT=0 c8 ava --verbose",
     "build": "tsc",
     "lint": "eslint ./src && prettier --check ./src/**/*.ts",
-    "dev": "NODE_ENV=develop tsnd --respawn --transpile-only --project tsconfig.json './src/test.ts'"
+    "lint-fix": "eslint --fix ./src && prettier --write ./src/**/*.ts",
+    "dev": "NODE_ENV=develop tsnd --respawn --transpile-only --project tsconfig.json './src/test.ts'",
+    "verify": "yarn lint && yarn build && yarn build -p ./test/tsconfig.json && yarn test"
   },
   "devDependencies": {
     "@sinonjs/fake-timers": "^9.1.2",
+    "@types/jest": "^28.1.7",
     "@types/node": "^18.6.5",
     "@types/sinonjs__fake-timers": "^8.1.2",
+    "@types/supertest": "^2.0.12",
     "@types/ws": "^8.5.3",
     "@typescript-eslint/eslint-plugin": "^5.17.0",
     "@typescript-eslint/parser": "^5.17.0",
@@ -38,8 +44,13 @@
     "nock": "^13.2.4",
     "pino-pretty": "^7.6.0",
     "prettier": "^2.6.1",
+    "ts-loader": "^9.3.1",
+    "ts-node-dev": "2.0.0",
     "typedoc": "^0.22.15",
-    "ts-node-dev": "2.0.0"
+    "url": "^0.11.0",
+    "webpack": "^5.74.0",
+    "webpack-cli": "^4.10.0",
+    "webpack-merge": "^5.8.0"
   },
   "prettier": {
     "semi": false,

package/src/adapter.ts

@@ -0,0 +1,263 @@
+import { Cache, CacheFactory } from './cache'
+import { AdapterConfig, BaseAdapterConfig, CustomSettingsType, SettingsMap } from './config'
+import {
+  AdapterRateLimitTier,
+  BackgroundExecuteRateLimiter,
+  FixedFrequencyRateLimiter,
+  getRateLimitingTier,
+  RequestRateLimiter,
+  SimpleCountingRateLimiter,
+} from './rate-limiting'
+import { Transport } from './transports'
+import { makeLogger, SubscriptionSetFactory } from './util'
+import { InputParameters } from './validation/input-params'
+
+const logger = makeLogger('Adapter')
+
+/**
+ * Dependencies that will be injected into the Adapter on startup
+ */
+export interface AdapterDependencies {
+  // TODO: Complete docs
+  cache: Cache
+  requestRateLimiter: RequestRateLimiter
+  backgroundExecuteRateLimiter: BackgroundExecuteRateLimiter
+  subscriptionSetFactory: SubscriptionSetFactory
+}
+
+/**
+ * Context that will be used on background executions of a Transport.
+ * For example, the endpointName used to log statements or generate Cache keys.
+ */
+export interface AdapterContext<
+  CustomSettings extends CustomSettingsType<CustomSettings> = SettingsMap,
+> {
+  adapterEndpoint: AdapterEndpoint
+  adapterConfig: AdapterConfig<CustomSettings>
+}
+
+/**
+ * Structure to describe rate limits specs for the Adapter
+ */
+interface AdapterRateLimitingConfig {
+  /** Adapter rate limits, gotten from the specific tier requested */
+  tiers: Record<string, AdapterRateLimitTier>
+}
+
+/**
+ * Main structure of an External Adapter
+ */
+export interface Adapter {
+  /** Name of the adapter */
+  name: string
+
+  /** If present, the string that will be used for requests with no specified endpoint */
+  defaultEndpoint?: string
+
+  /** List of [[AdapterEndpoint]]s in the adapter */
+  endpoints: AdapterEndpoint[]
+
+  /** Map of overrides to the default config values for an Adapter */
+  envDefaultOverrides?: Partial<BaseAdapterConfig>
+
+  /** List of custom env vars for this particular adapter (e.g. RPC_URL) */
+  customSettings?: SettingsMap
+
+  /** Configuration relevant to outbound (EA --\> DP) communication rate limiting */
+  rateLimiting?: AdapterRateLimitingConfig
+
+  /** Overrides for converting the 'base' parameter that are hardcoded into the adapter. */
+  // This must be included in the middleware in order to generate deterministing cache keys for hardcoded overrides
+  overrides?: Record<string, string>
+}
+
+/**
+ * Structure to describe rate limits specs for a specific adapter endpoint
+ */
+export interface EndpointRateLimitingConfig {
+  /**
+   * How much of the total limit for the adapter will be assigned to this specific endpoint.
+   * Should be a non-zero positive number up to 100.
+   * Endpoints in the same adapter without a specific allocation will divide the remaining limits equally.
+   */
+  allocationPercentage: number
+}
+
+/**
+ * Structure to describe a specific endpoint in an [[Adapter]]
+ */
+export interface AdapterEndpoint {
+  /** Name that will be used to match input params to this endpoint (case insensitive) */
+  name: string
+
+  /** List of alternative endpoint names that will resolve to this same transport (case insensitive) */
+  aliases?: string[]
+
+  /** Transport that will be used to handle data processing and communication for this endpoint */
+  transport: Transport<any, any, any>
+
+  /** Specification of what the body of a request hitting this endpoint should look like (used for validation) */
+  inputParameters: InputParameters
+
+  /** Specific details related to the rate limiting for this endpoint in particular */
+  rateLimiting?: EndpointRateLimitingConfig
+}
+
+/**
+ * Structure to describe an adapter that has been initialized
+ */
+export interface InitializedAdapter extends Adapter {
+  /** Object containing alias translations for all endpoints */
+  endpointsMap: Record<string, AdapterEndpoint>
+
+  /** Initialized dependencies that the adapter will use */
+  dependencies: AdapterDependencies
+
+  /** Configuration params for various adapter properties */
+  config: AdapterConfig
+}
+
+/**
+ * This function will take an adapter structure and go through each endpoint, calculating
+ * each one's allocation of the total rate limits that are set for the adapter as a whole.
+ *
+ * @param adapter - the adapter to initialize rate limiting for
+ */
+const calculateRateLimitAllocations = (adapter: Adapter) => {
+  const numberOfEndpoints = adapter.endpoints.length
+  const endpointsWithExplicitAllocations = adapter.endpoints.filter((e) => e.rateLimiting)
+
+  const totalExplicitAllocation = endpointsWithExplicitAllocations
+    .map((e) => e.rateLimiting?.allocationPercentage || 0)
+    .reduce((sum, next) => sum + next, 0)
+
+  if (totalExplicitAllocation > 100) {
+    throw new Error('The total allocation set for all endpoints summed cannot exceed 100%')
+  }
+
+  if (
+    totalExplicitAllocation === 100 &&
+    numberOfEndpoints - endpointsWithExplicitAllocations.length > 0
+  ) {
+    throw new Error(
+      'The explicit allocation is at 100% but there are endpoints with implicit allocation',
+    )
+  }
+
+  const implicitAllocation = 100 - totalExplicitAllocation
+
+  logger.debug('Adapter rate limit allocations:')
+  for (const endpoint of adapter.endpoints) {
+    if (!endpoint.rateLimiting) {
+      endpoint.rateLimiting = {
+        allocationPercentage:
+          implicitAllocation / (numberOfEndpoints - endpointsWithExplicitAllocations.length),
+      }
+    }
+
+    logger.debug(`Endpoint [${endpoint.name}] - ${endpoint.rateLimiting?.allocationPercentage}%`)
+  }
+}
+
+/**
+ * This function will process dependencies for an adapter, such as caches or rate limiters,
+ * in order to inject them into transports and other relevant places later in the lifecycle.
+ *
+ * @param config - the configuration for this adapter
+ * @param inputDependencies - a partial obj of initialized dependencies to override the created ones
+ * @param rateLimitingConfig - details from the adapter regarding rate limiting
+ * @returns a set of AdapterDependencies all initialized
+ */
+export const initializeDependencies = (
+  adapter: Adapter,
+  config: AdapterConfig,
+  inputDependencies?: Partial<AdapterDependencies>,
+): AdapterDependencies => {
+  const dependencies = inputDependencies || {}
+  if (!dependencies.cache) {
+    dependencies.cache = CacheFactory.buildCache(config)
+  }
+
+  // In the future we might want something more complex, but for now it's better to simplify
+  // and just use the same rate limiting for everything. Once we have a more complex use case we
+  // can think of ways to make this more configurable.
+  const rateLimitingTier = getRateLimitingTier(
+    adapter.rateLimiting?.tiers,
+    config.RATE_LIMIT_API_TIER,
+  )
+  if (!dependencies.requestRateLimiter) {
+    dependencies.requestRateLimiter = new SimpleCountingRateLimiter().initialize(
+      adapter.endpoints,
+      rateLimitingTier,
+    )
+  }
+  if (!dependencies.backgroundExecuteRateLimiter) {
+    dependencies.backgroundExecuteRateLimiter = new FixedFrequencyRateLimiter().initialize(
+      adapter.endpoints,
+      rateLimitingTier,
+    )
+  }
+  if (!dependencies.subscriptionSetFactory) {
+    dependencies.subscriptionSetFactory = new SubscriptionSetFactory(config)
+  }
+
+  return dependencies as AdapterDependencies
+}
+
+/**
+ * Takes an adapter and normalizes all endpoint names and aliases, as well as the default endpoint.
+ * i.e. makes them lowercase for now
+ * @param adapter - an instance of an Adapter
+ */
+const normalizeEndpointNames = (adapter: Adapter) => {
+  // Make endpoints case insensitive, including default
+  adapter.defaultEndpoint = adapter.defaultEndpoint?.toLowerCase()
+
+  for (const endpoint of adapter.endpoints) {
+    endpoint.name = endpoint.name.toLowerCase()
+    endpoint.aliases = endpoint.aliases?.map((a) => a.toLowerCase())
+  }
+}
+
+/**
+ * Initializes all of the [[Transport]]s in the adapter, passing along any [[AdapterDependencies]] and [[AdapterConfig]].
+ * Additionally, it builds a map out of all the endpoint names and aliases (checking for duplicates).
+ *
+ * @param adapter - an instance of an Adapter
+ * @param dependencies - dependencies that the adapter will need at initialization
+ * @param config - configuration variables already processed and validated
+ * @returns - the adapter with all transports initialized and aliases map built
+ */
+export const initializeAdapter = async (
+  adapter: Adapter,
+  config: AdapterConfig,
+  dependencies?: Partial<AdapterDependencies>,
+): Promise<InitializedAdapter> => {
+  normalizeEndpointNames(adapter)
+  calculateRateLimitAllocations(adapter)
+  const initializedDependencies = initializeDependencies(adapter, config, dependencies)
+
+  const endpointsMap: Record<string, AdapterEndpoint> = {}
+
+  for (const endpoint of adapter.endpoints) {
+    // Add aliases to map to use in validation
+    const aliases = [endpoint.name, ...(endpoint.aliases || [])]
+    for (const alias of aliases) {
+      if (endpointsMap[alias]) {
+        throw new Error(`Duplicate endpoint / alias: "${alias}"`)
+      }
+      endpointsMap[alias] = endpoint
+    }
+
+    logger.debug(`Initializing transport for endpoint "${endpoint.name}"...`)
+    await endpoint.transport.initialize(initializedDependencies)
+  }
+
+  logger.debug('Adapter initialization complete.')
+  return {
+    ...adapter,
+    endpointsMap,
+    dependencies: initializedDependencies,
+    config,
+  }
+}

package/src/background-executor.ts

@@ -0,0 +1,52 @@
+import { Server } from 'http'
+import { AdapterContext, InitializedAdapter } from './adapter'
+import { makeLogger, sleep } from './util'
+
+const logger = makeLogger('BackgroundExecutor')
+
+/**
+ * Very simple background loop that will call the [[Transport.backgroundExecute]] functions in all Transports.
+ * It gets the time in ms to wait as the return value from those functions, and sleeps until next execution.
+ *
+ * @param adapter - an initialized External Adapter
+ * @param server - the http server to attach an on close listener to
+ */
+export async function callBackgroundExecutes(adapter: InitializedAdapter, server?: Server) {
+  // Set up variable to check later on to see if we need to stop this background "thread"
+  // If no server is provided, the listener won't be set and serverClosed will always be false
+  let serverClosed = false
+  server?.on('close', () => {
+    serverClosed = true
+  })
+
+  for (const endpoint of adapter.endpoints) {
+    const backgroundExecute = endpoint.transport.backgroundExecute?.bind(endpoint.transport)
+    if (!backgroundExecute) {
+      logger.debug(`Endpoint "${endpoint.name}" has no background execute, skipping...`)
+      continue
+    }
+
+    const context: AdapterContext = {
+      adapterEndpoint: endpoint,
+      adapterConfig: adapter.config,
+    }
+
+    const handler = async () => {
+      if (serverClosed) {
+        logger.info('Server closed, stopping recursive backgroundExecute handler chain')
+        return
+      }
+
+      logger.debug(`Calling background execute for endpoint "${endpoint.name}"`)
+      const timeToWait = await backgroundExecute(context)
+      logger.debug(
+        `Finished background execute for endpoint "${endpoint.name}", sleeping for ${timeToWait}ms`,
+      )
+      await sleep(timeToWait)
+      handler()
+    }
+
+    // Start recursive async calls
+    handler()
+  }
+}

package/src/cache/factory.ts

@@ -0,0 +1,26 @@
+import Redis from 'ioredis'
+import { AdapterConfig } from '../config'
+import { makeLogger } from '../util'
+import { LocalCache } from './local'
+import * as cacheMetrics from './metrics'
+import { RedisCache } from './redis'
+
+const logger = makeLogger('CacheFactory')
+export class CacheFactory {
+  static buildCache(config: AdapterConfig) {
+    logger.info(`Using "${config.CACHE_TYPE}" cache.`)
+    if (config.CACHE_TYPE === 'local') {
+      return new LocalCache()
+    } else if (config.CACHE_TYPE === 'redis') {
+      const redis = new Redis({
+        enableAutoPipelining: true, // This will make multiple commands be batch automatically
+        host: config.CACHE_REDIS_HOST,
+        port: config.CACHE_REDIS_PORT,
+      })
+      redis.on('connect', () => {
+        cacheMetrics.redisConnectionsOpen.inc()
+      })
+      return new RedisCache(redis)
+    }
+  }
+}