@chainlink/external-adapter-framework 0.23.2 → 0.24.2

package/transports/rest.js

@@ -1,144 +0,0 @@
-"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 rateLimitMetrics = __importStar(require("../rate-limiting/metrics"));
-const util_1 = require("../util");
-const error_1 = require("../validation/error");
-const util_2 = require("./util");
-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.responseCache = dependencies.responseCache;
-        this.inFlightPrefix = `${IN_FLIGHT_PREFIX}-`;
-        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 inFlightKey = this.inFlightPrefix + req.requestContext.cacheKey;
-        const inFlight = this.config.options.requestCoalescing.enabled && (await this.inFlightCache.get(inFlightKey));
-        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(inFlightKey, 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');
-        const checkForRateLimit = async () => {
-            return this.waitUntilUnderRateLimit({
-                maxRetries: config.REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES,
-                msBetweenRetries: config.REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES,
-            });
-        };
-        await checkForRateLimit();
-        logger.trace('Sending request to data provider...');
-        const providerDataRequested = Date.now();
-        const providerResponse = await (0, util_2.axiosRequest)(request, config, checkForRateLimit);
-        const providerDataReceived = Date.now();
-        logger.debug(`Got response from provider, parsing (raw body: ${providerResponse.data})`);
-        const response = (await this.config.parseResponse(req, providerResponse, config));
-        response.timestamps = {
-            providerDataRequested,
-            providerDataReceived,
-            providerIndicatedTime: response.timestamps?.providerIndicatedTime,
-        };
-        if (config.API_VERBOSE) {
-            response.data = providerResponse.data;
-        }
-        if (config.METRICS_ENABLED && config.EXPERIMENTAL_METRICS_ENABLED) {
-            response.meta = {
-                metrics: { feedId: req.requestContext.meta?.metrics?.feedId || 'N/A' },
-            };
-        }
-        const result = {
-            params: req.requestContext.data,
-            response,
-        };
-        logger.debug('Setting provider response in cache');
-        await this.responseCache.write([result]);
-        // 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.inFlightCache.delete(inFlightKey);
-        }
-        return response;
-    }
-}
-exports.RestTransport = RestTransport;
-//# sourceMappingURL=rest.js.map

package/transports/rest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"rest.js","sourceRoot":"","sources":["../../../src/transports/rest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,2EAA4D;AAC5D,kCAA2C;AAO3C,+CAAkD;AAElD,iCAAqC;AAIrC,MAAM,gBAAgB,GAAG,UAAU,CAAA;AAEnC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,eAAe,CAAC,CAAA;AA8C1C;;;;;;;;GAQG;AACH,MAAa,aAAa;IASxB,YAAsB,MAA8B;QAA9B,WAAM,GAAN,MAAM,CAAwB;IAAG,CAAC;IAExD,KAAK,CAAC,UAAU,CACd,YAAsC,EACtC,MAA0C;QAE1C,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC,aAAa,CAAA;QAC/C,IAAI,CAAC,cAAc,GAAG,GAAG,gBAAgB,GAAG,CAAA;QAC5C,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,WAAW,GAAG,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAA;QACrE,MAAM,QAAQ,GACZ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,IAAI,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAA;QAC9F,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,CAAC,WAAW,EAAE,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC,CAAA,CAAC,2CAA2C;SACvG;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,iBAAiB,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,IAAI,CAAC,uBAAuB,CAAC;gBAClC,UAAU,EAAE,MAAM,CAAC,qCAAqC;gBACxD,gBAAgB,EAAE,MAAM,CAAC,4CAA4C;aACtE,CAAC,CAAA;QACJ,CAAC,CAAA;QACD,MAAM,iBAAiB,EAAE,CAAA;QAEzB,MAAM,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACnD,MAAM,qBAAqB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACxC,MAAM,gBAAgB,GAAG,MAAM,IAAA,mBAAY,EAIzC,OAAO,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAA;QACrC,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAEvC,MAAM,CAAC,KAAK,CAAC,kDAAkD,gBAAgB,CAAC,IAAI,GAAG,CAAC,CAAA;QACxF,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAC/C,GAAG,EACH,gBAAgB,EAChB,MAAM,CACP,CAAmC,CAAA;QACpC,QAAQ,CAAC,UAAU,GAAG;YACpB,qBAAqB;YACrB,oBAAoB;YACpB,qBAAqB,EAAE,QAAQ,CAAC,UAAU,EAAE,qBAAqB;SAClE,CAAA;QAED,IAAI,MAAM,CAAC,WAAW,EAAE;YACtB,QAAQ,CAAC,IAAI,GAAG,gBAAgB,CAAC,IAAI,CAAA;SACtC;QAED,IAAI,MAAM,CAAC,eAAe,IAAI,MAAM,CAAC,4BAA4B,EAAE;YACjE,QAAQ,CAAC,IAAI,GAAG;gBACd,OAAO,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,EAAE;aACvE,CAAA;SACF;QAED,MAAM,MAAM,GAAiC;YAC3C,MAAM,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI;YAC/B,QAAQ;SACT,CAAA;QAED,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAA;QAClD,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;QAExC,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,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;SAC7C;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF;AAlJD,sCAkJC"}

