Merc6933 GMCI EA - Data Link Feed

.changeset/proud-masks-film.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/gmci-adapter': major
+---
+
+Version 1.0.0 of GMCI EA

packages/sources/gmci/README.md

@@ -0,0 +1,53 @@
+# GMCI
+
+![0.0.0](https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/gmci/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 |
+| :-------: | :-------------: | :--------------------------------: | :----: | :-----: | :-----: |
+|    ✅     |     API_KEY     |    An API key for Data Provider    | string |         |         |
+|           | WS_API_ENDPOINT | WS endpoint for GMCI Data Provider | 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) | `price` |
+
+## Price Endpoint
+
+`price` is the only supported name for this endpoint.
+
+### Input Params
+
+| Required? |  Name  | Aliases | Description |  Type  | Options | Default | Depends On | Not Valid With |
+| :-------: | :----: | :-----: | :---------: | :----: | :-----: | :-----: | :--------: | :------------: |
+|    ✅     | symbol |         | Index name  | string |         |         |            |                |
+
+### Example
+
+Request:
+
+```json
+{
+  "data": {
+    "endpoint": "price",
+    "symbol": "GMCI30"
+  }
+}
+```
+
+---
+
+MIT License

packages/sources/gmci/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@chainlink/gmci-adapter",
+  "version": "0.0.0",
+  "description": "Chainlink gmci adapter.",
+  "keywords": [
+    "Chainlink",
+    "LINK",
+    "blockchain",
+    "oracle",
+    "gmci"
+  ],
+  "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.6.0",
+    "tslib": "2.4.1"
+  }
+}

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

@@ -0,0 +1,15 @@
+import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
+
+export const config = new AdapterConfig({
+  API_KEY: {
+    description: 'An API key for Data Provider',
+    type: 'string',
+    required: true,
+    sensitive: true,
+  },
+  WS_API_ENDPOINT: {
+    description: 'WS endpoint for GMCI Data Provider',
+    type: 'string',
+    required: true,
+  },
+})

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

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

packages/sources/gmci/src/endpoint/price.ts

@@ -0,0 +1,40 @@
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { config } from '../config'
+import { transport } from '../transport/price'
+
+export const inputParameters = new InputParameters(
+  {
+    symbol: {
+      required: true,
+      type: 'string',
+      description: 'Index name',
+    },
+  },
+  [
+    {
+      symbol: 'GMCI30',
+    },
+  ],
+)
+
+export type GMCIResultResponse = {
+  Result: number
+  Data: {
+    symbol: string
+    result: number
+  }
+}
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: GMCIResultResponse
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'price',
+  aliases: [],
+  transport: transport,
+  inputParameters,
+})

packages/sources/gmci/src/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: 'GMCI',
+  config,
+  endpoints: [price],
+})
+
+export const server = (): Promise<ServerInstance | undefined> => expose(adapter)

packages/sources/gmci/src/transport/price.ts

@@ -0,0 +1,100 @@
+import { EndpointContext } from '@chainlink/external-adapter-framework/adapter'
+import {
+  WebSocketTransport,
+  WebSocketTransportConfig,
+} from '@chainlink/external-adapter-framework/transports'
+import { makeLogger } from '@chainlink/external-adapter-framework/util'
+import { BaseEndpointTypes } from '../endpoint/price'
+import { convertTimetoUnixMs } from './util'
+
+export interface PriceMessage {
+  last_updated: string
+  price: number
+  symbol: string
+}
+
+export interface RebalanceMessage {
+  end_time: string
+  start_time: string
+  status: string
+  symbol: string
+}
+
+interface WsPriceResponse {
+  success: boolean
+  data: Array<PriceMessage>
+  topic: 'price'
+}
+
+interface WsRebalanceResponse {
+  success: boolean
+  data: Array<RebalanceMessage>
+  topic: 'rebalance_status'
+}
+
+export type WsResponse = WsPriceResponse | WsRebalanceResponse
+
+export type WsTransportTypes = BaseEndpointTypes & {
+  Provider: {
+    WsMessage: WsResponse
+  }
+}
+
+const logger = makeLogger('GmciTransport')
+
+export const options: WebSocketTransportConfig<WsTransportTypes> = {
+  url: (context: EndpointContext<WsTransportTypes>) => context.adapterSettings.WS_API_ENDPOINT,
+  options: async (context: EndpointContext<WsTransportTypes>) => ({
+    headers: {
+      'X-GMCI-API-KEY': context.adapterSettings.API_KEY,
+    },
+  }),
+
+  handlers: {
+    message(message: WsResponse) {
+      if (message.success === false) {
+        logger.info(message)
+        return
+      }
+
+      const results = []
+
+      if (message.topic === 'price') {
+        for (const item of message.data) {
+          results.push({
+            params: { symbol: item.symbol },
+            response: {
+              result: item.price,
+              data: {
+                result: item.price,
+                symbol: item.symbol,
+              },
+              timestamps: {
+                providerIndicatedTimeUnixMs: convertTimetoUnixMs(item.last_updated),
+              },
+            },
+          })
+        }
+      }
+      return results
+    },
+  },
+
+  builders: {
+    subscribeMessage: (params) => {
+      return {
+        op: 'subscribe',
+        args: [`price.${params.symbol}`.toLowerCase()],
+      }
+    },
+
+    unsubscribeMessage: (params) => {
+      return {
+        op: 'unsubscribe',
+        args: [`price.${params.symbol}`.toLowerCase()],
+      }
+    },
+  },
+}
+
+export const transport = new WebSocketTransport(options)

packages/sources/gmci/src/transport/util.ts

@@ -0,0 +1,3 @@
+export function convertTimetoUnixMs(isoTime: string) {
+  return Date.parse(isoTime)
+}

packages/sources/gmci/test-payload.json

@@ -0,0 +1,5 @@
+{
+ "requests": [{
+  "symbol": "GMCI30"
+ }]
+}

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

@@ -0,0 +1,17 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`websocket price endpoint should return success 1`] = `
+{
+  "data": {
+    "result": 183.7141917913536,
+    "symbol": "GMCI30",
+  },
+  "result": 183.7141917913536,
+  "statusCode": 200,
+  "timestamps": {
+    "providerDataReceivedUnixMs": 1018,
+    "providerDataStreamEstablishedUnixMs": 1010,
+    "providerIndicatedTimeUnixMs": 1752394072746,
+  },
+}
+`;