@chainlink/external-adapter-framework 0.5.0 → 0.5.2

package/transports/rest.js

@@ -0,0 +1,131 @@
+"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 T - Helper struct type that will be used to pass types to the generic parameters (check [[RestTransportGenerics]])
+ */
+class RestTransport {
+    constructor(config) {
+        this.config = config;
+    }
+    async initialize(dependencies, config) {
+        this.inFlightPrefix = `${IN_FLIGHT_PREFIX}-`;
+        this.cache = dependencies.cache;
+        this.inFlightCache = dependencies.cache;
+        this.rateLimiter = dependencies.requestRateLimiter;
+        // Allow enabling/disabling request coalescing through env var
+        this.config.options.requestCoalescing.enabled = config.REQUEST_COALESCING_ENABLED;
+        this.config.options.requestCoalescing.entropyMax = config.REQUEST_COALESCING_ENTROPY_MAX;
+    }
+    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 foregroundExecute(req, config) {
+        // Add some entropy here because of possible scenario where the key won't be set before multiple
+        // other instances in a burst request try to access the coalescing key.
+        const randomMs = Math.random() * (this.config.options.requestCoalescing.entropyMax || 0);
+        await (0, util_1.sleep)(randomMs);
+        // Check if request is in flight if coalescing is enabled
+        const inFlight = this.config.options.requestCoalescing.enabled &&
+            (await this.cache.get(this.inFlightPrefix + req.requestContext.cacheKey));
+        if (inFlight) {
+            logger.debug('Request is in flight, transport has been set up');
+            return;
+        }
+        else if (this.config.options.requestCoalescing.enabled) {
+            // If it wasn't in flight and coalescing is disabled, register it as in flight
+            const ttl = config.REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES *
+                config.REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES;
+            logger.debug('Setting up rest transport, setting request in flight in cache');
+            await this.inFlightCache.set(this.inFlightPrefix + req.requestContext.cacheKey, true, ttl + 100); // 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, config);
+        logger.debug(`Got response from provider, parsing (raw body: ${providerResponse.data})`);
+        const parsedResponse = await this.config.parseResponse(req, providerResponse, config);
+        if (config.API_VERBOSE) {
+            parsedResponse.data = providerResponse.data;
+        }
+        if (config.METRICS_ENABLED && config.EXPERIMENTAL_METRICS_ENABLED) {
+            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 },
+        };
+        if (this.config.options.requestCoalescing.enabled) {
+            logger.debug('Set provider response in cache, removing in flight from cache');
+            await this.cache.delete(this.inFlightPrefix);
+        }
+        return parsedResponse;
+    }
+}
+exports.RestTransport = RestTransport;
+//# sourceMappingURL=rest.js.map

