@chainlink/external-adapter-framework 0.30.2 → 0.31.0

package/generator-adapter/generators/app/templates/src/transport/http.ts.ejs

@@ -0,0 +1,98 @@
+import { HttpTransport } from '@chainlink/external-adapter-framework/transports'
+import { BaseEndpointTypes } from '../endpoint/<%= inputEndpointName %>'
+
+export interface ResponseSchema {
+  [key: string]: {
+    price: number
+    errorMessage?: string
+  }
+}
+
+<% if (includeComments) { -%>
+// HttpTransport extends base types from endpoint and adds additional, Provider-specific types like 'RequestBody', which is the type of
+// request body (not the request to adapter, but the request that adapter sends to Data Provider), and 'ResponseBody' which is
+// the type of raw response from Data Provider
+<% } -%>
+export type HttpTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    RequestBody: never
+    ResponseBody: ResponseSchema
+  }
+}
+<% if (includeComments) { -%>
+// HttpTransport is used to fetch and process data from a Provider using HTTP(S) protocol. It usually needs two methods
+// `prepareRequests` and `parseResponse`
+<% } -%>
+export const httpTransport = new HttpTransport<HttpTransportTypes>({
+<% if (includeComments) { -%>
+  // `prepareRequests` method receives request payloads sent to associated endpoint alongside adapter config(environment variables)
+  // and should return 'request information' to the Data Provider. Use this method to construct one or many requests, and the framework
+  // will send them to Data Provider
+<% } -%>
+  prepareRequests: (params, config) => {
+    return params.map((param) => {
+      return {
+<% if (includeComments) { -%>
+        // `params` are parameters associated to this single request and will also be available in the 'parseResponse' method.
+<% } -%>
+        params: [param],
+<% if (includeComments) { -%>
+        // `request` contains any valid axios request configuration
+<% } -%>
+        request: {
+          baseURL: config.API_ENDPOINT,
+          url: '/cryptocurrency/price',
+          headers: {
+            'X_API_KEY': config.API_KEY,
+          },
+          params: {
+            symbol: param.base.toUpperCase(),
+            convert: param.quote.toUpperCase(),
+          },
+        },
+      }
+    })
+  },
+<% if (includeComments) { -%>
+  // `parseResponse` takes the 'params' specified in the `prepareRequests` and the 'response' from Data Provider and should return
+  // an array of response objects to be stored in cache. Use this method to construct a list of response objects for every parameter in 'params'
+  // and the framework will save them in cache and return to user
+<% } -%>
+  parseResponse: (params, response) => {
+<% if (includeComments) { -%>
+    // In case error was received, it's a good practice to return meaningful information to user
+<% } -%>
+    if (!response.data) {
+      return params.map((param) => {
+        return {
+          params: param,
+          response: {
+            errorMessage: `The data provider didn't return any value for ${param.base}/${param.quote}`,
+            statusCode: 502,
+          },
+        }
+      })
+    }
+
+<% if (includeComments) { -%>
+    // For successful responses for each 'param' a new response object is created and returned as an array
+<% } -%>
+    return params.map((param) => {
+      const result = response.data[param.base.toUpperCase()].price
+<% if (includeComments) { -%>
+      // Response objects, whether successful or errors, contain two properties, 'params' and 'response'. 'response' is what will be
+      // stored in the cache and returned as adapter response and 'params' determines the identifier so that the next request with same 'params'
+      // will immediately return the response from the cache
+<% } -%>
+      return {
+        params: param,
+        response: {
+          result,
+          data: {
+            result
+          }
+        },
+      }
+    })
+  },
+})

package/generator-adapter/generators/app/templates/src/transport/ws.ts.ejs

