@chainlink/external-adapter-framework 0.0.6 → 0.0.8

package/package/transports/index.js

@@ -0,0 +1,87 @@
+"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 __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.buildTransportHandler = exports.buildCacheEntriesFromResults = void 0;
+const cache_1 = require("../cache");
+const util_1 = require("../util");
+__exportStar(require("./batch-warming"), exports);
+__exportStar(require("./rest"), exports);
+__exportStar(require("./websocket"), exports);
+const logger = (0, util_1.makeLogger)('Transport');
+/**
+ * Helper method to build cache entries to set after getting a bunch of responses from a DP.
+ *
+ * @param results - a list of results coming from a DataProvider
+ * @param context - context for the Adapter
+ * @returns a list of CacheEntries of AdapterResponses
+ */
+const buildCacheEntriesFromResults = (results, context) => results.map((r) => {
+    const cacheEntry = {
+        key: (0, cache_1.calculateCacheKey)(context, r.params),
+        value: {
+            result: r.value,
+            statusCode: 200,
+            data: null, // TODO: Maybe add data as well?
+        },
+    };
+    if (context.adapterConfig.METRICS_ENABLED &&
+        context.adapterConfig.EXPERIMENTAL_METRICS_ENABLED) {
+        const metrics = {
+            maxAge: Date.now() + context.adapterConfig.CACHE_MAX_AGE,
+            meta: {
+                metrics: {
+                    feedId: (0, cache_1.calculateFeedId)(context.adapterEndpoint, r.params)
+                }
+            }
+        };
+        cacheEntry.value = { ...cacheEntry.value, ...metrics };
+    }
+    return cacheEntry;
+});
+exports.buildCacheEntriesFromResults = buildCacheEntriesFromResults;
+/**
+ * Takes an Adapter, its configuration, and its dependencies, and it creates an express middleware
+ * that will pass along the AdapterRequest to the appropriate Transport (acc. to the endpoint in the req.)
+ *
+ * @param adapter - main adapter object, already initialized
+ * @returns the transport handler middleware function
+ */
+const buildTransportHandler = (adapter) => async (req, reply) => {
+    // Get transport, must be here because it's already checked in the validator
+    const transport = adapter.endpointsMap[req.requestContext.endpointName].transport;
+    // Set up transport if it hasn't been done already
+    if (!(await transport.hasBeenSetUp(req))) {
+        logger.debug('Transport not set up yet, doing so...');
+        const immediateResponse = await transport.setup(req, adapter.config);
+        if (immediateResponse) {
+            logger.debug('Got immediate response from transport, sending as response');
+            return reply.send(immediateResponse);
+        }
+    }
+    logger.debug('Transport is set up, polling cache for response...');
+    const response = await (0, cache_1.pollResponseFromCache)(adapter.dependencies.cache, req.requestContext.cacheKey, {
+        maxRetries: adapter.config.CACHE_POLLING_MAX_RETRIES,
+        sleep: adapter.config.CACHE_POLLING_SLEEP_MS,
+    });
+    if (response) {
+        logger.debug('Got a response from the cache, sending that back');
+        return reply.send(response);
+    }
+    logger.debug('Ran out of polling attempts, returning timeout');
+    reply.statusCode = 504;
+    return reply.send();
+};
+exports.buildTransportHandler = buildTransportHandler;

package/package/transports/metrics.d.ts

@@ -0,0 +1,21 @@
+import * as client from 'prom-client';
+import { AdapterContext } from '.';
+export declare const dataProviderMetricsLabel: (providerStatusCode?: number | undefined, method?: string) => {
+    provider_status_code: number | undefined;
+    method: string;
+};
+export declare const dataProviderRequests: client.Counter<"method" | "provider_status_code">;
+export declare const dataProviderRequestDurationSeconds: client.Histogram<string>;
+export declare const connectionErrorLabels: (message: string) => {
+    message: string;
+};
+export declare const messageSubsLabels: (feed_id: string, cache_key: string) => {
+    feed_id: string;
+    subscription_key: string;
+};
+export declare const recordWsMessageMetrics: <AdapterParams>(context: AdapterContext, subscribes: AdapterParams[], unsubscrices: AdapterParams[]) => void;
+export declare const wsConnectionActive: client.Gauge<"url">;
+export declare const wsConnectionErrors: client.Counter<"message" | "url">;
+export declare const wsSubscriptionActive: client.Gauge<"feed_id" | "connection_url" | "subscription_key">;
+export declare const wsSubscriptionTotal: client.Counter<"feed_id" | "connection_url" | "subscription_key">;
+export declare const wsMessageTotal: client.Counter<"feed_id" | "subscription_key">;