package/transports/rest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest.js","sourceRoot":"","sources":["../../../src/transports/rest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,kCAA2C;AAG3C,+CAAkD;AAClD,iCAAqC;AACrC,2EAA4D;AAK5D,MAAM,gBAAgB,GAAG,UAAU,CAAA;AAEnC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,eAAe,CAAC,CAAA;AAuB1C;;;;;;;;GAQG;AACH,MAAa,aAAa;IAMxB,YACY,MAkBT;QAlBS,WAAM,GAAN,MAAM,CAkBf;IACA,CAAC;IAEJ,KAAK,CAAC,UAAU,CACd,YAAiC,EACjC,MAA0C;QAE1C,IAAI,CAAC,cAAc,GAAG,GAAG,gBAAgB,GAAG,CAAA;QAC5C,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAA8C,CAAA;QACxE,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC,KAAuB,CAAA;QACzD,IAAI,CAAC,WAAW,GAAG,YAAY,CAAC,kBAAkB,CAAA;QAElD,8DAA8D;QAC9D,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,GAAG,MAAM,CAAC,0BAA0B,CAAA;QACjF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,GAAG,MAAM,CAAC,8BAA8B,CAAA;IAC1F,CAAC;IAES,KAAK,CAAC,uBAAuB,CACrC,OAGC,EACD,KAAK,GAAG,CAAC;QAET,IAAI,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,EAAE;YACpC,MAAM,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAA;YACrE,OAAM;SACP;QAED,IAAI,KAAK,IAAI,OAAO,CAAC,UAAU,EAAE;YAC/B,MAAM,IAAI,oBAAY,CAAC;gBACrB,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE,oFAAoF,OAAO,CAAC,UAAU,GAAG;aACnH,CAAC,CAAA;SACH;QAED,MAAM,CAAC,KAAK,CAAC,mDAAmD,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;QAC3F,MAAM,IAAA,YAAK,EAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;QACrC,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;IACxD,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,GAAiC,EACjC,MAA0C;QAE1C,gGAAgG;QAChG,uEAAuE;QACvE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,IAAI,CAAC,CAAC,CAAA;QACxF,MAAM,IAAA,YAAK,EAAC,QAAQ,CAAC,CAAA;QAErB,yDAAyD;QACzD,MAAM,QAAQ,GACZ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO;YAC7C,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC3E,IAAI,QAAQ,EAAE;YACZ,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAA;YAC/D,OAAM;SACP;aAAM,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,EAAE;YACxD,8EAA8E;YAC9E,MAAM,GAAG,GACP,MAAM,CAAC,qCAAqC;gBAC5C,MAAM,CAAC,4CAA4C,CAAA;YACrD,MAAM,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAA;YAC7E,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAC1B,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC,QAAQ,EACjD,IAAI,EACJ,GAAG,GAAG,GAAG,CACV,CAAA,CAAC,2CAA2C;SAC9C;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;QAE7D,MAAM,CAAC,KAAK,CAAC,sDAAsD,CAAC,CAAA;QACpE,MAAM,IAAI,CAAC,uBAAuB,CAAC;YACjC,UAAU,EAAE,MAAM,CAAC,qCAAqC;YACxD,gBAAgB,EAAE,MAAM,CAAC,4CAA4C;SACtE,CAAC,CAAA;QAEF,MAAM,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACnD,MAAM,gBAAgB,GAAG,MAAM,IAAA,mBAAY,EAIzC,OAAO,EAAE,MAAM,CAAC,CAAA;QAElB,MAAM,CAAC,KAAK,CAAC,kDAAkD,gBAAgB,CAAC,IAAI,GAAG,CAAC,CAAA;QACxF,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAA;QAErF,IAAI,MAAM,CAAC,WAAW,EAAE;YACtB,cAAc,CAAC,IAAI,GAAG,gBAAgB,CAAC,IAAI,CAAA;SAC5C;QAED,IAAI,MAAM,CAAC,eAAe,IAAI,MAAM,CAAC,4BAA4B,EAAE;YACjE,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,aAAa,CAAA;YACzD,cAAc,CAAC,IAAI,GAAG;gBACpB,OAAO,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,EAAE;aACvE,CAAA;SACF;QAED,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAA;QAClD,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC,CAAA;QAEvF,oCAAoC;QACpC,MAAM,IAAI,GAAG,gBAAgB,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;QACjE,gBAAgB,CAAC,0BAA0B;aACxC,MAAM,CAAC;YACN,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK;YAC1D,cAAc,EAAE,GAAG,CAAC,cAAc,CAAC,QAAQ;SAC5C,CAAC;aACD,GAAG,CAAC,IAAI,CAAC,CAAA;QAEZ,uDAAuD;QACvD,GAAG,CAAC,cAAc,CAAC,IAAI,GAAG;YACxB,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI;YAC1B,OAAO,EAAE,EAAE,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE;SAClE,CAAA;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,EAAE;YACjD,MAAM,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAA;YAC7E,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;SAC7C;QAED,OAAO,cAAc,CAAA;IACvB,CAAC;CACF;AArJD,sCAqJC"}

package/transports/routing.d.ts

