Feat/OPDATA-4164 securitize (#4013)

* OPDATA-4164 Securitize new EA

* add changeset

* remove unused file

* add unit test, small refactors to enable

* add sigutils for signature verification

* move tweetnacl from devdeps to deps

* remove console logs

* remove duplicate code block

* add more detail to sig verify error messages

* change error message in transport

Author: mmcallister-cll

.changeset/unlucky-carpets-design.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/securitize-adapter': major
+---
+
+Securitize Initial release

.pnp.cjs

@@ -0,0 +1,3 @@
+# Chainlink External Adapter for securitize
+
+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 securitize`.

packages/sources/securitize/CHANGELOG.md

@@ -0,0 +1,41 @@
+{
+  "name": "@chainlink/securitize-adapter",
+  "version": "0.0.0",
+  "description": "Chainlink securitize adapter.",
+  "keywords": [
+    "Chainlink",
+    "LINK",
+    "blockchain",
+    "oracle",
+    "securitize"
+  ],
+  "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.7.0",
+    "tslib": "2.4.1",
+    "tweetnacl": "^1.0.3"
+  }
+}

packages/sources/securitize/README.md

@@ -0,0 +1,15 @@
+import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
+
+export const config = new AdapterConfig({
+  API_KEY: {
+    description: 'An API key for Securitize NAV',
+    type: 'string',
+    required: true,
+    sensitive: true,
+  },
+  API_ENDPOINT: {
+    description: 'The API endpoint for Securitize NAV',
+    type: 'string',
+    default: 'https://partners-api.securitize.io/asset-metrics/api/v1/nav',
+  },
+})

packages/sources/securitize/package.json

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

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

@@ -0,0 +1,43 @@
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { SingleNumberResultResponse } from '@chainlink/external-adapter-framework/util'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
+import { config } from '../config'
+import { getPubKeys, httpTransport } from '../transport/nav'
+
+export const inputParameters = new InputParameters(
+  {
+    assetId: {
+      required: true,
+      type: 'string',
+      description: 'The assetId of the fund',
+    },
+    envVarPrefix: {
+      required: true,
+      type: 'string',
+      description: 'Maps the assetId to the {envVarPrefix.toUpperCase()}_PUBKEYS env var',
+    },
+  },
+  [
+    {
+      assetId: 'c52c3d79-8317-4692-86f8-4e0dfd508672',
+      envVarPrefix: 'testAsset',
+    },
+  ],
+)
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: SingleNumberResultResponse
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'nav',
+  transport: httpTransport,
+  inputParameters,
+  customInputValidation: (req): AdapterInputError | undefined => {
+    getPubKeys(req.requestContext.data.envVarPrefix)
+    return
+  },
+})

packages/sources/securitize/src/endpoint/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: 'SECURITIZE',
+  config,
+  endpoints: [nav],
+  rateLimiting: {
+    tiers: {
+      default: {
+        rateLimit1m: 30,
+        note: '500/minute but setting reasonable limits',
+      },
+    },
+  },
+})
+
+export const server = (): Promise<ServerInstance | undefined> => expose(adapter)

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

@@ -0,0 +1,124 @@
+import {
+  HttpTransport,
+  HttpTransportConfig,
+} from '@chainlink/external-adapter-framework/transports'
+import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
+import { BaseEndpointTypes } from '../endpoint/nav'
+import { validateResponseSignature } from './sigutils'
+
+export interface SingleResponseSchema {
+  assetId: string
+  name?: string
+  nav: number
+  seqNum: number
+  yieldOneDay?: string
+  yieldSevenDay?: string
+  recordDate: string
+  staleness?: number
+  signedMessage: {
+    signature: string
+    content: string
+    hash: string
+    prevHash: string | null
+    prevSig: string | null
+    prevContent: string | null
+  }
+}
+
+export interface ResponseSchema {
+  docs: SingleResponseSchema[]
+}
+
+export type HttpTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    RequestBody: never
+    ResponseBody: ResponseSchema
+  }
+}
+
+export function getPubKeys(assetEnvVarPrefix: string): string[] {
+  const envVarName = `${assetEnvVarPrefix.toUpperCase()}_PUBKEYS`
+  const pubkeys = process.env[envVarName]
+  if (!pubkeys) {
+    throw new AdapterInputError({
+      message: `Missing env var ${envVarName}`,
+      statusCode: 400,
+    })
+  }
+  return pubkeys.split(',').map((s) => s.trim()) ?? []
+}
+
+const transportConfig: HttpTransportConfig<HttpTransportTypes> = {
+  prepareRequests: (params, config) => {
+    return params.map((param) => {
+      return {
+        params: [param],
+        request: {
+          baseURL: config.API_ENDPOINT,
+          headers: {
+            apikey: config.API_KEY,
+          },
+          params: {
+            assetId: param.assetId,
+            sortBy: 'recordDate',
+            sortOrder: 'DESC',
+            page: 1,
+            limit: 1,
+          },
+        },
+      }
+    })
+  },
+  parseResponse: (params, response) => {
+    const asset = response?.data?.docs?.[0]
+    return params.map((param) => {
+      if (!asset) {
+        return {
+          params: param,
+          response: {
+            errorMessage: `The data provider didn't return any value for ${param.assetId}`,
+            statusCode: 502,
+          },
+        }
+      }
+
+      const timestamps = {
+        providerIndicatedTimeUnixMs: new Date(asset.recordDate).getTime(),
+      }
+
+      const pubkeys = getPubKeys(param.envVarPrefix)
+      validateResponseSignature(asset, pubkeys)
+
+      if (asset.assetId !== param.assetId) {
+        return {
+          params: param,
+          response: {
+            errorMessage: `Could not find ${param.assetId} in the response`,
+            statusCode: 502,
+          },
+          timestamps,
+        }
+      }
+      const result = asset.nav
+      return {
+        params: param,
+        response: {
+          result,
+          data: {
+            result,
+          },
+          timestamps,
+        },
+      }
+    })
+  },
+}
+
+// Exported for testing
+export class NavTransport extends HttpTransport<HttpTransportTypes> {
+  constructor() {
+    super(transportConfig)
+  }
+}
+
+export const httpTransport = new NavTransport()