@chainlink/external-adapter-framework 0.5.0 → 0.5.1

package/adapter/basic.d.ts

@@ -0,0 +1,90 @@
+import { SettingsMap, BaseAdapterConfig, AdapterConfig } from '../config';
+import { AdapterRequest, AdapterResponse, Merge } from '../util';
+import { AdapterEndpoint } from './endpoint';
+import { AdapterDependencies, AdapterParams, AdapterRateLimitingConfig, CustomAdapterSettings, EndpointGenerics, RequestTransform } from './types';
+/**
+ * Main class to represent an External Adapter
+ */
+export declare class Adapter<CustomSettings extends CustomAdapterSettings = SettingsMap> implements Omit<AdapterParams<CustomSettings>, 'bootstrap'> {
+    name: Uppercase<string>;
+    defaultEndpoint?: string | undefined;
+    endpoints: AdapterEndpoint<Merge<EndpointGenerics, {
+        CustomSettings: CustomSettings;
+    }>>[];
+    envDefaultOverrides?: Partial<BaseAdapterConfig> | undefined;
+    customSettings?: SettingsMap | undefined;
+    rateLimiting?: AdapterRateLimitingConfig | undefined;
+    overrides?: Record<string, string> | undefined;
+    requestTransforms?: RequestTransform[];
+    initialized: boolean;
+    /** Object containing alias translations for all endpoints */
+    endpointsMap: Record<string, AdapterEndpoint<Merge<EndpointGenerics, {
+        CustomSettings: CustomSettings;
+    }>>>;
+    /** Initialized dependencies that the adapter will use */
+    dependencies: AdapterDependencies;
+    /** Configuration params for various adapter properties */
+    config: AdapterConfig<CustomSettings>;
+    /** Bootstrap function that will run when initializing the adapter */
+    private readonly bootstrap?;
+    constructor(params: AdapterParams<CustomSettings>);
+    /**
+     * Initializes all of the [[Transport]]s in the adapter, passing along any [[AdapterDependencies]] and [[AdapterConfig]].
+     * Additionally, it builds a map out of all the endpoint names and aliases (checking for duplicates).
+     */
+    initialize(dependencies?: Partial<AdapterDependencies>): Promise<void>;
+    /**
+     * Takes an adapter and normalizes all endpoint names and aliases, as well as the default endpoint.
+     * i.e. makes them lowercase for now
+     */
+    private normalizeEndpointNames;
+    /**
+     * This function will take an adapter structure and go through each endpoint, calculating
+     * each one's allocation of the total rate limits that are set for the adapter as a whole.
+     *
+     */
+    private calculateRateLimitAllocations;
+    /**
+     * Creates a list of key/value pairs that need to be censored in the logs
+     * using the sensitive flag in the adapter config
+     */
+    private buildCensorList;
+    /**
+     * This function will process dependencies for an adapter, such as caches or rate limiters,
+     * in order to inject them into transports and other relevant places later in the lifecycle.
+     *
+     * @param inputDependencies - a partial obj of initialized dependencies to override the created ones
+     * @returns a set of AdapterDependencies all initialized
+     */
+    initializeDependencies(inputDependencies?: Partial<AdapterDependencies>): AdapterDependencies;
+    /**
+     * Attempts to find a value from the Cache and return that if found.
+     *
+     * @param req - the incoming request to this adapter
+     * @returns the cached value if exists
+     */
+    findResponseInCache(req: AdapterRequest): Promise<AdapterResponse | undefined>;
+    /**
+     * Default request transform that takes requests and manipulates
+     *
+     * @param adapter - the current adapter
+     * @param req - the current adapter request
+     * @returns the modified (or new) request
+     */
+    symbolOverrider(req: AdapterRequest): AdapterRequest<import("../util").RequestGenerics>;
+    /**
+     * Takes the incoming request and applies all request transforms in the adapter
+     *
+     * @param req - the current adapter request
+     * @returns the request after passing through all request transforms
+     */
+    runRequestTransforms(req: AdapterRequest): void;
+    /**
+     * Function to serve as middleware to pass along the AdapterRequest to the appropriate Transport (acc. to the endpoint in the req.)
+     *
+     * @param req - the incoming request to this adapter
+     * @param replySent - a promise that resolves when the reply has already been sent
+     * @returns a simple Promise when it's done
+     */
+    handleRequest(req: AdapterRequest, replySent: Promise<unknown>): Promise<AdapterResponse>;
+}

package/adapter/basic.js