@@ -0,0 +1,21 @@
+import { AdapterDependencies } from '../adapter';
+import { AdapterConfig } from '../config';
+import { AdapterRequest, AdapterResponse } from '../util/request';
+import { MetaTransport, Transport, TransportGenerics } from './';
+/**
+ * Transport implementation that takes 2 or more transports and a function that determines with transport to use.
+ *
+ * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[TransportGenerics]])
+ */
+export declare class RoutingTransport<T extends TransportGenerics> implements MetaTransport<T> {
+    transports: {
+        [key: string]: Transport<T>;
+    };
+    private route;
+    constructor(transports: {
+        [key: string]: Transport<T>;
+    }, route: (req: AdapterRequest<T['Request']>, adapterConfig?: AdapterConfig<T['CustomSettings']>) => string);
+    initialize(dependencies: AdapterDependencies, adapterConfig: AdapterConfig<T['CustomSettings']>, endpointName: string): Promise<void>;
+    private resolveTransport;
+    foregroundExecute(req: AdapterRequest<T['Request']>, adapterConfig: AdapterConfig<T['CustomSettings']>): Promise<AdapterResponse<any> | void>;
+}

package/transports/routing.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoutingTransport = void 0;
+const util_1 = require("../util");
+const error_1 = require("../validation/error");
+const logger = (0, util_1.makeLogger)('RoutingTransport');
+/**
+ * Transport implementation that takes 2 or more transports and a function that determines with transport to use.
+ *
+ * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[TransportGenerics]])
+ */
+class RoutingTransport {
+    constructor(
+    //  This is public for tests, which sometimes need the underlying transport for things like ticking the clock
+    transports, 
+    // Route should return to a string key that corresponds to a transport in the transports object
+    route) {
+        this.transports = transports;
+        this.route = route;
+    }
+    async initialize(dependencies, adapterConfig, endpointName) {
+        logger.debug(`Initializing ${Object.keys(this.transports).length} transports`);
+        Object.entries(this.transports).forEach(([k, v]) => {
+            logger.debug(`Initializing transport ${k} (${v.constructor.name})`);
+            v.initialize(dependencies, adapterConfig, endpointName);
+        });
+    }
+    resolveTransport(req, adapterConfig) {
+        logger.debug(`routing request using`, req.params);
+        const key = this.route(req, adapterConfig || undefined);
+        if (!this.transports[key]) {
+            throw new error_1.AdapterError({ statusCode: 400, message: `No transport found for ${key}` });
+        }
+        const transport = this.transports[key];
+        logger.debug(`Found ${transport.constructor.name} corresponding to ${key}`);
+        return transport;
+    }
+    // Allow AdapterResponse<any> below since we don't know what the adapter will return
+    /* eslint-disable  @typescript-eslint/no-explicit-any */
+    async foregroundExecute(req, adapterConfig) {
+        const transport = this.resolveTransport(req, adapterConfig);
+        if (transport.foregroundExecute) {
+            logger.debug(`Running foregroundExecute on retrieved transport`);
+            return transport.foregroundExecute(req, adapterConfig);
+        }
+        logger.debug(`Retrieved transport doesn't implement foregroundExecute`);
+    }
+}
+exports.RoutingTransport = RoutingTransport;
+//# sourceMappingURL=routing.js.map

package/transports/routing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing.js","sourceRoot":"","sources":["../../../src/transports/routing.ts"],"names":[],"mappings":";;;AAEA,kCAAoC;AAEpC,+CAAkD;AAGlD,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,kBAAkB,CAAC,CAAA;AAE7C;;;;GAIG;AACH,MAAa,gBAAgB;IAI3B;IACE,6GAA6G;IACtG,UAA2C;IAElD,+FAA+F;IACvF,KAGG;QANJ,eAAU,GAAV,UAAU,CAAiC;QAG1C,UAAK,GAAL,KAAK,CAGF;IACV,CAAC;IAEJ,KAAK,CAAC,UAAU,CACd,YAAiC,EACjC,aAAiD,EACjD,YAAoB;QAEpB,MAAM,CAAC,KAAK,CAAC,gBAAgB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,aAAa,CAAC,CAAA;QAC9E,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;YACjD,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,CAAA;YACnE,CAAC,CAAC,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC,CAAA;QACzD,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,gBAAgB,CACtB,GAAiC,EACjC,aAAkD;QAElD,MAAM,CAAC,KAAK,CAAC,uBAAuB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;QACjD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,aAAa,IAAI,SAAS,CAAC,CAAA;QACvD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACzB,MAAM,IAAI,oBAAY,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,0BAA0B,GAAG,EAAE,EAAE,CAAC,CAAA;SACtF;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QACtC,MAAM,CAAC,KAAK,CAAC,SAAS,SAAS,CAAC,WAAW,CAAC,IAAI,qBAAqB,GAAG,EAAE,CAAC,CAAA;QAC3E,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,oFAAoF;IACpF,wDAAwD;IACxD,KAAK,CAAC,iBAAiB,CACrB,GAAiC,EACjC,aAAiD;QAEjD,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;QAC3D,IAAI,SAAS,CAAC,iBAAiB,EAAE;YAC/B,MAAM,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAA;YAChE,OAAO,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;SACvD;QACD,MAAM,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAA;IACzE,CAAC;CACF;AAtDD,4CAsDC"}