package/package/transports/metrics.js

@@ -0,0 +1,105 @@
+"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.wsMessageTotal = exports.wsSubscriptionTotal = exports.wsSubscriptionActive = exports.wsConnectionErrors = exports.wsConnectionActive = exports.recordWsMessageMetrics = exports.messageSubsLabels = exports.connectionErrorLabels = exports.dataProviderRequestDurationSeconds = exports.dataProviderRequests = exports.dataProviderMetricsLabel = void 0;
+const client = __importStar(require("prom-client"));
+const cache_1 = require("../cache");
+const constants_1 = require("../metrics/constants");
+// Data Provider Metrics
+const dataProviderMetricsLabel = (providerStatusCode, method = 'get') => ({
+    provider_status_code: providerStatusCode,
+    method: method.toUpperCase(),
+});
+exports.dataProviderMetricsLabel = dataProviderMetricsLabel;
+exports.dataProviderRequests = new client.Counter({
+    name: 'data_provider_requests',
+    help: 'The number of http requests that are made to a data provider',
+    labelNames: ['method', 'provider_status_code'],
+});
+exports.dataProviderRequestDurationSeconds = new client.Histogram({
+    name: 'data_provider_request_duration_seconds',
+    help: 'A histogram bucket of the distribution of data provider request durations',
+    buckets: constants_1.requestDurationBuckets,
+});
+// Websocket Metrics
+const connectionErrorLabels = (message) => ({
+    // Key,
+    message,
+});
+exports.connectionErrorLabels = connectionErrorLabels;
+const messageSubsLabels = (feed_id, cache_key) => ({
+    feed_id,
+    subscription_key: cache_key,
+});
+exports.messageSubsLabels = messageSubsLabels;
+// Record WS message and subscription metrics
+// Recalculate cacheKey and feedId for metrics
+// since avoiding storing extra info in expiring sorted set
+const recordWsMessageMetrics = (context, subscribes, unsubscrices) => {
+    subscribes.forEach((param) => {
+        const feedId = (0, cache_1.calculateFeedId)(context.adapterEndpoint, param);
+        const cacheKey = (0, cache_1.calculateCacheKey)(context, param);
+        // Record total number of ws messages sent
+        exports.wsMessageTotal.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
+        // Record total number of subscriptions made
+        exports.wsSubscriptionTotal.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
+        // Record number of active ws subscriptions
+        exports.wsSubscriptionActive.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
+    });
+    unsubscrices.forEach((param) => {
+        const feedId = (0, cache_1.calculateFeedId)(context.adapterEndpoint, param);
+        const cacheKey = (0, cache_1.calculateCacheKey)(context, param);
+        // Record total number of ws messages sent
+        exports.wsMessageTotal.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
+        // Record number of active ws subscriptions
+        exports.wsSubscriptionActive.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).dec();
+    });
+};
+exports.recordWsMessageMetrics = recordWsMessageMetrics;
+exports.wsConnectionActive = new client.Gauge({
+    name: 'ws_connection_active',
+    help: 'The number of active connections',
+    labelNames: ['url'],
+});
+exports.wsConnectionErrors = new client.Counter({
+    name: 'ws_connection_errors',
+    help: 'The number of connection errors',
+    labelNames: ['url', 'message'],
+});
+exports.wsSubscriptionActive = new client.Gauge({
+    name: 'ws_subscription_active',
+    help: 'The number of currently active subscriptions',
+    labelNames: ['connection_url', 'feed_id', 'subscription_key'],
+});
+exports.wsSubscriptionTotal = new client.Counter({
+    name: 'ws_subscription_total',
+    help: 'The number of subscriptions opened in total',
+    labelNames: ['connection_url', 'feed_id', 'subscription_key'],
+});
+exports.wsMessageTotal = new client.Counter({
+    name: 'ws_message_total',
+    help: 'The number of messages received in total',
+    labelNames: ['feed_id', 'subscription_key'],
+});

