creating new allium-state ea for OPDATA-4235 (#4061)

* creating new allium-state ea for OPDATA-4235

* add changeset

* adjust date.new and timestamp inclusion

* adjust timestamp field as it was still marked as optional

* adjust timestamp field as it was still marked as optional

* removing the additional changesets

Author: jordanbounds

.changeset/selfish-apes-exist.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/allium-state-adapter': major
+---
+
+allium-state initial release

.pnp.cjs

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

packages/sources/allium-state/CHANGELOG.md

@@ -0,0 +1,42 @@
+{
+  "name": "@chainlink/allium-state-adapter",
+  "version": "0.0.0",
+  "description": "Chainlink allium-state adapter.",
+  "keywords": [
+    "Chainlink",
+    "LINK",
+    "blockchain",
+    "oracle",
+    "allium-state"
+  ],
+  "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": {
+    "@sinonjs/fake-timers": "9.1.2",
+    "@types/jest": "^29.5.14",
+    "@types/node": "22.14.1",
+    "@types/sinonjs__fake-timers": "8.1.5",
+    "nock": "13.5.6",
+    "typescript": "5.8.3"
+  },
+  "dependencies": {
+    "@chainlink/external-adapter-framework": "2.7.0",
+    "tslib": "2.4.1"
+  }
+}

packages/sources/allium-state/README.md

@@ -0,0 +1,15 @@
+import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
+
+export const config = new AdapterConfig({
+  WS_API_ENDPOINT: {
+    description: 'The WebSocket endpoint for Allium state prices',
+    type: 'string',
+    default: 'wss://api.allium.so/api/v1/developer/state-prices/ws',
+  },
+  API_KEY: {
+    description: 'API key for Allium',
+    type: 'string',
+    required: true,
+    sensitive: true,
+  },
+})

packages/sources/allium-state/package.json

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

packages/sources/allium-state/src/config/index.ts

@@ -0,0 +1,28 @@
+import {
+  AdapterEndpoint,
+  priceEndpointInputParametersDefinition,
+} 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 { wsTransport } from '../transport/price'
+
+export const inputParameters = new InputParameters(priceEndpointInputParametersDefinition, [
+  {
+    base: 'BTC',
+    quote: 'USD',
+  },
+])
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: SingleNumberResultResponse
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'price',
+  aliases: ['crypto', 'state'],
+  transport: wsTransport,
+  inputParameters,
+})

packages/sources/allium-state/src/endpoint/index.ts

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

packages/sources/allium-state/src/endpoint/price.ts

@@ -0,0 +1,82 @@
+import { WebSocketTransport } from '@chainlink/external-adapter-framework/transports'
+import { BaseEndpointTypes } from '../endpoint/price'
+
+export interface AlliumMessage {
+  type: string
+  subscription_id?: string
+  subscription_details?: {
+    base: string
+    quote: string
+  }
+  error?: string
+  timestamp: string
+  data?: {
+    base: string
+    quote: string
+    state_price: number
+  }
+}
+
+export type WsTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    WsMessage: AlliumMessage
+  }
+}
+
+export const wsTransport = new WebSocketTransport<WsTransportTypes>({
+  url: (context) => {
+    return context.adapterSettings.WS_API_ENDPOINT
+  },
+
+  options: (context) => ({
+    headers: {
+      'X-API-Key': context.adapterSettings.API_KEY,
+    },
+  }),
+
+  handlers: {
+    message(message) {
+      if (message?.type !== 'aggregated_state_price_update' || !message?.data?.state_price) {
+        return []
+      }
+
+      const { base, quote, state_price } = message.data
+      const providerDataReceivedUnixMs = Date.now()
+      const providerIndicatedTimeUnixMs = new Date(message.timestamp).getTime()
+
+      return [
+        {
+          params: { base, quote },
+          response: {
+            data: {
+              result: state_price,
+            },
+            result: state_price,
+            timestamps: {
+              providerDataReceivedUnixMs,
+              providerIndicatedTimeUnixMs,
+            },
+          },
+        },
+      ]
+    },
+  },
+
+  builders: {
+    subscribeMessage: (params) => {
+      return {
+        type: 'subscribe',
+        base: params.base,
+        quote: params.quote,
+      }
+    },
+
+    unsubscribeMessage: (params) => {
+      return {
+        type: 'unsubscribe',
+        base: params.base,
+        quote: params.quote,
+      }
+    },
+  },
+})