package/transports/sse.d.ts

@@ -0,0 +1,61 @@
+import { AxiosRequestConfig } from 'axios';
+import EventSource from 'eventsource';
+import { AdapterContext, AdapterDependencies } from '../adapter';
+import { Cache } from '../cache';
+import { AdapterConfig } from '../config';
+import { SubscriptionSet } from '../util';
+import { AdapterRequest, AdapterResponse, ProviderResult } from '../util/request';
+import { Transport, TransportGenerics } from './';
+export interface SSEConfig {
+    url: string;
+    eventSourceInitDict?: EventSource.EventSourceInitDict;
+}
+/**
+ * Helper struct type that will be used to pass types to the generic parameters of a Transport.
+ * Extends the common TransportGenerics, adding Provider specific types for this Batch endpoint.
+ */
+declare type SSETransportGenerics = TransportGenerics & {
+    /**
+     * Type details for any provider specific interfaces.
+     */
+    Provider: {
+        /**
+         * Structure of the body of the request that will be sent to the data provider.
+         */
+        RequestBody: unknown;
+    };
+};
+/**
+ * Transport implementation that establishes a long lived connection to a server using the SSE protocol and subcribes to updates.
+ *
+ * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[SSETransportGenerics]])
+ */
+export declare class SSETransport<T extends SSETransportGenerics> implements Transport<T> {
+    private config;
+    EventSource: typeof EventSource;
+    cache: Cache<AdapterResponse<T['Response']>>;
+    eventListeners: {
+        type: string;
+        parseResponse: (evt: MessageEvent) => ProviderResult<T>;
+    }[];
+    sseConnection?: EventSource;
+    subscriptionSet: SubscriptionSet<T['Request']['Params']>;
+    timeOfLastReq: number;
+    localSubscriptions: T['Request']['Params'][];
+    constructor(config: {
+        prepareSSEConnectionConfig: (params: T['Request']['Params'][], context: AdapterContext<T>) => SSEConfig;
+        prepareKeepAliveRequest: (context: AdapterContext<T>) => AxiosRequestConfig<T['Provider']['RequestBody']>;
+        prepareSubscriptionRequest: (params: T['Request']['Params'][], context: AdapterContext<T>) => AxiosRequestConfig<T['Provider']['RequestBody']>;
+        prepareUnsubscriptionRequest: (params: T['Request']['Params'][], context: AdapterContext<T>) => AxiosRequestConfig<T['Provider']['RequestBody']>;
+        eventListeners: {
+            type: string;
+            parseResponse: (evt: MessageEvent) => ProviderResult<T>[];
+        }[];
+        keepaliveSleepMs?: number;
+        pollingSleepMs?: number;
+    });
+    initialize(dependencies: AdapterDependencies, config: AdapterConfig<T['CustomSettings']>, endpointName: string): Promise<void>;
+    registerRequest(req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>): Promise<void>;
+    backgroundExecute(context: AdapterContext<T>): Promise<number>;
+}
+export {};

package/transports/sse.js

