@chainlink/external-adapter-framework 0.0.14 → 0.0.16

package/adapter.js

@@ -1,115 +1,128 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initializeAdapter = exports.initializeDependencies = void 0;
+exports.Adapter = exports.AdapterEndpoint = void 0;
 const cache_1 = require("./cache");
+const config_1 = require("./config");
 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%');
+class AdapterEndpoint {
+    constructor(params) {
+        this.name = params.name;
+        this.aliases = params.aliases;
+        this.transport = params.transport;
+        this.inputParameters = params.inputParameters;
+        this.rateLimiting = params.rateLimiting;
     }
-    if (totalExplicitAllocation === 100 &&
-        numberOfEndpoints - endpointsWithExplicitAllocations.length > 0) {
-        throw new Error('The explicit allocation is at 100% but there are endpoints with implicit allocation');
+}
+exports.AdapterEndpoint = AdapterEndpoint;
+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.config = (0, config_1.buildAdapterConfig)({
+            overrides: this.envDefaultOverrides,
+            customSettings: this.customSettings,
+        });
+        this.normalizeEndpointNames();
+        this.calculateRateLimitAllocations();
     }
-    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),
-            };
+    /**
+     * 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!');
         }
-        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 = cache_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);
-    }
-    if (!dependencies.subscriptionSetFactory) {
-        dependencies.subscriptionSetFactory = new util_1.SubscriptionSetFactory(config);
+        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);
+        }
+        logger.debug('Adapter initialization complete.');
+        this.initialized = true;
     }
-    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());
+    /**
+     * 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());
+        }
     }
-};
-/**
- * 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}"`);
+    /**
+     * 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),
+                };
             }
-            endpointsMap[alias] = endpoint;
+            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 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.cache) {
+            dependencies.cache = cache_1.CacheFactory.buildCache(this.config);
+        }
+        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);
         }
-        logger.debug(`Initializing transport for endpoint "${endpoint.name}"...`);
-        await endpoint.transport.initialize(initializedDependencies);
+        return dependencies;
     }
-    logger.debug('Adapter initialization complete.');
-    return {
-        ...adapter,
-        endpointsMap,
-        dependencies: initializedDependencies,
-        config,
-    };
-};
-exports.initializeAdapter = initializeAdapter;
+}
+exports.Adapter = Adapter;

package/cache/factory.js

@@ -44,6 +44,9 @@ class CacheFactory {
                 enableAutoPipelining: true,
                 host: config.CACHE_REDIS_HOST,
                 port: config.CACHE_REDIS_PORT,
+                password: config.CACHE_REDIS_PASSWORD,
+                path: config.CACHE_REDIS_PATH,
+                timeout: config.CACHE_REDIS_TIMEOUT,
             });
             redis.on('connect', () => {
                 cacheMetrics.redisConnectionsOpen.inc();

package/config/index.js

@@ -4,34 +4,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildAdapterConfig = exports.BaseSettings = void 0;
 exports.BaseSettings = {
     // V2 compat
-    // TODO: Remove non used in v3 ones
+    // ADAPTER_URL: {
+    //   description: 'The URL of another adapter from which data needs to be retrieved',
+    //   type: 'string',
+    // },
     API_ENDPOINT: {
-        description: 'The URL that the certain transports use to retrieve data',
+        description: 'The URL that certain transports use to retrieve data',
         type: 'string',
     },
     API_KEY: {
         description: 'Default setting for an EA key',
         type: 'string',
     },
-    // API_TIMEOUT: {
-    //   type: 'number',
-    //   default: 30000,
-    // },
-    // API_VERBOSE: {
-    //   type: 'boolean',
-    // },
+    API_TIMEOUT: {
+        description: 'The number of milliseconds a request can be pending before returning a timeout error for data provider request',
+        type: 'number',
+        default: 30000,
+    },
+    API_VERBOSE: {
+        description: 'Toggle whether the response from the EA should contain just the results or also include the full response body from the queried API.',
+        type: 'boolean',
+        default: false,
+    },
     BASE_URL: {
         description: 'Starting path for the EA handler endpoint',
         type: 'string',
         default: '/',
     },
-    // CACHE_ENABLED: {
-    //   type: 'boolean',
-    //   default: true,
-    // },
-    // CACHE_KEY_GROUP: {
-    //   type: 'string',
-    // },
     CACHE_MAX_AGE: {
         description: 'Maximum amount of time (in ms) that a response will stay cached',
         type: 'number',
@@ -55,28 +54,32 @@ exports.BaseSettings = {
         default: '127.0.0.1',
     },
     // CACHE_REDIS_MAX_QUEUED_ITEMS: {
+    //   description: 'Maximum length of the client internal command queue',
     //   type: 'number',
-    //   default: 100,
+    //   default: 500,
     // },
     // CACHE_REDIS_MAX_RECONNECT_COOLDOWN: {
     //   type: 'number',
     //   default: 3000,
     // },
-    // CACHE_REDIS_PASSWORD: {
-    //   type: 'string',
-    // },
-    // CACHE_REDIS_PATH: {
-    //   type: 'string',
-    // },
+    CACHE_REDIS_PASSWORD: {
+        description: 'The password required for redis auth',
+        type: 'string',
+    },
+    CACHE_REDIS_PATH: {
+        description: 'The UNIX socket string of the Redis server',
+        type: 'string',
+    },
     CACHE_REDIS_PORT: {
         description: 'Port for the Redis instance to be used',
         type: 'number',
         default: 6379,
     },
-    // CACHE_REDIS_TIMEOUT: {
-    //   type: 'number',
-    //   default: 500,
-    // },
+    CACHE_REDIS_TIMEOUT: {
+        description: 'Timeout to fail a Redis server request if no response (ms)',
+        type: 'number',
+        default: 500,
+    },
     // CACHE_REDIS_URL: {
     //   type: 'string',
     // },
@@ -86,30 +89,25 @@ exports.BaseSettings = {
         default: 'local',
         options: ['local', 'redis'],
     },
-    // CACHE_UPDATE_AGE_ON_GET: {
-    //   type: 'boolean',
-    //   default: false,
-    // },
     CORRELATION_ID_ENABLED: {
         description: 'Flag to enable correlation IDs for sent requests in logging',
         type: 'boolean',
         default: true,
     },
-    // DEBUG: {
-    //   type: 'boolean',
-    // },
-    // DEFAULT_WS_HEARTBEAT_INTERVAL: {
-    //   type: 'number',
-    //   default: 30000,
+    // DATA_PROVIDER_URL: {
+    //   description: 'Legacy variable that has the same functionality as ADAPTER_URL',
+    //   type: 'string',
     // },
+    DEBUG: {
+        description: 'Toggles debug mode',
+        type: 'boolean',
+        default: false,
+    },
     EA_PORT: {
         description: 'Port through which the EA will listen for REST requests (if mode is set to "reader" or "reader-writer")',
         type: 'number',
         default: 8080,
     },
-    // ENV_ADAPTER_URL: {
-    //   type: 'string',
-    // },
     // ERROR_CAPACITY: {
     //   type: 'number',
     // },
@@ -118,9 +116,6 @@ exports.BaseSettings = {
         type: 'boolean',
         default: true,
     },
-    // LEGACY_ENV_ADAPTER_URL: {
-    //   type: 'string',
-    // },
     LOG_LEVEL: {
         description: 'Minimum level required for logs to be output',
         type: 'string',
@@ -148,25 +143,22 @@ exports.BaseSettings = {
         description: 'Rate limiting tier to use from the available options for the adapter. If not present, the adapter will run using the first tier on the list.',
         type: 'string',
     },
-    // RATE_LIMIT_CAPACITY_MINUTE: {
-    //   type: 'number',
-    // },
-    // RATE_LIMIT_CAPACITY_SECOND: {
-    //   type: 'number',
-    // },
-    // RATE_LIMIT_CAPACITY: {
-    //   type: 'number',
-    // },
-    // RATE_LIMIT_ENABLED: {
-    //   type: 'boolean',
-    //   default: true,
-    // },
-    // RECORD: {
-    //   type: 'boolean',
-    // },
-    // REQUEST_COALESCING_ENABLED: {
-    //   type: 'boolean',
-    // },
+    RATE_LIMIT_CAPACITY: {
+        description: 'Used as rate limit capacity per minute and ignores tier settings if defined',
+        type: 'number',
+    },
+    RATE_LIMIT_CAPACITY_MINUTE: {
+        description: 'Used as rate limit capacity per minute and ignores tier settings if defined. Supercedes RATE_LIMIT_CAPACITY if both vars are set',
+        type: 'number',
+    },
+    RATE_LIMIT_CAPACITY_SECOND: {
+        description: 'Used as rate limit capacity per second and ignores tier settings if defined',
+        type: 'number',
+    },
+    REQUEST_COALESCING_ENABLED: {
+        description: 'Enable request coalescing',
+        type: 'boolean',
+    },
     // REQUEST_COALESCING_ENTROPY_MAX: {
     //   type: 'number',
     //   default: 0,
@@ -203,9 +195,6 @@ exports.BaseSettings = {
     //   type: 'number',
     //   default: 500,
     // },
-    // TIMEOUT: {
-    //   type: 'number',
-    // },
     // WARMUP_ENABLED: {
     //   type: 'boolean',
     //   default: true,
@@ -259,10 +248,11 @@ exports.BaseSettings = {
     // WS_SUBSCRIPTION_PRIORITY_LIST: {
     //   type: 'string',
     // },
-    // WS_SUBSCRIPTION_TTL: {
-    //   type: 'number',
-    //   default: 120000,
-    // },
+    WS_SUBSCRIPTION_TTL: {
+        description: '',
+        type: 'number',
+        default: 120000,
+    },
     // WS_SUBSCRIPTION_UNRESPONSIVE_TTL: {
     //   type: 'number',
     //   default: false,
@@ -297,16 +287,6 @@ exports.BaseSettings = {
         default: 'reader-writer',
         options: ['reader', 'writer', 'reader-writer'],
     },
-    REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES: {
-        description: 'Maximum amount of times the Rest Transport will attempt to set up a request when blocked by the rate limiter',
-        type: 'number',
-        default: 3,
-    },
-    REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES: {
-        description: 'Time that the Rest Transport will wait between retries when blocked by the rate limiter',
-        type: 'number',
-        default: 400,
-    },
     MAX_COMMON_KEY_SIZE: {
         description: 'Maximum amount of characters that the common part of the cache key or feed ID can have',
         type: 'number',
@@ -317,10 +297,16 @@ exports.BaseSettings = {
             }
         },
     },
-    // CACHE_KEY_IGNORED_PROPS : {
-    //   description: 'Properties to ignore when generating a feed ID for requests',
-    //   type: 'string'
-    // }
+    REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES: {
+        description: 'Maximum amount of times the Rest Transport will attempt to set up a request when blocked by the rate limiter',
+        type: 'number',
+        default: 3,
+    },
+    REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES: {
+        description: 'Time that the Rest Transport will wait between retries when blocked by the rate limiter',
+        type: 'number',
+        default: 400,
+    },
     SMOKE_TEST_PAYLOAD_FILE_NAME: {
         description: 'Name of the test payload file used for the smoke endpoint',
         type: 'string',

package/config/provider-limits.js

@@ -41,22 +41,17 @@ const getProviderLimits = (provider, limits, tier, protocol) => {
     }
     return limitsConfig;
 };
+const objectKeysToLowercase = (obj) => {
+    const lower = {};
+    for (const key in obj) {
+        lower[key.toLowerCase()] = obj[key];
+    }
+    return lower;
+};
 const parseLimits = (limits) => {
-    const _mapObject = (fn) => (o) => {
-        const entries = Object.entries(o);
-        const mapped = entries.map(fn);
-        return Object.fromEntries(mapped);
-    };
-    const _formatProtocol = _mapObject((entry) => {
-        const [tierName, rest] = entry;
-        return [tierName.toLowerCase(), { ...rest }];
-    });
-    const _formatProvider = (ls) => {
-        const http = _formatProtocol(ls.http);
-        const ws = _formatProtocol(ls?.ws);
-        return { http, ws };
-    };
-    return _formatProvider(limits);
+    limits.http = objectKeysToLowercase(limits.http);
+    limits.ws = objectKeysToLowercase(limits.ws);
+    return limits;
 };
 const calculateWSLimits = (providerLimit) => {
     return {

package/examples/bank-frick/accounts.js

@@ -8,6 +8,7 @@ const axios_1 = __importDefault(require("axios"));
 const util_1 = require("./util");
 const util_2 = require("../../util");
 const error_1 = require("../../validation/error");
+const adapter_1 = require("../../adapter");
 const logger = (0, util_2.makeLogger)('BankFrickTransport');
 // Note: this is a shallow pattern that only checks for a country code since IBANs in the sandbox are invalid
 const ibanPattern = /^[A-Z]{2}[A-Z\d]{14,30}$/;
@@ -184,8 +185,8 @@ class BankFrickAccountsTransport {
     }
 }
 exports.BankFrickAccountsTransport = BankFrickAccountsTransport;
-exports.accountsRestEndpoint = {
+exports.accountsRestEndpoint = new adapter_1.AdapterEndpoint({
     name: 'accounts',
     transport: new BankFrickAccountsTransport(),
     inputParameters,
-};
+});

package/examples/bank-frick/index.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.adapter = void 0;
+const adapter_1 = require("../../adapter");
 const accounts_1 = require("./accounts");
 const config_1 = require("./config");
-exports.adapter = {
+exports.adapter = new adapter_1.Adapter({
     name: 'bank-frick',
     defaultEndpoint: 'accounts',
     endpoints: [accounts_1.accountsRestEndpoint],
@@ -11,4 +12,4 @@ exports.adapter = {
     envDefaultOverrides: {
         API_ENDPOINT: 'https://olbsandbox.bankfrick.li/webapi/v2',
     },
-};
+});

package/examples/coingecko/src/config/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customSettings = exports.PRO_API_ENDPOINT = exports.DEFAULT_API_ENDPOINT = exports.DEFAULT_ENDPOINT = exports.NAME = void 0;
+exports.NAME = 'COINGECKO';
+exports.DEFAULT_ENDPOINT = 'crypto';
+exports.DEFAULT_API_ENDPOINT = 'https://api.coingecko.com/api/v3';
+exports.PRO_API_ENDPOINT = 'https://pro-api.coingecko.com/api/v3';
+exports.customSettings = {
+    API_KEY: {
+        description: 'API key for the CoinGecko API',
+        type: 'string',
+    },
+};