Add expand.network aggregated state price adapter (#3467)

Author: AtanasKrondev

.changeset/breezy-hounds-clean.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/expand-network-adapter': minor
+---
+
+Add adapter for expand network.

.pnp.cjs

@@ -0,0 +1,55 @@
+# EXPAND_NETWORK
+
+![0.0.0](https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/expand-network/package.json) ![v3](https://img.shields.io/badge/framework%20version-v3-blueviolet)
+
+This document was generated automatically. Please see [README Generator](../../scripts#readme-generator) for more info.
+
+## Environment Variables
+
+| Required? |      Name       |                   Description                   |  Type  | Options |             Default              |
+| :-------: | :-------------: | :---------------------------------------------: | :----: | :-----: | :------------------------------: |
+|           | WS_API_ENDPOINT | WS endpoint for expand.network price aggregator | string |         | `wss://aggregate.expand.network` |
+|    ✅     |     API_KEY     | An API key for expand.network price aggregator  | string |         |                                  |
+
+---
+
+## Data Provider Rate Limits
+
+There are no rate limits for this adapter.
+
+---
+
+## Input Parameters
+
+| Required? |   Name   |     Description     |  Type  |                      Options                       | Default |
+| :-------: | :------: | :-----------------: | :----: | :------------------------------------------------: | :-----: |
+|           | endpoint | The endpoint to use | string | [price](#price-endpoint), [state](#price-endpoint) | `price` |
+
+## Price Endpoint
+
+Supported names for this endpoint are: `price`, `state`.
+
+### Input Params
+
+| Required? | Name  |    Aliases     |                  Description                   |  Type  | Options | Default | Depends On | Not Valid With |
+| :-------: | :---: | :------------: | :--------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
+|    ✅     | base  | `coin`, `from` | The symbol of symbols of the currency to query | string |         |         |            |                |
+|    ✅     | quote | `market`, `to` |    The symbol of the currency to convert to    | string |         |         |            |                |
+
+### Example
+
+Request:
+
+```json
+{
+  "data": {
+    "endpoint": "price",
+    "base": "wstETH",
+    "quote": "ETH"
+  }
+}
+```
+
+---
+
+MIT License

.yarn/cache/@nomicfoundation-edr-darwin-arm64-npm-0.3.5-1d9a58a391-10.zip

@@ -0,0 +1,42 @@
+{
+  "name": "@chainlink/expand-network-adapter",
+  "version": "0.0.1",
+  "description": "Chainlink expand-network adapter.",
+  "keywords": [
+    "Chainlink",
+    "LINK",
+    "blockchain",
+    "oracle",
+    "expand-network"
+  ],
+  "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": "27.5.2",
+    "@types/node": "16.11.68",
+    "@types/sinonjs__fake-timers": "8.1.5",
+    "nock": "13.5.4",
+    "typescript": "5.0.4"
+  },
+  "dependencies": {
+    "@chainlink/external-adapter-framework": "1.4.0",
+    "tslib": "2.4.1"
+  }
+}

.yarn/cache/@nomicfoundation-edr-darwin-x64-npm-0.3.5-f2300f7c22-10.zip

@@ -0,0 +1,15 @@
+import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
+
+export const config = new AdapterConfig({
+  WS_API_ENDPOINT: {
+    description: 'WS endpoint for expand.network price aggregator',
+    type: 'string',
+    default: 'wss://aggregate.expand.network',
+  },
+  API_KEY: {
+    description: 'An API key for expand.network price aggregator',
+    type: 'string',
+    required: true,
+    sensitive: true,
+  },
+})

.yarn/cache/@nomicfoundation-solidity-analyzer-darwin-arm64-npm-0.1.1-269bd960f5-10.zip

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

.yarn/cache/@nomicfoundation-solidity-analyzer-darwin-x64-npm-0.1.1-88133d2c6c-10.zip

@@ -0,0 +1,28 @@
+import {
+  AdapterEndpoint,
+  priceEndpointInputParametersDefinition,
+} from '@chainlink/external-adapter-framework/adapter'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { SingleNumberResultResponse } from '@chainlink/external-adapter-framework/util'
+import { config } from '../config'
+import { wsTransport } from '../transport/price'
+
+export const inputParameters = new InputParameters(priceEndpointInputParametersDefinition, [
+  {
+    base: 'wstETH',
+    quote: 'ETH',
+  },
+])
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: SingleNumberResultResponse
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'price',
+  aliases: ['state', 'crypto'],
+  transport: wsTransport,
+  inputParameters,
+})

.yarn/cache/@rometools-cli-darwin-arm64-npm-12.1.3-e1f412f8be-10.zip

@@ -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: 'EXPAND_NETWORK',
+  config,
+  endpoints: [price],
+})
+
+export const server = (): Promise<ServerInstance | undefined> => expose(adapter)

