@chainlink/external-adapter-framework 0.5.0 → 0.5.2

package/README.md

@@ -1,102 +0,0 @@
-# EA Framework v3
-
-External adapters and its core framework serve as middleware to facilitate connections between Chainlink Nodes and Data Providers (DP). Their main purpose is threefold:
-
-- Abstract provider specific details, specifically:
-  - Transport (REST, WebSockets, RPC, SSE, etc.)
-  - Authentication (login flows, keys)
-  - Accept normalized request payloads and translate into the provider's interface (this also includes things like symbols/tickers)
-  - Parse provider responses into the desired data points (e.g. price from crypto endpoint)
-- Make the overall system more efficient by using as few resources (e.g. API credits, networking traffic, CPU usage) as possible to fetch data, achieved by features like:
-  - Caching: since DPs update data at various times and a request to their API incurs a certain latency, EAs keep a cache of values to
-    - Provide responses to the Chainlink Nodes as quickly as possible
-    - Communicate with DPs only when necessary
-  - Cache Warming: in order to make as many of the requests to EAs be fulfilled from the cache, EAs fetch values from DPs asynchronously to keep the local ones fresh.
-  - Batching: the CL Node requests feeds individually, but it's common for DPs to provide batch endpoints to get many data points at once. With Batching, EAs keep track of incoming requests and consolidate them into one batched request.
-  - Rate limiting: the EA framework additionally checks request rates (frequency) to make sure they fall within acceptable limits (like quotas for the DP's API, or adjusting based on the NOP's API tier).
-- Perform off chain computations (think aggregations, indexing, or any sort of data processing)
-
-By providing a framework that gives users easy access to those features, we reduce the complexity required for Nodes to communicate with DPs since by using EAs there is only one standardized way to do so, while at the same time optimizing said communication so it's as resource efficient as possible. It also makes internal and external development easier and faster, by serving as a strict guideline to implement and add new providers.
-
-## Qs
-
-- Store entire response in cache?
-- Check for valid result in adapter response?
-
-## Env vars
-
-These are all existing env vars, marked DONE if they have been ported to this version, or N/A if the new version disregards them altogether.
-
-| Name                                       | State | Comments                                                     |
-| :----------------------------------------- | :---: | :----------------------------------------------------------- |
-| ADAPTER_URL                                |   -   |                                                              |
-| API_ENDPOINT                               |   √   |                                                              |
-| API_KEY                                    |   √   |                                                              |
-| API_TIMEOUT                                |   √   | Sets timeout for axios request                               |
-| API_VERBOSE                                |   √   | Does not return verbose on cache hit                         |
-| BASE_URL                                   |   √   |                                                              |
-| CACHE_ENABLED                              |  N/A  | Cache is integral to this fw, not including this for now     |
-| CACHE_KEY_IGNORED_PROPS                    |  N/A  | Not applicable after feed ID generation logic change         |
-| CACHE_KEY_GROUP                            |  N/A  | Grouping cache data is not needed in v3                      |
-| CACHE_MAX_AGE                              |   √   |                                                              |
-| CACHE_MAX_ITEMS                            |   -   | Should add when replacing obj in local impl with LRU package |
-| CACHE_MIN_AGE                              |   -   | Used for rate limiting                                       |
-| CACHE_REDIS_CONNECTION_TIMEOUT             |   -   | TODO: Redis                                                  |
-| CACHE_REDIS_HOST                           |   √   |                                                              |
-| CACHE_REDIS_MAX_QUEUED_ITEMS               |   -   | TODO: Redis                                                  |
-| CACHE_REDIS_MAX_RECONNECT_COOLDOWN         |   -   | TODO: Redis                                                  |
-| CACHE_REDIS_PASSWORD                       |   √   |                                                              |
-| CACHE_REDIS_PATH                           |   √   |                                                              |
-| CACHE_REDIS_PORT                           |   √   |                                                              |
-| CACHE_REDIS_TIMEOUT                        |   √   |                                                              |
-| CACHE_REDIS_URL                            |   -   | TODO: Redis                                                  |
-| CACHE_TYPE                                 |   √   |                                                              |
-| CACHE_UPDATE_AGE_ON_GET                    |  N/A  | No longer used in EA currently, apparently                   |
-| DATA_PROVIDER_URL                          |   -   | Legacy var same as ADAPTER_URL                               |
-| DEBUG                                      |   √   |                                                              |
-| DEFAULT_WS_HEARTBEAT_INTERVAL              |  N/A  |                                                              |
-| EA_HOST                                    |   √   |                                                              |
-| EA_PORT                                    |   √   |                                                              |
-| ERROR_CAPACITY                             |   -   | Error backoff is not currently in v3                         |
-| EXPERIMENTAL_METRICS_ENABLED               |   √   | Maintaining for backwards compatibility. Defaults to true    |
-| LOG_LEVEL                                  |       |                                                              |
-| METRICS_ENABLED                            |   √   | Defaults to true                                             |
-| METRICS_NAME                               |   √   |                                                              |
-| METRICS_PORT                               |   √   |                                                              |
-| METRICS_USE_BASE_URL                       |   √   |                                                              |
-| NODE_ENV                                   |       |                                                              |
-| npm_package_version                        |       |                                                              |
-| RATE_LIMIT_API_TIER                        |   √   |                                                              |
-| RATE_LIMIT_CAPACITY                        |   √   | Used for per minute rate limit if exists                     |
-| RATE_LIMIT_CAPACITY_MINUTE                 |   √   | Used for per minute rate limit if exists                     |
-| RATE_LIMIT_CAPACITY_SECOND                 |   √   | Used for per second rate limit if exists                     |
-| RATE_LIMIT_ENABLED                         |  N/A  | Rate limit always enabled in v3                              |
-| RECORD                                     |  N/A  | Not needed in v3 config for integration testing              |
-| REQUEST_COALESCING_ENABLED                 |   √   | Overrides transport config option if set                     |
-| REQUEST_COALESCING_ENTROPY_MAX             |       |                                                              |
-| REQUEST_COALESCING_INTERVAL                |       |                                                              |
-| REQUEST_COALESCING_INTERVAL_COEFFICIENT    |       |                                                              |
-| REQUEST_COALESCING_INTERVAL_MAX            |       |                                                              |
-| REQUEST_COALESCING_MAX_RETRIES             |       |                                                              |
-| RETRY                                      |   -   | Retry mechanism not yet part of v3                           |
-| SERVER_RATE_LIMIT_MAX                      |       |                                                              |
-| SERVER_SLOW_DOWN_AFTER_FACTOR              |       |                                                              |
-| SERVER_SLOW_DOWN_DELAY_MS                  |       |                                                              |
-| TIMEOUT                                    |   X   | API_TIMEOUT is used for same purpose                         |
-| WARMUP_ENABLED                             |       |                                                              |
-| WARMUP_INTERVAL                            |       |                                                              |
-| WARMUP_SUBSCRIPTION_TTL                    |       |                                                              |
-| WARMUP_UNHEALTHY_THRESHOLD                 |       |                                                              |
-| WS_API_ENDPOINT                            |       |                                                              |
-| WS_API_KEY                                 |       |                                                              |
-| WS_CONNECTION_KEY                          |  N/A  | Connection key is no longer used for WS in v3                |
-| WS_CONNECTION_LIMIT                        |       |                                                              |
-| WS_CONNECTION_RETRY_DELAY                  |       |                                                              |
-| WS_CONNECTION_RETRY_LIMIT                  |       |                                                              |
-| WS_CONNECTION_TTL                          |       |                                                              |
-| WS_ENABLED                                 |  N/A  | Shouldn't be part of this fw                                 |
-| WS_SUBSCRIPTION_LIMIT                      |       |                                                              |
-| WS_SUBSCRIPTION_PRIORITY_LIST              |       |                                                              |
-| WS_SUBSCRIPTION_TTL                        |       |                                                              |
-| WS_SUBSCRIPTION_UNRESPONSIVE_TTL           |       |                                                              |
-| WS_TIME_UNTIL_HANDLE_NEXT_MESSAGE_OVERRIDE |       |                                                              |