@chainlink/external-adapter-framework 0.4.0 → 0.5.1

package/config/index.js

@@ -0,0 +1,359 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateAdapterConfig = exports.buildAdapterConfig = exports.BaseSettings = void 0;
+exports.BaseSettings = {
+    // V2 compat
+    // ADAPTER_URL: {
+    //   description: 'The URL of another adapter from which data needs to be retrieved',
+    //   type: 'string',
+    // },
+    API_ENDPOINT: {
+        description: 'The URL that certain transports use to retrieve data',
+        type: 'string',
+    },
+    API_KEY: {
+        description: 'Default setting for an EA key',
+        type: 'string',
+        sensitive: true,
+    },
+    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: '/',
+    },
+    BATCH_TRANSPORT_SETUP_VALIDATION: {
+        description: 'Flag to toggle batch transport setup validation',
+        type: 'boolean',
+        default: false,
+    },
+    CACHE_MAX_AGE: {
+        description: 'Maximum amount of time (in ms) that a response will stay cached',
+        type: 'number',
+        default: 90000,
+    },
+    // CACHE_MAX_ITEMS: {
+    //   type: 'number',
+    //   default: 1000,
+    // },
+    // CACHE_MIN_AGE: {
+    //   type: 'number',
+    //   default: 30000,
+    // },
+    // CACHE_REDIS_CONNECTION_TIMEOUT: {
+    //   type: 'number',
+    //   default: 15000,
+    // },
+    CACHE_REDIS_HOST: {
+        description: 'Hostname for the Redis instance to be used',
+        type: 'string',
+        default: '127.0.0.1',
+    },
+    // CACHE_REDIS_MAX_QUEUED_ITEMS: {
+    //   description: 'Maximum length of the client internal command queue',
+    //   type: 'number',
+    //   default: 500,
+    // },
+    // CACHE_REDIS_MAX_RECONNECT_COOLDOWN: {
+    //   type: 'number',
+    //   default: 3000,
+    // },
+    CACHE_REDIS_PASSWORD: {
+        description: 'The password required for redis auth',
+        type: 'string',
+        sensitive: true,
+    },
+    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: {
+        description: 'Timeout to fail a Redis server request if no response (ms)',
+        type: 'number',
+        default: 500,
+    },
+    // CACHE_REDIS_URL: {
+    //   type: 'string',
+    // },
+    CACHE_TYPE: {
+        description: 'The type of cache to use throughout the EA',
+        type: 'enum',
+        default: 'local',
+        options: ['local', 'redis'],
+    },
+    CORRELATION_ID_ENABLED: {
+        description: 'Flag to enable correlation IDs for sent requests in logging',
+        type: 'boolean',
+        default: true,
+    },
+    // 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,
+    },
+    // DEFAULT_WS_HEARTBEAT_INTERVAL: {
+    //   description: 'Interval between WS heartbeat pings (ms)',
+    //   type: 'number',
+    //   default: 30000,
+    // },
+    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,
+    },
+    // ERROR_CAPACITY: {
+    //   type: 'number',
+    // },
+    EXPERIMENTAL_METRICS_ENABLED: {
+        description: 'Flag to specify whether or not to collect metrics. Used as fallback for METRICS_ENABLED',
+        type: 'boolean',
+        default: true,
+    },
+    LOG_LEVEL: {
+        description: 'Minimum level required for logs to be output',
+        type: 'string',
+        default: 'info',
+    },
+    METRICS_ENABLED: {
+        description: 'Flag to specify whether or not to startup the metrics server',
+        type: 'boolean',
+        default: true,
+    },
+    METRICS_NAME: {
+        description: 'Metrics name',
+        type: 'string',
+    },
+    METRICS_PORT: {
+        description: 'Port metrics will be exposed to',
+        type: 'number',
+        default: 9080,
+    },
+    METRICS_USE_BASE_URL: {
+        description: 'Flag to specify whether or not to prepend the BASE_URL to the metrics endpoint',
+        type: 'boolean',
+    },
+    RATE_LIMIT_API_TIER: {
+        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: {
+        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',
+        default: false,
+    },
+    REQUEST_COALESCING_ENTROPY_MAX: {
+        description: 'Amount of random delay (entropy) in milliseconds that will be added to requests. Avoids issue where the request coalescing key will not be set before multiple other instances in a burst try to access the same key',
+        type: 'number',
+        default: 0,
+    },
+    // REQUEST_COALESCING_INTERVAL: {
+    //   type: 'number',
+    //   default: 100,
+    // },
+    // REQUEST_COALESCING_INTERVAL_COEFFICIENT: {
+    //   type: 'number',
+    //   default: 2,
+    // },
+    // REQUEST_COALESCING_INTERVAL_MAX: {
+    //   type: 'number',
+    //   default: 1000,
+    // },
+    // REQUEST_COALESCING_MAX_RETRIES: {
+    //   type: 'number',
+    //   default: 5,
+    // },
+    // RETRY: {
+    //   type: 'boolean',
+    //   default: 1,
+    // },
+    SSE_SUBSCRIPTION_UPDATE_SLEEP: {
+        description: 'Maximum amount of time (in ms) between each update to the set of subscribed feeds',
+        type: 'number',
+        default: 1000,
+    },
+    SSE_KEEPALIVE_SLEEP: {
+        description: 'Maximum amount of time (in ms) between each SSE keepalive request',
+        type: 'number',
+        default: 60000,
+    },
+    SSE_SUBSCRIPTION_TTL: {
+        description: 'Maximum amount of time (in ms) an SSE subscription will be cached before being unsubscribed',
+        type: 'number',
+        default: 300000,
+    },
+    WARMUP_SUBSCRIPTION_TTL: {
+        type: 'number',
+        description: 'TTL for batch warmer subscriptions',
+        default: 300000,
+    },
+    // WARMUP_UNHEALTHY_THRESHOLD: {
+    //   type: 'number',
+    //   default: 3,
+    // },
+    WS_API_ENDPOINT: {
+        description: 'Override the base websocket URL within the EA.',
+        type: 'string',
+    },
+    WS_API_KEY: {
+        description: 'The websocket API key to authenticate with',
+        type: 'string',
+        sensitive: true,
+    },
+    WS_SUBSCRIPTION_TTL: {
+        description: '',
+        type: 'number',
+        default: 120000,
+    },
+    // WS_SUBSCRIPTION_UNRESPONSIVE_TTL: {
+    //   type: 'number',
+    //   default: false,
+    // },
+    // WS_TIME_UNTIL_HANDLE_NEXT_MESSAGE_OVERRIDE: {
+    //   description: 'Time to wait until adapter should handle next WS message',
+    //   type: 'number',
+    // },
+    // V3
+    CACHE_POLLING_MAX_RETRIES: {
+        description: 'Max amount of times to attempt to find EA response in the cache after the Transport has been set up',
+        type: 'number',
+        default: 10,
+    },
+    CACHE_POLLING_SLEEP_MS: {
+        description: 'The number of ms to sleep between each retry to fetch the EA response in the cache',
+        type: 'number',
+        default: 200,
+    },
+    DEFAULT_CACHE_KEY: {
+        description: 'Default key to be used when one cannot be determined from request parameters',
+        type: 'string',
+        default: 'DEFAULT_CACHE_KEY',
+    },
+    EA_HOST: {
+        description: 'Host this EA will listen for REST requests on (if mode is set to "reader" or "reader-writer")',
+        type: 'string',
+        default: '::',
+    },
+    EA_MODE: {
+        description: 'Port this EA will listen for REST requests on (if mode is set to "reader" or "reader-writer")',
+        type: 'enum',
+        default: 'reader-writer',
+        options: ['reader', 'writer', 'reader-writer'],
+    },
+    MAX_COMMON_KEY_SIZE: {
+        description: 'Maximum amount of characters that the common part of the cache key or feed ID can have',
+        type: 'number',
+        default: 300,
+        validate: (value) => {
+            if (!(value && value >= 150 && value <= 500)) {
+                return 'MAX_COMMON_KEY_SIZE must be a number between 150 and 500';
+            }
+        },
+    },
+    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',
+    },
+};
+const buildAdapterConfig = ({ overrides = {}, customSettings = {}, }) => {
+    const vars = {};
+    // Iterate base adapter env vars
+    for (const [key, config] of Object.entries(exports.BaseSettings)) {
+        const value = getEnv(key, config) ?? overrides?.[key] ?? config.default;
+        vars[key] = value;
+    }
+    // Iterate custom vars
+    for (const [key, config] of Object.entries(customSettings)) {
+        if (exports.BaseSettings[key]) {
+            throw new Error(`Custom env var "${key}" declared, but a base framework env var with that name already exists.`);
+        }
+        const value = getEnv(key, config) ?? config.default;
+        vars[key] = value;
+    }
+    return vars;
+};
+exports.buildAdapterConfig = buildAdapterConfig;
+const validateAdapterConfig = (adapterConfig, customSettings = {}) => {
+    const validationErrors = [];
+    Object.entries(exports.BaseSettings)
+        .concat(Object.entries(customSettings || {}))
+        .forEach(([name, setting]) => {
+        validateSetting(name, adapterConfig[name], setting, validationErrors);
+    });
+    if (validationErrors.length > 0) {
+        throw new Error(`Validation failed for the following variables:\n ${validationErrors.join('\n')}`);
+    }
+};
+exports.validateAdapterConfig = validateAdapterConfig;
+const validateSetting = (key, value, config, validationErrors) => {
+    // Check if a required setting has been provided
+    if (config.required && (value === null || value === undefined)) {
+        validationErrors.push(`${key}: Value is required, but none was provided`);
+    }
+    else if (config.validate) {
+        // Cast validate to unknown because TS can't select one of multiple variants of the validate function signature
+        const validationRes = config.validate(value);
+        if (validationRes) {
+            validationErrors.push(`${key}: ${validationRes}`);
+        }
+    }
+};
+const getEnv = (name, config) => {
+    const value = process.env[name];
+    if (!value) {
+        return null;
+    }
+    switch (config.type) {
+        case 'string':
+            return value;
+        case 'number':
+            return parseInt(value);
+        case 'boolean':
+            return value === 'true';
+        case 'enum':
+            if (!config.options?.includes(value)) {
+                throw new Error(`Env var "${name}" has value "${value}" which is not included in the valid options (${config.options})`);
+            }
+            return value;
+    }
+};
+//# sourceMappingURL=index.js.map