.yarn/cache/@rometools-cli-darwin-x64-npm-12.1.3-213b94ec09-10.zip

@@ -0,0 +1,64 @@
+import { WebSocketTransport } from '@chainlink/external-adapter-framework/transports'
+import { BaseEndpointTypes } from '../endpoint/price'
+
+export interface WSResponse {
+  blockTime: string
+  baseSymbol: string
+  quoteSymbol: string
+  aggregatedStatePrice: string
+  aggregatedStatePriceUSD: string
+  aggregatedMarketDepthBaseToken: string
+  aggregatedMarketDepthBaseTokenUSD: string
+  aggregatedMarketDepthQuoteToken: string
+  aggregatedMarketDepthQuoteTokenUSD: string
+  totalTradingVolume: string
+}
+
+export type WsTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    WsMessage: WSResponse
+  }
+}
+export const wsTransport = new WebSocketTransport<WsTransportTypes>({
+  url: (context) => context.adapterSettings.WS_API_ENDPOINT,
+  options: async (context) => ({
+    headers: {
+      authorization: 'secret-token',
+      'x-api-key': context.adapterSettings.API_KEY,
+    },
+  }),
+  handlers: {
+    message(message) {
+      if (!message.aggregatedStatePrice) {
+        return
+      }
+      const result = Number(message.aggregatedStatePrice)
+      const providerIndicatedTimeUnixMs = new Date(
+        message.blockTime.split(' ').join('T').concat('Z'),
+      ).getTime()
+      return [
+        {
+          params: { base: message.baseSymbol, quote: message.quoteSymbol },
+          response: {
+            result,
+            data: {
+              result,
+            },
+            timestamps: {
+              providerIndicatedTimeUnixMs,
+            },
+          },
+        },
+      ]
+    },
+  },
+  builders: {
+    subscribeMessage: (params) => {
+      const pair = `${params.base}/${params.quote}`.toUpperCase()
+      return {
+        action: 'liquiditymetrics',
+        asset: pair,
+      }
+    },
+  },
+})

packages/sources/expand-network/CHANGELOG.md

@@ -0,0 +1,8 @@
+{
+  "requests": [
+    {
+      "base": "wstETH",
+      "quote": "ETH"
+    }
+  ]
+}

packages/sources/expand-network/README.md

@@ -0,0 +1,60 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`websocket price endpoint should return error on empty base 1`] = `
+{
+  "error": {
+    "message": "[Param: base] param is required but no value was provided",
+    "name": "AdapterError",
+  },
+  "status": "errored",
+  "statusCode": 400,
+}
+`;
+
+exports[`websocket price endpoint should return error on empty data 1`] = `
+{
+  "error": {
+    "message": "[Param: base] param is required but no value was provided",
+    "name": "AdapterError",
+  },
+  "status": "errored",
+  "statusCode": 400,
+}
+`;
+
+exports[`websocket price endpoint should return error on empty quote 1`] = `
+{
+  "error": {
+    "message": "[Param: quote] param is required but no value was provided",
+    "name": "AdapterError",
+  },
+  "status": "errored",
+  "statusCode": 400,
+}
+`;
+
+exports[`websocket price endpoint should return error on invalid pair 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[`websocket price endpoint should return success 1`] = `
+{
+  "data": {
+    "result": 1.1803771088055002,
+  },
+  "result": 1.1803771088055002,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 1018,
+    "providerDataStreamEstablishedUnixMs": 1010,
+    "providerIndicatedTimeUnixMs": 1728302896000,
+  },
+}
+`;