account-lookup-service 15.5.0-iso.0

package/src/lib/argv.js

@@ -0,0 +1,39 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * Crosslake
+ - Lewis daly <lewisd@crosslaketech.com>
+ --------------
+ ******/
+
+/**
+ * @name getArgs
+ *
+ * @description Provide a mockable way to override the process.argv
+ *
+ * @returns {Array<String>} - A list of the process args
+ */
+const getArgs = () => {
+  return process.argv
+}
+
+module.exports = {
+  getArgs
+}

package/src/lib/cache.js

@@ -0,0 +1,126 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ * Name Surname <name.surname@gatesfoundation.com>
+
+ * Kevin Leyow <kevin.leyow@infitx.com>
+
+ --------------
+ ******/
+
+'use strict'
+
+const CatboxMemory = require('@hapi/catbox-memory')
+const Config = require('../lib/config')
+
+let enabled = true
+let ttl
+let catboxMemoryClient = null
+
+class CacheClient {
+  constructor (meta) {
+    this.meta = meta
+  }
+
+  getMeta () {
+    return this.meta
+  }
+
+  createKey (id) {
+    return {
+      segment: this.meta.id,
+      id
+    }
+  }
+
+  get (key) {
+    if (enabled) {
+      return catboxMemoryClient.get(key)
+    }
+    return null
+  }
+
+  set (key, value) {
+    catboxMemoryClient.set(key, value, parseInt(ttl))
+  }
+
+  drop (key) {
+    catboxMemoryClient.drop(key)
+  }
+}
+
+/*
+  Each client should register itself during module load.
+  The client meta should be:
+  {
+    id [MANDATORY]
+    preloadCache() [OPTIONAL]
+      this will be called to preload data
+  }
+*/
+let cacheClients = {}
+
+const registerCacheClient = (clientMeta) => {
+  const newClient = new CacheClient(clientMeta)
+  cacheClients[clientMeta.id] = newClient
+  return newClient
+}
+
+const initCache = async function () {
+  // Read config
+  ttl = Config.GENERAL_CACHE_CONFIG.EXPIRES_IN_MS
+  enabled = Config.GENERAL_CACHE_CONFIG.CACHE_ENABLED
+
+  // Init catbox.
+  catboxMemoryClient = new CatboxMemory.Engine({
+    maxByteSize: Config.GENERAL_CACHE_CONFIG.MAX_BYTE_SIZE
+  })
+  await catboxMemoryClient.start()
+
+  for (const clientId in cacheClients) {
+    const clientMeta = cacheClients[clientId].getMeta()
+    await clientMeta.preloadCache()
+  }
+}
+
+const destroyCache = async function () {
+  await catboxMemoryClient.stop()
+  catboxMemoryClient = null
+}
+
+const dropClients = function () {
+  cacheClients = {}
+}
+
+const isCacheEnabled = function () {
+  return enabled
+}
+
+module.exports = {
+  // Clients registration
+  registerCacheClient,
+
+  // Init & destroy the cache
+  initCache,
+  destroyCache,
+  isCacheEnabled,
+
+  // exposed for tests
+  CatboxMemory,
+  dropClients
+}

package/src/lib/config.js