package/config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/config/index.ts"],"names":[],"mappings":";;;AAAa,QAAA,YAAY,GAAG;IAC1B,YAAY;IACZ,iBAAiB;IACjB,qFAAqF;IACrF,oBAAoB;IACpB,KAAK;IACL,YAAY,EAAE;QACZ,WAAW,EAAE,sDAAsD;QACnE,IAAI,EAAE,QAAQ;KACf;IACD,OAAO,EAAE;QACP,WAAW,EAAE,+BAA+B;QAC5C,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;KAChB;IACD,WAAW,EAAE;QACX,WAAW,EACT,gHAAgH;QAClH,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,KAAK;KACf;IACD,WAAW,EAAE;QACX,WAAW,EACT,sIAAsI;QACxI,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;KACf;IACD,QAAQ,EAAE;QACR,WAAW,EAAE,2CAA2C;QACxD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,GAAG;KACb;IACD,gCAAgC,EAAE;QAChC,WAAW,EAAE,iDAAiD;QAC9D,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;KACf;IACD,aAAa,EAAE;QACb,WAAW,EAAE,iEAAiE;QAC9E,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,KAAK;KACf;IACD,qBAAqB;IACrB,oBAAoB;IACpB,mBAAmB;IACnB,KAAK;IACL,mBAAmB;IACnB,oBAAoB;IACpB,oBAAoB;IACpB,KAAK;IACL,oCAAoC;IACpC,oBAAoB;IACpB,oBAAoB;IACpB,KAAK;IACL,gBAAgB,EAAE;QAChB,WAAW,EAAE,4CAA4C;QACzD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,WAAW;KACrB;IACD,kCAAkC;IAClC,wEAAwE;IACxE,oBAAoB;IACpB,kBAAkB;IAClB,KAAK;IACL,wCAAwC;IACxC,oBAAoB;IACpB,mBAAmB;IACnB,KAAK;IACL,oBAAoB,EAAE;QACpB,WAAW,EAAE,sCAAsC;QACnD,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;KAChB;IACD,gBAAgB,EAAE;QAChB,WAAW,EAAE,4CAA4C;QACzD,IAAI,EAAE,QAAQ;KACf;IACD,gBAAgB,EAAE;QAChB,WAAW,EAAE,wCAAwC;QACrD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,IAAI;KACd;IACD,mBAAmB,EAAE;QACnB,WAAW,EAAE,4DAA4D;QACzE,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,GAAG;KACb;IACD,qBAAqB;IACrB,oBAAoB;IACpB,KAAK;IACL,UAAU,EAAE;QACV,WAAW,EAAE,4CAA4C;QACzD,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;KAC5B;IACD,sBAAsB,EAAE;QACtB,WAAW,EAAE,6DAA6D;QAC1E,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd;IACD,uBAAuB;IACvB,mFAAmF;IACnF,oBAAoB;IACpB,KAAK;IACL,KAAK,EAAE;QACL,WAAW,EAAE,oBAAoB;QACjC,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;KACf;IACD,mCAAmC;IACnC,6DAA6D;IAC7D,oBAAoB;IACpB,oBAAoB;IACpB,KAAK;IACL,OAAO,EAAE;QACP,WAAW,EACT,yGAAyG;QAC3G,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,IAAI;KACd;IACD,oBAAoB;IACpB,oBAAoB;IACpB,KAAK;IACL,4BAA4B,EAAE;QAC5B,WAAW,EACT,yFAAyF;QAC3F,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd;IACD,SAAS,EAAE;QACT,WAAW,EAAE,8CAA8C;QAC3D,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,MAAM;KAChB;IACD,eAAe,EAAE;QACf,WAAW,EAAE,8DAA8D;QAC3E,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;KACd;IACD,YAAY,EAAE;QACZ,WAAW,EAAE,cAAc;QAC3B,IAAI,EAAE,QAAQ;KACf;IACD,YAAY,EAAE;QACZ,WAAW,EAAE,iCAAiC;QAC9C,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,IAAI;KACd;IACD,oBAAoB,EAAE;QACpB,WAAW,EAAE,gFAAgF;QAC7F,IAAI,EAAE,SAAS;KAChB;IACD,mBAAmB,EAAE;QACnB,WAAW,EACT,8IAA8I;QAChJ,IAAI,EAAE,QAAQ;KACf;IACD,mBAAmB,EAAE;QACnB,WAAW,EAAE,6EAA6E;QAC1F,IAAI,EAAE,QAAQ;KACf;IACD,0BAA0B,EAAE;QAC1B,WAAW,EACT,kIAAkI;QACpI,IAAI,EAAE,QAAQ;KACf;IACD,0BAA0B,EAAE;QAC1B,WAAW,EAAE,6EAA6E;QAC1F,IAAI,EAAE,QAAQ;KACf;IACD,0BAA0B,EAAE;QAC1B,WAAW,EAAE,2BAA2B;QACxC,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;KACf;IACD,8BAA8B,EAAE;QAC9B,WAAW,EACT,sNAAsN;QACxN,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC;KACX;IACD,iCAAiC;IACjC,oBAAoB;IACpB,kBAAkB;IAClB,KAAK;IACL,6CAA6C;IAC7C,oBAAoB;IACpB,gBAAgB;IAChB,KAAK;IACL,qCAAqC;IACrC,oBAAoB;IACpB,mBAAmB;IACnB,KAAK;IACL,oCAAoC;IACpC,oBAAoB;IACpB,gBAAgB;IAChB,KAAK;IACL,WAAW;IACX,qBAAqB;IACrB,gBAAgB;IAChB,KAAK;IACL,6BAA6B,EAAE;QAC7B,WAAW,EACT,mFAAmF;QACrF,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,IAAI;KACd;IACD,mBAAmB,EAAE;QACnB,WAAW,EAAE,mEAAmE;QAChF,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,KAAK;KACf;IACD,oBAAoB,EAAE;QACpB,WAAW,EACT,6FAA6F;QAC/F,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,MAAM;KAChB;IACD,uBAAuB,EAAE;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oCAAoC;QACjD,OAAO,EAAE,MAAM;KAChB;IACD,gCAAgC;IAChC,oBAAoB;IACpB,gBAAgB;IAChB,KAAK;IACL,eAAe,EAAE;QACf,WAAW,EAAE,gDAAgD;QAC7D,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,WAAW,EAAE,4CAA4C;QACzD,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,IAAI;KAChB;IACD,mBAAmB,EAAE;QACnB,WAAW,EAAE,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,MAAM;KAChB;IACD,sCAAsC;IACtC,oBAAoB;IACpB,oBAAoB;IACpB,KAAK;IACL,gDAAgD;IAChD,6EAA6E;IAC7E,oBAAoB;IACpB,KAAK;IAEL,KAAK;IACL,yBAAyB,EAAE;QACzB,WAAW,EACT,qGAAqG;QACvG,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,EAAE;KACZ;IACD,sBAAsB,EAAE;QACtB,WAAW,EACT,oFAAoF;QACtF,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,GAAG;KACb;IACD,iBAAiB,EAAE;QACjB,WAAW,EAAE,8EAA8E;QAC3F,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,mBAAmB;KAC7B;IACD,OAAO,EAAE;QACP,WAAW,EACT,+FAA+F;QACjG,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,IAAI;KACd;IACD,OAAO,EAAE;QACP,WAAW,EACT,+FAA+F;QACjG,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,eAAe;QACxB,OAAO,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,CAAC;KAC/C;IACD,mBAAmB,EAAE;QACnB,WAAW,EACT,wFAAwF;QAC1F,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,GAAG;QACZ,QAAQ,EAAE,CAAC,KAAc,EAAE,EAAE;YAC3B,IAAI,CAAC,CAAC,KAAK,IAAI,KAAK,IAAI,GAAG,IAAI,KAAK,IAAI,GAAG,CAAC,EAAE;gBAC5C,OAAO,0DAA0D,CAAA;aAClE;QACH,CAAC;KACF;IACD,qCAAqC,EAAE;QACrC,WAAW,EACT,8GAA8G;QAChH,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC;KACX;IACD,4CAA4C,EAAE;QAC5C,WAAW,EACT,yFAAyF;QAC3F,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,GAAG;KACb;IACD,4BAA4B,EAAE;QAC5B,WAAW,EAAE,2DAA2D;QACxE,IAAI,EAAE,QAAQ;KACf;CACO,CAAA;AAEH,MAAM,kBAAkB,GAAG,CAEhC,EACA,SAAS,GAAG,EAAgC,EAC5C,cAAc,GAAG,EAAiB,GACnC,EAAiC,EAAE;IAClC,MAAM,IAAI,GAAG,EAAkD,CAAA;IAE/D,gCAAgC;IAChC,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,oBAAY,CAEtD,EAAE;QACD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAa,EAAE,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAA;QACjF,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;KAClB;IAED,sBAAsB;IACtB,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAA6B,EAAE;QACtF,IAAK,oBAAwC,CAAC,GAAa,CAAC,EAAE;YAC5D,MAAM,IAAI,KAAK,CACb,mBAAmB,GAAG,yEAAyE,CAChG,CAAA;SACF;QACD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAa,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAA;QAC7D,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;KAClB;IAED,OAAO,IAAqC,CAAA;AAC9C,CAAC,CAAA;AA5BY,QAAA,kBAAkB,sBA4B9B;AAEM,MAAM,qBAAqB,GAAG,CAGnC,aAA4C,EAC5C,iBAAiB,EAAiB,EAC5B,EAAE;IACR,MAAM,gBAAgB,GAAa,EAAE,CAAA;IACrC,MAAM,CAAC,OAAO,CAAC,oBAA2B,CAAC;SACxC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAE,cAA8B,IAAI,EAAE,CAAC,CAAC;SAC7D,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE;QAC3B,eAAe,CAAC,IAAI,EAAG,aAA+B,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAA;IAC1F,CAAC,CAAC,CAAA;IAEJ,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CACb,oDAAoD,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAClF,CAAA;KACF;AACH,CAAC,CAAA;AAlBY,QAAA,qBAAqB,yBAkBjC;AAED,MAAM,eAAe,GAAG,CACtB,GAAW,EACX,KAAmC,EACnC,MAAe,EACf,gBAA0B,EAC1B,EAAE;IACF,gDAAgD;IAChD,IAAI,MAAM,CAAC,QAAQ,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC,EAAE;QAC9D,gBAAgB,CAAC,IAAI,CAAC,GAAG,GAAG,4CAA4C,CAAC,CAAA;KAC1E;SAAM,IAAI,MAAM,CAAC,QAAQ,EAAE;QAC1B,+GAA+G;QAC/G,MAAM,aAAa,GACjB,MAAM,CAAC,QACR,CAAC,KAAK,CAAC,CAAA;QACR,IAAI,aAAa,EAAE;YACjB,gBAAgB,CAAC,IAAI,CAAC,GAAG,GAAG,KAAK,aAAa,EAAE,CAAC,CAAA;SAClD;KACF;AACH,CAAC,CAAA;AAED,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,MAAe,EAA2B,EAAE;IACxE,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC/B,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,IAAI,CAAA;KACZ;IAED,QAAQ,MAAM,CAAC,IAAI,EAAE;QACnB,KAAK,QAAQ;YACX,OAAO,KAAK,CAAA;QACd,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAA;QACxB,KAAK,SAAS;YACZ,OAAO,KAAK,KAAK,MAAM,CAAA;QACzB,KAAK,MAAM;YACT,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE;gBACpC,MAAM,IAAI,KAAK,CACb,YAAY,IAAI,gBAAgB,KAAK,iDAAiD,MAAM,CAAC,OAAO,GAAG,CACxG,CAAA;aACF;YACD,OAAO,KAAK,CAAA;KACf;AACH,CAAC,CAAA"}

