Generic API EA (#4134)

* Generated boilerplate

* generic-api EA

* address comments

* ripcordDisabledValue description

* Generate readme

* Manually change readme

* Make auth header optional

* Remove known-issues.md

* Blacklist README generation

---------

Co-authored-by: app-token-issuer-data-feeds[bot] <134377064+app-token-issuer-data-feeds[bot]@users.noreply.github.com>

Author: dskloetc

.changeset/hot-rabbits-shout.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/generic-api-adapter': major
+---
+
+Initial release of the generic-api adapter.

.pnp.cjs

@@ -22,6 +22,7 @@
     "dlc-btc-por",
     "dxdao",
     "dydx-stark",
+    "generic-api",
     "google-bigquery",
     "google-weather",
     "graphql",

packages/scripts/src/generate-readme/readmeBlacklist.json

@@ -0,0 +1,66 @@
+# GENERIC_API
+
+![0.0.0](https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/generic-api/package.json) ![v3](https://img.shields.io/badge/framework%20version-v3-blueviolet)
+
+This document maintained manually.
+
+## Variable env vars
+
+To support a specific value for input parameter `apiName`, the environment variable `<API_NAME>_API_URL`, and optionally `<API_NAME>_AUTH_HEADER` and `<API_NAME>_AUTH_HEADER_VALUE` must be set, where `<API_NAME>` is the upper-snake-case version of the value provided for the `apiName` parameter.
+
+## Environment Variables
+
+| Required? |             Name              |                      Description                      |  Type  |
+| :-------: | :---------------------------: | :---------------------------------------------------: | :----: |
+|    ✅     |      {API_NAME}\_API_URL      |       The API URL to use for a given `apiUrl`.        | string |
+|           |    {API_NAME}\_AUTH_HEADER    | The header to pass the authentication credentials on. | string |
+|           | {API_NAME}\_AUTH_HEADER_VALUE | The credentials to pass on the authentcation header.  | string |
+
+---
+
+## Data Provider Rate Limits
+
+|  Name   | Requests/credits per second | Requests/credits per minute | Requests/credits per hour | Note |
+| :-----: | :-------------------------: | :-------------------------: | :-----------------------: | :--: |
+| default |                             |             20              |                           |      |
+
+---
+
+## Input Parameters
+
+| Required? |   Name   |     Description     |  Type  |        Options         | Default |
+| :-------: | :------: | :-----------------: | :----: | :--------------------: | :-----: |
+|           | endpoint | The endpoint to use | string | [http](#http-endpoint) | `http`  |
+
+## Http Endpoint
+
+`http` is the only supported name for this endpoint.
+
+### Input Params
+
+| Required? |         Name         | Aliases |                                      Description                                       |  Type  | Options | Default | Depends On | Not Valid With |
+| :-------: | :------------------: | :-----: | :------------------------------------------------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
+|    ✅     |       apiName        |         |              Used as prefix for environment variables to find API config               | string |         |         |            |                |
+|    ✅     |       dataPath       |         |                  The path to the field containing the data to return                   | string |         |         |            |                |
+|           |     ripcordPath      |         |                       The path to the ripcord field if expected                        | string |         |         |            |                |
+|           | ripcordDisabledValue |         | The value the ripcord field should have during normal operation, converted to a string | string |         | `false` |            |                |
+
+### Example
+
+Request:
+
+```json
+{
+  "data": {
+    "endpoint": "http",
+    "apiName": "client-name",
+    "dataPath": "PoR",
+    "ripcordPath": "ripcord",
+    "ripcordDisabledValue": "false"
+  }
+}
+```
+
+---
+
+MIT License

packages/sources/generic-api/CHANGELOG.md

@@ -0,0 +1,42 @@
+{
+  "name": "@chainlink/generic-api-adapter",
+  "version": "0.0.0",
+  "description": "Chainlink generic-api adapter.",
+  "keywords": [
+    "Chainlink",
+    "LINK",
+    "blockchain",
+    "oracle",
+    "generic-api"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "url": "https://github.com/smartcontractkit/external-adapters-js",
+    "type": "git"
+  },
+  "license": "MIT",
+  "scripts": {
+    "clean": "rm -rf dist && rm -f tsconfig.tsbuildinfo",
+    "prepack": "yarn build",
+    "build": "tsc -b",
+    "server": "node -e 'require(\"./index.js\").server()'",
+    "server:dist": "node -e 'require(\"./dist/index.js\").server()'",
+    "start": "yarn server:dist"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "22.14.1",
+    "@types/object-path": "0.11.4",
+    "nock": "13.5.6",
+    "typescript": "5.8.3"
+  },
+  "dependencies": {
+    "@chainlink/external-adapter-framework": "2.8.0",
+    "object-path": "^0.11.5",
+    "tslib": "2.4.1"
+  }
+}

packages/sources/generic-api/README.md

@@ -0,0 +1,42 @@
+import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
+import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
+
+export const config = new AdapterConfig({})
+
+const sanitizeEnvVarName = (name: string): string => {
+  return name.toUpperCase().replace(/[^a-zA-Z0-9]/g, '_')
+}
+
+const getEnvVarName = (prefix: string, name: string): string => {
+  return sanitizeEnvVarName(`${prefix}_${name}`)
+}
+
+const getEnvVar = (prefix: string, name: string, required: boolean): string | undefined => {
+  const envVarName = getEnvVarName(prefix, name)
+  if (required && !(envVarName in process.env)) {
+    throw new AdapterInputError({
+      message: `Missing required environment variable '${envVarName}'.`,
+      statusCode: 400,
+    })
+  }
+  return process.env[envVarName] as string
+}
+
+export const getApiConfig = (apiName: string) => {
+  const url = getEnvVar(apiName, 'API_URL', true) as string
+  const authHeader = getEnvVar(apiName, 'AUTH_HEADER', false)
+  const authHeaderValue = getEnvVar(apiName, 'AUTH_HEADER_VALUE', false)
+  if (!!authHeader !== !!authHeaderValue) {
+    const authHeadVarName = getEnvVarName(apiName, 'AUTH_HEADER')
+    const authHeadValueVarName = getEnvVarName(apiName, 'AUTH_HEADER_VALUE')
+    throw new AdapterInputError({
+      message: `If one of ${authHeadVarName} or ${authHeadValueVarName} is set, both must be set.`,
+      statusCode: 500,
+    })
+  }
+  return {
+    url,
+    authHeader,
+    authHeaderValue,
+  }
+}

packages/sources/generic-api/package.json

@@ -0,0 +1,61 @@
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { AdapterError } from '@chainlink/external-adapter-framework/validation/error'
+import { config, getApiConfig } from '../config'
+import { httpTransport } from '../transport/http'
+
+export const inputParameters = new InputParameters(
+  {
+    apiName: {
+      required: true,
+      type: 'string',
+      description: 'Used as prefix for environment variables to find API config',
+    },
+    dataPath: {
+      required: true,
+      type: 'string',
+      description: 'The path to the field containing the data to return',
+    },
+    ripcordPath: {
+      required: false,
+      type: 'string',
+      description: 'The path to the ripcord field if expected',
+    },
+    ripcordDisabledValue: {
+      default: 'false',
+      type: 'string',
+      description:
+        'If the ripcord field has a different value than this, the adapter will return an error.',
+    },
+  },
+  [
+    {
+      apiName: 'client-name',
+      dataPath: 'PoR',
+      ripcordPath: 'ripcord',
+      ripcordDisabledValue: 'false',
+    },
+  ],
+)
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: {
+    Result: string
+    Data: {
+      result: string
+    }
+  }
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'http',
+  aliases: [],
+  transport: httpTransport,
+  inputParameters,
+  customInputValidation: (request): AdapterError | undefined => {
+    getApiConfig(request.requestContext.data.apiName)
+    return
+  },
+})

packages/sources/generic-api/src/config/index.ts

@@ -0,0 +1 @@
+export { endpoint as http } from './http'

packages/sources/generic-api/src/endpoint/http.ts

@@ -0,0 +1,20 @@
+import { expose, ServerInstance } from '@chainlink/external-adapter-framework'
+import { Adapter } from '@chainlink/external-adapter-framework/adapter'
+import { config } from './config'
+import { http } from './endpoint'
+
+export const adapter = new Adapter({
+  defaultEndpoint: http.name,
+  name: 'GENERIC_API',
+  config,
+  endpoints: [http],
+  rateLimiting: {
+    tiers: {
+      default: {
+        rateLimit1m: 20,
+      },
+    },
+  },
+})
+
+export const server = (): Promise<ServerInstance | undefined> => expose(adapter)