package/package/transports/rest.d.ts

@@ -0,0 +1,43 @@
+import { AdapterRequest, AdapterResponse } from '../util/request';
+import { AdapterDependencies, Transport } from './';
+import { Cache } from '../cache';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AdapterConfig, SettingsMap } from '../config';
+import { RequestRateLimiter } from '../rate-limiting';
+/**
+ * Transport implementation that takes incoming requests, transforms them into a DataProvider request,
+ * and executes that request returning the response immediately from the `setup` function.
+ * Optionally, setting the `coalescing` option to `true` will make it so once a request is in flight,
+ * new adapter requests for the same feed will not trigger a new one, but return an empty promise from
+ * the setup instead so the normal cache polling mechanism is used.
+ *
+ * @typeParam AdapterParams - interface for the adapter request body
+ * @typeParam ProviderRequestBody - interface for the body of the request to the Data Provider
+ * @typeParam ProviderResponseBody - interface for the body of the Data Provider's response
+ */
+export declare class RestTransport<AdapterParams, ProviderRequestBody, ProviderResponseBody, CustomSettings extends SettingsMap> implements Transport<AdapterParams, ProviderResponseBody, CustomSettings> {
+    protected config: {
+        prepareRequest: (req: AdapterRequest<AdapterParams>, config: AdapterConfig<CustomSettings>) => AxiosRequestConfig<ProviderRequestBody> | Promise<AxiosRequestConfig<ProviderRequestBody>>;
+        parseResponse: (req: AdapterRequest<AdapterParams>, res: AxiosResponse<ProviderResponseBody>, config: AdapterConfig<CustomSettings>) => AdapterResponse<ProviderResponseBody> | Promise<AdapterResponse<ProviderResponseBody>>;
+        options: {
+            coalescing: boolean;
+        };
+    };
+    inFlightPrefix: string;
+    cache: Cache;
+    rateLimiter: RequestRateLimiter;
+    constructor(config: {
+        prepareRequest: (req: AdapterRequest<AdapterParams>, config: AdapterConfig<CustomSettings>) => AxiosRequestConfig<ProviderRequestBody> | Promise<AxiosRequestConfig<ProviderRequestBody>>;
+        parseResponse: (req: AdapterRequest<AdapterParams>, res: AxiosResponse<ProviderResponseBody>, config: AdapterConfig<CustomSettings>) => AdapterResponse<ProviderResponseBody> | Promise<AdapterResponse<ProviderResponseBody>>;
+        options: {
+            coalescing: boolean;
+        };
+    });
+    initialize(dependencies: AdapterDependencies): Promise<void>;
+    hasBeenSetUp(req: AdapterRequest<AdapterParams>): Promise<boolean>;
+    protected waitUntilUnderRateLimit(options: {
+        maxRetries: number;
+        msBetweenRetries: number;
+    }, retry?: number): Promise<void>;
+    setup(req: AdapterRequest<AdapterParams>, config: AdapterConfig<CustomSettings>): Promise<AdapterResponse<ProviderResponseBody> | undefined>;
+}

package/package/transports/rest.js