@@ -0,0 +1,325 @@
+"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.Adapter = void 0;
+const ioredis_1 = __importDefault(require("ioredis"));
+const cache_1 = require("../cache");
+const cacheMetrics = __importStar(require("../cache/metrics"));
+const config_1 = require("../config");
+const transportMetrics = __importStar(require("../transports/metrics"));
+const rate_limiting_1 = require("../rate-limiting");
+const util_1 = require("../util");
+const censor_list_1 = __importDefault(require("../util/censor/censor-list"));
+const error_1 = require("../validation/error");
+const logger = (0, util_1.makeLogger)('Adapter');
+/**
+ * Main class to represent an External Adapter
+ */
+class Adapter {
+    constructor(params) {
+        // After initialization
+        this.initialized = false;
+        /** Object containing alias translations for all endpoints */
+        this.endpointsMap = {};
+        // Copy over params
+        this.name = params.name;
+        this.defaultEndpoint = params.defaultEndpoint?.toLowerCase();
+        this.endpoints = params.endpoints;
+        this.envDefaultOverrides = params.envDefaultOverrides;
+        this.customSettings = params.customSettings;
+        this.rateLimiting = params.rateLimiting;
+        this.overrides = params.overrides;
+        this.requestTransforms = [this.symbolOverrider.bind(this), ...(params.requestTransforms || [])];
+        this.bootstrap = params.bootstrap;
+        this.config = (0, config_1.buildAdapterConfig)({
+            overrides: this.envDefaultOverrides,
+            customSettings: this.customSettings,
+        });
+        this.normalizeEndpointNames();
+        this.calculateRateLimitAllocations();
+    }
+    /**
+     * Initializes all of the [[Transport]]s in the adapter, passing along any [[AdapterDependencies]] and [[AdapterConfig]].
+     * Additionally, it builds a map out of all the endpoint names and aliases (checking for duplicates).
+     */
+    async initialize(dependencies) {
+        if (this.initialized) {
+            throw new Error('This adapter has already been initialized!');
+        }
+        // Building configs during initialization to avoid validation errors during construction
+        (0, config_1.validateAdapterConfig)(this.config, this.customSettings);
+        if (this.bootstrap) {
+            await this.bootstrap(this);
+        }
+        this.dependencies = this.initializeDependencies(dependencies);
+        for (const endpoint of this.endpoints) {
+            // Add aliases to map to use in validation
+            const aliases = [endpoint.name, ...(endpoint.aliases || [])];
+            for (const alias of aliases) {
+                if (this.endpointsMap[alias]) {
+                    throw new Error(`Duplicate endpoint / alias: "${alias}"`);
+                }
+                this.endpointsMap[alias] = endpoint;
+            }
+            logger.debug(`Initializing transport for endpoint "${endpoint.name}"...`);
+            await endpoint.transport.initialize(this.dependencies, this.config, endpoint.name);
+        }
+        // Build list of key/values that need to be redacted in logs
+        // Populates the static array in CensorList to use in censor-transport
+        this.buildCensorList();
+        logger.debug('Adapter initialization complete.');
+        this.initialized = true;
+    }
+    /**
+     * Takes an adapter and normalizes all endpoint names and aliases, as well as the default endpoint.
+     * i.e. makes them lowercase for now
+     */
+    normalizeEndpointNames() {
+        for (const endpoint of this.endpoints) {
+            endpoint.name = endpoint.name.toLowerCase();
+            endpoint.aliases = endpoint.aliases?.map((a) => a.toLowerCase());
+        }
+    }
+    /**
+     * This function will take an adapter structure and go through each endpoint, calculating
+     * each one's allocation of the total rate limits that are set for the adapter as a whole.
+     *
+     */
+    calculateRateLimitAllocations() {
+        const numberOfEndpoints = this.endpoints.length;
+        const endpointsWithExplicitAllocations = this.endpoints.filter((e) => e.rateLimiting);
+        const totalExplicitAllocation = endpointsWithExplicitAllocations
+            .map((e) => e.rateLimiting?.allocationPercentage || 0)
+            .reduce((sum, next) => sum + next, 0);
+        if (totalExplicitAllocation > 100) {
+            throw new Error('The total allocation set for all endpoints summed cannot exceed 100%');
+        }
+        if (totalExplicitAllocation === 100 &&
+            numberOfEndpoints - endpointsWithExplicitAllocations.length > 0) {
+            throw new Error('The explicit allocation is at 100% but there are endpoints with implicit allocation');
+        }
+        const implicitAllocation = 100 - totalExplicitAllocation;
+        logger.debug('Adapter rate limit allocations:');
+        for (const endpoint of this.endpoints) {
+            if (!endpoint.rateLimiting) {
+                endpoint.rateLimiting = {
+                    allocationPercentage: implicitAllocation / (numberOfEndpoints - endpointsWithExplicitAllocations.length),
+                };
+            }
+            logger.debug(`Endpoint [${endpoint.name}] - ${endpoint.rateLimiting?.allocationPercentage}%`);
+        }
+    }
+    /**
+     * Creates a list of key/value pairs that need to be censored in the logs
+     * using the sensitive flag in the adapter config
+     */
+    buildCensorList() {
+        const censorList = Object.entries(config_1.BaseSettings)
+            .concat(Object.entries(this.customSettings || {}))
+            .filter(([name, setting]) => setting &&
+            setting.type === 'string' &&
+            setting.sensitive &&
+            this.config[name])
+            .map(([name]) => ({
+            key: name,
+            // Escaping potential special characters in values before creating regex
+            value: new RegExp(
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            this.config[name].replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&'), 'gi'),
+        }));
+        censor_list_1.default.set(censorList);
+    }
+    /**
+     * This function will process dependencies for an adapter, such as caches or rate limiters,
+     * in order to inject them into transports and other relevant places later in the lifecycle.
+     *
+     * @param inputDependencies - a partial obj of initialized dependencies to override the created ones
+     * @returns a set of AdapterDependencies all initialized
+     */
+    initializeDependencies(inputDependencies) {
+        const dependencies = inputDependencies || {};
+        if (!dependencies.redisClient) {
+            if (this.config.CACHE_TYPE === 'redis') {
+                dependencies.redisClient = new ioredis_1.default({
+                    enableAutoPipelining: true,
+                    host: this.config.CACHE_REDIS_HOST,
+                    port: this.config.CACHE_REDIS_PORT,
+                    password: this.config.CACHE_REDIS_PASSWORD,
+                    path: this.config.CACHE_REDIS_PATH,
+                    timeout: this.config.CACHE_REDIS_TIMEOUT,
+                });
+                dependencies.redisClient.on('connect', () => {
+                    cacheMetrics.redisConnectionsOpen.inc();
+                });
+            }
+        }
+        if (!dependencies.cache) {
+            dependencies.cache = cache_1.CacheFactory.buildCache(this.config.CACHE_TYPE, dependencies.redisClient);
+        }
+        const rateLimitingTier = (0, rate_limiting_1.getRateLimitingTier)(this.config, this.rateLimiting?.tiers);
+        if (!dependencies.requestRateLimiter) {
+            dependencies.requestRateLimiter = new rate_limiting_1.SimpleCountingRateLimiter().initialize(this.endpoints, rateLimitingTier);
+        }
+        if (!dependencies.backgroundExecuteRateLimiter) {
+            dependencies.backgroundExecuteRateLimiter = new rate_limiting_1.FixedFrequencyRateLimiter().initialize(this.endpoints, rateLimitingTier);
+        }
+        if (!dependencies.subscriptionSetFactory) {
+            dependencies.subscriptionSetFactory = new util_1.SubscriptionSetFactory(this.config, this.name, dependencies.redisClient);
+        }
+        return dependencies;
+    }
+    /**
+     * Attempts to find a value from the Cache and return that if found.
+     *
+     * @param req - the incoming request to this adapter
+     * @returns the cached value if exists
+     */
+    async findResponseInCache(req) {
+        const response = await this.dependencies.cache.get(req.requestContext.cacheKey);
+        if (response) {
+            if (this.config.METRICS_ENABLED && this.config.EXPERIMENTAL_METRICS_ENABLED) {
+                const label = cacheMetrics.cacheMetricsLabel(req.requestContext.cacheKey, req.requestContext.meta?.metrics?.feedId || 'N/A', this.config.CACHE_TYPE);
+                // Record cache staleness and cache get count and value
+                const staleness = (0, cache_1.calculateStaleness)(response.maxAge, this.config.CACHE_MAX_AGE);
+                cacheMetrics.cacheGet(label, response.result, staleness);
+                req.requestContext.meta = {
+                    ...req.requestContext.meta,
+                    metrics: { ...req.requestContext.meta?.metrics, cacheHit: true },
+                };
+            }
+            return response;
+        }
+    }
+    /**
+     * Default request transform that takes requests and manipulates
+     *
+     * @param adapter - the current adapter
+     * @param req - the current adapter request
+     * @returns the modified (or new) request
+     */
+    symbolOverrider(req) {
+        const rawRequestBody = req.body;
+        const requestOverrides = rawRequestBody.data?.overrides?.[this.name.toLowerCase()];
+        const base = req.requestContext.data['base'];
+        // Perform overrides specified in the request payload
+        if (requestOverrides?.[base]) {
+            req.requestContext.data['base'] = requestOverrides[base];
+        }
+        // Perform hardcoded adapter overrides
+        if (this.overrides?.[base]) {
+            req.requestContext.data['base'] = this.overrides[base];
+        }
+        return req;
+    }
+    /**
+     * Takes the incoming request and applies all request transforms in the adapter
+     *
+     * @param req - the current adapter request
+     * @returns the request after passing through all request transforms
+     */
+    runRequestTransforms(req) {
+        if (!this.requestTransforms) {
+            return;
+        }
+        for (const transform of this.requestTransforms) {
+            transform(req);
+        }
+    }
+    /**
+     * Function to serve as middleware to pass along the AdapterRequest to the appropriate Transport (acc. to the endpoint in the req.)
+     *
+     * @param req - the incoming request to this adapter
+     * @param replySent - a promise that resolves when the reply has already been sent
+     * @returns a simple Promise when it's done
+     */
+    async handleRequest(req, replySent) {
+        // Get transport, must be here because it's already checked in the validator
+        const transport = this.endpointsMap[req.requestContext.endpointName].transport;
+        // First try to find the response in our cache, keep it ready
+        const cachedResponse = await this.findResponseInCache(req);
+        // Next we fire off the transport's registration of the request if defined, regardless of if we already have a cached response.
+        // This is necessary to ensure things like subscription sets are updated each time we get a request
+        let requestRegistrationPromise;
+        if (transport.registerRequest) {
+            const handler = async () => {
+                // If we already have a cached response, wait for it to be sent back before continuing with registration
+                // This way we respond to incoming requests from the cache as fast as possible
+                if (cachedResponse) {
+                    await replySent;
+                }
+                // Disable the non-null assertion error, since we're checking this exists in the if above
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                return transport.registerRequest(req, this.config);
+            };
+            // Execute the registration handler without blocking
+            logger.debug(`Firing request registration handler${cachedResponse ? ' (cached response already sent)' : ''}`);
+            requestRegistrationPromise = handler();
+        }
+        // Now that we have dealt with request registration, we can return the cached response if present
+        if (cachedResponse) {
+            logger.debug('Found response from cache, sending that');
+            return cachedResponse;
+        }
+        // If there was no cached response, execute the foregroundExecute if defined
+        const immediateResponse = transport.foregroundExecute && (await transport.foregroundExecute(req, this.config));
+        if (immediateResponse) {
+            logger.debug('Got immediate response from transport, sending as response');
+            return immediateResponse;
+        }
+        // Finally, either because there was no synchronous execute or because it returned an empty response,
+        // we wait for the cache to be filled (either from background work started in the sync execute, or the backgroundExecute).
+        // We can wait for the request registration to have finished here, since we're going to be sleeping for the cache anyways,
+        // and it's useful in case the registration throws a promise so that it doesn't go unhandled.
+        await requestRegistrationPromise;
+        // Observe the idle time taken for polling response
+        const metricsTimer = transportMetrics.transportPollingDurationSeconds
+            .labels({ endpoint: req.requestContext.endpointName })
+            .startTimer();
+        logger.debug('Transport is set up, polling cache for response...');
+        const response = await (0, cache_1.pollResponseFromCache)(this.dependencies.cache, req.requestContext.cacheKey, {
+            maxRetries: this.config.CACHE_POLLING_MAX_RETRIES,
+            sleep: this.config.CACHE_POLLING_SLEEP_MS,
+        });
+        metricsTimer({ succeeded: String(!!response) });
+        if (response) {
+            logger.debug('Got a response from polling the cache, sending that back');
+            return response;
+        }
+        // Record polling mechanism failure to return response
+        transportMetrics.transportPollingFailureCount
+            .labels({ endpoint: req.requestContext.endpointName })
+            .inc();
+        logger.debug('Ran out of polling attempts, returning timeout');
+        throw new error_1.AdapterTimeoutError({
+            message: 'Timed out waiting for provider result.',
+            statusCode: 504,
+        });
+    }
+}
+exports.Adapter = Adapter;
+//# sourceMappingURL=basic.js.map

package/adapter/basic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basic.js","sourceRoot":"","sources":["../../../src/adapter/basic.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAA2B;AAC3B,oCAAyF;AACzF,+DAAgD;AAChD,sCAOkB;AAClB,wEAAyD;AACzD,oDAIyB;AACzB,kCAAoG;AACpG,6EAAuE;AAWvE,+CAAyD;AAEzD,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,SAAS,CAAC,CAAA;AAEpC;;GAEG;AACH,MAAa,OAAO;IA+BlB,YAAY,MAAqC;QAlBjD,uBAAuB;QACvB,gBAAW,GAAG,KAAK,CAAA;QAEnB,6DAA6D;QAC7D,iBAAY,GAGR,EAAE,CAAA;QAYJ,mBAAmB;QACnB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QACvB,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,EAAE,WAAW,EAAE,CAAA;QAC5D,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAA;QACjC,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAA;QACrD,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAA;QAC3C,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;QACvC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAA;QACjC,IAAI,CAAC,iBAAiB,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,CAAA;QAC/F,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAA;QAEjC,IAAI,CAAC,MAAM,GAAG,IAAA,2BAAkB,EAAC;YAC/B,SAAS,EAAE,IAAI,CAAC,mBAAmB;YACnC,cAAc,EAAE,IAAI,CAAC,cAAc;SACpC,CAAC,CAAA;QAEF,IAAI,CAAC,sBAAsB,EAAE,CAAA;QAC7B,IAAI,CAAC,6BAA6B,EAAE,CAAA;IACtC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,YAA2C;QAC1D,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;SAC9D;QAED,wFAAwF;QACxF,IAAA,8BAAqB,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAA;QAEvD,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;SAC3B;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAA;QAE7D,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;YACrC,0CAA0C;YAC1C,MAAM,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAA;YAC5D,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;gBAC3B,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;oBAC5B,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,GAAG,CAAC,CAAA;iBAC1D;gBACD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAA;aACpC;YAED,MAAM,CAAC,KAAK,CAAC,wCAAwC,QAAQ,CAAC,IAAI,MAAM,CAAC,CAAA;YACzE,MAAM,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;SACnF;QAED,4DAA4D;QAC5D,sEAAsE;QACtE,IAAI,CAAC,eAAe,EAAE,CAAA;QAEtB,MAAM,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAA;QAChD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;IACzB,CAAC;IAED;;;OAGG;IACK,sBAAsB;QAC5B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;YACrC,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAA;YAC3C,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;SACjE;IACH,CAAC;IAED;;;;OAIG;IACK,6BAA6B;QACnC,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAA;QAC/C,MAAM,gCAAgC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;QAErF,MAAM,uBAAuB,GAAG,gCAAgC;aAC7D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,EAAE,oBAAoB,IAAI,CAAC,CAAC;aACrD,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,EAAE,CAAC,CAAC,CAAA;QAEvC,IAAI,uBAAuB,GAAG,GAAG,EAAE;YACjC,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAA;SACxF;QAED,IACE,uBAAuB,KAAK,GAAG;YAC/B,iBAAiB,GAAG,gCAAgC,CAAC,MAAM,GAAG,CAAC,EAC/D;YACA,MAAM,IAAI,KAAK,CACb,qFAAqF,CACtF,CAAA;SACF;QAED,MAAM,kBAAkB,GAAG,GAAG,GAAG,uBAAuB,CAAA;QAExD,MAAM,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAA;QAC/C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE;gBAC1B,QAAQ,CAAC,YAAY,GAAG;oBACtB,oBAAoB,EAClB,kBAAkB,GAAG,CAAC,iBAAiB,GAAG,gCAAgC,CAAC,MAAM,CAAC;iBACrF,CAAA;aACF;YAED,MAAM,CAAC,KAAK,CAAC,aAAa,QAAQ,CAAC,IAAI,OAAO,QAAQ,CAAC,YAAY,EAAE,oBAAoB,GAAG,CAAC,CAAA;SAC9F;IACH,CAAC;IAED;;;OAGG;IACK,eAAe;QACrB,MAAM,UAAU,GAAqB,MAAM,CAAC,OAAO,CAAC,qBAA2B,CAAC;aAC7E,MAAM,CAAC,MAAM,CAAC,OAAO,CAAE,IAAI,CAAC,cAA8B,IAAI,EAAE,CAAC,CAAC;aAClE,MAAM,CACL,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,CAClB,OAAO;YACP,OAAO,CAAC,IAAI,KAAK,QAAQ;YACzB,OAAO,CAAC,SAAS;YACjB,IAAI,CAAC,MAAM,CAAC,IAA2C,CAAC,CAC3D;aACA,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;YAChB,GAAG,EAAE,IAAI;YACT,wEAAwE;YACxE,KAAK,EAAE,IAAI,MAAM;YACf,oEAAoE;YAClE,IAAI,CAAC,MAAwB,CAAC,IAAI,CAAa,CAAC,OAAO,CACvD,0BAA0B,EAC1B,MAAM,CACP,EACD,IAAI,CACL;SACF,CAAC,CAAC,CAAA;QACL,qBAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,sBAAsB,CAAC,iBAAgD;QACrE,MAAM,YAAY,GAAG,iBAAiB,IAAI,EAAE,CAAA;QAE5C,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE;YAC7B,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,OAAO,EAAE;gBACtC,YAAY,CAAC,WAAW,GAAG,IAAI,iBAAK,CAAC;oBACnC,oBAAoB,EAAE,IAAI;oBAC1B,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB;oBAClC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB;oBAClC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,oBAAoB;oBAC1C,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,gBAAgB;oBAClC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,mBAAmB;iBACzC,CAAC,CAAA;gBACF,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;oBAC1C,YAAY,CAAC,oBAAoB,CAAC,GAAG,EAAE,CAAA;gBACzC,CAAC,CAAC,CAAA;aACH;SACF;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;YACvB,YAAY,CAAC,KAAK,GAAG,oBAAY,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,CAAA;SAC/F;QAED,MAAM,gBAAgB,GAAG,IAAA,mCAAmB,EAC1C,IAAI,CAAC,MAAuB,EAC5B,IAAI,CAAC,YAAY,EAAE,KAAK,CACzB,CAAA;QACD,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE;YACpC,YAAY,CAAC,kBAAkB,GAAG,IAAI,yCAAyB,EAAE,CAAC,UAAU,CAC1E,IAAI,CAAC,SAAS,EACd,gBAAgB,CACjB,CAAA;SACF;QACD,IAAI,CAAC,YAAY,CAAC,4BAA4B,EAAE;YAC9C,YAAY,CAAC,4BAA4B,GAAG,IAAI,yCAAyB,EAAE,CAAC,UAAU,CACpF,IAAI,CAAC,SAAS,EACd,gBAAgB,CACjB,CAAA;SACF;QACD,IAAI,CAAC,YAAY,CAAC,sBAAsB,EAAE;YACxC,YAAY,CAAC,sBAAsB,GAAG,IAAI,6BAAsB,CAC9D,IAAI,CAAC,MAAuB,EAC5B,IAAI,CAAC,IAAI,EACT,YAAY,CAAC,WAAW,CACzB,CAAA;SACF;QAED,OAAO,YAAmC,CAAA;IAC5C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,mBAAmB,CAAC,GAAmB;QAC3C,MAAM,QAAQ,GAAG,MAAO,IAAI,CAAC,YAAY,CAAC,KAAgC,CAAC,GAAG,CAC5E,GAAG,CAAC,cAAc,CAAC,QAAQ,CAC5B,CAAA;QAED,IAAI,QAAQ,EAAE;YACZ,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,IAAI,IAAI,CAAC,MAAM,CAAC,4BAA4B,EAAE;gBAC3E,MAAM,KAAK,GAAG,YAAY,CAAC,iBAAiB,CAC1C,GAAG,CAAC,cAAc,CAAC,QAAQ,EAC3B,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,EACjD,IAAI,CAAC,MAAM,CAAC,UAAU,CACvB,CAAA;gBAED,uDAAuD;gBACvD,MAAM,SAAS,GAAG,IAAA,0BAAkB,EAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;gBAChF,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;gBACxD,GAAG,CAAC,cAAc,CAAC,IAAI,GAAG;oBACxB,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI;oBAC1B,OAAO,EAAE,EAAE,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;iBACjE,CAAA;aACF;YAED,OAAO,QAAQ,CAAA;SAChB;IACH,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CAAC,GAAmB;QACjC,MAAM,cAAc,GAAG,GAAG,CAAC,IAA4C,CAAA;QACvE,MAAM,gBAAgB,GAAG,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;QAClF,MAAM,IAAI,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAW,CAAA;QAEtD,qDAAqD;QACrD,IAAI,gBAAgB,EAAE,CAAC,IAAI,CAAC,EAAE;YAC5B,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAA;SACzD;QAED,sCAAsC;QACtC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE;YAC1B,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;SACvD;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,GAAmB;QACtC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3B,OAAM;SACP;QAED,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC9C,SAAS,CAAC,GAAG,CAAC,CAAA;SACf;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CAAC,GAAmB,EAAE,SAA2B;QAClE,4EAA4E;QAC5E,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,SAAS,CAAA;QAE9E,6DAA6D;QAC7D,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;QAE1D,+HAA+H;QAC/H,mGAAmG;QACnG,IAAI,0BAAqD,CAAA;QACzD,IAAI,SAAS,CAAC,eAAe,EAAE;YAC7B,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE;gBACzB,wGAAwG;gBACxG,8EAA8E;gBAC9E,IAAI,cAAc,EAAE;oBAClB,MAAM,SAAS,CAAA;iBAChB;gBAED,yFAAyF;gBACzF,oEAAoE;gBACpE,OAAO,SAAS,CAAC,eAAgB,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;YACrD,CAAC,CAAA;YAED,oDAAoD;YACpD,MAAM,CAAC,KAAK,CACV,sCACE,cAAc,CAAC,CAAC,CAAC,iCAAiC,CAAC,CAAC,CAAC,EACvD,EAAE,CACH,CAAA;YACD,0BAA0B,GAAG,OAAO,EAAE,CAAA;SACvC;QAED,iGAAiG;QACjG,IAAI,cAAc,EAAE;YAClB,MAAM,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAA;YACvD,OAAO,cAAc,CAAA;SACtB;QAED,4EAA4E;QAC5E,MAAM,iBAAiB,GACrB,SAAS,CAAC,iBAAiB,IAAI,CAAC,MAAM,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;QACtF,IAAI,iBAAiB,EAAE;YACrB,MAAM,CAAC,KAAK,CAAC,4DAA4D,CAAC,CAAA;YAC1E,OAAO,iBAAiB,CAAA;SACzB;QAED,qGAAqG;QACrG,0HAA0H;QAC1H,0HAA0H;QAC1H,6FAA6F;QAC7F,MAAM,0BAA0B,CAAA;QAEhC,mDAAmD;QACnD,MAAM,YAAY,GAAG,gBAAgB,CAAC,+BAA+B;aAClE,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC;aACrD,UAAU,EAAE,CAAA;QAEf,MAAM,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAA;QAClE,MAAM,QAAQ,GAAG,MAAM,IAAA,6BAAqB,EAC1C,IAAI,CAAC,YAAY,CAAC,KAA+B,EACjD,GAAG,CAAC,cAAc,CAAC,QAAQ,EAC3B;YACE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,yBAAyB;YACjD,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,sBAAsB;SAC1C,CACF,CAAA;QAED,YAAY,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;QAE/C,IAAI,QAAQ,EAAE;YACZ,MAAM,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAA;YACxE,OAAO,QAAQ,CAAA;SAChB;QAED,sDAAsD;QACtD,gBAAgB,CAAC,4BAA4B;aAC1C,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC;aACrD,GAAG,EAAE,CAAA;QAER,MAAM,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAA;QAC9D,MAAM,IAAI,2BAAmB,CAAC;YAC5B,OAAO,EAAE,wCAAwC;YACjD,UAAU,EAAE,GAAG;SAChB,CAAC,CAAA;IACJ,CAAC;CACF;AA3YD,0BA2YC"}

package/adapter/endpoint.d.ts

@@ -0,0 +1,17 @@
+import { MetaTransport, Transport } from '../transports';
+import { InputParameters } from '../validation';
+import { InputValidator } from '../validation/input-validator';
+import { AdapterEndpointParams, EndpointGenerics, EndpointRateLimitingConfig } from './types';
+/**
+ * Main class to represent an endpoint within an External Adapter
+ */
+export declare class AdapterEndpoint<T extends EndpointGenerics> implements AdapterEndpointParams<T> {
+    name: string;
+    aliases?: string[] | undefined;
+    transport: Transport<T> | MetaTransport<T>;
+    inputParameters: InputParameters;
+    rateLimiting?: EndpointRateLimitingConfig | undefined;
+    validator: InputValidator;
+    cacheKeyGenerator?: (data: Record<string, unknown>) => string;
+    constructor(params: AdapterEndpointParams<T>);
+}

package/adapter/endpoint.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdapterEndpoint = void 0;
+const input_validator_1 = require("../validation/input-validator");
+/**
+ * Main class to represent an endpoint within an External Adapter
+ */
+class AdapterEndpoint {
+    constructor(params) {
+        this.name = params.name;
+        this.aliases = params.aliases;
+        this.transport = params.transport;
+        this.inputParameters = params.inputParameters;
+        this.rateLimiting = params.rateLimiting;
+        this.validator = new input_validator_1.InputValidator(this.inputParameters);
+        this.cacheKeyGenerator = params.cacheKeyGenerator;
+    }
+}
+exports.AdapterEndpoint = AdapterEndpoint;
+//# sourceMappingURL=endpoint.js.map

package/adapter/endpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoint.js","sourceRoot":"","sources":["../../../src/adapter/endpoint.ts"],"names":[],"mappings":";;;AAEA,mEAA8D;AAG9D;;GAEG;AACH,MAAa,eAAe;IAS1B,YAAY,MAAgC;QAC1C,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAA;QAC7B,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAA;QACjC,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAA;QAC7C,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;QACvC,IAAI,CAAC,SAAS,GAAG,IAAI,gCAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;QACzD,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAA;IACnD,CAAC;CACF;AAlBD,0CAkBC"}

package/adapter/index.d.ts

@@ -0,0 +1,4 @@
+export * from './basic';
+export * from './price';
+export * from './endpoint';
+export * from './types';

package/adapter/index.js

@@ -0,0 +1,21 @@
+"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 });
+__exportStar(require("./basic"), exports);
+__exportStar(require("./price"), exports);
+__exportStar(require("./endpoint"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/adapter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapter/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,0CAAuB;AACvB,6CAA0B;AAC1B,0CAAuB"}

package/adapter/price.d.ts

@@ -0,0 +1,77 @@
+import { SettingsMap } from '../config';
+import { AdapterRequest, AdapterRequestContext, AdapterResponse, RequestGenerics } from '../util';
+import { AdapterEndpoint } from './endpoint';
+import { Adapter, AdapterEndpointParams, AdapterParams, EndpointGenerics } from './index';
+/**
+ * Type for the base input parameter config that any [[PriceEndpoint]] must extend
+ */
+export declare type PriceEndpointInputParameters = {
+    base: {
+        aliases: readonly ['from', 'coin', ...string[]];
+        type: 'string';
+        description: 'The symbol of symbols of the currency to query';
+        required: boolean;
+    };
+    quote: {
+        aliases: readonly ['to', 'market', ...string[]];
+        type: 'string';
+        description: 'The symbol of the currency to convert to';
+        required: boolean;
+    };
+};
+/**
+ * Base input parameter config that any [[PriceEndpoint]] must extend
+ */
+export declare const priceEndpointInputParameters: PriceEndpointInputParameters;
+/**
+ * Type for base input params for a PriceEndpoint
+ */
+export declare type PriceEndpointParams = {
+    base: string;
+    quote: string;
+};
+/**
+ * Structure of an "includes" file.
+ * Include pairs describe an incoming price feed request, and the details specify
+ */
+export declare type IncludesFile = IncludePair[];
+declare type IncludeDetails = {
+    from: string;
+    to: string;
+    inverse: boolean;
+};
+declare type IncludePair = {
+    from: string;
+    to: string;
+    includes: IncludeDetails[];
+};
+declare type IncludesMap = Record<string, Record<string, IncludeDetails>>;
+/**
+ * A PriceEndpoint is a specific type of AdapterEndpoint. Meant to comply with standard practices for
+ * Data Feeds, its InputParameters must extend the basic ones (base/quote).
+ */
+export declare class PriceEndpoint<T extends EndpointGenerics> extends AdapterEndpoint<T> {
+    constructor(params: AdapterEndpointParams<T> & {
+        inputParameters: PriceEndpointInputParameters;
+    });
+}
+declare type PriceAdapterRequest<T extends RequestGenerics> = AdapterRequest<T> & {
+    requestContext: AdapterRequestContext<T> & {
+        priceMeta: {
+            inverse: boolean;
+        };
+    };
+};
+/**
+ * A PriceAdapter is a specific kind of Adapter that includes at least one PriceEnpoint.
+ */
+export declare class PriceAdapter<CustomSettings extends SettingsMap> extends Adapter<CustomSettings> {
+    includesMap?: IncludesMap;
+    constructor(params: AdapterParams<CustomSettings> & {
+        includes?: IncludesFile;
+    });
+    handleRequest(req: PriceAdapterRequest<{
+        Params: PriceEndpointParams;
+    }>, replySent: Promise<unknown>): Promise<AdapterResponse>;
+}
+export {};