David's changes

Author: dskloetc

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

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

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

@@ -1,8 +1,10 @@
 import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
 import { InputParameters } from '@chainlink/external-adapter-framework/validation'
+import { AdapterError } from '@chainlink/external-adapter-framework/validation/error'
 import { config } from '../config'
 import { FTSE100Data } from '../parsing/ftse100'
 import { RussellDailyValuesData } from '../parsing/russell'
+import { validateInstrument } from '../transport/constants'
 import { sftpTransport } from '../transport/sftp'
 
 export const inputParameters = new InputParameters(
@@ -29,8 +31,6 @@ export const inputParameters = new InputParameters(
   ],
 )
 
-export type TInputParameters = typeof inputParameters.definition
-
 /**
  * Union type for all possible response data structures
  */
@@ -41,14 +41,20 @@ export type BaseEndpointTypes = {
   Response: {
     Result: number
     Data: {
+      filename: string
       result: IndexResponseData
     }
   }
   Settings: typeof config.settings
 }
 
 export const endpoint = new AdapterEndpoint({
-  name: 'ftse_sftp',
+  name: 'sftp',
   transport: sftpTransport,
   inputParameters,
+  customInputValidation: (request, _settings): AdapterError | undefined => {
+    const { instrument } = request.requestContext.data
+    validateInstrument(instrument)
+    return
+  },
 })

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

@@ -1,12 +1,13 @@
 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'
+import { sftp } from './endpoint'
 
 export const adapter = new Adapter({
+  defaultEndpoint: sftp.name,
   name: 'FTSE_SFTP',
   config,
-  endpoints: [endpoints.sftp.endpoint],
+  endpoints: [sftp],
 })
 
 export const server = (): Promise<ServerInstance | undefined> => expose(adapter)

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

