feat(opdata-5793): generated EA

package.json

@@ -77,5 +77,10 @@
   "resolutions": {
     "ethereum-cryptography@^1.1.2": "patch:ethereum-cryptography@npm%3A1.1.2#./.yarn/patches/ethereum-cryptography-npm-1.1.2-c16cfd7e8a.patch",
     "ethereum-cryptography@^1.0.3": "patch:ethereum-cryptography@npm%3A1.1.2#./.yarn/patches/ethereum-cryptography-npm-1.1.2-c16cfd7e8a.patch"
+  },
+  "dependenciesMeta": {
+    "@chainlink/external-adapter-framework@2.9.0": {
+      "unplugged": true
+    }
   }
 }

packages/sources/equitize/README.md

@@ -0,0 +1,3 @@
+# Chainlink External Adapter for example-adapter
+
+This README will be generated automatically when code is merged to `main`. If you would like to generate a preview of the README, please run `yarn generate:readme example-adapter`.

packages/sources/equitize/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@chainlink/equitize-adapter",
+  "version": "0.0.0",
+  "description": "Chainlink equitize adapter.",
+  "keywords": [
+    "Chainlink",
+    "LINK",
+    "blockchain",
+    "oracle",
+    "equitize"
+  ],
+  "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",
+    "nock": "13.5.6",
+    "typescript": "5.8.3"
+  },
+  "dependencies": {
+    "@chainlink/external-adapter-framework": "2.11.4",
+    "tslib": "2.4.1"
+  }
+}

packages/sources/equitize/src/config/index.ts

@@ -0,0 +1,9 @@
+import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
+
+export const config = new AdapterConfig({
+  API_ENDPOINT: {
+    description: 'An API endpoint for Equitize',
+    type: 'string',
+    default: 'https://staging-mint-5ylweigmlq-el.a.run.app',
+  },
+})

packages/sources/equitize/src/config/overrides.json

@@ -0,0 +1,3 @@
+{
+  "equitize": {}
+}

packages/sources/equitize/src/endpoint/index.ts

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

packages/sources/equitize/src/endpoint/nav.ts

@@ -0,0 +1,26 @@
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { SingleNumberResultResponse } from '@chainlink/external-adapter-framework/util'
+import {
+  EmptyInputParameters,
+  InputParameters,
+} from '@chainlink/external-adapter-framework/validation/input-params'
+import { config } from '../config'
+import { httpTransport } from '../transport/nav'
+
+export const inputParameters = new InputParameters({}, [])
+
+export type BaseEndpointTypes = {
+  Parameters: EmptyInputParameters
+  Response: SingleNumberResultResponse & {
+    Data: {
+      ripcord: boolean
+    }
+  }
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'nav',
+  transport: httpTransport,
+  inputParameters,
+})

packages/sources/equitize/src/index.ts

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

packages/sources/equitize/src/transport/nav.ts

@@ -0,0 +1,102 @@
+import { HttpTransport } from '@chainlink/external-adapter-framework/transports'
+import { BaseEndpointTypes } from '../endpoint/nav'
+
+export interface ResponseSchema {
+  accountName: string
+  NAV: string
+  updatedAt: string
+  ripcord: boolean
+  ripcordDetails: string[]
+}
+
+export type HttpTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    RequestBody: never
+    ResponseBody: ResponseSchema
+  }
+}
+
+/**
+ * Extracts timestamp from provider response
+ */
+export const extractTimestamp = (updatedAt: string): number => {
+  return new Date(updatedAt).getTime()
+}
+
+/**
+ * Parses NAV value from string to number
+ */
+export const parseNavValue = (nav: string): number => {
+  return Number(nav)
+}
+
+/**
+ * Builds request configuration structure
+ */
+export const buildRequestConfig = (apiEndpoint: string) => {
+  return {
+    baseURL: apiEndpoint,
+    url: '/nav',
+    headers: {
+      accept: 'application/json',
+    },
+  }
+}
+
+/**
+ * Builds error response structure when no data is returned
+ */
+export const buildErrorResponse = () => {
+  return {
+    errorMessage: 'The data provider did not return any value',
+    statusCode: 502,
+  }
+}
+
+/**
+ * Builds successful response data structure
+ */
+export const buildSuccessResponseData = (data: ResponseSchema) => {
+  const result = parseNavValue(data.NAV)
+  const timestamps = {
+    providerIndicatedTimeUnixMs: extractTimestamp(data.updatedAt),
+  }
+
+  return {
+    result,
+    data: {
+      result,
+      ripcord: data.ripcord,
+    },
+    timestamps,
+  }
+}
+
+export const httpTransport = new HttpTransport<HttpTransportTypes>({
+  prepareRequests: (params, config) => {
+    return params.map((param) => {
+      return {
+        params: [param],
+        request: buildRequestConfig(config.API_ENDPOINT),
+      }
+    })
+  },
+
+  parseResponse: (params, response) => {
+    if (!response.data) {
+      return params.map((param) => {
+        return {
+          params: param,
+          response: buildErrorResponse(),
+        }
+      })
+    }
+
+    return params.map((param) => {
+      return {
+        params: param,
+        response: buildSuccessResponseData(response.data),
+      }
+    })
+  },
+})

packages/sources/equitize/test-payload.json

@@ -0,0 +1,7 @@
+{
+  "requests": [
+    {
+      "endpoint": "nav"
+    }
+  ]
+}

packages/sources/equitize/test/integration/__snapshots__/adapter.test.ts.snap

@@ -0,0 +1,55 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`execute nav endpoint happy path should return success 1`] = `
+{
+  "data": {
+    "result": 146.51,
+    "ripcord": false,
+  },
+  "result": 146.51,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+    "providerIndicatedTimeUnixMs": 1771898690593,
+  },
+}
+`;
+
+exports[`execute nav endpoint happy path should use nav as default endpoint 1`] = `
+{
+  "data": {
+    "result": 146.51,
+    "ripcord": false,
+  },
+  "result": 146.51,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+    "providerIndicatedTimeUnixMs": 1771898690593,
+  },
+}
+`;
+
+exports[`execute nav endpoint upstream failures should return error when upstream returns 5xx 1`] = `
+{
+  "error": {
+    "message": "The EA has not received any values from the Data Provider for the requested data yet. Retry after a short delay, and if the problem persists raise this issue in the relevant channels.",
+    "name": "AdapterError",
+  },
+  "status": "errored",
+  "statusCode": 504,
+}
+`;
+
+exports[`execute nav endpoint validation errors should return error for invalid endpoint 1`] = `
+{
+  "error": {
+    "message": "Adapter does not have a "invalid" endpoint.",
+    "name": "AdapterError",
+  },
+  "status": "errored",
+  "statusCode": 404,
+}
+`;