@@ -0,0 +1,94 @@
+import { WebSocketTransport } from '@chainlink/external-adapter-framework/transports'
+import { BaseEndpointTypes } from '../endpoint/<%= inputEndpointName %>'
+
+export interface WSResponse {
+  success: boolean
+  price: number
+  base: string
+  quote: string
+  time: number
+}
+
+<% if (includeComments) { -%>
+// WsTransport extends base types from endpoint and adds additional, Provider-specific types like 'WsMessage', which is the type of
+// websocket received message
+<% } -%>
+export type WsTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    WsMessage: WSResponse
+  }
+}
+<% if (includeComments) { -%>
+// WebSocketTransport is used to fetch and process data from a Provider using Websocket protocol.
+<% } -%>
+export const wsTransport = new WebSocketTransport<WsTransportTypes>({
+<% if (includeComments) { -%>
+  // use `url` method to provide connection url. It accepts adapter context, so you have access to adapter config(environment variables) and
+  // request payload if needed
+<% } -%>
+  url: (context) => context.adapterSettings.WS_API_ENDPOINT,
+<% if (includeComments) { -%>
+  // 'handler' contains two helpful methods. one of them is `message`. This method is called when there is a new websocket message.
+  // The other one is 'open' method. It is called when the websocket connection is successfully opened. Use this method to execute some logic
+  // when the connection is established (custom authentication, logging, ...)
+<% } -%>
+  handlers: {
+<% if (includeComments) { -%>
+    // 'message' handler receives a raw websocket message as first argument and adapter context as second and should return an array of
+    // response objects. Use this method to construct a list of response objects, and the framework will save them in cache and return to user
+<% } -%>
+    message(message) {
+<% if (includeComments) { -%>
+      // in cases when error or unknown message is received, use 'return' to skip the iteration.
+<% } -%>
+      if (message.success === false) {
+        return
+      }
+
+<% if (includeComments) { -%>
+    // Response objects, whether successful or errors (if not skipped), contain two properties, 'params' and 'response'. 'response' is what
+    // will be stored in the cache and returned as adapter response and 'params' determines the identifier so that the next request with
+    // same 'params' will immediately return the response from the cache
+<% } -%>
+      return [
+        {
+          params: { base: message.base, quote: message.quote },
+          response: {
+            result: message.price,
+            data: {
+             result: message.price
+            },
+            timestamps: {
+              providerIndicatedTimeUnixMs: message.time,
+            },
+          },
+        },
+      ]
+    },
+  },
+<% if (includeComments) { -%>
+  // `builders` are builder methods, that will be used to prepare specific WS messages to be sent to Data Provider
+<% } -%>
+  builders: {
+<% if (includeComments) { -%>
+    // `subscribeMessage` accepts request parameters and should construct and return a payload that will be sent to Data Provider
+    // Use this method to subscribe to live feeds
+<% } -%>
+    subscribeMessage: (params) => {
+      return {
+        type: 'subscribe',
+        symbols: `${params.base}/${params.quote}`.toUpperCase()
+      }
+    },
+<% if (includeComments) { -%>
+    // `unsubscribeMessage` accepts request parameters and should construct and return a payload that will be sent to Data Provider
+    // Use this method to unsubscribe from live feeds
+<% } -%>
+    unsubscribeMessage: (params) => {
+      return {
+        type: 'unsubscribe',
+        symbols: `${params.base}/${params.quote}`.toUpperCase()
+      }
+    },
+  },
+})

package/generator-adapter/generators/app/templates/test/adapter-ws.test.ts.ejs

@@ -0,0 +1,58 @@
+import { WebSocketClassProvider } from '@chainlink/external-adapter-framework/transports'
+import {
+  TestAdapter,
+  setEnvVariables,
+  mockWebSocketProvider,
+  MockWebsocketServer,
+} from '@chainlink/external-adapter-framework/util/testing-utils'
+import FakeTimers from '@sinonjs/fake-timers'
+import { mockWebsocketServer } from './fixtures'
+
+
+describe('websocket', () => {
+  let mockWsServer: MockWebsocketServer | undefined
+  let testAdapter: TestAdapter
+  const wsEndpoint = 'ws://localhost:9090'
+  let oldEnv: NodeJS.ProcessEnv
+<% for(let i=0; i<endpoints.length; i++) {%>
+  const data<%- endpoints[i].normalizedEndpointNameCap %> = {
+    base: 'ETH',
+    quote: 'USD',
+    endpoint: '<%- endpoints[i].inputEndpointName %>',
+    transport: 'ws'
+  }
+<% } %>
+  beforeAll(async () => {
+    oldEnv = JSON.parse(JSON.stringify(process.env))
+    process.env['WS_API_ENDPOINT'] = wsEndpoint
+    process.env['API_KEY'] = 'fake-api-key'
+    mockWebSocketProvider(WebSocketClassProvider)
+    mockWsServer = mockWebsocketServer(wsEndpoint)
+
+    const adapter = (await import('./../../src')).adapter
+    testAdapter = await TestAdapter.startWithMockedCache(adapter, {
+      clock: FakeTimers.install(),
+      testAdapter: {} as TestAdapter<never>,
+    })
+
+    // Send initial request to start background execute and wait for cache to be filled with results
+<% for(var i=0; i<endpoints.length; i++) {%>
+    await testAdapter.request(data<%- endpoints[i].normalizedEndpointNameCap %>) <% } %>
+    await testAdapter.waitForCache(<%- endpoints.length %>)
+  })
+
+  afterAll(async () => {
+    setEnvVariables(oldEnv)
+    mockWsServer?.close()
+    testAdapter.clock?.uninstall()
+    await testAdapter.api.close()
+  })
+<% for(var i=0; i<endpoints.length; i++) {%>
+  describe('<%= endpoints[i].inputEndpointName %> endpoint', () => {
+    it('should return success', async () => {
+      const response = await testAdapter.request(data<%- endpoints[i].normalizedEndpointNameCap %>)
+      expect(response.json()).toMatchSnapshot()
+    })
+  })
+<% } %>
+})

