@chainlink/external-adapter-framework 0.0.22 → 0.0.25

package/cache/factory.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -7,6 +30,7 @@ exports.CacheFactory = void 0;
 const ioredis_1 = __importDefault(require("ioredis"));
 const util_1 = require("../util");
 const local_1 = require("./local");
+const cacheMetrics = __importStar(require("./metrics"));
 const redis_1 = require("./redis");
 const logger = (0, util_1.makeLogger)('CacheFactory');
 class CacheFactory {
@@ -24,6 +48,9 @@ class CacheFactory {
                 path: config.CACHE_REDIS_PATH,
                 timeout: config.CACHE_REDIS_TIMEOUT,
             });
+            redis.on('connect', () => {
+                cacheMetrics.redisConnectionsOpen.inc();
+            });
             return new redis_1.RedisCache(redis);
         }
     }

package/cache/index.js

@@ -10,12 +10,25 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildCacheMiddleware = exports.pollResponseFromCache = exports.calculateKey = exports.calculateFeedId = exports.calculateCacheKey = void 0;
 const util_1 = require("../util");
+const cacheMetrics = __importStar(require("./metrics"));
 __exportStar(require("./local"), exports);
 __exportStar(require("./redis"), exports);
 __exportStar(require("./factory"), exports);
@@ -144,8 +157,10 @@ const buildCacheMiddleware = (adapter) => async (req, res) => {
     if (response) {
         logger.debug('Found response from cache, sending that');
         if (adapter.config.METRICS_ENABLED && adapter.config.EXPERIMENTAL_METRICS_ENABLED) {
+            const label = cacheMetrics.cacheMetricsLabel(req.requestContext.cacheKey, req.requestContext.meta?.metrics?.feedId || 'N/A', adapter.config.CACHE_TYPE);
             // Record cache staleness and cache get count and value
-            calculateStaleness(response.maxAge, adapter.config.CACHE_MAX_AGE);
+            const staleness = calculateStaleness(response.maxAge, adapter.config.CACHE_MAX_AGE);
+            cacheMetrics.cacheGet(label, response.result, staleness);
             req.requestContext.meta = {
                 ...req.requestContext.meta,
                 metrics: { ...req.requestContext.meta?.metrics, cacheHit: true },

package/cache/local.js

@@ -1,7 +1,31 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocalCache = void 0;
 const util_1 = require("../util");
+const cacheMetrics = __importStar(require("./metrics"));
 const logger = (0, util_1.makeLogger)('LocalCache');
 /**
  * Local implementation of a Cache. It uses a simple js Object, storing entries with both
@@ -45,6 +69,8 @@ class LocalCache {
         const feedId = value.meta?.metrics?.feedId;
         if (feedId) {
             // Record cache set count, max age, and staleness (set to 0 for cache set)
+            const label = cacheMetrics.cacheMetricsLabel(key, feedId, cacheMetrics.CacheTypes.Local);
+            cacheMetrics.cacheSet(label, ttl);
         }
     }
     async setMany(entries, ttl) {

package/cache/redis.js

@@ -1,7 +1,31 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RedisCache = void 0;
 const util_1 = require("../util");
+const cacheMetrics = __importStar(require("./metrics"));
 const logger = (0, util_1.makeLogger)('RedisCache');
 /**
  * Redis implementation of a Cache. It uses a simple js Object, storing entries with both
@@ -16,6 +40,10 @@ class RedisCache {
     async get(key) {
         logger.trace(`Getting key ${key}`);
         const value = await this.client.get(key);
+        // Record get command sent to Redis
+        cacheMetrics.redisCommandsSentCount
+            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'get' })
+            .inc();
         if (!value) {
             logger.debug(`No entry in redis cache for key "${key}", returning undefined`);
             return undefined;
@@ -25,6 +53,10 @@ class RedisCache {
     async delete(key) {
         logger.trace(`Deleting key ${key}`);
         await this.client.del(key);
+        // Record delete command sent to Redis
+        cacheMetrics.redisCommandsSentCount
+            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'delete' })
+            .inc();
     }
     async set(key, value, ttl) {
         logger.trace(`Setting key ${key}`);
@@ -33,7 +65,13 @@ class RedisCache {
         const feedId = value.meta?.metrics?.feedId;
         if (feedId) {
             // Record cache set count, max age, and staleness (set to 0 for cache set)
+            const label = cacheMetrics.cacheMetricsLabel(key, feedId, cacheMetrics.CacheTypes.Redis);
+            cacheMetrics.cacheSet(label, ttl);
         }
+        // Record set command sent to Redis
+        cacheMetrics.redisCommandsSentCount
+            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'set' })
+            .inc();
     }
     async setMany(entries, ttl) {
         logger.trace(`Setting a bunch of keys`);
@@ -48,8 +86,15 @@ class RedisCache {
             // Only record metrics if feed Id is present, otherwise assuming value is not adapter response to record
             const feedId = entry.value.meta?.metrics?.feedId;
             if (feedId) {
+                // Record cache set count, max age, and staleness (set to 0 for cache set)
+                const label = cacheMetrics.cacheMetricsLabel(entry.key, feedId, cacheMetrics.CacheTypes.Redis);
+                cacheMetrics.cacheSet(label, ttl);
             }
         }
+        // Record setMany command sent to Redis
+        cacheMetrics.redisCommandsSentCount
+            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'exec' })
+            .inc();
     }
 }
 exports.RedisCache = RedisCache;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chainlink/external-adapter-framework",
-  "version": "0.0.22",
+  "version": "0.0.25",
   "main": "dist/index.js",
   "license": "MIT",
   "dependencies": {
@@ -44,7 +44,7 @@
     "nock": "^13.2.4",
     "pino-pretty": "^7.6.0",
     "prettier": "^2.6.1",
-    "ts-node-dev": "^2.0.0",
+    "ts-node-dev": "2.0.0",
     "typedoc": "^0.22.15"
   },
   "prettier": {

package/transports/batch-warming.js

@@ -1,9 +1,35 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BatchWarmingTransport = void 0;
 const util_1 = require("../util");
 const _1 = require("./");
 const util_2 = require("./util");
+const rateLimitMetrics = __importStar(require("../rate-limiting/metrics"));
+const cacheMetrics = __importStar(require("../cache/metrics"));
+const WARMUP_BATCH_REQUEST_ID = '9002';
 const logger = (0, util_1.makeLogger)('BatchWarmingTransport');
 /**
  * Transport implementation that takes incoming batches requests and keeps a warm cache of values.
@@ -43,12 +69,14 @@ class BatchWarmingTransport {
             logger.debug('No entries in batch warming set, skipping');
             if (this.WARMER_ACTIVE) {
                 // Decrement count when warmer changed from having entries to having none
+                cacheMetrics.cacheWarmerCount.labels({ isBatched: 'true' }).dec();
                 this.WARMER_ACTIVE = false;
             }
             return this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
         }
         else if (this.WARMER_ACTIVE === false) {
             // Increment count when warmer changed from having no entries to having some
+            cacheMetrics.cacheWarmerCount.labels({ isBatched: 'true' }).inc();
             this.WARMER_ACTIVE = true;
         }
         const request = this.config.prepareRequest(entries, context);
@@ -59,6 +87,14 @@ class BatchWarmingTransport {
         const adapterResponses = (0, _1.buildCacheEntriesFromResults)(results, context);
         logger.debug('Setting adapter responses in cache');
         await this.cache.setMany(adapterResponses, context.adapterConfig.CACHE_MAX_AGE);
+        // Record cost of data provider call
+        const cost = rateLimitMetrics.retrieveCost(providerResponse.data);
+        rateLimitMetrics.rateLimitCreditsSpentTotal
+            .labels({
+            feed_id: 'N/A',
+            participant_id: WARMUP_BATCH_REQUEST_ID,
+        })
+            .inc(cost);
         return this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
     }
 }

package/transports/rest.js

@@ -1,9 +1,33 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RestTransport = void 0;
 const util_1 = require("../util");
 const error_1 = require("../validation/error");
 const util_2 = require("./util");
+const rateLimitMetrics = __importStar(require("../rate-limiting/metrics"));
 const IN_FLIGHT_PREFIX = 'InFlight';
 const logger = (0, util_1.makeLogger)('RestTransport');
 /**
@@ -90,6 +114,14 @@ class RestTransport {
         }
         logger.debug('Setting provider response in cache');
         await this.cache.set(req.requestContext.cacheKey, parsedResponse, config.CACHE_MAX_AGE);
+        // Record cost of data provider call
+        const cost = rateLimitMetrics.retrieveCost(providerResponse.data);
+        rateLimitMetrics.rateLimitCreditsSpentTotal
+            .labels({
+            feed_id: req.requestContext.meta?.metrics?.feedId || 'N/A',
+            participant_id: req.requestContext.cacheKey,
+        })
+            .inc(cost);
         // Update cacheHit flag in request meta for metrics use
         req.requestContext.meta = {
             ...req.requestContext.meta,

package/transports/util.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -6,6 +29,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.axiosRequest = void 0;
 const axios_1 = __importDefault(require("axios"));
 const error_1 = require("../validation/error");
+const transportMetrics = __importStar(require("./metrics"));
 /**
  * Performs axios request along with metrics recording and error handling
  *
@@ -13,6 +37,7 @@ const error_1 = require("../validation/error");
  * @returns axios response for the request
  */
 async function axiosRequest(request, config) {
+    const responseTimer = transportMetrics.dataProviderRequestDurationSeconds.startTimer();
     let providerResponse;
     try {
         request.timeout = config.API_TIMEOUT;
@@ -37,6 +62,9 @@ async function axiosRequest(request, config) {
             providerStatusCode = 0; // 0 -> connection error
         }
         // Record count of failed data provider request
+        transportMetrics.dataProviderRequests
+            .labels(transportMetrics.dataProviderMetricsLabel(providerStatusCode, request.method))
+            .inc();
         adapterError.statusCode = 200;
         adapterError.providerStatusCode = providerStatusCode;
         adapterError.message = error?.message;
@@ -47,7 +75,12 @@ async function axiosRequest(request, config) {
     }
     finally {
         // Record time taken for data provider request for success or failure
+        responseTimer();
     }
+    // Record count of successful data provider requests
+    transportMetrics.dataProviderRequests
+        .labels(transportMetrics.dataProviderMetricsLabel(providerResponse.status, request.method))
+        .inc();
     return providerResponse;
 }
 exports.axiosRequest = axiosRequest;

package/transports/websocket.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -7,6 +30,7 @@ exports.WebSocketTransport = exports.WebSocketClassProvider = void 0;
 const ws_1 = __importDefault(require("ws"));
 const util_1 = require("../util");
 const _1 = require("./");
+const transportMetrics = __importStar(require("./metrics"));
 const logger = (0, util_1.makeLogger)('WebSocketTransport');
 class WebSocketClassProvider {
     static set(ctor) {
@@ -63,6 +87,7 @@ class WebSocketTransport {
                 logger.debug('Successfully executed connection opened handler');
                 // Record active ws connections by incrementing count on open
                 // Using URL in label since connection_key is removed from v3
+                transportMetrics.wsConnectionActive.inc();
                 resolve(true);
             });
             this.wsConnection.addEventListener('message', async (event) => {
@@ -78,11 +103,15 @@ class WebSocketTransport {
             });
             this.wsConnection.addEventListener('error', async (event) => {
                 // Record connection error count
+                transportMetrics.wsConnectionErrors
+                    .labels(transportMetrics.connectionErrorLabels(event.message))
+                    .inc();
             });
             this.wsConnection.addEventListener('close', (event) => {
                 logger.debug(`Closed websocket connection. Code: ${event.code} ; reason: ${event.reason?.toString()}`);
                 // Record active ws connections by decrementing count on close
                 // Using URL in label since connection_key is removed from v3
+                transportMetrics.wsConnectionActive.dec();
             });
         });
     }
@@ -126,6 +155,8 @@ class WebSocketTransport {
             logger.trace(`Sending message: ${JSON.stringify(message)}`);
             this.wsConnection.send(message);
         }
+        // Record WS message and subscription metrics
+        transportMetrics.recordWsMessageMetrics(context, subscribeParams, unsubscribeParams);
         logger.debug('Setting local state to cache value');
         this.localSubscriptions = desiredSubs;
         logger.debug('Background execute complete');

package/adapter.d.ts

@@ -1,139 +0,0 @@
-import { Cache } from './cache';
-import { AdapterConfig, BaseAdapterConfig, CustomSettingsType, SettingsMap } from './config';
-import { AdapterRateLimitTier, BackgroundExecuteRateLimiter, RequestRateLimiter } from './rate-limiting';
-import { Transport } from './transports';
-import { SubscriptionSetFactory } from './util';
-import { InputParameters } from './validation/input-params';
-/**
- * Dependencies that will be injected into the Adapter on startup
- */
-export interface AdapterDependencies {
-    /** Specific instance of the Cache the adapter will use (e.g. Local, Redis, etc.) */
-    cache: Cache;
-    /** Shared instance of the request rate limiter */
-    requestRateLimiter: RequestRateLimiter;
-    /** Shared instance of the background execute rate limiter */
-    backgroundExecuteRateLimiter: BackgroundExecuteRateLimiter;
-    /** Factory to create subscription sets based on the specified cache type */
-    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> {
-    /** Endpoint instance within the adapter that the Transport is related to */
-    adapterEndpoint: AdapterEndpoint<unknown, unknown, CustomSettings>;
-    /** Initialized config for the adapter that the Transport can access */
-    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 AdapterParams<CustomSettings extends SettingsMap> {
-    /** 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. This is purposefully typed any; it's the correct type in this case.
-     *
-     * When you try to create an adapter and you provide an endpoint, if these generics were set to "unknown" instead
-     * what would happen is that Typescript would check if the types match, and would fail to assign unknown to the
-     * specific Params or Result in the transport itself.
-     * We also can't use generics, because if we had more than one transport with different requests (very likely)
-     * then those new types wouldn't match with each other.
-     */
-    endpoints: AdapterEndpoint<any, any, CustomSettings>[];
-    /** 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. */
-    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 AdapterEndpointParams<Params, Result, CustomSettings extends SettingsMap> {
-    /** 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<Params, Result, CustomSettings>;
-    /** 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;
-}
-export declare class AdapterEndpoint<Params, Result, CustomSettings extends SettingsMap> implements AdapterEndpointParams<Params, Result, CustomSettings> {
-    name: string;
-    aliases?: string[] | undefined;
-    transport: Transport<Params, Result, CustomSettings>;
-    inputParameters: InputParameters;
-    rateLimiting?: EndpointRateLimitingConfig | undefined;
-    constructor(params: AdapterEndpointParams<Params, Result, CustomSettings>);
-}
-export declare class Adapter<CustomSettings extends SettingsMap = SettingsMap> implements AdapterParams<CustomSettings> {
-    name: string;
-    defaultEndpoint?: string | undefined;
-    endpoints: AdapterEndpoint<unknown, unknown, CustomSettings>[];
-    envDefaultOverrides?: Partial<BaseAdapterConfig> | undefined;
-    customSettings?: SettingsMap | undefined;
-    rateLimiting?: AdapterRateLimitingConfig | undefined;
-    overrides?: Record<string, string> | undefined;
-    initialized: boolean;
-    /** Object containing alias translations for all endpoints */
-    endpointsMap: Record<string, AdapterEndpoint<unknown, unknown, CustomSettings>>;
-    /** Initialized dependencies that the adapter will use */
-    dependencies: AdapterDependencies;
-    /** Configuration params for various adapter properties */
-    config: AdapterConfig;
-    constructor(params: AdapterParams<CustomSettings>);
-    /**
-     * 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).
-     */
-    initialize(dependencies?: Partial<AdapterDependencies>): Promise<void>;
-    /**
-     * Takes an adapter and normalizes all endpoint names and aliases, as well as the default endpoint.
-     * i.e. makes them lowercase for now
-     */
-    private normalizeEndpointNames;
-    /**
-     * 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.
-     *
-     */
-    private calculateRateLimitAllocations;
-    /**
-     * 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 inputDependencies - a partial obj of initialized dependencies to override the created ones
-     * @returns a set of AdapterDependencies all initialized
-     */
-    initializeDependencies(inputDependencies?: Partial<AdapterDependencies>): AdapterDependencies;
-}
-export {};

package/background-executor.d.ts

@@ -1,9 +0,0 @@
-import { Adapter } from './adapter';
-/**
- * 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 declare function callBackgroundExecutes(adapter: Adapter, apiShutdownPromise?: Promise<void>): Promise<void>;

package/cache/factory.d.ts

@@ -1,6 +0,0 @@
-import { AdapterConfig } from '../config';
-import { LocalCache } from './local';
-import { RedisCache } from './redis';
-export declare class CacheFactory {
-    static buildCache(config: AdapterConfig): LocalCache<unknown> | RedisCache<unknown> | undefined;
-}