package/config/provider-limits.d.ts

@@ -0,0 +1,27 @@
+export declare const DEFAULT_MINUTE_RATE_LIMIT = 60;
+export declare const BURST_UNDEFINED_QUOTA_MULTIPLE = 2;
+export declare const DEFAULT_WS_CONNECTIONS = 2;
+export declare const DEFAULT_WS_SUBSCRIPTIONS = 10;
+declare type RateLimitTimeFrame = 'rateLimit1s' | 'rateLimit1m' | 'rateLimit1h';
+declare type HTTPTier = {
+    rateLimit1s?: number;
+    rateLimit1m?: number;
+    rateLimit1h?: number;
+    note?: string;
+};
+declare type WSTier = {
+    connections: number;
+    subscriptions: number;
+};
+export interface Limits {
+    http: Record<string, HTTPTier>;
+    ws: Record<string, WSTier>;
+}
+interface ProviderRateLimit {
+    second: number;
+    minute: number;
+}
+export declare const getHTTPLimit: (provider: string, limits: Limits, tier: string, timeframe: RateLimitTimeFrame) => number;
+export declare const getRateLimit: (provider: string, limits: Limits, tier: string) => ProviderRateLimit;
+export declare const getWSLimits: (provider: string, limits: Limits, tier: string) => WSTier;
+export {};