@@ -0,0 +1,129 @@
+"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');
+/**
+ * Transport implementation that takes incoming requests, transforms them into a DataProvider request,
+ * and executes that request returning the response immediately from the `setup` function.
+ * Optionally, setting the `coalescing` option to `true` will make it so once a request is in flight,
+ * new adapter requests for the same feed will not trigger a new one, but return an empty promise from
+ * the setup instead so the normal cache polling mechanism is used.
+ *
+ * @typeParam AdapterParams - interface for the adapter request body
+ * @typeParam ProviderRequestBody - interface for the body of the request to the Data Provider
+ * @typeParam ProviderResponseBody - interface for the body of the Data Provider's response
+ */
+class RestTransport {
+    constructor(config) {
+        this.config = config;
+    }
+    async initialize(dependencies) {
+        this.inFlightPrefix = `${IN_FLIGHT_PREFIX}-`;
+        this.cache = dependencies.cache;
+        this.rateLimiter = dependencies.requestRateLimiter;
+    }
+    async hasBeenSetUp(req) {
+        if (!this.config.options.coalescing) {
+            return false;
+        }
+        // Check if request is in flight
+        const inFlight = await this.cache.get(this.inFlightPrefix + req.requestContext.cacheKey);
+        if (inFlight) {
+            logger.debug('Request is in flight, transport has been set up');
+            return true;
+        }
+        else {
+            logger.debug('Request not in flight, transport not set up');
+            return false;
+        }
+    }
+    async waitUntilUnderRateLimit(options, retry = 0) {
+        if (this.rateLimiter.isUnderLimits()) {
+            logger.trace('Incoming request would not be under limits, moving on');
+            return;
+        }
+        if (retry >= options.maxRetries) {
+            throw new error_1.AdapterError({
+                statusCode: 504,
+                message: `REST Transport timed out while waiting for rate limit availability (max retries: ${options.maxRetries})`,
+            });
+        }
+        logger.debug(`Request would be over rate limits, sleeping for ${options.msBetweenRetries}`);
+        await (0, util_1.sleep)(options.msBetweenRetries);
+        await this.waitUntilUnderRateLimit(options, retry + 1);
+    }
+    async setup(req, config) {
+        if (this.config.options.coalescing) {
+            logger.debug('Setting up rest transport, setting request in flight in cache');
+            // TODO: Should this use a separate cache?
+            // TODO: Set viable ttl to approximate timeout from API
+            // TODO: Make this ttl configurable
+            await this.cache.set(this.inFlightPrefix + req.requestContext.cacheKey, true, 2000); // Can't use Infinity for things like Redis
+        }
+        const request = await this.config.prepareRequest(req, config);
+        logger.trace('Check if we are under rate limits to perform request');
+        await this.waitUntilUnderRateLimit({
+            maxRetries: config.REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES,
+            msBetweenRetries: config.REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES,
+        });
+        logger.trace('Sending request to data provider...');
+        const providerResponse = await (0, util_2.axiosRequest)(request);
+        logger.debug(`Got response from provider, parsing (raw body: ${providerResponse.data})`); // TODO: Sensitive data?
+        const parsedResponse = await this.config.parseResponse(req, providerResponse, config);
+        if (config.METRICS_ENABLED && config.EXPERIMENTAL_METRICS_ENABLED) {
+            // TODO: Potentially create function to add all telemetry data
+            parsedResponse.maxAge = Date.now() + config.CACHE_MAX_AGE;
+            parsedResponse.meta = { metrics: { feedId: req.requestContext.meta?.metrics?.feedId || 'N/A' } };
+        }
+        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,
+            metrics: { ...req.requestContext.meta?.metrics, cacheHit: false },
+        };
+        // TODO: move this to a try/catch/finally
+        if (this.config.options.coalescing) {
+            logger.debug('Set provider response in cache, removing in flight from cache');
+            await this.cache.delete(this.inFlightPrefix);
+        }
+        return parsedResponse;
+    }
+}
+exports.RestTransport = RestTransport;

package/package/transports/util.d.ts

@@ -0,0 +1,8 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+/**
+ * Performs axios request along with metrics recording and error handling
+ *
+ * @param request - axios request config
+ * @returns axios response for the request
+ */
+export declare function axiosRequest<ProviderRequestBody, ProviderResponseBody>(request: AxiosRequestConfig<ProviderRequestBody>): Promise<AxiosResponse<ProviderResponseBody>>;

package/package/transports/util.js