@@ -0,0 +1,183 @@
+/*****
+ * @file This registers all handlers for the central-ledger API
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * Rajiv Mothilal <rajiv.mothilal@modusbox.com>
+
+ --------------
+ ******/
+const fs = require('node:fs')
+const RC = require('parse-strings-in-object')(require('rc')('ALS', require('../../config/default.json')))
+const { storageTypeValues } = require('@mojaloop/inter-scheme-proxy-cache-lib')
+
+function getFileContent (path) {
+  if (!fs.existsSync(path)) {
+    console.log(`File ${path} doesn't exist, can't enable JWS signing`)
+    throw new Error('File doesn\'t exist')
+  }
+  return fs.readFileSync(path)
+}
+
+const getOrDefault = (value, defaultValue) => {
+  if (value === undefined) {
+    return defaultValue
+  }
+
+  return value
+}
+
+const DEFAULT_PROTOCOL_VERSION = {
+  CONTENT: {
+    DEFAULT: '1.1',
+    VALIDATELIST: [
+      '1.0',
+      '1.1'
+    ]
+  },
+  ACCEPT: {
+    DEFAULT: '1',
+    VALIDATELIST: [
+      '1',
+      '1.0',
+      '1.1'
+    ]
+  }
+}
+
+const getProtocolVersions = (defaultProtocolVersions, overrideProtocolVersions) => {
+  const T_PROTOCOL_VERSION = {
+    ...defaultProtocolVersions,
+    ...overrideProtocolVersions
+  }
+
+  if (overrideProtocolVersions && overrideProtocolVersions.CONTENT) {
+    T_PROTOCOL_VERSION.CONTENT = {
+      ...defaultProtocolVersions.CONTENT,
+      ...overrideProtocolVersions.CONTENT
+    }
+  }
+  if (overrideProtocolVersions && overrideProtocolVersions.ACCEPT) {
+    T_PROTOCOL_VERSION.ACCEPT = {
+      ...defaultProtocolVersions.ACCEPT,
+      ...overrideProtocolVersions.ACCEPT
+    }
+  }
+
+  if (T_PROTOCOL_VERSION.CONTENT &&
+    T_PROTOCOL_VERSION.CONTENT.VALIDATELIST &&
+    (typeof T_PROTOCOL_VERSION.CONTENT.VALIDATELIST === 'string' ||
+      T_PROTOCOL_VERSION.CONTENT.VALIDATELIST instanceof String)) {
+    T_PROTOCOL_VERSION.CONTENT.VALIDATELIST = JSON.parse(T_PROTOCOL_VERSION.CONTENT.VALIDATELIST)
+  }
+  if (T_PROTOCOL_VERSION.ACCEPT &&
+    T_PROTOCOL_VERSION.ACCEPT.VALIDATELIST &&
+    (typeof T_PROTOCOL_VERSION.ACCEPT.VALIDATELIST === 'string' ||
+      T_PROTOCOL_VERSION.ACCEPT.VALIDATELIST instanceof String)) {
+    T_PROTOCOL_VERSION.ACCEPT.VALIDATELIST = JSON.parse(T_PROTOCOL_VERSION.ACCEPT.VALIDATELIST)
+  }
+  return T_PROTOCOL_VERSION
+}
+
+if (RC.PROXY_CACHE?.enabled && !storageTypeValues.includes(RC.PROXY_CACHE.type)) {
+  throw new TypeError(`Incorrect proxyCache type: ${RC.PROXY_CACHE.type}`)
+}
+
+const config = {
+  HUB_ID: RC.HUB_PARTICIPANT.ID,
+  HUB_NAME: RC.HUB_PARTICIPANT.NAME,
+  API_PORT: RC.API_PORT,
+  API_TYPE: RC.API_TYPE, // 'fspiop' or 'iso20022'
+  DATABASE: {
+    client: RC.DATABASE.DIALECT,
+    connection: {
+      host: RC.DATABASE.HOST.replace(/\/$/, ''),
+      port: RC.DATABASE.PORT,
+      user: RC.DATABASE.USER,
+      password: RC.DATABASE.PASSWORD,
+      database: RC.DATABASE.DATABASE
+    },
+    pool: {
+      // minimum size
+      min: getOrDefault(RC.DATABASE.POOL_MIN_SIZE, 2),
+
+      // maximum size
+      max: getOrDefault(RC.DATABASE.POOL_MAX_SIZE, 10),
+      // acquire promises are rejected after this many milliseconds
+      // if a resource cannot be acquired
+      acquireTimeoutMillis: getOrDefault(RC.DATABASE.ACQUIRE_TIMEOUT_MILLIS, 30000),
+
+      // create operations are cancelled after this many milliseconds
+      // if a resource cannot be acquired
+      createTimeoutMillis: getOrDefault(RC.DATABASE.CREATE_TIMEOUT_MILLIS, 3000),
+
+      // destroy operations are awaited for at most this many milliseconds
+      // new resources will be created after this timeout
+      destroyTimeoutMillis: getOrDefault(RC.DATABASE.DESTROY_TIMEOUT_MILLIS, 5000),
+
+      // free resouces are destroyed after this many milliseconds
+      idleTimeoutMillis: getOrDefault(RC.DATABASE.IDLE_TIMEOUT_MILLIS, 30000),
+
+      // how often to check for idle resources to destroy
+      reapIntervalMillis: getOrDefault(RC.DATABASE.REAP_INTERVAL_MILLIS, 1000),
+
+      // long long to idle after failed create before trying again
+      createRetryIntervalMillis: getOrDefault(RC.DATABASE.CREATE_RETRY_INTERVAL_MILLIS, 20)
+      // ping: function (conn, cb) { conn.query('SELECT 1', cb) }
+    },
+    debug: getOrDefault(RC.DATABASE.DEBUG, false)
+  },
+  DISPLAY_ROUTES: RC.DISPLAY_ROUTES,
+  RUN_MIGRATIONS: RC.RUN_MIGRATIONS,
+  ADMIN_PORT: RC.ADMIN_PORT,
+  CENTRAL_SHARED_ENDPOINT_CACHE_CONFIG: RC.CENTRAL_SHARED_ENDPOINT_CACHE_CONFIG,
+  CENTRAL_SHARED_PARTICIPANT_CACHE_CONFIG: RC.CENTRAL_SHARED_PARTICIPANT_CACHE_CONFIG,
+  GENERAL_CACHE_CONFIG: RC.GENERAL_CACHE_CONFIG,
+  HANDLERS: RC.HANDLERS,
+  HANDLERS_DISABLED: RC.HANDLERS.DISABLED,
+  HANDLERS_MONITORING_PORT: RC.HANDLERS.MONITORING_PORT,
+  HANDLERS_TIMEOUT: RC.HANDLERS.TIMEOUT,
+  HANDLERS_TIMEOUT_DISABLED: RC.HANDLERS.TIMEOUT.DISABLED,
+  HANDLERS_TIMEOUT_TIMEXP: RC.HANDLERS.TIMEOUT.TIMEXP,
+  HANDLERS_TIMEOUT_TIMEZONE: RC.HANDLERS.TIMEOUT.TIMEZONE,
+  HANDLERS_TIMEOUT_BATCH_SIZE: RC.HANDLERS.TIMEOUT.BATCH_SIZE,
+  ERROR_HANDLING: RC.ERROR_HANDLING,
+  SWITCH_ENDPOINT: RC.SWITCH_ENDPOINT,
+  INSTRUMENTATION_METRICS_DISABLED: RC.INSTRUMENTATION.METRICS.DISABLED,
+  INSTRUMENTATION_METRICS_LABELS: RC.INSTRUMENTATION.METRICS.labels,
+  INSTRUMENTATION_METRICS_CONFIG: RC.INSTRUMENTATION.METRICS.config,
+  JWS_SIGN: RC.ENDPOINT_SECURITY.JWS.JWS_SIGN,
+  FSPIOP_SOURCE_TO_SIGN: RC.HUB_NAME,
+  JWS_SIGNING_KEY_PATH: RC.ENDPOINT_SECURITY.JWS.JWS_SIGNING_KEY_PATH,
+  API_DOC_ENDPOINTS_ENABLED: RC.API_DOC_ENDPOINTS_ENABLED || false,
+  FEATURE_ENABLE_EXTENDED_PARTY_ID_TYPE: RC.FEATURE_ENABLE_EXTENDED_PARTY_ID_TYPE || false,
+  PROTOCOL_VERSIONS: getProtocolVersions(DEFAULT_PROTOCOL_VERSION, RC.PROTOCOL_VERSIONS),
+  PROXY_CACHE_CONFIG: RC.PROXY_CACHE,
+  proxyMap: RC.PROXY_MAP
+}
+
+if (config.JWS_SIGN) {
+  config.JWS_SIGNING_KEY = getFileContent(config.JWS_SIGNING_KEY_PATH)
+}
+
+module.exports = config

