R25 EA

.changeset/fresh-ducks-remain.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/r25-adapter': major
+---
+
+This change contains an external adapter for the r25 endpoint

packages/sources/r25/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@chainlink/r25-adapter",
+  "version": "0.0.0",
+  "description": "Chainlink r25 adapter.",
+  "keywords": [
+    "Chainlink",
+    "LINK",
+    "blockchain",
+    "oracle",
+    "r25"
+  ],
+  "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"
+  },
+  "dependencies": {
+    "@chainlink/external-adapter-framework": "2.11.1",
+    "crypto-js": "4.2.0",
+    "tslib": "2.4.1"
+  },
+  "devDependencies": {
+    "@types/crypto-js": "4.2.2",
+    "@types/jest": "^29.5.14",
+    "@types/node": "22.14.1",
+    "nock": "13.5.6",
+    "typescript": "5.8.3"
+  }
+}

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

@@ -0,0 +1,21 @@
+import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
+
+export const config = new AdapterConfig({
+  API_KEY: {
+    description: 'An API key for R25',
+    type: 'string',
+    required: true,
+    sensitive: true,
+  },
+  API_SECRET: {
+    description: 'An API secret for R25 used to sign requests',
+    type: 'string',
+    required: true,
+    sensitive: true,
+  },
+  API_ENDPOINT: {
+    description: 'An API endpoint for R25',
+    type: 'string',
+    default: 'https://app.r25.xyz',
+  },
+})

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

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

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

@@ -0,0 +1,38 @@
+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 { config } from '../config'
+import { httpTransport } from '../transport/nav'
+
+export const inputParameters = new InputParameters(
+  {
+    chainType: {
+      type: 'string',
+      description: 'The chain type (e.g., polygon, sui)',
+      required: true,
+    },
+    tokenName: {
+      type: 'string',
+      description: 'The token name (e.g., rcusdp)',
+      required: true,
+    },
+  },
+  [
+    {
+      chainType: 'polygon',
+      tokenName: 'rcusdp',
+    },
+  ],
+)
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: SingleNumberResultResponse
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'nav',
+  transport: httpTransport,
+  inputParameters,
+})

packages/sources/r25/src/index.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 { endpoint as navEndpoint } from './endpoint/nav'
+
+export const adapter = new Adapter({
+  defaultEndpoint: navEndpoint.name,
+  name: 'R25',
+  config,
+  endpoints: [navEndpoint],
+  rateLimiting: {
+    tiers: {
+      default: {
+        rateLimit1s: 5, //5 requests per second
+      },
+    },
+  },
+})
+
+export const server = (): Promise<ServerInstance | undefined> => expose(adapter)

packages/sources/r25/src/transport/authentication.ts

@@ -0,0 +1,54 @@
+import CryptoJS from 'crypto-js'
+
+export interface GetRequestHeadersParams {
+  method: string
+  path: string
+  params: Record<string, string>
+  apiKey: string
+  secret: string
+  timestamp: number
+}
+
+/**
+ * Generate the HMAC-SHA256 signature for R25 API requests.
+ *
+ * The signature string is constructed as:
+ * {method}\n{path}\n{sorted_params}\n{timestamp}\n{api_key}
+ *
+ * Where:
+ * - method: HTTP method in lowercase (e.g., "get")
+ * - path: Request path (e.g., "/api/public/current/nav")
+ * - sorted_params: Query parameters sorted by key, formatted as key=value, joined with &
+ * - timestamp: Current UTC timestamp in milliseconds
+ * - api_key: API key
+ */
+export const getRequestHeaders = ({
+  method,
+  path,
+  params,
+  apiKey,
+  secret,
+  timestamp,
+}: GetRequestHeadersParams): Record<string, string> => {
+  // Sort parameters by key in lexicographical order and format as key=value
+  const sortedParams = Object.keys(params)
+    .sort()
+    .map((key) => `${key}=${params[key]}`)
+    .join('&')
+
+  const stringToSign = [
+    method.toLowerCase(),
+    path,
+    sortedParams,
+    timestamp.toString(),
+    apiKey,
+  ].join('\n')
+
+  const signature = CryptoJS.HmacSHA256(stringToSign, secret).toString(CryptoJS.enc.Hex)
+
+  return {
+    'x-api-key': apiKey,
+    'x-utc-timestamp': timestamp.toString(),
+    'x-signature': signature,
+  }
+}

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

@@ -0,0 +1,86 @@
+import { HttpTransport } from '@chainlink/external-adapter-framework/transports'
+import { BaseEndpointTypes } from '../endpoint/nav'
+import { getRequestHeaders } from './authentication'
+
+export interface ResponseSchema {
+  code: string
+  success: boolean
+  message: string
+  data: {
+    lastUpdate: string
+    tokenName: string
+    chainType: string
+    totalSupply: number
+    totalAsset: number
+    currentNav: string
+  }
+}
+
+export type HttpTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    RequestBody: never
+    ResponseBody: ResponseSchema
+  }
+}
+
+export const httpTransport = new HttpTransport<HttpTransportTypes>({
+  prepareRequests: (params, config) => {
+    return params.map((param) => {
+      const method = 'GET'
+      const path = '/api/public/current/nav'
+      const timestamp = Date.now()
+
+      const queryParams = {
+        chainType: param.chainType,
+        tokenName: param.tokenName,
+      }
+
+      const headers = getRequestHeaders({
+        method,
+        path,
+        params: queryParams,
+        apiKey: config.API_KEY,
+        secret: config.API_SECRET,
+        timestamp,
+      })
+
+      return {
+        params: [param],
+        request: {
+          baseURL: config.API_ENDPOINT,
+          url: path,
+          params: queryParams,
+          headers,
+        },
+      }
+    })
+  },
+  parseResponse: (params, response) => {
+    return params.map((param) => {
+      const apiResponse = response.data as ResponseSchema
+      if (!apiResponse.success) {
+        return {
+          params: param,
+          response: {
+            errorMessage: apiResponse.message || 'Request failed',
+            statusCode: 502,
+          },
+        }
+      }
+
+      const result = Number(apiResponse.data.currentNav)
+      return {
+        params: param,
+        response: {
+          result,
+          data: {
+            result,
+          },
+          timestamps: {
+            providerIndicatedTimeUnixMs: new Date(apiResponse.data.lastUpdate).getTime(),
+          },
+        },
+      }
+    })
+  },
+})

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

@@ -0,0 +1,49 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`execute nav endpoint should return error for invalid chainType 1`] = `
+{
+  "errorMessage": "Invalid chainType combination",
+  "statusCode": 502,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+  },
+}
+`;
+
+exports[`execute nav endpoint should return error for invalid chainType and tokenName 1`] = `
+{
+  "errorMessage": "Invalid tokenName combination",
+  "statusCode": 502,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+  },
+}
+`;
+
+exports[`execute nav endpoint should return error for invalid token 1`] = `
+{
+  "errorMessage": "Invalid tokenName combination",
+  "statusCode": 502,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+  },
+}
+`;
+
+exports[`execute nav endpoint should return success 1`] = `
+{
+  "data": {
+    "result": 1.020408163265306,
+  },
+  "result": 1.020408163265306,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 978347471111,
+    "providerDataRequestedUnixMs": 978347471111,
+    "providerIndicatedTimeUnixMs": 1762880153448,
+  },
+}
+`;