@@ -0,0 +1,97 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SSETransport = void 0;
+const axios_1 = __importDefault(require("axios"));
+const eventsource_1 = __importDefault(require("eventsource"));
+const util_1 = require("../util");
+const _1 = require("./");
+const logger = (0, util_1.makeLogger)('SSETransport');
+/**
+ * Transport implementation that establishes a long lived connection to a server using the SSE protocol and subcribes to updates.
+ *
+ * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[SSETransportGenerics]])
+ */
+class SSETransport {
+    constructor(config) {
+        this.config = config;
+        this.EventSource = eventsource_1.default;
+        this.timeOfLastReq = 0;
+        // The double sets serve to create a simple polling mechanism instead of needing a subscription
+        // This one would not; this is always local state
+        this.localSubscriptions = [];
+    }
+    async initialize(dependencies, config, endpointName) {
+        this.cache = dependencies.cache;
+        this.subscriptionSet = dependencies.subscriptionSetFactory.buildSet(endpointName);
+        if (dependencies.eventSource) {
+            this.EventSource = dependencies.eventSource;
+        }
+    }
+    async registerRequest(req, config) {
+        logger.debug(`Adding entry to subscription set (ttl: ${config.SSE_SUBSCRIPTION_TTL}): [${req.requestContext.cacheKey}] = ${req.requestContext.data}`);
+        await this.subscriptionSet.add(req.requestContext.cacheKey, req.requestContext.data, config.SSE_SUBSCRIPTION_TTL);
+    }
+    // Unlike cache warming, this execute will manage subscriptions
+    async backgroundExecute(context) {
+        logger.debug('Starting background execute, getting subscriptions from sorted set');
+        const desiredSubs = await this.subscriptionSet.getAll();
+        logger.debug('Generating delta (subscribes & unsubscribes)');
+        const subscribeParams = desiredSubs.filter((s) => !this.localSubscriptions.includes(s));
+        const unsubscribeParams = this.localSubscriptions.filter((s) => !desiredSubs.includes(s));
+        logger.debug(`${subscribeParams.length} new subscriptions; ${unsubscribeParams.length} to unsubscribe`);
+        if (subscribeParams.length) {
+            logger.trace(`Will subscribe to: ${subscribeParams}`);
+        }
+        if (unsubscribeParams.length) {
+            logger.trace(`Will unsubscribe to: ${unsubscribeParams}`);
+        }
+        if ((subscribeParams.length || unsubscribeParams.length) &&
+            (!this.sseConnection || this.sseConnection.readyState !== this.sseConnection.OPEN)) {
+            logger.debug('No established connection and new subscriptions available, connecting to SSE');
+            const sseConfig = this.config.prepareSSEConnectionConfig(subscribeParams, context);
+            this.sseConnection = new this.EventSource(sseConfig.url, sseConfig.eventSourceInitDict);
+            const eventHandlerGenerator = (listener) => {
+                return (e) => {
+                    const providerResponses = listener.parseResponse(e);
+                    const cacheEntries = (0, _1.buildCacheEntriesFromResults)(providerResponses, context);
+                    this.cache.setMany(cacheEntries, context.adapterConfig.CACHE_MAX_AGE);
+                };
+            };
+            this.config.eventListeners.forEach((listener) => {
+                this.sseConnection?.addEventListener(listener.type, eventHandlerGenerator(listener));
+            });
+        }
+        const makeRequest = async (req) => {
+            try {
+                const res = await axios_1.default.request(req);
+                logger.debug(res.data, `response status ${res.statusText} from keepalive request`);
+            }
+            catch (err) {
+                logger.error(err, `Error on keepalive request`);
+            }
+            this.timeOfLastReq = Date.now();
+        };
+        if (subscribeParams.length) {
+            const subscribeRequest = this.config.prepareSubscriptionRequest(subscribeParams, context);
+            makeRequest(subscribeRequest);
+        }
+        if (unsubscribeParams.length) {
+            const unsubscribeRequest = this.config.prepareUnsubscriptionRequest(unsubscribeParams, context);
+            makeRequest(unsubscribeRequest);
+        }
+        if (desiredSubs.length &&
+            Date.now() - this.timeOfLastReq > context.adapterConfig.SSE_KEEPALIVE_SLEEP) {
+            const prepareKeepAliveRequest = this.config.prepareKeepAliveRequest(context);
+            makeRequest(prepareKeepAliveRequest);
+        }
+        logger.debug('Setting local state to cache value');
+        this.localSubscriptions = desiredSubs;
+        logger.debug('Background execute complete');
+        return context.adapterConfig.SSE_SUBSCRIPTION_UPDATE_SLEEP;
+    }
+}
+exports.SSETransport = SSETransport;
+//# sourceMappingURL=sse.js.map