package/config/provider-limits.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWSLimits = exports.getRateLimit = exports.getHTTPLimit = exports.DEFAULT_WS_SUBSCRIPTIONS = exports.DEFAULT_WS_CONNECTIONS = exports.BURST_UNDEFINED_QUOTA_MULTIPLE = exports.DEFAULT_MINUTE_RATE_LIMIT = void 0;
+const util_1 = require("../util");
+exports.DEFAULT_MINUTE_RATE_LIMIT = 60;
+exports.BURST_UNDEFINED_QUOTA_MULTIPLE = 2;
+exports.DEFAULT_WS_CONNECTIONS = 2;
+exports.DEFAULT_WS_SUBSCRIPTIONS = 10;
+const logger = (0, util_1.makeLogger)('ProviderLimits');
+const getHTTPLimit = (provider, limits, tier, timeframe) => {
+    const providerLimit = getProviderLimits(provider, limits, tier, 'http');
+    return providerLimit?.[timeframe] || 0;
+};
+exports.getHTTPLimit = getHTTPLimit;
+const getRateLimit = (provider, limits, tier) => {
+    const providerLimit = getProviderLimits(provider, limits, tier, 'http');
+    return calculateRateLimit(providerLimit);
+};
+exports.getRateLimit = getRateLimit;
+const getWSLimits = (provider, limits, tier) => {
+    const providerLimit = getProviderLimits(provider, limits, tier, 'ws');
+    return calculateWSLimits(providerLimit);
+};
+exports.getWSLimits = getWSLimits;
+const getProviderLimits = (provider, limits, tier, protocol) => {
+    const providerConfig = parseLimits(limits);
+    if (!providerConfig) {
+        throw new Error(`Rate Limit: Provider: "${provider}" doesn't match any provider spec in limits.json`);
+    }
+    const protocolConfig = providerConfig[protocol];
+    if (!protocolConfig) {
+        throw new Error(`Rate Limit: "${provider}" doesn't have any configuration for ${protocol} in limits.json`);
+    }
+    let limitsConfig = protocolConfig[tier.toLowerCase()];
+    if (!limitsConfig) {
+        logger.debug(`Rate Limit: "${provider} does not have tier ${tier} defined. Falling back to lowest tier"`);
+        limitsConfig = Object.values(protocolConfig)?.[0];
+    }
+    if (!limitsConfig) {
+        throw new Error(`Rate Limit: Provider: "${provider}" has no tiers defined for ${protocol} in limits.json`);
+    }
+    return limitsConfig;
+};
+const objectKeysToLowercase = (obj) => {
+    const lower = {};
+    for (const key in obj) {
+        lower[key.toLowerCase()] = obj[key];
+    }
+    return lower;
+};
+const parseLimits = (limits) => {
+    limits.http = objectKeysToLowercase(limits.http);
+    limits.ws = objectKeysToLowercase(limits.ws);
+    return limits;
+};
+const calculateWSLimits = (providerLimit) => {
+    return {
+        connections: providerLimit.connections,
+        subscriptions: providerLimit.subscriptions,
+    };
+};
+const calculateRateLimit = (providerLimit) => {
+    let quota = providerLimit.rateLimit1m;
+    if (!quota && providerLimit?.rateLimit1h) {
+        quota = providerLimit?.rateLimit1h / 60;
+    }
+    else if (!quota && providerLimit?.rateLimit1s) {
+        quota = providerLimit?.rateLimit1s * 60;
+    }
+    return {
+        second: providerLimit?.rateLimit1s || (quota / 60) * exports.BURST_UNDEFINED_QUOTA_MULTIPLE,
+        minute: quota,
+    };
+};
+//# sourceMappingURL=provider-limits.js.map