package/src/lib/db.js

@@ -0,0 +1,26 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * Rajiv Mothilal <rajiv.mothilal@modusbox.com>
+ --------------
+ ******/
+'use strict'
+
+module.exports = require('@mojaloop/database-lib').Db

package/src/lib/headers.js

@@ -0,0 +1,53 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * Steven Oderayi <steven.oderayi@modusbox.com>
+
+ --------------
+ ******/
+'use strict'
+
+const Mustache = require('mustache')
+const Enums = require('@mojaloop/central-services-shared').Enum
+const Config = require('../lib/config')
+
+/**
+ * @function createErrorCallbackHeaders
+ * @description it returns the FSPIOP headers for error callback
+ * @param {object} params - parameters to the function with the shape `{ requestHeaders, partyIdType, partyIdentifier, endpointTemplate }`
+ *
+ * @returns {object} - FSPIOP callback headers merged with the request headers passed in `params.requestHeaders`
+ */
+exports.createCallbackHeaders = (params) => {
+  const callbackHeaders = { ...params.requestHeaders }
+
+  callbackHeaders[Enums.Http.Headers.FSPIOP.SOURCE] = Config.HUB_NAME
+  callbackHeaders[Enums.Http.Headers.FSPIOP.DESTINATION] = params.requestHeaders[Enums.Http.Headers.FSPIOP.SOURCE]
+  callbackHeaders[Enums.Http.Headers.FSPIOP.HTTP_METHOD] = Enums.Http.RestMethods.PUT
+  callbackHeaders[Enums.Http.Headers.FSPIOP.URI] = Mustache.render(params.endpointTemplate, {
+    partyIdType: params.partyIdType, partyIdentifier: params.partyIdentifier
+  })
+
+  return callbackHeaders
+}