package/transports/sse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sse.js","sourceRoot":"","sources":["../../../src/transports/sse.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAiD;AACjD,8DAAqC;AAIrC,kCAAqD;AAErD,yBAA+E;AAE/E,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,cAAc,CAAC,CAAA;AAuBzC;;;;GAIG;AACH,MAAa,YAAY;IAevB,YACU,MAsBP;QAtBO,WAAM,GAAN,MAAM,CAsBb;QArCH,gBAAW,GAAuB,qBAAW,CAAA;QAQ7C,kBAAa,GAAG,CAAC,CAAA;QAEjB,+FAA+F;QAC/F,iDAAiD;QACjD,uBAAkB,GAA6B,EAAE,CAAA;IA0B9C,CAAC;IAEJ,KAAK,CAAC,UAAU,CACd,YAAiC,EACjC,MAA0C,EAC1C,YAAoB;QAEpB,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAA8C,CAAA;QACxE,IAAI,CAAC,eAAe,GAAG,YAAY,CAAC,sBAAsB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;QACjF,IAAI,YAAY,CAAC,WAAW,EAAE;YAC5B,IAAI,CAAC,WAAW,GAAG,YAAY,CAAC,WAAW,CAAA;SAC5C;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,GAAiC,EACjC,MAA0C;QAE1C,MAAM,CAAC,KAAK,CACV,0CAA0C,MAAM,CAAC,oBAAoB,OAAO,GAAG,CAAC,cAAc,CAAC,QAAQ,OAAO,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CACxI,CAAA;QACD,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAC5B,GAAG,CAAC,cAAc,CAAC,QAAQ,EAC3B,GAAG,CAAC,cAAc,CAAC,IAAI,EACvB,MAAM,CAAC,oBAAoB,CAC5B,CAAA;IACH,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,iBAAiB,CAAC,OAA0B;QAChD,MAAM,CAAC,KAAK,CAAC,oEAAoE,CAAC,CAAA;QAClF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAA;QAEvD,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAC5D,MAAM,eAAe,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QACvF,MAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QAEzF,MAAM,CAAC,KAAK,CACV,GAAG,eAAe,CAAC,MAAM,uBAAuB,iBAAiB,CAAC,MAAM,iBAAiB,CAC1F,CAAA;QACD,IAAI,eAAe,CAAC,MAAM,EAAE;YAC1B,MAAM,CAAC,KAAK,CAAC,sBAAsB,eAAe,EAAE,CAAC,CAAA;SACtD;QACD,IAAI,iBAAiB,CAAC,MAAM,EAAE;YAC5B,MAAM,CAAC,KAAK,CAAC,wBAAwB,iBAAiB,EAAE,CAAC,CAAA;SAC1D;QAED,IACE,CAAC,eAAe,CAAC,MAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC;YACpD,CAAC,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,UAAU,KAAK,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAClF;YACA,MAAM,CAAC,KAAK,CAAC,8EAA8E,CAAC,CAAA;YAC5F,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,0BAA0B,CAAC,eAAe,EAAE,OAAO,CAAC,CAAA;YAClF,IAAI,CAAC,aAAa,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,CAAC,mBAAmB,CAAC,CAAA;YAEvF,MAAM,qBAAqB,GAAG,CAAC,QAA8C,EAAE,EAAE;gBAC/E,OAAO,CAAC,CAAe,EAAE,EAAE;oBACzB,MAAM,iBAAiB,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;oBACnD,MAAM,YAAY,GAAG,IAAA,+BAA4B,EAAC,iBAAiB,EAAE,OAAO,CAAC,CAAA;oBAC7E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAA;gBACvE,CAAC,CAAA;YACH,CAAC,CAAA;YAED,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;gBAC9C,IAAI,CAAC,aAAa,EAAE,gBAAgB,CAAC,QAAQ,CAAC,IAAI,EAAE,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAA;YACtF,CAAC,CAAC,CAAA;SACH;QAED,MAAM,WAAW,GAAG,KAAK,EAAE,GAAqD,EAAE,EAAE;YAClF,IAAI;gBACF,MAAM,GAAG,GAAG,MAAM,eAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;gBACpC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,mBAAmB,GAAG,CAAC,UAAU,yBAAyB,CAAC,CAAA;aACnF;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,4BAA4B,CAAC,CAAA;aAChD;YACD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACjC,CAAC,CAAA;QAED,IAAI,eAAe,CAAC,MAAM,EAAE;YAC1B,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,0BAA0B,CAAC,eAAe,EAAE,OAAO,CAAC,CAAA;YACzF,WAAW,CAAC,gBAAgB,CAAC,CAAA;SAC9B;QACD,IAAI,iBAAiB,CAAC,MAAM,EAAE;YAC5B,MAAM,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,4BAA4B,CACjE,iBAAiB,EACjB,OAAO,CACR,CAAA;YACD,WAAW,CAAC,kBAAkB,CAAC,CAAA;SAChC;QACD,IACE,WAAW,CAAC,MAAM;YAClB,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,mBAAmB,EAC3E;YACA,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAA;YAC5E,WAAW,CAAC,uBAAuB,CAAC,CAAA;SACrC;QAED,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAA;QAClD,IAAI,CAAC,kBAAkB,GAAG,WAAW,CAAA;QAErC,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAA;QAC3C,OAAO,OAAO,CAAC,aAAa,CAAC,6BAA6B,CAAA;IAC5D,CAAC;CACF;AA9ID,oCA8IC"}