@@ -0,0 +1,85 @@
+"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 };
+};
+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
+ *
+ * @param request - axios request config
+ * @returns axios response for the request
+ */
+async function axiosRequest(request) {
+    const responseTimer = transportMetrics.dataProviderRequestDurationSeconds.startTimer();
+    let providerResponse;
+    try {
+        providerResponse = await axios_1.default.request(request);
+    }
+    catch (e) {
+        const error = e;
+        // Request error
+        let providerStatusCode;
+        let adapterError;
+        if (error.code === 'ECONNABORTED') {
+            adapterError = new error_1.AdapterTimeoutError({});
+            providerStatusCode = error?.response?.status ?? 504;
+            adapterError.name = 'Data Provider Request Timeout error';
+        }
+        else if (error?.response?.status) {
+            adapterError = new error_1.AdapterDataProviderError({});
+            providerStatusCode = error?.response?.status;
+        }
+        else {
+            adapterError = new error_1.AdapterConnectionError({});
+            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;
+        adapterError.cause = error;
+        adapterError.errorResponse = error?.response?.data;
+        adapterError.url = request.url;
+        throw adapterError;
+    }
+    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/package/transports/websocket.d.ts

@@ -0,0 +1,80 @@
+import WebSocket from 'ws';
+import { Cache } from '../cache';
+import { SettingsMap } from '../config';
+import { BackgroundExecuteRateLimiter } from '../rate-limiting';
+import { ExpiringSortedSet } from '../util';
+import { AdapterRequest, ProviderResult } from '../util/request';
+import { AdapterContext, AdapterDependencies, Transport } from './';
+export declare const DEFAULT_WS_TTL = 10000;
+declare type WebSocketClass = new (url: string, protocols?: string | string[] | undefined) => WebSocket;
+export declare class WebSocketClassProvider {
+    static ctor: WebSocketClass;
+    static set(ctor: WebSocketClass): void;
+    static get(): WebSocketClass;
+}
+/**
+ * Config object that is provided to the WebSocketTransport constructor.
+ */
+export interface WebSocketTransportConfig<AdapterParams, ProviderDataMessage, CustomSettings extends SettingsMap> {
+    /** Endpoint to which to open the WS connection*/
+    url: string;
+    /** Map of handlers for different WS lifecycle events */
+    handlers: {
+        /**
+         * Handles when the WS is successfully opened
+         *
+         * @param wsConnection - the WebSocket with an established connection
+         * @returns an empty Promise, or void
+         */
+        open: (wsConnection: WebSocket, context: AdapterContext<CustomSettings>) => Promise<void> | void;
+        /**
+         * Handles when the WS receives a message
+         *
+         * @param message - the message received by the WS
+         * @param context - the background context for the Adapter
+         * @returns a list of cache entries of adapter responses to set in the cache
+         */
+        message: (message: ProviderDataMessage, context: AdapterContext<CustomSettings>) => ProviderResult<AdapterParams>[];
+    };
+    /** Map of "builders", functions that will be used to prepare specific WS messages */
+    builders: {
+        /**
+         * Builds a WS message that will be sent to subscribe to a specific feed
+         *
+         * @param params - the body of the adapter request
+         * @returns the WS message (can be any type as long as the [[WebSocket]] doesn't complain)
+         */
+        subscribeMessage: (params: AdapterParams) => unknown;
+        /**
+         * Builds a WS message that will be sent to unsubscribe to a specific feed
+         *
+         * @param params - the body of the adapter request
+         * @returns the WS message (can be any type as long as the [[WebSocket]] doesn't complain)
+         */
+        unsubscribeMessage: (params: AdapterParams) => unknown;
+    };
+}
+/**
+ * Transport implementation that takes incoming requests, adds them to an [[ExpiringSortedSet]] and,
+ * through a WebSocket connection, subscribes to the relevant feeds to populate the cache.
+ *
+ * @typeParam AdapterParams - interface for the adapter request body
+ * @typeParam ProviderDataMessage - interface for a WS message containing processable data (i.e. not part of open/close/login/etc)
+ */
+export declare class WebSocketTransport<AdapterParams, ProviderDataMessage, CustomSettings extends SettingsMap> implements Transport<AdapterParams, null, CustomSettings> {
+    private config;
+    cache: Cache;
+    rateLimiter: BackgroundExecuteRateLimiter;
+    expiringSortedSet: ExpiringSortedSet<AdapterParams>;
+    localSubscriptions: AdapterParams[];
+    wsConnection: WebSocket;
+    constructor(config: WebSocketTransportConfig<AdapterParams, ProviderDataMessage, CustomSettings>);
+    initialize(dependencies: AdapterDependencies): Promise<void>;
+    hasBeenSetUp(req: AdapterRequest<AdapterParams>): Promise<boolean>;
+    setup(req: AdapterRequest<AdapterParams>): Promise<void>;
+    serializeMessage(payload: unknown): string;
+    deserializeMessage(data: WebSocket.Data): ProviderDataMessage;
+    establishWsConnection(context: AdapterContext<CustomSettings>): Promise<unknown>;
+    backgroundExecute(context: AdapterContext<CustomSettings>): Promise<number>;
+}
+export {};