package/generator-adapter/generators/app/templates/test/adapter.test.ts.ejs

@@ -0,0 +1,50 @@
+import {
+  TestAdapter,
+  setEnvVariables,
+} from '@chainlink/external-adapter-framework/util/testing-utils'
+import * as nock from 'nock'
+import { mockResponseSuccess } from './fixtures'
+
+describe('execute', () => {
+  let spy: jest.SpyInstance
+  let testAdapter: TestAdapter
+  let oldEnv: NodeJS.ProcessEnv
+
+  beforeAll(async () => {
+    oldEnv = JSON.parse(JSON.stringify(process.env))
+    process.env.API_KEY = process.env.API_KEY ?? 'fake-api-key'
+    const mockDate = new Date('2001-01-01T11:11:11.111Z')
+    spy = jest.spyOn(Date, 'now').mockReturnValue(mockDate.getTime())
+
+    const adapter = (await import('./../../src')).adapter
+    adapter.rateLimiting = undefined
+    testAdapter = await TestAdapter.startWithMockedCache(adapter, {
+      testAdapter: {} as TestAdapter<never>,
+    })
+  })
+
+  afterAll(async () => {
+    setEnvVariables(oldEnv)
+    await testAdapter.api.close()
+    nock.restore()
+    nock.cleanAll()
+    spy.mockRestore()
+  })
+
+  <% for(var i=0; i<endpoints.length; i++) {%>
+  describe('<%= endpoints[i].inputEndpointName %> endpoint', () => {
+    it('should return success', async () => {
+      const data = {
+        base: 'ETH',
+        quote: 'USD',
+        endpoint: '<%= endpoints[i].inputEndpointName %>',
+        transport: '<%= transportName %>'
+      }
+      mockResponseSuccess()
+      const response = await testAdapter.request(data)
+      expect(response.statusCode).toBe(200)
+      expect(response.json()).toMatchSnapshot()
+    })
+  })
+      <% } %>
+})

package/generator-adapter/generators/app/templates/test/fixtures.ts.ejs

@@ -0,0 +1,44 @@
+<% if (includeHttpFixtures) { %>import nock from 'nock'<% } %>
+<% if (includeWsFixtures) { %>import { MockWebsocketServer } from '@chainlink/external-adapter-framework/util/testing-utils'<% } %>
+<% if (includeHttpFixtures) { %>
+export const mockResponseSuccess = (): nock.Scope =>
+    nock('https://dataproviderapi.com', {
+      encodedQueryParams: true,
+    })
+      .get('/cryptocurrency/price')
+      .query({
+        symbol: 'ETH',
+        convert: 'USD',
+      })
+      .reply(200, () => ({ ETH: { price: 10000 } }), [
+        'Content-Type',
+        'application/json',
+        'Connection',
+        'close',
+        'Vary',
+        'Accept-Encoding',
+        'Vary',
+        'Origin',
+      ])
+      .persist()
+<% } %>
+<% if (includeWsFixtures) { %>
+export const mockWebsocketServer = (URL: string): MockWebsocketServer => {
+    const mockWsServer = new MockWebsocketServer(URL, { mock: false })
+    mockWsServer.on('connection', (socket) => {
+      socket.on('message', (message) => {
+          return socket.send(
+            JSON.stringify({
+              success: true,
+              price: 1000,
+              base: 'ETH',
+              quote: 'USD',
+              time: '1999999'
+            }),
+          )
+      })
+    })
+
+    return mockWsServer
+  }
+<% } %>

