@chainlink/external-adapter-framework 0.0.8 → 0.0.12

package/package/adapter.js

@@ -1,112 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initializeAdapter = exports.initializeDependencies = void 0;
-const factory_1 = require("./cache/factory");
-const rate_limiting_1 = require("./rate-limiting");
-const util_1 = require("./util");
-const logger = (0, util_1.makeLogger)('Adapter');
-/**
- * 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.
- *
- * @param adapter - the adapter to initialize rate limiting for
- */
-const calculateRateLimitAllocations = (adapter) => {
-    const numberOfEndpoints = adapter.endpoints.length;
-    const endpointsWithExplicitAllocations = adapter.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 adapter.endpoints) {
-        if (!endpoint.rateLimiting) {
-            endpoint.rateLimiting = {
-                allocationPercentage: implicitAllocation / (numberOfEndpoints - endpointsWithExplicitAllocations.length),
-            };
-        }
-        logger.debug(`Endpoint [${endpoint.name}] - ${endpoint.rateLimiting?.allocationPercentage}%`);
-    }
-};
-/**
- * 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 config - the configuration for this adapter
- * @param inputDependencies - a partial obj of initialized dependencies to override the created ones
- * @param rateLimitingConfig - details from the adapter regarding rate limiting
- * @returns a set of AdapterDependencies all initialized
- */
-const initializeDependencies = (adapter, config, inputDependencies) => {
-    const dependencies = inputDependencies || {};
-    if (!dependencies.cache) {
-        dependencies.cache = factory_1.CacheFactory.buildCache(config);
-    }
-    // In the future we might want something more complex, but for now it's better to simplify
-    // and just use the same rate limiting for everything. Once we have a more complex use case we
-    // can think of ways to make this more configurable.
-    const rateLimitingTier = (0, rate_limiting_1.getRateLimitingTier)(adapter.rateLimiting?.tiers, config.RATE_LIMIT_API_TIER);
-    if (!dependencies.requestRateLimiter) {
-        dependencies.requestRateLimiter = new rate_limiting_1.SimpleCountingRateLimiter().initialize(adapter.endpoints, rateLimitingTier);
-    }
-    if (!dependencies.backgroundExecuteRateLimiter) {
-        dependencies.backgroundExecuteRateLimiter = new rate_limiting_1.FixedFrequencyRateLimiter().initialize(adapter.endpoints, rateLimitingTier);
-    }
-    return dependencies;
-};
-exports.initializeDependencies = initializeDependencies;
-/**
- * Takes an adapter and normalizes all endpoint names and aliases, as well as the default endpoint.
- * i.e. makes them lowercase for now
- * @param adapter - an instance of an Adapter
- */
-const normalizeEndpointNames = (adapter) => {
-    // Make endpoints case insensitive, including default
-    adapter.defaultEndpoint = adapter.defaultEndpoint?.toLowerCase();
-    for (const endpoint of adapter.endpoints) {
-        endpoint.name = endpoint.name.toLowerCase();
-        endpoint.aliases = endpoint.aliases?.map((a) => a.toLowerCase());
-    }
-};
-/**
- * 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).
- *
- * @param adapter - an instance of an Adapter
- * @param dependencies - dependencies that the adapter will need at initialization
- * @param config - configuration variables already processed and validated
- * @returns - the adapter with all transports initialized and aliases map built
- */
-const initializeAdapter = async (adapter, config, dependencies) => {
-    normalizeEndpointNames(adapter);
-    calculateRateLimitAllocations(adapter);
-    const initializedDependencies = (0, exports.initializeDependencies)(adapter, config, dependencies);
-    const endpointsMap = {};
-    for (const endpoint of adapter.endpoints) {
-        // Add aliases to map to use in validation
-        const aliases = [endpoint.name, ...(endpoint.aliases || [])];
-        for (const alias of aliases) {
-            if (endpointsMap[alias]) {
-                throw new Error(`Duplicate endpoint / alias: "${alias}"`);
-            }
-            endpointsMap[alias] = endpoint;
-        }
-        logger.debug(`Initializing transport for endpoint "${endpoint.name}"...`);
-        await endpoint.transport.initialize(initializedDependencies);
-    }
-    logger.debug('Adapter initialization complete.');
-    return {
-        ...adapter,
-        endpointsMap,
-        dependencies: initializedDependencies,
-        config,
-    };
-};
-exports.initializeAdapter = initializeAdapter;

package/package/examples/coingecko/batch-warming.d.ts

@@ -1,2 +0,0 @@
-import { AdapterEndpoint } from '../../adapter';
-export declare const batchEndpoint: AdapterEndpoint;

package/package/examples/coingecko/index.d.ts

@@ -1,2 +0,0 @@
-import { Adapter } from '../../adapter';
-export declare const adapter: Adapter;

package/package/examples/coingecko/rest.d.ts

@@ -1,2 +0,0 @@
-import { AdapterEndpoint } from '../../adapter';
-export declare const restEndpoint: AdapterEndpoint;

package/package/examples/ncfx/index.d.ts

@@ -1,2 +0,0 @@
-import { Adapter } from '../../adapter';
-export declare const adapter: Adapter;

package/package/metrics/util.d.ts

@@ -1,3 +0,0 @@
-import { AdapterMetricsMeta, AdapterRequestData } from '../util';
-import { AdapterEndpoint } from '../adapter';
-export declare const getMetricsMeta: (endpoint: AdapterEndpoint, data: AdapterRequestData) => AdapterMetricsMeta;

package/validation/override-functions.d.ts

@@ -1,3 +0,0 @@
-import { InitializedAdapter } from '../adapter';
-import { AdapterRequest } from '../util/request';
-export declare const performSymbolOverrides: (adapter: InitializedAdapter, req: AdapterRequest) => void;