package/transports/util.d.ts

@@ -0,0 +1,9 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AdapterConfig, SettingsMap } from '../config';
+/**
+ * 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, CustomSettings extends SettingsMap>(request: AxiosRequestConfig<ProviderRequestBody>, config: AdapterConfig<CustomSettings>): Promise<AxiosResponse<ProviderResponseBody>>;

package/transports/util.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 __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, config) {
+    const responseTimer = transportMetrics.dataProviderRequestDurationSeconds.startTimer();
+    let providerResponse;
+    try {
+        request.timeout = config.API_TIMEOUT;
+        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;
+//# sourceMappingURL=util.js.map

package/transports/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/transports/util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA4E;AAE5E,+CAK4B;AAC5B,4DAA6C;AAE7C;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAKhC,OAAgD,EAChD,MAAqC;IAErC,MAAM,aAAa,GAAG,gBAAgB,CAAC,kCAAkC,CAAC,UAAU,EAAE,CAAA;IACtF,IAAI,gBAAqD,CAAA;IACzD,IAAI;QACF,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC,WAAW,CAAA;QACpC,gBAAgB,GAAG,MAAM,eAAK,CAAC,OAAO,CAAuB,OAAO,CAAC,CAAA;KACtE;IAAC,OAAO,CAAU,EAAE;QACnB,MAAM,KAAK,GAAG,CAAe,CAAA;QAC7B,gBAAgB;QAChB,IAAI,kBAAsC,CAAA;QAC1C,IAAI,YAA0B,CAAA;QAC9B,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE;YACjC,YAAY,GAAG,IAAI,2BAAmB,CAAC,EAAE,CAAC,CAAA;YAC1C,kBAAkB,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,CAAA;YACnD,YAAY,CAAC,IAAI,GAAG,qCAAqC,CAAA;SAC1D;aAAM,IAAI,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE;YAClC,YAAY,GAAG,IAAI,gCAAwB,CAAC,EAAE,CAAC,CAAA;YAC/C,kBAAkB,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAA;SAC7C;aAAM;YACL,YAAY,GAAG,IAAI,8BAAsB,CAAC,EAAE,CAAC,CAAA;YAC7C,kBAAkB,GAAG,CAAC,CAAA,CAAC,wBAAwB;SAChD;QACD,+CAA+C;QAC/C,gBAAgB,CAAC,oBAAoB;aAClC,MAAM,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,kBAAkB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;aACrF,GAAG,EAAE,CAAA;QAER,YAAY,CAAC,UAAU,GAAG,GAAG,CAAA;QAC7B,YAAY,CAAC,kBAAkB,GAAG,kBAAkB,CAAA;QACpD,YAAY,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,CAAA;QACrC,YAAY,CAAC,KAAK,GAAG,KAAK,CAAA;QAC1B,YAAY,CAAC,aAAa,GAAG,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAA;QAClD,YAAY,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QAE9B,MAAM,YAAY,CAAA;KACnB;YAAS;QACR,qEAAqE;QACrE,aAAa,EAAE,CAAA;KAChB;IAED,oDAAoD;IACpD,gBAAgB,CAAC,oBAAoB;SAClC,MAAM,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;SAC1F,GAAG,EAAE,CAAA;IAER,OAAO,gBAAgB,CAAA;AACzB,CAAC;AArDD,oCAqDC"}

package/transports/websocket.d.ts

@@ -0,0 +1,95 @@
+import WebSocket, { ClientOptions, RawData } from 'ws';
+import { AdapterContext, AdapterDependencies } from '../adapter';
+import { Cache } from '../cache';
+import { AdapterConfig } from '../config';
+import { BackgroundExecuteRateLimiter } from '../rate-limiting';
+import { SubscriptionSet } from '../util';
+import { AdapterRequest, AdapterResponse, ProviderResult } from '../util/request';
+import { Transport, TransportGenerics } from './';
+export { WebSocket, RawData as WebSocketRawData };
+declare type WebSocketClass = new (url: string, protocols?: string | string[] | undefined, options?: ClientOptions) => 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<T extends WebsocketTransportGenerics> {
+    /** Endpoint to which to open the WS connection*/
+    url: (context: AdapterContext<T>) => string;
+    /** Optional parameters used when establishing the WebSocket connection */
+    options?: (context: AdapterContext<T>) => ClientOptions;
+    /** 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<T>) => 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: T['Provider']['WsMessage'], context: AdapterContext<T>) => ProviderResult<T>[] | undefined;
+    };
+    /** 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: T['Request']['Params']) => 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: T['Request']['Params']) => unknown;
+    };
+}
+/**
+ * Helper struct type that will be used to pass types to the generic parameters of a Transport.
+ * Extends the common TransportGenerics, adding Provider specific types for this Batch endpoint.
+ */
+declare type WebsocketTransportGenerics = TransportGenerics & {
+    /**
+     * Type details for any provider specific interfaces.
+     */
+    Provider: {
+        /**
+         * Structure of any message that will come through the websocket connection.
+         */
+        WsMessage: unknown;
+    };
+};
+/**
+ * Transport implementation that takes incoming requests, adds them to an [[subscriptionSet]] and,
+ * through a WebSocket connection, subscribes to the relevant feeds to populate the cache.
+ *
+ * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[WebsocketTransportGenerics]])
+ */
+export declare class WebSocketTransport<T extends WebsocketTransportGenerics> implements Transport<T> {
+    private config;
+    cache: Cache<AdapterResponse<T['Response']>>;
+    rateLimiter: BackgroundExecuteRateLimiter;
+    subscriptionSet: SubscriptionSet<T['Request']['Params']>;
+    localSubscriptions: T['Request']['Params'][];
+    wsConnection: WebSocket;
+    constructor(config: WebSocketTransportConfig<T>);
+    initialize(dependencies: AdapterDependencies, config: AdapterConfig<T['CustomSettings']>, endpointName: string): Promise<void>;
+    registerRequest(req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>): Promise<void>;
+    serializeMessage(payload: unknown): string;
+    deserializeMessage(data: WebSocket.Data): T['Provider']['WsMessage'];
+    establishWsConnection(context: AdapterContext<T>): Promise<unknown>;
+    backgroundExecute(context: AdapterContext<T>): Promise<number>;
+}