package/generator-adapter/generators/app/templates/test-payload.json

@@ -0,0 +1,6 @@
+{
+ "requests": [{
+  "from": "BTC",
+  "to": "USD"
+ }]
+}

package/generator-adapter/generators/app/templates/tsconfig.base.json

@@ -0,0 +1,40 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "incremental": true /* Enable incremental compilation */,
+    "target": "ES2020" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    "composite": true /* Enable project compilation */,
+    "declaration": true /* Generates corresponding '.d.ts' file. */,
+    "declarationMap": true /* Generates a sourcemap for each corresponding '.d.ts' file. */,
+    "noEmit": false /* Do not emit outputs. */,
+    "noErrorTruncation": true /* Do not truncate error messages */,
+    "skipLibCheck": true /* Skip type checking of declaration files. Requires TypeScript version 2.0 or later. */,
+    "importHelpers": true /* Import emit helpers from 'tslib'. */,
+
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+
+    /* Additional Checks */
+    "noUnusedLocals": true /* Report errors on unused locals. */,
+    "noUnusedParameters": true /* Report errors on unused parameters. */,
+    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
+    "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */,
+
+    /* Module Resolution Options */
+    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
+    "allowSyntheticDefaultImports": true /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */,
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+
+    /* Source Map Options */
+    "inlineSourceMap": true /* Emit a single file with source maps instead of having a separate file. */,
+    "inlineSources": true /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */,
+
+    /* Experimental Options */
+    "experimentalDecorators": true /* Enables experimental support for ES7 decorators. */,
+    "emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */,
+
+    "resolveJsonModule": true /* Allows importing modules with a ‘.json’ extension */
+  }
+}

package/generator-adapter/generators/app/templates/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "<%- standalone ? "./tsconfig.base.json" : "../../tsconfig.base.json" %>",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src/**/*", "src/**/*.json"],
+  "exclude": ["dist", "**/*.spec.ts", "**/*.test.ts"]
+}

package/generator-adapter/generators/app/templates/tsconfig.test.json

@@ -0,0 +1,7 @@
+{
+  "extends": "<%- standalone ? "./tsconfig.base.json" : "../../tsconfig.base.json" %>",
+  "include": ["src/**/*", "**/test", "src/**/*.json"],
+  "compilerOptions": {
+    "noEmit": true
+  }
+}

package/generator-adapter/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "generator-adapter",
+  "version": "0.0.1",
+  "files": [
+    "generators"
+  ],
+  "main": "generators/app/index.js",
+  "keywords": [
+    "yeoman-generator",
+    "extnerl-adapter-generator"
+  ]
+}

package/index.js

@@ -9,6 +9,7 @@ const path_1 = require("path");
 const redlock_1 = require("redlock");
 const adapter_1 = require("./adapter");
 const background_executor_1 = require("./background-executor");
+const router_1 = __importDefault(require("./debug/router"));
 const metrics_1 = require("./metrics");
 const util_1 = require("./util");
 const validation_1 = require("./validation");