package/config/provider-limits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider-limits.js","sourceRoot":"","sources":["../../../src/config/provider-limits.ts"],"names":[],"mappings":";;;AAAA,kCAAoC;AAEvB,QAAA,yBAAyB,GAAG,EAAE,CAAA;AAC9B,QAAA,8BAA8B,GAAG,CAAC,CAAA;AAElC,QAAA,sBAAsB,GAAG,CAAC,CAAA;AAC1B,QAAA,wBAAwB,GAAG,EAAE,CAAA;AA0B1C,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,gBAAgB,CAAC,CAAA;AAEpC,MAAM,YAAY,GAAG,CAC1B,QAAgB,EAChB,MAAc,EACd,IAAY,EACZ,SAA6B,EACrB,EAAE;IACV,MAAM,aAAa,GAAG,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACvE,OAAQ,aAA0B,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;AACtD,CAAC,CAAA;AARY,QAAA,YAAY,gBAQxB;AAEM,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAE,IAAY,EAAqB,EAAE;IAChG,MAAM,aAAa,GAAG,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACvE,OAAO,kBAAkB,CAAC,aAAyB,CAAC,CAAA;AACtD,CAAC,CAAA;AAHY,QAAA,YAAY,gBAGxB;AAEM,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAE,IAAY,EAAU,EAAE;IACpF,MAAM,aAAa,GAAG,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IACrE,OAAO,iBAAiB,CAAC,aAAuB,CAAC,CAAA;AACnD,CAAC,CAAA;AAHY,QAAA,WAAW,eAGvB;AAED,MAAM,iBAAiB,GAAG,CACxB,QAAgB,EAChB,MAAc,EACd,IAAY,EACZ,QAAuB,EACQ,EAAE;IACjC,MAAM,cAAc,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC1C,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CACb,0BAA0B,QAAQ,kDAAkD,CACrF,CAAA;KACF;IAED,MAAM,cAAc,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA;IAC/C,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CACb,gBAAgB,QAAQ,wCAAwC,QAAQ,iBAAiB,CAC1F,CAAA;KACF;IAED,IAAI,YAAY,GAAG,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;IAErD,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,CAAC,KAAK,CACV,gBAAgB,QAAQ,uBAAuB,IAAI,wCAAwC,CAC5F,CAAA;QACD,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;KAClD;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,MAAM,IAAI,KAAK,CACb,0BAA0B,QAAQ,8BAA8B,QAAQ,iBAAiB,CAC1F,CAAA;KACF;IAED,OAAO,YAAY,CAAA;AACrB,CAAC,CAAA;AAED,MAAM,qBAAqB,GAAG,CAAI,GAAsB,EAAqB,EAAE;IAC7E,MAAM,KAAK,GAAsB,EAAE,CAAA;IAEnC,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE;QACrB,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAA;KACpC;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED,MAAM,WAAW,GAAG,CAAC,MAAc,EAAU,EAAE;IAC7C,MAAM,CAAC,IAAI,GAAG,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAChD,MAAM,CAAC,EAAE,GAAG,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IAC5C,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,iBAAiB,GAAG,CAAC,aAAqB,EAAU,EAAE;IAC1D,OAAO;QACL,WAAW,EAAE,aAAa,CAAC,WAAW;QACtC,aAAa,EAAE,aAAa,CAAC,aAAa;KAC3C,CAAA;AACH,CAAC,CAAA;AAED,MAAM,kBAAkB,GAAG,CAAC,aAAuB,EAAqB,EAAE;IACxE,IAAI,KAAK,GAAG,aAAa,CAAC,WAAW,CAAA;IACrC,IAAI,CAAC,KAAK,IAAI,aAAa,EAAE,WAAW,EAAE;QACxC,KAAK,GAAG,aAAa,EAAE,WAAW,GAAG,EAAE,CAAA;KACxC;SAAM,IAAI,CAAC,KAAK,IAAI,aAAa,EAAE,WAAW,EAAE;QAC/C,KAAK,GAAG,aAAa,EAAE,WAAW,GAAG,EAAE,CAAA;KACxC;IACD,OAAO;QACL,MAAM,EAAE,aAAa,EAAE,WAAW,IAAI,CAAE,KAAgB,GAAG,EAAE,CAAC,GAAG,sCAA8B;QAC/F,MAAM,EAAE,KAAe;KACxB,CAAA;AACH,CAAC,CAAA"}

