Merc6933 GMCI EA - Data Link Feed

.changeset/itchy-pianos-wave.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/gmci-adapter': minor
+---
+
+GMCI EA for GMCI30 Index

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 |         | `wss://api.gmci.co/private` |
+
+---
+
+## 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 |
+| :-------: | :---: | :-----: | :---------: | :----: | :-----: | :-----: | :--------: | :------------: |
+|    ✅     | index |         | Index name  | string |         |         |            |                |
+
+### Example
+
+Request:
+
+```json
+{
+  "data": {
+    "endpoint": "price",
+    "index": "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": "27.5.2",
+    "@types/node": "16.18.119",
+    "@types/sinonjs__fake-timers": "8.1.5",
+    "nock": "13.5.5",
+    "typescript": "5.6.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',
+    default: 'wss://api.gmci.co/private',
+  },
+})

packages/sources/gmci/src/config/overrides.json

@@ -0,0 +1,3 @@
+{
+  "gmci": {}
+}

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,45 @@
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { config } from '../config'
+import overrides from '../config/overrides.json'
+import { transport } from '../transport/price'
+
+export const inputParameters = new InputParameters(
+  {
+    index: {
+      required: true,
+      type: 'string',
+      description: 'Index name',
+    },
+  },
+  [
+    {
+      index: 'GMCI30',
+    },
+  ],
+)
+
+export type GMCIResultResponse = {
+  Result: number
+  Data: {
+    status?: string
+    end_time?: string
+    start_time?: string
+    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,
+  overrides: overrides['gmci'],
+})

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)