From 0e6e3d8c90d57815fbe19d8a582516f7b062f1e4 Mon Sep 17 00:00:00 2001 From: Michael Xiao Date: Fri, 6 Dec 2024 12:43:39 -0500 Subject: [PATCH] NYFED (#3607) * NYFED * Rename input --- .changeset/early-phones-smile.md | 5 ++ .pnp.cjs | 20 ++++++ packages/sources/nyfed/CHANGELOG.md | 0 packages/sources/nyfed/README.md | 3 + packages/sources/nyfed/package.json | 40 +++++++++++ packages/sources/nyfed/src/config/index.ts | 9 +++ packages/sources/nyfed/src/endpoint/index.ts | 1 + packages/sources/nyfed/src/endpoint/rate.ts | 32 +++++++++ packages/sources/nyfed/src/index.ts | 21 ++++++ packages/sources/nyfed/src/transport/rate.ts | 72 +++++++++++++++++++ packages/sources/nyfed/test-payload.json | 5 ++ .../__snapshots__/adapter.test.ts.snap | 16 +++++ .../nyfed/test/integration/adapter.test.ts | 45 ++++++++++++ .../nyfed/test/integration/fixtures.ts | 36 ++++++++++ packages/sources/nyfed/tsconfig.json | 9 +++ packages/sources/nyfed/tsconfig.test.json | 7 ++ packages/tsconfig.json | 3 + packages/tsconfig.test.json | 3 + yarn.lock | 13 ++++ 19 files changed, 340 insertions(+) create mode 100644 .changeset/early-phones-smile.md create mode 100644 packages/sources/nyfed/CHANGELOG.md create mode 100644 packages/sources/nyfed/README.md create mode 100644 packages/sources/nyfed/package.json create mode 100644 packages/sources/nyfed/src/config/index.ts create mode 100644 packages/sources/nyfed/src/endpoint/index.ts create mode 100644 packages/sources/nyfed/src/endpoint/rate.ts create mode 100644 packages/sources/nyfed/src/index.ts create mode 100644 packages/sources/nyfed/src/transport/rate.ts create mode 100644 packages/sources/nyfed/test-payload.json create mode 100644 packages/sources/nyfed/test/integration/__snapshots__/adapter.test.ts.snap create mode 100644 packages/sources/nyfed/test/integration/adapter.test.ts create mode 100644 packages/sources/nyfed/test/integration/fixtures.ts create mode 100644 packages/sources/nyfed/tsconfig.json create mode 100755 packages/sources/nyfed/tsconfig.test.json diff --git a/.changeset/early-phones-smile.md b/.changeset/early-phones-smile.md new file mode 100644 index 0000000000..7a4195a1a7 --- /dev/null +++ b/.changeset/early-phones-smile.md @@ -0,0 +1,5 @@ +--- +'@chainlink/nyfed-adapter': major +--- + +NYFED diff --git a/.pnp.cjs b/.pnp.cjs index 11ed654542..fa3970511a 100755 --- a/.pnp.cjs +++ b/.pnp.cjs @@ -702,6 +702,10 @@ const RAW_RUNTIME_STATE = "name": "@chainlink/nikkei-adapter",\ "reference": "workspace:packages/sources/nikkei"\ },\ + {\ + "name": "@chainlink/nyfed-adapter",\ + "reference": "workspace:packages/sources/nyfed"\ + },\ {\ "name": "@chainlink/oanda-adapter",\ "reference": "workspace:packages/sources/oanda"\ @@ -1104,6 +1108,7 @@ const RAW_RUNTIME_STATE = ["@chainlink/nft-blue-chip-adapter", ["workspace:packages/sources/nft-blue-chip"]],\ ["@chainlink/nftx-adapter", ["workspace:packages/composites/nftx"]],\ ["@chainlink/nikkei-adapter", ["workspace:packages/sources/nikkei"]],\ + ["@chainlink/nyfed-adapter", ["workspace:packages/sources/nyfed"]],\ ["@chainlink/oanda-adapter", ["workspace:packages/sources/oanda"]],\ ["@chainlink/observation", ["workspace:packages/observation"]],\ ["@chainlink/oilpriceapi-adapter", ["workspace:packages/sources/oilpriceapi"]],\ @@ -8157,6 +8162,21 @@ const RAW_RUNTIME_STATE = "linkType": "SOFT"\ }]\ ]],\ + ["@chainlink/nyfed-adapter", [\ + ["workspace:packages/sources/nyfed", {\ + "packageLocation": "./packages/sources/nyfed/",\ + "packageDependencies": [\ + ["@chainlink/nyfed-adapter", "workspace:packages/sources/nyfed"],\ + ["@chainlink/external-adapter-framework", "npm:1.7.4"],\ + ["@types/jest", "npm:27.5.2"],\ + ["@types/node", "npm:16.18.119"],\ + ["nock", "npm:13.5.5"],\ + ["tslib", "npm:2.4.1"],\ + ["typescript", "patch:typescript@npm%3A5.6.3#optional!builtin::version=5.6.3&hash=8c6c40"]\ + ],\ + "linkType": "SOFT"\ + }]\ + ]],\ ["@chainlink/oanda-adapter", [\ ["workspace:packages/sources/oanda", {\ "packageLocation": "./packages/sources/oanda/",\ diff --git a/packages/sources/nyfed/CHANGELOG.md b/packages/sources/nyfed/CHANGELOG.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/sources/nyfed/README.md b/packages/sources/nyfed/README.md new file mode 100644 index 0000000000..9abbe33d86 --- /dev/null +++ b/packages/sources/nyfed/README.md @@ -0,0 +1,3 @@ +# Chainlink External Adapter for nyfed + +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 nyfed`. diff --git a/packages/sources/nyfed/package.json b/packages/sources/nyfed/package.json new file mode 100644 index 0000000000..dd3cbf70ad --- /dev/null +++ b/packages/sources/nyfed/package.json @@ -0,0 +1,40 @@ +{ + "name": "@chainlink/nyfed-adapter", + "version": "0.0.0", + "description": "Chainlink nyfed adapter.", + "keywords": [ + "Chainlink", + "LINK", + "blockchain", + "oracle", + "nyfed" + ], + "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": { + "@types/jest": "27.5.2", + "@types/node": "16.18.119", + "nock": "13.5.5", + "typescript": "5.6.3" + }, + "dependencies": { + "@chainlink/external-adapter-framework": "1.7.4", + "tslib": "2.4.1" + } +} diff --git a/packages/sources/nyfed/src/config/index.ts b/packages/sources/nyfed/src/config/index.ts new file mode 100644 index 0000000000..bbc1abe7bb --- /dev/null +++ b/packages/sources/nyfed/src/config/index.ts @@ -0,0 +1,9 @@ +import { AdapterConfig } from '@chainlink/external-adapter-framework/config' + +export const config = new AdapterConfig({ + API_ENDPOINT: { + description: 'An API endpoint for Data Provider', + type: 'string', + default: 'https://markets.newyorkfed.org/api/rates/secured/all/latest.json', + }, +}) diff --git a/packages/sources/nyfed/src/endpoint/index.ts b/packages/sources/nyfed/src/endpoint/index.ts new file mode 100644 index 0000000000..f06e62e00d --- /dev/null +++ b/packages/sources/nyfed/src/endpoint/index.ts @@ -0,0 +1 @@ +export { endpoint as rate } from './rate' diff --git a/packages/sources/nyfed/src/endpoint/rate.ts b/packages/sources/nyfed/src/endpoint/rate.ts new file mode 100644 index 0000000000..b11c712f94 --- /dev/null +++ b/packages/sources/nyfed/src/endpoint/rate.ts @@ -0,0 +1,32 @@ +import { AdapterEndpoint } 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 { httpTransport } from '../transport/rate' + +export const inputParameters = new InputParameters( + { + symbol: { + required: true, + type: 'string', + description: 'Symbol of the rate you are looking for', + }, + }, + [ + { + symbol: 'SOFR', + }, + ], +) + +export type BaseEndpointTypes = { + Parameters: typeof inputParameters.definition + Response: SingleNumberResultResponse + Settings: typeof config.settings +} + +export const endpoint = new AdapterEndpoint({ + name: 'rate', + transport: httpTransport, + inputParameters, +}) diff --git a/packages/sources/nyfed/src/index.ts b/packages/sources/nyfed/src/index.ts new file mode 100644 index 0000000000..554f88341f --- /dev/null +++ b/packages/sources/nyfed/src/index.ts @@ -0,0 +1,21 @@ +import { expose, ServerInstance } from '@chainlink/external-adapter-framework' +import { Adapter } from '@chainlink/external-adapter-framework/adapter' +import { config } from './config' +import { rate } from './endpoint' + +export const adapter = new Adapter({ + defaultEndpoint: rate.name, + name: 'NYFED', + config, + endpoints: [rate], + rateLimiting: { + tiers: { + default: { + rateLimit1m: 6, + note: 'Reasonable limits', + }, + }, + }, +}) + +export const server = (): Promise => expose(adapter) diff --git a/packages/sources/nyfed/src/transport/rate.ts b/packages/sources/nyfed/src/transport/rate.ts new file mode 100644 index 0000000000..06fa6f58b6 --- /dev/null +++ b/packages/sources/nyfed/src/transport/rate.ts @@ -0,0 +1,72 @@ +import { HttpTransport } from '@chainlink/external-adapter-framework/transports' +import { BaseEndpointTypes } from '../endpoint/rate' + +export interface ResponseSchema { + refRates: { + effectiveDate: string + type: string + percentRate?: number + }[] +} + +export type HttpTransportTypes = BaseEndpointTypes & { + Provider: { + RequestBody: never + ResponseBody: ResponseSchema + } +} +export const httpTransport = new HttpTransport({ + prepareRequests: (params, config) => { + return params.map((param) => { + return { + params: [param], + request: { + baseURL: config.API_ENDPOINT, + }, + } + }) + }, + parseResponse: (params, response) => { + if (!response.data) { + return params.map((param) => { + return { + params: param, + response: { + errorMessage: `The data provider didn't return any value`, + statusCode: 502, + }, + } + }) + } + + return params.map((param) => { + const result = response.data.refRates.find( + (d) => d.type.toUpperCase() == param.symbol.toUpperCase(), + ) + if (result?.percentRate == undefined) { + return { + params: param, + response: { + errorMessage: `The data provider didn't return any value for ${param.symbol}`, + statusCode: 502, + }, + } + } else { + return { + params: param, + response: { + result: result.percentRate, + data: { + result: result.percentRate, + }, + timestamps: { + providerIndicatedTimeUnixMs: result.effectiveDate + ? new Date(result.effectiveDate).getTime() + : undefined, + }, + }, + } + } + }) + }, +}) diff --git a/packages/sources/nyfed/test-payload.json b/packages/sources/nyfed/test-payload.json new file mode 100644 index 0000000000..6a5cc61c7f --- /dev/null +++ b/packages/sources/nyfed/test-payload.json @@ -0,0 +1,5 @@ +{ + "requests": [{ + "symbol": "SOFR" + }] +} diff --git a/packages/sources/nyfed/test/integration/__snapshots__/adapter.test.ts.snap b/packages/sources/nyfed/test/integration/__snapshots__/adapter.test.ts.snap new file mode 100644 index 0000000000..b4849ecff7 --- /dev/null +++ b/packages/sources/nyfed/test/integration/__snapshots__/adapter.test.ts.snap @@ -0,0 +1,16 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`execute rate endpoint should return success 1`] = ` +{ + "data": { + "result": 4.59, + }, + "result": 4.59, + "statusCode": 200, + "timestamps": { + "providerDataReceivedUnixMs": 978347471111, + "providerDataRequestedUnixMs": 978347471111, + "providerIndicatedTimeUnixMs": 1733356800000, + }, +} +`; diff --git a/packages/sources/nyfed/test/integration/adapter.test.ts b/packages/sources/nyfed/test/integration/adapter.test.ts new file mode 100644 index 0000000000..499d224b07 --- /dev/null +++ b/packages/sources/nyfed/test/integration/adapter.test.ts @@ -0,0 +1,45 @@ +import { + TestAdapter, + setEnvVariables, +} from '@chainlink/external-adapter-framework/util/testing-utils' +import * as nock from 'nock' +import { mockResponseSuccess } from './fixtures' + +describe('execute', () => { + let spy: jest.SpyInstance + let testAdapter: TestAdapter + let oldEnv: NodeJS.ProcessEnv + + beforeAll(async () => { + oldEnv = JSON.parse(JSON.stringify(process.env)) + process.env.API_ENDPOINT = 'http://fake-url' + + const mockDate = new Date('2001-01-01T11:11:11.111Z') + spy = jest.spyOn(Date, 'now').mockReturnValue(mockDate.getTime()) + + const adapter = (await import('./../../src')).adapter + adapter.rateLimiting = undefined + testAdapter = await TestAdapter.startWithMockedCache(adapter, { + testAdapter: {} as TestAdapter, + }) + }) + + afterAll(async () => { + setEnvVariables(oldEnv) + await testAdapter.api.close() + nock.restore() + nock.cleanAll() + spy.mockRestore() + }) + + describe('rate endpoint', () => { + it('should return success', async () => { + mockResponseSuccess() + const response = await testAdapter.request({ + symbol: 'SOFR', + }) + expect(response.statusCode).toBe(200) + expect(response.json()).toMatchSnapshot() + }) + }) +}) diff --git a/packages/sources/nyfed/test/integration/fixtures.ts b/packages/sources/nyfed/test/integration/fixtures.ts new file mode 100644 index 0000000000..067f3357e6 --- /dev/null +++ b/packages/sources/nyfed/test/integration/fixtures.ts @@ -0,0 +1,36 @@ +import nock from 'nock' + +export const mockResponseSuccess = (): nock.Scope => + nock('http://fake-url', { + encodedQueryParams: true, + }) + .get('/') + .reply( + 200, + () => ({ + refRates: [ + { + effectiveDate: '2024-12-05', + type: 'SOFR', + percentRate: 4.59, + percentPercentile1: 4.55, + percentPercentile25: 4.57, + percentPercentile75: 4.65, + percentPercentile99: 4.68, + volumeInBillions: 2325, + revisionIndicator: '', + }, + ], + }), + [ + 'Content-Type', + 'application/json', + 'Connection', + 'close', + 'Vary', + 'Accept-Encoding', + 'Vary', + 'Origin', + ], + ) + .persist() diff --git a/packages/sources/nyfed/tsconfig.json b/packages/sources/nyfed/tsconfig.json new file mode 100644 index 0000000000..f59363fd76 --- /dev/null +++ b/packages/sources/nyfed/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "outDir": "dist", + "rootDir": "src" + }, + "include": ["src/**/*", "src/**/*.json"], + "exclude": ["dist", "**/*.spec.ts", "**/*.test.ts"] +} diff --git a/packages/sources/nyfed/tsconfig.test.json b/packages/sources/nyfed/tsconfig.test.json new file mode 100755 index 0000000000..e3de28cb5c --- /dev/null +++ b/packages/sources/nyfed/tsconfig.test.json @@ -0,0 +1,7 @@ +{ + "extends": "../../tsconfig.base.json", + "include": ["src/**/*", "**/test", "src/**/*.json"], + "compilerOptions": { + "noEmit": true + } +} diff --git a/packages/tsconfig.json b/packages/tsconfig.json index 81333ac81b..5668855a4d 100644 --- a/packages/tsconfig.json +++ b/packages/tsconfig.json @@ -506,6 +506,9 @@ { "path": "./sources/nikkei" }, + { + "path": "./sources/nyfed" + }, { "path": "./sources/oanda" }, diff --git a/packages/tsconfig.test.json b/packages/tsconfig.test.json index 5f7a72c680..d4c1802557 100644 --- a/packages/tsconfig.test.json +++ b/packages/tsconfig.test.json @@ -506,6 +506,9 @@ { "path": "./sources/nikkei/tsconfig.test.json" }, + { + "path": "./sources/nyfed/tsconfig.test.json" + }, { "path": "./sources/oanda/tsconfig.test.json" }, diff --git a/yarn.lock b/yarn.lock index 0e825a5719..3ef48b38a8 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4922,6 +4922,19 @@ __metadata: languageName: unknown linkType: soft +"@chainlink/nyfed-adapter@workspace:packages/sources/nyfed": + version: 0.0.0-use.local + resolution: "@chainlink/nyfed-adapter@workspace:packages/sources/nyfed" + dependencies: + "@chainlink/external-adapter-framework": "npm:1.7.4" + "@types/jest": "npm:27.5.2" + "@types/node": "npm:16.18.119" + nock: "npm:13.5.5" + tslib: "npm:2.4.1" + typescript: "npm:5.6.3" + languageName: unknown + linkType: soft + "@chainlink/oanda-adapter@workspace:packages/sources/oanda": version: 0.0.0-use.local resolution: "@chainlink/oanda-adapter@workspace:packages/sources/oanda"