package/src/lib/healthCheck/subServiceHealth.js

@@ -0,0 +1,84 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * Lewis Daly <lewis@vesselstech.com>
+ --------------
+ ******/
+'use strict'
+
+const { statusEnum, serviceName } = require('@mojaloop/central-services-shared').HealthCheck.HealthCheckEnums
+const Logger = require('@mojaloop/central-services-logger')
+
+const MigrationLockModel = require('../../models/misc/migrationLock')
+
+/**
+ * @function getSubServiceHealthDatastore
+ *
+ * @description Gets the health of the Datastore by ensuring the table is currently locked
+ * in a migration state. This implicity checks the connection with the database.
+ *
+ * @returns Promise<SubServiceHealth> The SubService health object for the datastore
+ */
+const getSubServiceHealthDatastore = async () => {
+  let status = statusEnum.OK
+
+  try {
+    const isLocked = await MigrationLockModel.getIsMigrationLocked()
+    if (isLocked) {
+      status = statusEnum.DOWN
+    }
+  } catch (err) {
+    Logger.isDebugEnabled && Logger.debug(`getSubServiceHealthDatastore failed with error ${err.message}.`)
+    status = statusEnum.DOWN
+  }
+
+  return {
+    name: serviceName.datastore,
+    status
+  }
+}
+
+/**
+ * @function getProxyCacheHealth
+ *
+ * @description Gets the health of the proxy cache by checking the connection to the cache.
+ *
+ * @returns Promise<SubServiceHealth> The SubService health object for the proxy cache
+ */
+const getProxyCacheHealth = async (proxyCache) => {
+  let status = statusEnum.OK
+
+  try {
+    status = await proxyCache.healthCheck() ? statusEnum.OK : statusEnum.DOWN
+  } catch (err) {
+    Logger.isDebugEnabled && Logger.debug(`getProxyCacheHealth failed with error ${err.message}.`)
+    status = statusEnum.DOWN
+  }
+
+  return {
+    name: serviceName.proxyCache,
+    status
+  }
+}
+
+module.exports = {
+  getSubServiceHealthDatastore,
+  getProxyCacheHealth
+}

package/src/lib/index.js

@@ -0,0 +1,11 @@
+const { loggerFactory, asyncStorage } = require('@mojaloop/central-services-logger/src/contextLogger')
+const { TransformFacades } = require('@mojaloop/ml-schema-transformer-lib')
+
+const logger = loggerFactory('ALS') // global logger without context
+
+module.exports = {
+  logger,
+  loggerFactory,
+  asyncStorage,
+  TransformFacades
+}

package/src/lib/migrator.js