package/examples/bank-frick/accounts.d.ts

@@ -0,0 +1,45 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AdapterDependencies, AdapterEndpoint } from '../../adapter';
+import { Cache } from '../../cache';
+import { AdapterConfig } from '../../config';
+import { Transport } from '../../transports';
+import { AdapterRequest, AdapterResponse, SingleNumberResultResponse } from '../../util';
+import { customSettings } from './config';
+import { AdapterInputParameters, BankFrickAccountsRequestSchema, BankFrickAccountsResponseSchema, SigningAlgorithm } from './types';
+export declare type AccountsEndpointTypes = {
+    Request: {
+        Params: AdapterInputParameters;
+    };
+    Response: SingleNumberResultResponse;
+    CustomSettings: typeof customSettings;
+};
+/**
+ * RestTransport implementation for Bank Frick, which has unusually complex requirements for an EA
+ * The RestTransport is generally built to make a single request and return a single response.
+ * This transport instead is used to fetch and process pages of data, and also requires a JWT to run
+ *
+ * This transport does all the heavy lifting in setup(), which is where the paging happens, and it
+ * also has complex retry logic that will attempt to refresh the JWT when certain HTTP errors occur
+ */
+export declare class BankFrickAccountsTransport implements Transport<AccountsEndpointTypes> {
+    token: string;
+    cache: Cache<AdapterResponse<AccountsEndpointTypes['Response']>>;
+    initialize(dependencies: AdapterDependencies): Promise<void>;
+    /**
+     * Creates an AxiosRequestConfig object for fetching a page of accounts from the Bank Frick API
+     */
+    prepareRequest(firstPosition: number, inputParams: AdapterInputParameters, config: AdapterConfig<typeof customSettings>): AxiosRequestConfig<BankFrickAccountsRequestSchema>;
+    /**
+     * Request with retry logic for Bank Frick's API. In addition to standard retry logic, this function
+     * compares errors against expected errors from the Bank Frick API, and will throw without retries
+     * on a known fatal error, or try to refresh the JWT on a known auth error
+     **/
+    makeRequest(axiosRequest: AxiosRequestConfig<BankFrickAccountsRequestSchema>, config: AdapterConfig<typeof customSettings>, signingAlgorithm?: SigningAlgorithm): Promise<AxiosResponse<BankFrickAccountsResponseSchema>>;
+    validateInputParams(params: AdapterInputParameters): string[];
+    /**
+     * Fetches pages of data from the Bank Frick API, scans for accounts by IBAN, and returns the balance
+     * of all found accounts. Returns a 404 if any IBAN isn't found.
+     */
+    foregroundExecute(req: AdapterRequest<AccountsEndpointTypes['Request']>, config: AdapterConfig<typeof customSettings>): Promise<AdapterResponse<AccountsEndpointTypes['Response']>>;
+}
+export declare const accountsRestEndpoint: AdapterEndpoint<AccountsEndpointTypes>;