[OPDATA-3889] FTSE SFTP EA Downloading and Parsing

.changeset/warm-hornets-compete.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/ftse-sftp-adapter': major
+---
+
+Adding Downloading and parsing logic for russell and ftse csv files from ftse sftp server

.changeset/wild-kids-notice.md

@@ -0,0 +1,5 @@
+---
+'@chainlink/ftse-sftp-adapter': minor
+---
+
+Added the SFTP Transport and Configs

packages/sources/ftse-sftp/package.json

@@ -31,12 +31,14 @@
     "@chainlink/external-adapter-framework": "2.7.0",
     "csv-parse": "5.5.6",
     "decimal.js": "^10.5.0",
+    "ssh2-sftp-client": "^12.0.1",
     "tslib": "^2.3.1"
   },
   "devDependencies": {
     "@sinonjs/fake-timers": "^14.0.0",
     "@types/jest": "^29.5.14",
     "@types/node": "22.14.1",
+    "@types/ssh2-sftp-client": "^9.0.5",
     "jest": "^29.7.0",
     "jest-util": "^29.7.0",
     "nock": "13.5.6",

packages/sources/ftse-sftp/src/config/index.ts

@@ -0,0 +1,33 @@
+import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
+
+export const NAME = 'FTSE_SFTP_ADAPTER'
+
+export const config = new AdapterConfig({
+  SFTP_HOST: {
+    description: 'SFTP server hostname or IP address',
+    type: 'string',
+    required: true,
+  },
+  SFTP_PORT: {
+    description: 'SFTP server port',
+    type: 'number',
+    default: 22,
+  },
+  SFTP_USERNAME: {
+    description: 'SFTP username for authentication',
+    type: 'string',
+    required: true,
+  },
+  SFTP_PASSWORD: {
+    description: 'SFTP password for authentication',
+    type: 'string',
+    sensitive: true,
+    required: true,
+  },
+  BACKGROUND_EXECUTE_MS: {
+    description:
+      'The amount of time the background execute should sleep before performing the next request',
+    type: 'number',
+    default: 10_000,
+  },
+})

packages/sources/ftse-sftp/src/endpoint/index.ts

@@ -0,0 +1,3 @@
+import * as sftp from './sftp'
+
+export { sftp }

packages/sources/ftse-sftp/src/endpoint/sftp.ts

@@ -0,0 +1,54 @@
+import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
+import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { config } from '../config'
+import { FTSE100Data } from '../parsing/ftse100'
+import { RussellDailyValuesData } from '../parsing/russell'
+import { sftpTransport } from '../transport/sftp'
+
+export const inputParameters = new InputParameters(
+  {
+    instrument: {
+      required: true,
+      type: 'string',
+      description: 'Abstract identifier of the index to fetch the data for',
+    },
+  },
+  [
+    {
+      instrument: 'FTSE100INDEX',
+    },
+    {
+      instrument: 'Russell1000INDEX',
+    },
+    {
+      instrument: 'Russell2000INDEX',
+    },
+    {
+      instrument: 'Russell3000INDEX',
+    },
+  ],
+)
+
+export type TInputParameters = typeof inputParameters.definition
+
+/**
+ * Union type for all possible response data structures
+ */
+export type IndexResponseData = FTSE100Data | RussellDailyValuesData
+
+export type BaseEndpointTypes = {
+  Parameters: typeof inputParameters.definition
+  Response: {
+    Result: number
+    Data: {
+      result: IndexResponseData
+    }
+  }
+  Settings: typeof config.settings
+}
+
+export const endpoint = new AdapterEndpoint({
+  name: 'ftse_sftp',
+  transport: sftpTransport,
+  inputParameters,
+})

packages/sources/ftse-sftp/src/index.ts

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

packages/sources/ftse-sftp/src/transport/constants.ts

@@ -0,0 +1,20 @@
+export const instrumentToFilePathMap: Record<string, string> = {
+  FTSE100INDEX: '/data/valuation/uk_all_share/',
+  Russell1000INDEX: '/data/Returns_and_Values/Russell_US_Indexes_Daily_Index_Values_Real_Time_TXT/',
+  Russell2000INDEX: '/data/Returns_and_Values/Russell_US_Indexes_Daily_Index_Values_Real_Time_TXT/',
+  Russell3000INDEX: '/data/Returns_and_Values/Russell_US_Indexes_Daily_Index_Values_Real_Time_TXT/',
+}
+
+export const instrumentToFileTemplateMap: Record<string, string> = {
+  FTSE100INDEX: 'ukallv*.csv',
+  Russell1000INDEX: 'daily_values_russell_*.CSV',
+  Russell2000INDEX: 'daily_values_russell_*.CSV',
+  Russell3000INDEX: 'daily_values_russell_*.CSV',
+}
+
+export const instrumentToFileRegexMap: Record<string, RegExp> = {
+  FTSE100INDEX: /^ukallv\d{4}\.csv$/,
+  Russell1000INDEX: /^daily_values_russell_\d{6}\.CSV$/,
+  Russell2000INDEX: /^daily_values_russell_\d{6}\.CSV$/,
+  Russell3000INDEX: /^daily_values_russell_\d{6}\.CSV$/,
+}