@@ -0,0 +1,17 @@
+'use strict'
+
+const Path = require('path')
+const Migrations = require('@mojaloop/database-lib').Migrations
+const Knexfile = require('../../config/knexfile')
+
+const updateMigrationsLocation = (kf) => {
+  const parsedMigrationDir = Path.parse(kf.migrations.directory)
+  kf.migrations.directory = Path.join(process.cwd(), parsedMigrationDir.base)
+  const parsedSeedsDir = Path.parse(kf.seeds.directory)
+  kf.seeds.directory = Path.join(process.cwd(), parsedSeedsDir.base)
+  return kf
+}
+
+exports.migrate = async function () {
+  return Migrations.migrate(updateMigrationsLocation(Knexfile))
+}

package/src/lib/requestLogger.js

@@ -0,0 +1,54 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+
+ * Rajiv Mothilal <rajiv.mothilal@modusbox.com>
+
+ --------------
+ ******/
+
+'use strict'
+
+const { logger, asyncStorage } = require('./index')
+
+const logRequest = function (request) {
+  const { path, method, headers, payload, query } = request
+  const requestId = request.info.id = `${request.info.id}__${headers.traceid}`
+  asyncStorage.enterWith({ requestId })
+
+  logger.isInfoEnabled && logger.info(`[==> req] ${method.toUpperCase()} ${path}`, { headers, payload, query })
+}
+
+const logResponse = function (request) {
+  if (logger.isInfoEnabled) {
+    const { path, method, headers, payload, query, response } = request
+    const { received } = request.info
+
+    const statusCode = response instanceof Error
+      ? response.output?.statusCode
+      : response.statusCode
+    const respTimeSec = ((Date.now() - received) / 1000).toFixed(3)
+
+    logger.info(`[<== ${statusCode}][${respTimeSec} s] ${method.toUpperCase()} ${path}`, { headers, payload, query })
+  }
+}
+
+module.exports = {
+  logRequest,
+  logResponse
+}

package/src/lib/util.js

@@ -0,0 +1,66 @@
+const util = require('util')
+const Path = require('path')
+const Enum = require('@mojaloop/central-services-shared').Enum
+const { HeaderValidation, Hapi } = require('@mojaloop/central-services-shared').Util
+const Config = require('../lib/config')
+
+const getSpanTags = ({ headers }, transactionType, transactionAction) => {
+  const tags = {
+    transactionType,
+    transactionAction
+  }
+  if (headers && headers[Enum.Http.Headers.FSPIOP.SOURCE]) {
+    tags.source = headers[Enum.Http.Headers.FSPIOP.SOURCE]
+  }
+  if (headers && headers[Enum.Http.Headers.FSPIOP.DESTINATION]) {
+    tags.destination = headers[Enum.Http.Headers.FSPIOP.DESTINATION]
+  }
+  return tags
+}
+
+const pathForInterface = ({ isAdmin, isMockInterface }) => {
+  let apiFile
+  let pathFolder
+
+  if (Config.FEATURE_ENABLE_EXTENDED_PARTY_ID_TYPE) {
+    pathFolder = '../interface/thirdparty/'
+  } else {
+    pathFolder = '../interface/'
+  }
+
+  if (isAdmin) {
+    if (isMockInterface) {
+      apiFile = 'admin_swagger.json'
+    } else {
+      apiFile = 'admin-swagger.yaml'
+    }
+  } else {
+    if (isMockInterface) {
+      apiFile = 'api_swagger.json'
+    } else {
+      apiFile = Config.API_TYPE === Hapi.API_TYPES.iso20022
+        ? 'api-swagger-iso20022-parties.yaml'
+        : 'api-swagger.yaml'
+    }
+  }
+  return Path.resolve(__dirname, pathFolder + apiFile)
+}
+
+/**
+ * @function getStackOrInspect
+ * @description Gets the error stack, or uses util.inspect to inspect the error
+ * @param {*} err - An error object
+ */
+function getStackOrInspect (err) {
+  return err?.stack || util.inspect(err)
+}
+
+module.exports = {
+  getSpanTags,
+  pathForInterface,
+  getStackOrInspect,
+  hubNameConfig: {
+    hubName: Config.HUB_NAME,
+    hubNameRegex: HeaderValidation.getHubNameRegex(Config.HUB_NAME)
+  }
+}