package/transports/routing.d.ts

@@ -1,22 +0,0 @@
-import { AdapterDependencies } from '../adapter';
-import { AdapterConfig } from '../config';
-import { AdapterRequest, AdapterResponse } from '../util';
-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>;
-    registerRequest(req: AdapterRequest<T['Request']>, adapterConfig: AdapterConfig<T['CustomSettings']>): Promise<void>;
-    private resolveTransport;
-    foregroundExecute(req: AdapterRequest<T['Request']>, adapterConfig: AdapterConfig<T['CustomSettings']>): Promise<AdapterResponse<any> | void>;
-}

package/transports/routing.js

@@ -1,60 +0,0 @@
-"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);
-        });
-    }
-    async registerRequest(req, adapterConfig) {
-        logger.debug(`registering request using `, req.requestContext.data);
-        const transport = this.resolveTransport(req, adapterConfig);
-        if (transport.registerRequest) {
-            logger.debug(`Running registerRequest on retrieved transport`);
-            return transport.registerRequest(req, adapterConfig);
-        }
-        logger.debug(`Retrieved transport doesn't implement registerRequest`);
-    }
-    resolveTransport(req, adapterConfig) {
-        logger.debug(`routing request using `, req.requestContext.data);
-        const key = this.route(req, adapterConfig || undefined);
-        if (!this.transports[key]) {
-            logger.error(`No transport found for key ${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

@@ -1 +0,0 @@
-{"version":3,"file":"routing.js","sourceRoot":"","sources":["../../../src/transports/routing.ts"],"names":[],"mappings":";;;AAEA,kCAAqE;AACrE,+CAAkD;AAGlD,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,kBAAkB,CAAC,CAAA;AAE7C;;;;GAIG;AACH,MAAa,gBAAgB;IAI3B;IACE,6GAA6G;IACtG,UAA2C;IAClD,+FAA+F;IACvF,KAGG;QALJ,eAAU,GAAV,UAAU,CAAiC;QAE1C,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;IAED,KAAK,CAAC,eAAe,CACnB,GAAiC,EACjC,aAAiD;QAEjD,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAEnE,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;QAC3D,IAAI,SAAS,CAAC,eAAe,EAAE;YAC7B,MAAM,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAA;YAC9D,OAAO,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;SACrD;QACD,MAAM,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAA;IACvE,CAAC;IAEO,gBAAgB,CACtB,GAAiC,EACjC,aAAkD;QAElD,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAC/D,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,CAAC,KAAK,CAAC,8BAA8B,GAAG,EAAE,CAAC,CAAA;YACjD,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;AApED,4CAoEC"}

package/transports/util.d.ts

@@ -1,11 +0,0 @@
-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
- * @param config - the adapter config containing the env vars
- * @param checkForRateLimit - async function to check and wait for rate limit
- * @returns axios response for the request
- */
-export declare function axiosRequest<ProviderRequestBody, ProviderResponseBody, CustomSettings extends SettingsMap>(request: AxiosRequestConfig<ProviderRequestBody>, config: AdapterConfig<CustomSettings>, checkForRateLimit?: () => Promise<void>): Promise<AxiosResponse<ProviderResponseBody>>;

package/transports/util.js

@@ -1,117 +0,0 @@
-"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"));
-const util_1 = require("../util");
-/**
- * Performs axios request along with metrics recording and error handling
- *
- * @param request - axios request config
- * @param config - the adapter config containing the env vars
- * @param checkForRateLimit - async function to check and wait for rate limit
- * @returns axios response for the request
- */
-async function axiosRequest(request, config, checkForRateLimit) {
-    const responseTimer = transportMetrics.dataProviderRequestDurationSeconds.startTimer();
-    let providerResponse;
-    const maxRetries = config.RETRY;
-    const initialExponent = 1;
-    const retry = async (exponent) => {
-        const _exponentialDelayRetry = async (exp) => {
-            await (0, util_1.sleep)((2 ** exp + Math.random()) * 1000);
-            if (checkForRateLimit) {
-                await checkForRateLimit();
-            }
-            return retry(exp + 1);
-        };
-        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') {
-                providerStatusCode = error?.response?.status ?? 504;
-                adapterError = new error_1.AdapterTimeoutError({
-                    statusCode: 504,
-                    name: 'Data Provider Request Timeout error',
-                    providerStatusCode: error?.response?.status ?? 504,
-                    message: error?.message,
-                    cause: error,
-                    errorResponse: error?.response?.data,
-                    url: request.url,
-                });
-                // Record count of failed data provider request
-                transportMetrics.dataProviderRequests
-                    .labels(transportMetrics.dataProviderMetricsLabel(providerStatusCode, request.method))
-                    .inc();
-                throw adapterError;
-            }
-            if (exponent >= maxRetries) {
-                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;
-            }
-            return _exponentialDelayRetry(exponent);
-        }
-        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;
-    };
-    return retry(initialExponent);
-}
-exports.axiosRequest = axiosRequest;
-//# sourceMappingURL=util.js.map

package/transports/util.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/transports/util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA4E;AAE5E,+CAK4B;AAC5B,4DAA6C;AAC7C,kCAA+B;AAE/B;;;;;;;GAOG;AACI,KAAK,UAAU,YAAY,CAKhC,OAAgD,EAChD,MAAqC,EACrC,iBAAuC;IAEvC,MAAM,aAAa,GAAG,gBAAgB,CAAC,kCAAkC,CAAC,UAAU,EAAE,CAAA;IACtF,IAAI,gBAAqD,CAAA;IACzD,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAA;IAC/B,MAAM,eAAe,GAAG,CAAC,CAAA;IAEzB,MAAM,KAAK,GAAG,KAAK,EAAE,QAAgB,EAAgD,EAAE;QACrF,MAAM,sBAAsB,GAAG,KAAK,EAAE,GAAW,EAAE,EAAE;YACnD,MAAM,IAAA,YAAK,EAAC,CAAC,CAAC,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;YAC9C,IAAI,iBAAiB,EAAE;gBACrB,MAAM,iBAAiB,EAAE,CAAA;aAC1B;YACD,OAAO,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA;QACvB,CAAC,CAAA;QAED,IAAI;YACF,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC,WAAW,CAAA;YACpC,gBAAgB,GAAG,MAAM,eAAK,CAAC,OAAO,CAAuB,OAAO,CAAC,CAAA;SACtE;QAAC,OAAO,CAAU,EAAE;YACnB,MAAM,KAAK,GAAG,CAAe,CAAA;YAC7B,gBAAgB;YAChB,IAAI,kBAAsC,CAAA;YAC1C,IAAI,YAA0B,CAAA;YAC9B,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE;gBACjC,kBAAkB,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,CAAA;gBACnD,YAAY,GAAG,IAAI,2BAAmB,CAAC;oBACrC,UAAU,EAAE,GAAG;oBACf,IAAI,EAAE,qCAAqC;oBAC3C,kBAAkB,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG;oBAClD,OAAO,EAAE,KAAK,EAAE,OAAO;oBACvB,KAAK,EAAE,KAAK;oBACZ,aAAa,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI;oBACpC,GAAG,EAAE,OAAO,CAAC,GAAG;iBACjB,CAAC,CAAA;gBAEF,+CAA+C;gBAC/C,gBAAgB,CAAC,oBAAoB;qBAClC,MAAM,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,kBAAkB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;qBACrF,GAAG,EAAE,CAAA;gBAER,MAAM,YAAY,CAAA;aACnB;YAED,IAAI,QAAQ,IAAI,UAAU,EAAE;gBAC1B,IAAI,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE;oBAC3B,YAAY,GAAG,IAAI,gCAAwB,CAAC,EAAE,CAAC,CAAA;oBAC/C,kBAAkB,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAA;iBAC7C;qBAAM;oBACL,YAAY,GAAG,IAAI,8BAAsB,CAAC,EAAE,CAAC,CAAA;oBAC7C,kBAAkB,GAAG,CAAC,CAAA,CAAC,wBAAwB;iBAChD;gBACD,+CAA+C;gBAC/C,gBAAgB,CAAC,oBAAoB;qBAClC,MAAM,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,kBAAkB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;qBACrF,GAAG,EAAE,CAAA;gBAER,YAAY,CAAC,UAAU,GAAG,GAAG,CAAA;gBAC7B,YAAY,CAAC,kBAAkB,GAAG,kBAAkB,CAAA;gBACpD,YAAY,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,CAAA;gBACrC,YAAY,CAAC,KAAK,GAAG,KAAK,CAAA;gBAC1B,YAAY,CAAC,aAAa,GAAG,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAA;gBAClD,YAAY,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;gBAE9B,MAAM,YAAY,CAAA;aACnB;YAED,OAAO,sBAAsB,CAAC,QAAQ,CAAC,CAAA;SACxC;gBAAS;YACR,qEAAqE;YACrE,aAAa,EAAE,CAAA;SAChB;QAED,oDAAoD;QACpD,gBAAgB,CAAC,oBAAoB;aAClC,MAAM,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;aAC1F,GAAG,EAAE,CAAA;QAER,OAAO,gBAAgB,CAAA;IACzB,CAAC,CAAA;IAED,OAAO,KAAK,CAAC,eAAe,CAAC,CAAA;AAC/B,CAAC;AAzFD,oCAyFC"}

package/util/metrics.d.ts

@@ -1,8 +0,0 @@
-import * as client from 'prom-client';
-import { Metrics } from '../metrics';
-export declare const requestMetrics: Metrics<{
-    dataProviderRequests: client.Counter<"method" | "provider_status_code">;
-    dataProviderRequestDurationSeconds: client.Histogram<string>;
-    requesterQueueSize: client.Gauge<string>;
-    requesterQueueOverflow: client.Counter<string>;
-}>;

package/util/metrics.js

@@ -1,50 +0,0 @@
-"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.requestMetrics = void 0;
-const client = __importStar(require("prom-client"));
-const metrics_1 = require("../metrics");
-const constants_1 = require("../metrics/constants");
-exports.requestMetrics = new metrics_1.Metrics(() => ({
-    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'],
-    }),
-    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,
-    }),
-    requesterQueueSize: new client.Gauge({
-        name: 'requester_queue_size',
-        help: 'The number of provider http requests currently queued to be executed',
-    }),
-    requesterQueueOverflow: new client.Counter({
-        name: 'requester_queue_overflow',
-        help: 'Total times the requester queue replaced the oldest item to avoid an overflow',
-    }),
-}));
-//# sourceMappingURL=metrics.js.map

package/util/metrics.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../src/util/metrics.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AACrC,wCAAoC;AACpC,oDAA6D;AAEhD,QAAA,cAAc,GAAG,IAAI,iBAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAC/C,oBAAoB,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC;QACvC,IAAI,EAAE,wBAAwB;QAC9B,IAAI,EAAE,8DAA8D;QACpE,UAAU,EAAE,CAAC,QAAQ,EAAE,sBAAsB,CAAU;KACxD,CAAC;IACF,kCAAkC,EAAE,IAAI,MAAM,CAAC,SAAS,CAAC;QACvD,IAAI,EAAE,wCAAwC;QAC9C,IAAI,EAAE,2EAA2E;QACjF,OAAO,EAAE,kCAAsB;KAChC,CAAC;IACF,kBAAkB,EAAE,IAAI,MAAM,CAAC,KAAK,CAAC;QACnC,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,sEAAsE;KAC7E,CAAC;IACF,sBAAsB,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC;QACzC,IAAI,EAAE,0BAA0B;QAChC,IAAI,EAAE,+EAA+E;KACtF,CAAC;CACH,CAAC,CAAC,CAAA"}

package/util/request.d.ts

@@ -1,217 +0,0 @@
-import { FastifyReply, FastifyRequest, HookHandlerDoneFunction } from 'fastify';
-import { Adapter } from '../adapter';
-import { AdapterError } from '../validation/error';
-declare module 'fastify' {
-    interface FastifyRequest {
-        requestContext: AdapterRequestContext;
-    }
-}
-export type Merge<T1, T2> = {
-    [K in keyof T1 | keyof T2]: K extends keyof T2 ? T2[K] : K extends keyof T1 ? T1[K] : never;
-};
-/**
- * Structure for the body of all requests that will be sent to the adapter
- */
-export interface AdapterRequestBody<T = AdapterRequestData> {
-    /** Adapter endpoint (not to be confused with REST API endpoint) */
-    endpoint?: string;
-    /** Main data that will be validated and used on each adapter request */
-    data: T;
-}
-/**
- * Object that will be added to the request on a successful validation.
- * Contains all the necessary information the adapter will need across the request execution.
- */
-export type AdapterRequestContext<T = AdapterRequestData> = {
-    /** Name of the endpoint this payload should be directed to */
-    endpointName: string;
-    /** Precalculated cache key used to get and set corresponding values from the cache and subscription sets */
-    cacheKey: string;
-    /** Normalized and validated data coming from the request body */
-    data: T;
-    /** Metadata relevant to this particular request */
-    meta?: AdapterRequestMeta;
-};
-/**
- * Helper type to denote an empty body
- */
-type EmptyBody = Record<string, never>;
-/**
- * Helper type to provide fastify for all adapter handlers
- */
-export type AdapterRouteGeneric = {
-    /** Set to an empty record so the user does not access the raw request data and uses the Validated data from the context instead */
-    Body: EmptyBody;
-};
-/**
- * Structure for all requests incoming to this adapter
- */
-export type AdapterRequest<T extends RequestGenerics = RequestGenerics> = FastifyRequest<AdapterRouteGeneric> & {
-    /** Set to an empty record so the user does not access the raw request data and uses the Validated data from the context instead */
-    body: EmptyBody;
-    /** Container for all validated information that will be used by the framework across this request's lifecycle */
-    requestContext: AdapterRequestContext<T['Params']>;
-};
-/**
- * Metadata for a particular request
- */
-export interface AdapterRequestMeta {
-    /** Relevant metrics gathered for this request */
-    metrics?: AdapterMetricsMeta;
-    /** An error that ocurred somewhere along this requests' lifecycle */
-    error?: AdapterError | Error;
-}
-/**
- * Meta info that pertains to exposing metrics
- */
-export interface AdapterMetricsMeta {
-    /** String to uniquely identify a specific price feed */
-    feedId?: string;
-    /** Boolean to note if this request's response was found in the cache directly */
-    cacheHit?: boolean;
-}
-/**
- * Basic shape for the data within the request body
- */
-export type AdapterRequestData = Record<string, unknown> & {
-    endpoint?: string;
-};
-export type ProviderResultGenerics = {
-    Request: RequestGenerics;
-    Response: ResponseGenerics;
-};
-/**
- * Helper type to hold the value from responses from a provider, and the adapter params they correspond to.
- */
-export type ProviderResult<T extends ProviderResultGenerics> = {
-    /** The set of parameters that uniquely relate to the response */
-    params: T['Request']['Params'];
-    /** Value that will be included in the result property of the response */
-    response: PartialAdapterResponse<T['Response']>;
-};
-export type TimestampedProviderResult<T extends ProviderResultGenerics> = Pick<ProviderResult<T>, 'params'> & {
-    /** Value that will be included in the result property of the response, with timestamps applied */
-    response: TimestampedAdapterResponse<T['Response']>;
-};
-/**
- * Here we do actually want an object, since unknown could be a primitive.
- * The rule itself does say "marginally better"
- */
-export type EmptyObject = Object;
-/**
- * Helper struct type that provides detail about the incoming Adapter Request
- */
-export type RequestGenerics = {
-    /**
-     * Type for the parameters sent to the EA in the data property of the body.
-     */
-    Params: EmptyObject;
-};
-/**
- * Helper struct type that provides detail about the outgoing Adapter Response
- */
-export type ResponseGenerics = {
-    /**
-     * Type for the data property of the response.
-     */
-    Data: unknown;
-    /**
-     * Type for the result property of the response.
-     * This is mostly used for OCR, and corresponds to one "word" when talking about it from an on-chain perspective.
-     */
-    Result: string | number | null;
-};
-/**
- * Details for timestamps to be included in the response
- */
-type ResponseTimestamps = {
-    /** Time at which data was received from the provider */
-    providerDataReceived: number;
-    /** Time indicated by the provider representing the time at which this value was calculated/set/valid */
-    providerIndicatedTime: number | undefined;
-} & ({
-    /**
-     * For sync protocols (request -\> response).
-     * Time at which data was requested from the provider.
-     */
-    providerDataRequested: number;
-    providerDataStreamEstablished?: never;
-} | {
-    /**
-     * For async protocols (subscription -\> n events received).
-     * Time at which a data stream was established for the provider.
-     */
-    providerDataStreamEstablished: number;
-    providerDataRequested?: never;
-});
-/**
- * Object with timestamps that will be present in both successful and provider error responses
- */
-type TimestampedResponseObject = {
-    /** Timestamps relevant for data provider timings */
-    timestamps: ResponseTimestamps;
-};
-/**
- * Response from the EA to send when manually storing an error in the cache
- */
-type ProviderErrorResponse = {
-    /** Status code for the errored response */
-    statusCode: number;
-    /** Error message that will be sent back from the adapter */
-    errorMessage: string;
-} & {
-    data?: never;
-    result?: never;
-    meta?: never;
-};
-/**
- * Provider error response with timestamps added
- */
-export type TimestampedProviderErrorResponse = ProviderErrorResponse & TimestampedResponseObject;
-/**
- * The most basic data that needs to be manually set for an adapter response.
- */
-export type PartialSuccessfulResponse<T extends ResponseGenerics> = {
-    /** Response data, holds "result" for Flux Monitor */
-    data: T['Data'];
-    /** Result value used for OCR */
-    result: T['Result'];
-    /** Optionally, specify manually some of the timestamps here */
-    timestamps?: Pick<ResponseTimestamps, 'providerIndicatedTime'>;
-} & {
-    errorMessage?: never;
-};
-/**
- * Partial EA response, with timestamps added
- */
-type TimestampedSuccessfulResponse<T extends ResponseGenerics> = PartialSuccessfulResponse<T> & TimestampedResponseObject;
-/**
- * Full EA successful response, with metadata and defaults added
- */
-type SuccessfulResponse<T extends ResponseGenerics> = TimestampedSuccessfulResponse<T> & {
-    /** Metadata relevant to this request */
-    meta?: AdapterRequestMeta;
-    /** HTTP status code, by default will be set to 200 */
-    statusCode: number;
-};
-/**
- * Response body from the EA, before timestamps, defaults and metadata are filled in
- */
-export type PartialAdapterResponse<T extends ResponseGenerics = ResponseGenerics> = PartialSuccessfulResponse<T> | ProviderErrorResponse;
-/**
- * Response body from the EA with timestamps, before defaults and metadata are filled in
- */
-export type TimestampedAdapterResponse<T extends ResponseGenerics = ResponseGenerics> = TimestampedSuccessfulResponse<T> | TimestampedProviderErrorResponse;
-/**
- * Shape of the response body from the adapter
- */
-export type AdapterResponse<T extends ResponseGenerics = ResponseGenerics> = SuccessfulResponse<T> | TimestampedProviderErrorResponse;
-export type SingleNumberResultResponse = {
-    Result: number;
-    Data: {
-        result: number;
-    };
-};
-export type Middleware = ((req: AdapterRequest, reply: FastifyReply, done: HookHandlerDoneFunction) => FastifyReply | void) | ((req: AdapterRequest, reply: FastifyReply) => Promise<FastifyReply | void>);
-export type AdapterMiddlewareBuilder = (adapter: Adapter) => Middleware;
-export {};