@@ -145,6 +146,11 @@ async function buildRestApi(adapter) {
     app.get((0, path_1.join)(adapter.config.settings.BASE_URL, 'health'), (req, res) => {
         res.status(200).send({ message: 'OK', version: VERSION });
     });
+    // If specified, serve debug endpoints to assist in issue triaging
+    if (adapter.config.settings.DEBUG_ENDPOINTS === true) {
+        (0, router_1.default)(app, adapter);
+        logger.info('Serving debug endpoints');
+    }
     // Use global error handling
     app.setErrorHandler(validation_1.errorCatchingMiddleware);
     // Always reply with json content

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAkD;AAElD,+BAA2B;AAC3B,qCAAwC;AACxC,uCAAwD;AACxD,+DAA8D;AAE9D,uCAAsE;AACtE,iCAMe;AACf,6CAA2E;AAK3E,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,MAAM,CAAC,CAAA;AAEjC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAA;AAY3C,MAAM,aAAa,GAAG,CAAC,eAAgC,EAAE,EAAE;IAChE,IAAI,CAAC,eAAe,CAAC,WAAW,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE;QACjE,OAAO,EAAE,CAAA;KACV;IAED,IAAI,eAAe,CAAC,WAAW,IAAI,eAAe,CAAC,YAAY,EAAE;QAC/D,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;KAC5E;IAED,IACE,CAAC,eAAe,CAAC,eAAe;QAChC,CAAC,eAAe,CAAC,cAAc;QAC/B,CAAC,eAAe,CAAC,MAAM,EACvB;QACA,MAAM,SAAS,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,cAAc,CAAA;QAC9E,MAAM,IAAI,KAAK,CACb,uFAAuF,SAAS,kBAAkB,CACnH,CAAA;KACF;IAED,MAAM,YAAY,GAAG;QACnB,GAAG,EAAE,eAAe,CAAC,eAAe;QACpC,IAAI,EAAE,eAAe,CAAC,cAAc;QACpC,EAAE,EAAE,eAAe,CAAC,MAAM;QAC1B,UAAU,EAAE,eAAe,CAAC,cAAc;QAC1C,WAAW,EAAE,eAAe,CAAC,YAAY;KAC1C,CAAA;IACD,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,CAAA;AAChC,CAAC,CAAA;AA5BY,QAAA,aAAa,iBA4BzB;AAED;;;;;;;GAOG;AACI,MAAM,KAAK,GAAG,KAAK,EACxB,OAAmB,EACnB,YAA2C,EAI1C,EAAE;IACH,IAAI,CAAC,CAAC,OAAO,YAAY,iBAAO,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CACb,oFAAoF,CACrF,CAAA;KACF;IAED,kFAAkF;IAClF,MAAM,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAA;IAEtC,IAAI,GAAG,GAAgC,SAAS,CAAA;IAChD,IAAI,UAAU,GAAgC,SAAS,CAAA;IAEvD,IACE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe;QACvC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,4BAA4B,EACpD;QACA,UAAU,GAAG,IAAA,4BAAkB,EAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;KACvE;IAED,oGAAoG;IACpG,IAAI,kBAAkB,CAAA;IAEtB,IACE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,KAAK,QAAQ;QAC5C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,KAAK,eAAe,EACnD;QACA,mDAAmD;QACnD,GAAG,GAAG,MAAM,YAAY,CAAC,OAA6B,CAAC,CAAA;QAEvD,yEAAyE;QACzE,kBAAkB,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACjD,GAAG,EAAE,OAAO,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;gBACjC,0DAA0D;gBAC1D,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBACxC,OAAO,EAAE,CAAA;YACX,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;KACH;SAAM;QACL,MAAM,CAAC,IAAI,CAAC,yEAAyE,CAAC,CAAA;KACvF;IAED,4EAA4E;IAC5E,4FAA4F;IAC5F,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,MAAM,EAAE;QACtC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAA;KAC3B;IACD,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,GAAU,EAAE,EAAE;QAC9C,qDAAqD;QACrD,IAAI,GAAG,YAAY,wBAAc,EAAE;YACjC,MAAM,GAAG,CAAA;SACV;QACD,IAAA,iBAAU,EAAC,GAAG,EAAE,CACd,MAAM,CAAC,KAAK,CAAC;YACX,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,OAAO,EAAE,GAAG,CAAC,OAAO;SACrB,CAAC,CACH,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,IACE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,KAAK,QAAQ;QAC5C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,KAAK,eAAe,EACnD;QACA,4EAA4E;QAC5E,MAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAA;QACjD,IAAA,4CAAsB,EAAC,OAA6B,EAAE,kBAAkB,CAAC,CAAA;KAC1E;SAAM;QACL,MAAM,CAAC,IAAI,CACT,4FAA4F,CAC7F,CAAA;KACF;IAED,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,CAAA;AAC5B,CAAC,CAAA;AAjFY,QAAA,KAAK,SAiFjB;AAEM,MAAM,MAAM,GAAG,KAAK,EACzB,OAAmB,EACnB,YAA2C,EACL,EAAE;IACxC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,MAAM,IAAA,aAAK,EAAC,OAAO,EAAE,YAAY,CAAC,CAAA;IAE9D,MAAM,SAAS,GAAG,KAAK,EAAE,GAAgC,EAAE,IAAY,EAAE,EAAE;QACzE,IAAI,GAAG,EAAE;YACP,IAAI;gBACF,MAAM,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;aAClE;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAA,iBAAU,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,gDAAgD,GAAG,EAAE,CAAC,CAAC,CAAA;gBACrF,OAAO,CAAC,IAAI,EAAE,CAAA;aACf;YAED,MAAM,CAAC,IAAI,CAAC,qBAAsB,GAAG,CAAC,MAAM,CAAC,OAAO,EAAkB,CAAC,IAAI,EAAE,CAAC,CAAA;SAC/E;IACH,CAAC,CAAA;IAED,wCAAwC;IACxC,MAAM,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;IACrD,MAAM,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;IAEjE,8DAA8D;IAC9D,IAAI,OAAO,CAAC,mBAAmB,EAAE;QAC/B,IAAI;YACF,MAAM,OAAO,CAAC,mBAAmB,CAAA;SAClC;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,GAAG,EAAE,KAAK,EAAE,CAAA;YAClB,MAAM,UAAU,EAAE,KAAK,EAAE,CAAA;YACzB,MAAM,KAAK,CAAA;SACZ;KACF;IAED,kEAAkE;IAClE,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AApCY,QAAA,MAAM,UAoClB;AAED,KAAK,UAAU,YAAY,CAAC,OAAgB;IAC1C,MAAM,UAAU,GAA2C,IAAA,qBAAa,EAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACjG,MAAM,GAAG,GAAG,IAAA,iBAAO,EAAC;QAClB,GAAG,UAAU;QACb,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB;KAC1D,CAAC,CAAA;IAEF,6DAA6D;IAC7D,GAAG,CAAC,GAAG,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACrE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAA;IAC3D,CAAC,CAAC,CAAA;IAEF,4BAA4B;IAC5B,GAAG,CAAC,eAAe,CAAC,oCAAuB,CAAC,CAAA;IAE5C,iCAAiC;IACjC,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAC3C,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,iCAAiC,EAAE,CAAC,CAAA;QACpE,IAAI,EAAE,CAAA;IACR,CAAC,CAAC,CAAA;IAEF,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QAC5B,0CAA0C;QAC1C,MAAM,CAAC,OAAO,CAAsB,YAAY,EAAE,IAAA,gCAAmB,EAAC,OAAO,CAAC,CAAC,CAAA;QAC/E,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,EAAE;YAClD,MAAM,CAAC,OAAO,CAAsB,WAAW,EAAE,+BAAwB,CAAC,CAAA;SAC3E;QAED,MAAM,CAAC,KAAK,CAAsB;YAChC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ;YACrC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;gBAC5B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,aAAa,CAC1C,GAA2C,EAC3C,KAAoC,CACrC,CAAA;gBACD,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC9D,CAAC;SACF,CAAC,CAAA;QAEF,IACE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe;YACvC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,4BAA4B,EACpD;YACA,MAAM,CAAC,OAAO,CAAsB,YAAY,EAAE,gCAAsB,CAAC,CAAA;SAC1E;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,GAAG,CAAA;AACZ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAkD;AAElD,+BAA2B;AAC3B,qCAAwC;AACxC,uCAAwD;AACxD,+DAA8D;AAE9D,4DAAmD;AACnD,uCAAsE;AACtE,iCAMe;AACf,6CAA2E;AAK3E,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,MAAM,CAAC,CAAA;AAEjC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAA;AAY3C,MAAM,aAAa,GAAG,CAAC,eAAgC,EAAE,EAAE;IAChE,IAAI,CAAC,eAAe,CAAC,WAAW,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE;QACjE,OAAO,EAAE,CAAA;KACV;IAED,IAAI,eAAe,CAAC,WAAW,IAAI,eAAe,CAAC,YAAY,EAAE;QAC/D,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;KAC5E;IAED,IACE,CAAC,eAAe,CAAC,eAAe;QAChC,CAAC,eAAe,CAAC,cAAc;QAC/B,CAAC,eAAe,CAAC,MAAM,EACvB;QACA,MAAM,SAAS,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,cAAc,CAAA;QAC9E,MAAM,IAAI,KAAK,CACb,uFAAuF,SAAS,kBAAkB,CACnH,CAAA;KACF;IAED,MAAM,YAAY,GAAG;QACnB,GAAG,EAAE,eAAe,CAAC,eAAe;QACpC,IAAI,EAAE,eAAe,CAAC,cAAc;QACpC,EAAE,EAAE,eAAe,CAAC,MAAM;QAC1B,UAAU,EAAE,eAAe,CAAC,cAAc;QAC1C,WAAW,EAAE,eAAe,CAAC,YAAY;KAC1C,CAAA;IACD,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,CAAA;AAChC,CAAC,CAAA;AA5BY,QAAA,aAAa,iBA4BzB;AAED;;;;;;;GAOG;AACI,MAAM,KAAK,GAAG,KAAK,EACxB,OAAmB,EACnB,YAA2C,EAI1C,EAAE;IACH,IAAI,CAAC,CAAC,OAAO,YAAY,iBAAO,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CACb,oFAAoF,CACrF,CAAA;KACF;IAED,kFAAkF;IAClF,MAAM,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAA;IAEtC,IAAI,GAAG,GAAgC,SAAS,CAAA;IAChD,IAAI,UAAU,GAAgC,SAAS,CAAA;IAEvD,IACE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe;QACvC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,4BAA4B,EACpD;QACA,UAAU,GAAG,IAAA,4BAAkB,EAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;KACvE;IAED,oGAAoG;IACpG,IAAI,kBAAkB,CAAA;IAEtB,IACE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,KAAK,QAAQ;QAC5C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,KAAK,eAAe,EACnD;QACA,mDAAmD;QACnD,GAAG,GAAG,MAAM,YAAY,CAAC,OAA6B,CAAC,CAAA;QAEvD,yEAAyE;QACzE,kBAAkB,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACjD,GAAG,EAAE,OAAO,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;gBACjC,0DAA0D;gBAC1D,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBACxC,OAAO,EAAE,CAAA;YACX,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;KACH;SAAM;QACL,MAAM,CAAC,IAAI,CAAC,yEAAyE,CAAC,CAAA;KACvF;IAED,4EAA4E;IAC5E,4FAA4F;IAC5F,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,MAAM,EAAE;QACtC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAA;KAC3B;IACD,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,GAAU,EAAE,EAAE;QAC9C,qDAAqD;QACrD,IAAI,GAAG,YAAY,wBAAc,EAAE;YACjC,MAAM,GAAG,CAAA;SACV;QACD,IAAA,iBAAU,EAAC,GAAG,EAAE,CACd,MAAM,CAAC,KAAK,CAAC;YACX,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,OAAO,EAAE,GAAG,CAAC,OAAO;SACrB,CAAC,CACH,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,IACE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,KAAK,QAAQ;QAC5C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,KAAK,eAAe,EACnD;QACA,4EAA4E;QAC5E,MAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAA;QACjD,IAAA,4CAAsB,EAAC,OAA6B,EAAE,kBAAkB,CAAC,CAAA;KAC1E;SAAM;QACL,MAAM,CAAC,IAAI,CACT,4FAA4F,CAC7F,CAAA;KACF;IAED,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,CAAA;AAC5B,CAAC,CAAA;AAjFY,QAAA,KAAK,SAiFjB;AAEM,MAAM,MAAM,GAAG,KAAK,EACzB,OAAmB,EACnB,YAA2C,EACL,EAAE;IACxC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,MAAM,IAAA,aAAK,EAAC,OAAO,EAAE,YAAY,CAAC,CAAA;IAE9D,MAAM,SAAS,GAAG,KAAK,EAAE,GAAgC,EAAE,IAAY,EAAE,EAAE;QACzE,IAAI,GAAG,EAAE;YACP,IAAI;gBACF,MAAM,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;aAClE;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAA,iBAAU,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,gDAAgD,GAAG,EAAE,CAAC,CAAC,CAAA;gBACrF,OAAO,CAAC,IAAI,EAAE,CAAA;aACf;YAED,MAAM,CAAC,IAAI,CAAC,qBAAsB,GAAG,CAAC,MAAM,CAAC,OAAO,EAAkB,CAAC,IAAI,EAAE,CAAC,CAAA;SAC/E;IACH,CAAC,CAAA;IAED,wCAAwC;IACxC,MAAM,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;IACrD,MAAM,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;IAEjE,8DAA8D;IAC9D,IAAI,OAAO,CAAC,mBAAmB,EAAE;QAC/B,IAAI;YACF,MAAM,OAAO,CAAC,mBAAmB,CAAA;SAClC;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,GAAG,EAAE,KAAK,EAAE,CAAA;YAClB,MAAM,UAAU,EAAE,KAAK,EAAE,CAAA;YACzB,MAAM,KAAK,CAAA;SACZ;KACF;IAED,kEAAkE;IAClE,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AApCY,QAAA,MAAM,UAoClB;AAED,KAAK,UAAU,YAAY,CAAC,OAAgB;IAC1C,MAAM,UAAU,GAA2C,IAAA,qBAAa,EAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACjG,MAAM,GAAG,GAAG,IAAA,iBAAO,EAAC;QAClB,GAAG,UAAU;QACb,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB;KAC1D,CAAC,CAAA;IAEF,6DAA6D;IAC7D,GAAG,CAAC,GAAG,CAAC,IAAA,WAAI,EAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACrE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAA;IAC3D,CAAC,CAAC,CAAA;IAEF,kEAAkE;IAClE,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,KAAK,IAAI,EAAE;QACpD,IAAA,gBAAsB,EAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QACpC,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAA;KACvC;IAED,4BAA4B;IAC5B,GAAG,CAAC,eAAe,CAAC,oCAAuB,CAAC,CAAA;IAE5C,iCAAiC;IACjC,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAC3C,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,iCAAiC,EAAE,CAAC,CAAA;QACpE,IAAI,EAAE,CAAA;IACR,CAAC,CAAC,CAAA;IAEF,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QAC5B,0CAA0C;QAC1C,MAAM,CAAC,OAAO,CAAsB,YAAY,EAAE,IAAA,gCAAmB,EAAC,OAAO,CAAC,CAAC,CAAA;QAC/E,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,EAAE;YAClD,MAAM,CAAC,OAAO,CAAsB,WAAW,EAAE,+BAAwB,CAAC,CAAA;SAC3E;QAED,MAAM,CAAC,KAAK,CAAsB;YAChC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ;YACrC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;gBAC5B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,aAAa,CAC1C,GAA2C,EAC3C,KAAoC,CACrC,CAAA;gBACD,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC9D,CAAC;SACF,CAAC,CAAA;QAEF,IACE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe;YACvC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,4BAA4B,EACpD;YACA,MAAM,CAAC,OAAO,CAAsB,YAAY,EAAE,gCAAsB,CAAC,CAAA;SAC1E;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,GAAG,CAAA;AACZ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chainlink/external-adapter-framework",
-  "version": "0.30.2",
+  "version": "0.31.0",
   "main": "dist/index.js",
   "license": "MIT",
   "dependencies": {
@@ -9,15 +9,17 @@
     "eventsource": "2.0.2",
     "fastify": "4.13.0",
     "ioredis": "5.2.3",
+    "mock-socket": "9.1.5",
     "pino": "8.6.1",
     "pino-pretty": "9.1.0",
     "prom-client": "13.2.0",
-    "ws": "8.9.0",
     "redlock": "5.0.0-beta.2",
-    "mock-socket": "9.1.5"
+    "yeoman-generator": "3.1.1",
+    "ws": "8.9.0"
   },
   "scripts": {
-    "build": "mkdir -p ./dist/src && cp package.json dist/src && cp README.md dist/src && tsc",
+    "build": "mkdir -p ./dist/src && cp package.json dist/src && cp README.md dist/src && tsc && yarn build-generator",
+    "build-generator": "mkdir -p ./dist/src/generator-adapter/generators/app/templates && cp -R scripts/generator-adapter/generators/app/templates dist/src/generator-adapter/generators/app && cp scripts/generator-adapter/package.json dist/src/generator-adapter && tsc --project scripts/generator-adapter/tsconfig.json && tsc scripts/adapter-generator.ts --outDir dist/src",
     "generate-docs": "typedoc src/**/*.ts",
     "generate-ref-tables": "ts-node scripts/metrics-table.ts > docs/reference-tables/metrics.md && ts-node scripts/ea-settings-table.ts > docs/reference-tables/ea-settings.md && yarn prettier --write docs/reference-tables",
     "lint-fix": "eslint --max-warnings=0 --fix . && prettier --write ./src/**/*.ts ./test/**/*.ts ./*.{json,js,yaml}",
@@ -28,6 +30,9 @@
     "verify": "yarn lint && yarn build && yarn build -p ./test/tsconfig.json && yarn test && yarn code-coverage",
     "code-coverage": "c8 check-coverage --statements 95 --lines 95 --functions 95 --branches 90"
   },
+  "bin": {
+    "create-external-adapter": "adapter-generator.js"
+  },
   "devDependencies": {
     "@sinonjs/fake-timers": "9.1.2",
     "@types/eventsource": "1.1.11",
@@ -47,7 +52,8 @@
     "ts-node": "10.9.1",
     "ts-node-dev": "2.0.0",
     "typedoc": "0.23.21",
-    "typescript": "5.0.4"
+    "typescript": "5.0.4",
+    "@types/yeoman-generator": "5.2.11"
   },
   "prettier": {
     "semi": false,