@@ -1,17 +1,12 @@
-export const instrumentToFilePathMap: Record<string, string> = {
+import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
+
+export const instrumentToDirectoryMap: 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$/,
@@ -24,6 +19,15 @@ export const instrumentToFileRegexMap: Record<string, RegExp> = {
  * @param instrument The instrument identifier to validate
  * @returns true if the instrument is supported, false otherwise
  */
-export function isInstrumentSupported(instrument: string): boolean {
-  return !!(instrumentToFilePathMap[instrument] && instrumentToFileRegexMap[instrument])
+const isInstrumentSupported = (instrument: string): boolean => {
+  return !!(instrumentToDirectoryMap[instrument] && instrumentToFileRegexMap[instrument])
+}
+
+export const validateInstrument = (instrument: string): void => {
+  if (!isInstrumentSupported(instrument)) {
+    throw new AdapterInputError({
+      statusCode: 400,
+      message: `Unsupported instrument: ${instrument}`,
+    })
+  }
 }

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

@@ -1,40 +1,24 @@
 import { EndpointContext } from '@chainlink/external-adapter-framework/adapter'
-import { ResponseCache } from '@chainlink/external-adapter-framework/cache/response'
 import { TransportDependencies } from '@chainlink/external-adapter-framework/transports'
 import { SubscriptionTransport } from '@chainlink/external-adapter-framework/transports/abstract/subscription'
 import { AdapterResponse, makeLogger, sleep } from '@chainlink/external-adapter-framework/util'
 import { AdapterInputError } from '@chainlink/external-adapter-framework/validation/error'
-import SftpClient, { FileInfo } from 'ssh2-sftp-client'
+import { ConnectOptions } from 'ssh2-sftp-client'
 import { BaseEndpointTypes, IndexResponseData, inputParameters } from '../endpoint/sftp'
 import { CSVParserFactory } from '../parsing/factory'
-import {
-  instrumentToFilePathMap,
-  instrumentToFileRegexMap,
-  isInstrumentSupported,
-} from './constants'
+import { instrumentToDirectoryMap, instrumentToFileRegexMap, validateInstrument } from './constants'
+import { getFileContentsFromFileRegex } from './utils'
 
 const logger = makeLogger('FTSE SFTP Adapter')
 
 type RequestParams = typeof inputParameters.validated
 
-interface SftpConnectionConfig {
-  host: string
-  port: number
-  username: string
-  password: string
-  readyTimeout: number
-}
-
 export class SftpTransport extends SubscriptionTransport<BaseEndpointTypes> {
   config!: BaseEndpointTypes['Settings']
   endpointName!: string
-  name!: string
-  responseCache!: ResponseCache<BaseEndpointTypes>
-  sftpClient: SftpClient
 
   constructor() {
     super()
-    this.sftpClient = new SftpClient()
   }
 
   async initialize(
@@ -45,9 +29,6 @@ export class SftpTransport extends SubscriptionTransport<BaseEndpointTypes> {
   ): Promise<void> {
     await super.initialize(dependencies, adapterSettings, endpointName, transportName)
     this.config = adapterSettings
-    this.endpointName = endpointName
-    this.name = transportName
-    this.responseCache = dependencies.responseCache
   }
 
   async backgroundHandler(
@@ -73,13 +54,6 @@ export class SftpTransport extends SubscriptionTransport<BaseEndpointTypes> {
           providerIndicatedTimeUnixMs: undefined,
         },
       }
-    } finally {
-      try {
-        await this.sftpClient.end()
-        logger.info('SFTP connection closed')
-      } catch (error) {
-        logger.error('Error closing SFTP connection:', error)
-      }
     }
 
     await this.responseCache.write(this.name, [{ params: param, response }])
@@ -90,25 +64,12 @@ export class SftpTransport extends SubscriptionTransport<BaseEndpointTypes> {
   ): Promise<AdapterResponse<BaseEndpointTypes['Response']>> {
     const providerDataRequestedUnixMs = Date.now()
 
-    await this.connectToSftp()
-
-    const parsedData = await this.tryDownloadAndParseFile(param.instrument)
+    const { filename, result, parsedData } = await this.tryDownloadAndParseFile(param.instrument)
 
-    // Extract the numeric result based on the data type
-    let result: number
-    if ('gbpIndex' in parsedData) {
-      // FTSE data
-      result = (parsedData.gbpIndex as number) ?? 0
-    } else if ('close' in parsedData) {
-      // Russell data
-      result = parsedData.close as number
-    } else {
-      throw new Error('Unknown data format received from parser')
-    }
-
-    logger.info(`Successfully processed data for instrument: ${param.instrument}`)
+    logger.debug(`Successfully processed data for instrument: ${param.instrument}`)
     return {
       data: {
+        filename,
         result: parsedData,
       },
       statusCode: 200,
@@ -121,66 +82,30 @@ export class SftpTransport extends SubscriptionTransport<BaseEndpointTypes> {
     }
   }
 
-  private async connectToSftp(): Promise<void> {
-    const connectConfig: SftpConnectionConfig = {
+  private async tryDownloadAndParseFile(instrument: string): Promise<{
+    filename: string
+    result: number
+    parsedData: IndexResponseData
+  }> {
+    validateInstrument(instrument)
+
+    const connectOptions: ConnectOptions = {
       host: this.config.SFTP_HOST,
-      port: this.config.SFTP_PORT || 22,
+      port: this.config.SFTP_PORT,
       username: this.config.SFTP_USERNAME,
       password: this.config.SFTP_PASSWORD,
       readyTimeout: 30000,
     }
 
-    try {
-      // Create a new client instance to avoid connection state issues
-      this.sftpClient = new SftpClient()
-      await this.sftpClient.connect(connectConfig)
-      logger.info('Successfully connected to SFTP server')
-    } catch (error) {
-      logger.error(error, 'Failed to connect to SFTP server')
-      throw new AdapterInputError({
-        statusCode: 500,
-        message: `Failed to connect to SFTP server: ${
-          error instanceof Error ? error.message : 'Unknown error'
-        }`,
-      })
-    }
-  }
+    const directory = instrumentToDirectoryMap[instrument]
+    const filenameRegex = instrumentToFileRegexMap[instrument]
 
-  private async tryDownloadAndParseFile(instrument: string): Promise<IndexResponseData> {
-    // Validate that the instrument is supported
-    if (!isInstrumentSupported(instrument)) {
-      throw new AdapterInputError({
-        statusCode: 400,
-        message: `Unsupported instrument: ${instrument}`,
-      })
-    }
+    const { filename, fileContent } = await getFileContentsFromFileRegex({
+      connectOptions,
+      directory,
+      filenameRegex,
+    })
 
-    const filePath = instrumentToFilePathMap[instrument]
-    const fileRegex = instrumentToFileRegexMap[instrument]
-
-    const fileList = await this.sftpClient.list(filePath)
-    // Filter files based on the regex pattern
-    const matchingFiles = fileList
-      .map((file: FileInfo) => file.name)
-      .filter((fileName: string) => fileRegex.test(fileName))
-
-    if (matchingFiles.length === 0) {
-      throw new AdapterInputError({
-        statusCode: 500,
-        message: `No files matching pattern ${fileRegex} found in directory: ${filePath}`,
-      })
-    } else if (matchingFiles.length > 1) {
-      throw new AdapterInputError({
-        statusCode: 500,
-        message: `Multiple files matching pattern ${fileRegex} found in directory: ${filePath}.`,
-      })
-    }
-    const fullPath = `${filePath}${matchingFiles[0]}`
-
-    // Log the download attempt
-    logger.info(`Downloading file: ${fullPath}`)
-
-    const fileContent = await this.sftpClient.get(fullPath)
     // we need latin1 here because the file contains special characters like "®"
     const csvContent = fileContent.toString('latin1')
 
@@ -193,7 +118,13 @@ export class SftpTransport extends SubscriptionTransport<BaseEndpointTypes> {
       })
     }
 
-    return (await parser.parse(csvContent)) as IndexResponseData
+    const { result, parsedData } = await parser.parse(csvContent)
+
+    return {
+      filename,
+      result,
+      parsedData: parsedData as IndexResponseData,
+    }
   }
 
   getSubscriptionTtlFromConfig(adapterSettings: BaseEndpointTypes['Settings']): number {

packages/sources/ftse-sftp/test/fixtures/index.ts

@@ -1,5 +1,6 @@
 import fs from 'fs'
 import path from 'path'
+import { FileInfo } from 'ssh2-sftp-client'
 
 // Helper function to read fixture files
 export function readFixtureFile(filename: string): string {
@@ -24,23 +25,26 @@ export const expectedRussellData = {
   close: 3547.4,
 }
 
-// Test data generation helpers
-export const createFTSETestData = (dataRows: string[]): string => {
-  const header = `02/09/2025 (C) FTSE International Limited 2025. All Rights Reserved
-FTSE UK All-Share Indices Valuation Service
+export const ftseFilename = 'ukallv0209.csv'
+export const russellFilename = 'daily_values_russell_250827.CSV'
 
-Index Code,Index/Sector Name,Number of Constituents,Index Base Currency,USD Index,GBP Index,EUR Index,JPY Index,AUD Index,CNY Index,HKD Index,CAD Index,LOC Index,Base Currency (GBP) Index,USD TRI,GBP TRI,EUR TRI,JPY TRI,AUD TRI,CNY TRI,HKD TRI,CAD TRI,LOC TRI,Base Currency (GBP) TRI,Mkt Cap (USD),Mkt Cap (GBP),Mkt Cap (EUR),Mkt Cap (JPY),Mkt Cap (AUD),Mkt Cap (CNY),Mkt Cap (HKD),Mkt Cap (CAD),Mkt Cap (LOC),Mkt Cap Base Currency (GBP),XD Adjustment (YTD),Dividend Yield`
+export const ftseDirectory = '/data/valuation/uk_all_share/'
+export const russellDirectory =
+  '/data/Returns_and_Values/Russell_US_Indexes_Daily_Index_Values_Real_Time_TXT/'
 
-  return header + '\n' + dataRows.join('\n')
+export const fileContents: Record<string, string> = {
+  [path.join(ftseDirectory, ftseFilename)]: ftseCsvFixture,
+  [path.join(russellDirectory, russellFilename)]: russellCsvFixture,
 }
 
-export const createRussellTestData = (dataRows: string[]): string => {
-  const header = `"Daily Values",,,,,,,,,,,,,,
-,,,,,,,,,,,,,,
-,,,,,,,,,,,,,,
-"As of August 27, 2025",,,,,,,,"Last 5 Trading Days",,,,"1 Year Ending",,
-,,,,,,,,"Closing Values",,,,"Closing Values",,
-,"Open","High","Low","Close","Net Chg","% Chg","High","Low","Net Chg","% Chg","High","Low","Net Chg","% Chg"`
-
-  return header + '\n' + dataRows.join('\n')
-}
+export const directoryListings = {
+  [ftseDirectory]: [
+    'vall_icb2302.csv',
+    'vall1809.csv',
+    'valllst.csv',
+    ftseFilename,
+    'ukallvlst.csv',
+    'vall_icb2302_v1.csv',
+  ].map((name) => ({ name })),
+  [russellDirectory]: ['history', russellFilename].map((name) => ({ name })),
+} as unknown as Record<string, FileInfo[]>