account-lookup-service 15.5.0-iso.0

package/src/models/oracle/facade.js

@@ -0,0 +1,341 @@
+/*****
+ 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>
+ * Steven Oderayi <steven.oderayi@modusbox.com>
+
+ --------------
+ ******/
+
+'use strict'
+
+const Mustache = require('mustache')
+const request = require('@mojaloop/central-services-shared').Util.Request
+const Enums = require('@mojaloop/central-services-shared').Enum
+const Logger = require('@mojaloop/central-services-logger')
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const Metrics = require('@mojaloop/central-services-metrics')
+
+const Config = require('../../lib/config')
+const oracleEndpointCached = require('../oracle/oracleEndpointCached')
+const { hubNameRegex } = require('../../lib/util').hubNameConfig
+
+/**
+ * @function oracleRequest
+ *
+ * @description This sends a request to the oracles that are registered to the ALS
+ *
+ * @param {object} headers - incoming http request headers
+ * @param {string} method - incoming http request method
+ * @param {object} params - uri parameters of the http request
+ * @param {object} query - the query parameter on the uri of the http request
+ * @param {object} payload - payload of the request being sent out
+ *
+ * @returns {object} returns the response from the oracle
+ */
+exports.oracleRequest = async (headers, method, params = {}, query = {}, payload = undefined, cache) => {
+  try {
+    let url
+    const partyIdType = params.Type
+    const partyIdentifier = params.ID
+    const currency = (payload && payload.currency) ? payload.currency : (query && query.currency) ? query.currency : undefined
+    const partySubIdOrType = (params && params.SubId) ? params.SubId : (query && query.partySubIdOrType) ? query.partySubIdOrType : undefined
+    const isGetRequest = method.toUpperCase() === Enums.Http.RestMethods.GET
+    if (currency && partySubIdOrType && isGetRequest) {
+      url = await _getOracleEndpointByTypeCurrencyAndSubId(partyIdType, partyIdentifier, currency, partySubIdOrType)
+    } else if (currency && isGetRequest) {
+      url = await _getOracleEndpointByTypeAndCurrency(partyIdType, partyIdentifier, currency)
+    } else if (partySubIdOrType && isGetRequest) {
+      url = await _getOracleEndpointByTypeAndSubId(partyIdType, partyIdentifier, partySubIdOrType)
+    } else {
+      url = await _getOracleEndpointByType(partyIdType, partyIdentifier)
+      if (partySubIdOrType) {
+        payload = { ...payload, partySubIdOrType }
+      }
+    }
+    Logger.isDebugEnabled && Logger.debug(`Oracle endpoints: ${url}`)
+    const histTimerEnd = Metrics.getHistogram(
+      'egress_oracleRequest',
+      'Egress: oracleRequest',
+      ['success', 'hit']
+    ).startTimer()
+    try {
+      if (isGetRequest) {
+        let cachedOracleFspResponse
+        cachedOracleFspResponse = cache && cache.get(cache.createKey(`oracleSendRequest_${url}`))
+        if (!cachedOracleFspResponse) {
+          cachedOracleFspResponse = await request.sendRequest({
+            url,
+            headers,
+            source: headers[Enums.Http.Headers.FSPIOP.SOURCE],
+            destination: headers[Enums.Http.Headers.FSPIOP.DESTINATION] || Config.HUB_NAME,
+            method: method.toUpperCase(),
+            payload,
+            hubNameRegex
+          })
+          // Trying to cache the whole response object will fail because it contains circular references
+          // so we'll just cache the data property of the response.
+          cachedOracleFspResponse = {
+            data: cachedOracleFspResponse.data
+          }
+          cache && cache.set(
+            cache.createKey(`oracleSendRequest_${url}`),
+            cachedOracleFspResponse
+          )
+          histTimerEnd({ success: true, hit: false })
+        } else {
+          cachedOracleFspResponse = cachedOracleFspResponse.item
+          histTimerEnd({ success: true, hit: true })
+          Logger.isDebugEnabled && Logger.debug(`${new Date().toISOString()}, [oracleRequest]: cache hit for fsp for partyId lookup`)
+        }
+
+        return cachedOracleFspResponse
+      }
+
+      return await request.sendRequest({
+        url,
+        headers,
+        source: headers[Enums.Http.Headers.FSPIOP.SOURCE],
+        destination: headers[Enums.Http.Headers.FSPIOP.DESTINATION] || Config.HUB_NAME,
+        method: method.toUpperCase(),
+        payload,
+        hubNameRegex
+      })
+    } catch (err) {
+      histTimerEnd({ success: false, hit: false })
+      throw err
+    }
+  } catch (err) {
+    Logger.isErrorEnabled && Logger.error(`error in oracleRequest: ${err?.stack}`)
+    // If the error was a 400 from the Oracle, we'll modify the error to generate a response to the
+    // initiator of the request.
+    if (
+      err.name === 'FSPIOPError' &&
+      err.apiErrorCode.code === ErrorHandler.Enums.FSPIOPErrorCodes.DESTINATION_COMMUNICATION_ERROR.code
+    ) {
+      if (err.extensions.some(ext => (ext.key === 'status' && ext.value === Enums.Http.ReturnCodes.BADREQUEST.CODE))) {
+        throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.PARTY_NOT_FOUND)
+        // Added error 404 to cover a special case of the Mowali implementation
+        // which uses mojaloop/als-oracle-pathfinder and currently returns 404
+        // and in which case the Mowali implementation expects back `DESTINATION_FSP_ERROR`.
+      } else if (err.extensions.some(ext => (ext.key === 'status' && ext.value === Enums.Http.ReturnCodes.NOTFOUND.CODE))) {
+        throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.DESTINATION_FSP_ERROR)
+      }
+    }
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+/**
+ * @function _getOracleEndpointByTypeAndCurrency
+ *
+ * @description Retirieves and returns the URL to an oracle by partyIdType and currency
+ *
+ * @param {string} partyIdType - party ID type (e.g MSISDN)
+ * @param {string} partyIdentifier - party ID
+ * @param {string} currency - currency ID
+ *
+ * @returns {string} returns the endpoint to the oracle
+ */
+const _getOracleEndpointByTypeAndCurrency = async (partyIdType, partyIdentifier, currency) => {
+  let url
+  const oracleEndpointModel = await oracleEndpointCached.getOracleEndpointByTypeAndCurrency(partyIdType, currency)
+  if (oracleEndpointModel.length > 0) {
+    if (oracleEndpointModel.length > 1) {
+      const defautOracle = oracleEndpointModel.filter(oracle => oracle.isDefault).pop()
+      if (defautOracle) {
+        url = Mustache.render(
+          defautOracle.value + Enums.EndPoints.FspEndpointTemplates.ORACLE_PARTICIPANTS_TYPE_ID_CURRENCY,
+          { partyIdType, partyIdentifier, currency }
+        )
+      }
+    } else {
+      url = Mustache.render(
+        oracleEndpointModel[0].value + Enums.EndPoints.FspEndpointTemplates.ORACLE_PARTICIPANTS_TYPE_ID_CURRENCY,
+        { partyIdType, partyIdentifier, currency }
+      )
+    }
+  } else {
+    Logger.isErrorEnabled && Logger.error(`Oracle type:${partyIdType} and currency:${currency} not found`)
+    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, `Oracle type:${partyIdType} and currency:${currency} not found`).toApiErrorObject(Config.ERROR_HANDLING)
+  }
+  return url
+}
+
+/**
+ * @function _getOracleEndpointByType
+ *
+ * @description Retrieves and returns the URL to an oracle by partyIdType
+ *
+ * @param {string} partyIdType - party ID type (e.g MSISDN)
+ * @param {string} partyIdentifier - party ID
+ *
+ * @returns {string} returns the endpoint to the oracle
+ */
+const _getOracleEndpointByType = async (partyIdType, partyIdentifier) => {
+  let url
+  const oracleEndpointModel = await oracleEndpointCached.getOracleEndpointByType(partyIdType)
+  if (oracleEndpointModel.length > 0) {
+    if (oracleEndpointModel.length > 1) {
+      const defaultOracle = oracleEndpointModel.filter(oracle => oracle.isDefault).pop()
+      if (defaultOracle) {
+        url = Mustache.render(
+          defaultOracle.value + Enums.EndPoints.FspEndpointTemplates.ORACLE_PARTICIPANTS_TYPE_ID,
+          { partyIdType, partyIdentifier }
+        )
+      }
+    } else {
+      url = Mustache.render(
+        oracleEndpointModel[0].value + Enums.EndPoints.FspEndpointTemplates.ORACLE_PARTICIPANTS_TYPE_ID,
+        { partyIdType, partyIdentifier }
+      )
+    }
+  } else {
+    Logger.isErrorEnabled && Logger.error(`Oracle type:${partyIdType} not found`)
+    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, `Oracle type: ${partyIdType} not found`)
+  }
+  return url
+}
+
+/**
+ * @function _getOracleEndpointByTypeAndSubId
+ *
+ * @description Retrieves and returns the URL to an oracle by partyIdType and subId
+ *
+ * @param {string} partyIdType - party ID type (e.g MSISDN)
+ * @param {string} partyIdentifier - party ID
+ * @param {string} partySubIdOrType - party subId
+ *
+ * @returns {string} returns the endpoint to the oracle
+ */
+const _getOracleEndpointByTypeAndSubId = async (partyIdType, partyIdentifier, partySubIdOrType) => {
+  let url
+  const oracleEndpointModel = await oracleEndpointCached.getOracleEndpointByType(partyIdType)
+  if (oracleEndpointModel.length > 0) {
+    if (oracleEndpointModel.length > 1) {
+      const defautOracle = oracleEndpointModel.filter(oracle => oracle.isDefault).pop()
+      if (defautOracle) {
+        url = Mustache.render(
+          defautOracle.value + Enums.EndPoints.FspEndpointTemplates.ORACLE_PARTICIPANTS_TYPE_ID_SUB_ID,
+          { partyIdType, partyIdentifier, partySubIdOrType }
+        )
+      }
+    } else {
+      url = Mustache.render(
+        oracleEndpointModel[0].value + Enums.EndPoints.FspEndpointTemplates.ORACLE_PARTICIPANTS_TYPE_ID_SUB_ID,
+        { partyIdType, partyIdentifier, partySubIdOrType }
+      )
+    }
+  } else {
+    Logger.isErrorEnabled && Logger.error(`Oracle type: ${partyIdType} and subId: ${partySubIdOrType} not found`)
+    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, `Oracle type: ${partyIdType} and subId: ${partySubIdOrType} not found`).toApiErrorObject(Config.ERROR_HANDLING)
+  }
+  return url
+}
+
+/**
+ * @function _getOracleEndpointByTypeCurrencyAndSubId
+ *
+ * @description Retirieves and returns the URL to an oracle by partyIdType and currency
+ *
+ * @param {string} partyIdType - party ID type (e.g MSISDN)
+ * @param {string} partyIdentifier - party ID
+ * @param {string} currency - currency ID
+ * @param {string} partySubIdOrType - party subId
+ *
+ * @returns {string} returns the endpoint to the oracle
+ */
+const _getOracleEndpointByTypeCurrencyAndSubId = async (partyIdType, partyIdentifier, currency, partySubIdOrType) => {
+  let url
+  const oracleEndpointModel = await oracleEndpointCached.getOracleEndpointByTypeAndCurrency(partyIdType, currency)
+  if (oracleEndpointModel.length > 0) {
+    if (oracleEndpointModel.length > 1) {
+      const defautOracle = oracleEndpointModel.filter(oracle => oracle.isDefault).pop()
+      if (defautOracle) {
+        url = Mustache.render(
+          defautOracle.value + Enums.EndPoints.FspEndpointTemplates.ORACLE_PARTICIPANTS_TYPE_ID_CURRENCY_SUB_ID,
+          { partyIdType, partyIdentifier, currency, partySubIdOrType }
+        )
+      }
+    } else {
+      url = Mustache.render(
+        oracleEndpointModel[0].value + Enums.EndPoints.FspEndpointTemplates.ORACLE_PARTICIPANTS_TYPE_ID_CURRENCY_SUB_ID,
+        { partyIdType, partyIdentifier, currency, partySubIdOrType }
+      )
+    }
+  } else {
+    Logger.isErrorEnabled && Logger.error(`Oracle type: ${partyIdType}, currency: ${currency}, and subId: ${partySubIdOrType} not found`)
+    throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, `Oracle type:${partyIdType}, currency:${currency} and subId: ${partySubIdOrType} not found`).toApiErrorObject(Config.ERROR_HANDLING)
+  }
+  return url
+}
+
+/**
+ * @function oracleBatchRequest
+ *
+ * @description This sends a request to the oracles that are registered to the ALS
+ *
+ * @param {object} headers - incoming http request headers
+ * @param {object} method - incoming http request method
+ * @param {object} requestPayload - the requestPayload from the original request
+ * @param {string} type - oracle type
+ * @param {object} payload - the payload to send in the request
+ *
+ * @returns {object} returns the response from the oracle
+ */
+exports.oracleBatchRequest = async (headers, method, requestPayload, type, payload) => {
+  try {
+    let oracleEndpointModel
+    let url
+    if ((requestPayload && requestPayload.currency && requestPayload.currency.length !== 0)) {
+      oracleEndpointModel = await oracleEndpointCached.getOracleEndpointByTypeAndCurrency(type, requestPayload.currency)
+    } else {
+      oracleEndpointModel = await oracleEndpointCached.getOracleEndpointByType(type)
+    }
+    if (oracleEndpointModel.length > 0) {
+      if (oracleEndpointModel.length > 1) {
+        for (const record of oracleEndpointModel) {
+          if (record.isDefault) {
+            url = record.value + Enums.EndPoints.FspEndpointTemplates.ORACLE_PARTICIPANTS_BATCH
+            break
+          }
+        }
+      } else {
+        url = oracleEndpointModel[0].value + Enums.EndPoints.FspEndpointTemplates.ORACLE_PARTICIPANTS_BATCH
+      }
+      Logger.isDebugEnabled && Logger.debug(`Oracle endpoints: ${url}`)
+      return await request.sendRequest({
+        url,
+        headers,
+        source: headers[Enums.Http.Headers.FSPIOP.SOURCE],
+        destination: headers[Enums.Http.Headers.FSPIOP.DESTINATION] || Config.HUB_NAME,
+        method,
+        payload,
+        hubNameRegex
+      })
+    } else {
+      Logger.isErrorEnabled && Logger.error(`Oracle type:${type} not found`)
+      throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.ADD_PARTY_INFO_ERROR, `Oracle type:${type} not found`)
+    }
+  } catch (err) {
+    Logger.isErrorEnabled && Logger.error(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}

package/src/models/oracle/index.js

@@ -0,0 +1,41 @@
+/*****
+ 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'
+
+const oracleEndpointModel = require('./oracleEndpoint')
+
+module.exports = {
+  getOracleEndpointByType: oracleEndpointModel.getOracleEndpointByType,
+  getOracleEndpointByTypeAndCurrency: oracleEndpointModel.getOracleEndpointByTypeAndCurrency,
+  getOracleEndpointByCurrency: oracleEndpointModel.getOracleEndpointByCurrency,
+  getAllOracleEndpoint: oracleEndpointModel.getAllOracleEndpoint,
+  getAllOracleEndpointsByMatchCondition: oracleEndpointModel.getAllOracleEndpointsByMatchCondition,
+  createOracleEndpoint: oracleEndpointModel.createOracleEndpoint,
+  updateOracleEndpointById: oracleEndpointModel.updateOracleEndpointById,
+  setIsActiveOracleEndpoint: oracleEndpointModel.setIsActiveOracleEndpoint,
+  destroyOracleEndpointById: oracleEndpointModel.destroyOracleEndpointById,
+  getOracleEndpointById: oracleEndpointModel.getOracleEndpointById
+}

package/src/models/oracle/oracleEndpoint.js

@@ -0,0 +1,192 @@
+/*****
+ 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'
+
+const Db = require('../../lib/db')
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+
+const getOracleEndpointByType = async (type) => {
+  try {
+    return Db.from('oracleEndpoint').query(builder => {
+      return builder.innerJoin('endpointType AS et', 'oracleEndpoint.endpointTypeId', 'et.endpointTypeId')
+        .innerJoin('partyIdType AS pt', 'oracleEndpoint.partyIdTypeId', 'pt.partyIdTypeId')
+        .where({
+          'pt.name': type,
+          'pt.isActive': 1,
+          'oracleEndpoint.isActive': 1,
+          'et.isActive': 1
+        })
+        .select('oracleEndpoint.oracleEndpointId', 'et.type as endpointType', 'oracleEndpoint.value',
+          'pt.name as idType', 'oracleEndpoint.currencyId as currency', 'oracleEndpoint.isDefault')
+    })
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const getOracleEndpointByTypeAndCurrency = async (type, currencyId) => {
+  try {
+    return Db.from('oracleEndpoint').query(builder => {
+      return builder.innerJoin('currency AS cu', 'oracleEndpoint.currencyId', 'cu.currencyId')
+        .innerJoin('endpointType AS et', 'oracleEndpoint.endpointTypeId', 'et.endpointTypeId')
+        .innerJoin('partyIdType AS pt', 'oracleEndpoint.partyIdTypeId', 'pt.partyIdTypeId')
+        .where({
+          'pt.name': type,
+          'cu.currencyId': currencyId,
+          'pt.isActive': 1,
+          'oracleEndpoint.isActive': 1,
+          'et.isActive': 1
+        })
+        .select('oracleEndpoint.oracleEndpointId', 'et.type as endpointType', 'oracleEndpoint.value',
+          'pt.name as idType', 'oracleEndpoint.currencyId as currency', 'oracleEndpoint.isDefault')
+    })
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const getOracleEndpointByCurrency = async (currencyId) => {
+  try {
+    return Db.from('oracleEndpoint').query(builder => {
+      return builder.innerJoin('currency AS cu', 'oracleEndpoint.currencyId', 'cu.currencyId')
+        .innerJoin('endpointType AS et', 'oracleEndpoint.endpointTypeId', 'et.endpointTypeId')
+        .innerJoin('partyIdType AS pt', 'oracleEndpoint.partyIdTypeId', 'pt.partyIdTypeId')
+        .where({
+          'cu.currencyId': currencyId,
+          'pt.isActive': 1,
+          'oracleEndpoint.isActive': 1,
+          'et.isActive': 1
+        })
+        .select('oracleEndpoint.oracleEndpointId', 'et.type as endpointType', 'oracleEndpoint.value',
+          'pt.name as idType', 'oracleEndpoint.currencyId as currency', 'oracleEndpoint.isDefault')
+    })
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const getOracleEndpointById = async (oracleEndpointId) => {
+  try {
+    return Db.from('oracleEndpoint').query(builder => {
+      return builder.innerJoin('currency AS cu', 'oracleEndpoint.currencyId', 'cu.currencyId')
+        .innerJoin('endpointType AS et', 'oracleEndpoint.endpointTypeId', 'et.endpointTypeId')
+        .innerJoin('partyIdType AS pt', 'oracleEndpoint.partyIdTypeId', 'pt.partyIdTypeId')
+        .where({
+          'oracleEndpoint.oracleEndpointId': oracleEndpointId,
+          'pt.isActive': 1,
+          'oracleEndpoint.isActive': 1,
+          'et.isActive': 1
+        })
+        .select('oracleEndpoint.oracleEndpointId', 'et.type as endpointType', 'oracleEndpoint.value',
+          'pt.name as idType', 'oracleEndpoint.currencyId as currency', 'oracleEndpoint.isDefault')
+    })
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const getAllOracleEndpoint = async () => {
+  try {
+    return Db.from('oracleEndpoint').query(builder => {
+      return builder.innerJoin('endpointType AS et', 'oracleEndpoint.endpointTypeId', 'et.endpointTypeId')
+        .innerJoin('partyIdType AS pt', 'oracleEndpoint.partyIdTypeId', 'pt.partyIdTypeId')
+        .where({
+          'pt.isActive': 1,
+          'oracleEndpoint.isActive': 1,
+          'et.isActive': 1
+        })
+        .select('oracleEndpoint.oracleEndpointId', 'et.type as endpointType', 'oracleEndpoint.value',
+          'pt.name as idType', 'oracleEndpoint.currencyId as currency', 'oracleEndpoint.isDefault')
+    })
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const getAllOracleEndpointsByMatchCondition = async (oracleEndpointModel, partyIdTypeId, endpointTypeId) => {
+  try {
+    return Db.from('oracleEndpoint').query(builder => {
+      return builder.innerJoin('endpointType AS et', 'oracleEndpoint.endpointTypeId', 'et.endpointTypeId')
+        .innerJoin('partyIdType AS pt', 'oracleEndpoint.partyIdTypeId', 'pt.partyIdTypeId')
+        .where({
+          'oracleEndpoint.currencyId': oracleEndpointModel.currency,
+          'et.endpointTypeId': endpointTypeId,
+          'pt.partyIdTypeId': partyIdTypeId,
+          'oracleEndpoint.isActive': 1
+        })
+        .select('oracleEndpoint.oracleEndpointId', 'et.type as endpointType', 'oracleEndpoint.value',
+          'pt.name as idType', 'oracleEndpoint.currencyId as currency', 'oracleEndpoint.isDefault',
+          'oracleEndpoint.isActive', 'oracleEndpoint.partyIdTypeId', 'oracleEndpoint.endpointTypeId', 'oracleEndpoint.currencyId')
+    })
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const createOracleEndpoint = async (oracleEndpointModel) => {
+  try {
+    return await Db.from('oracleEndpoint').insert(oracleEndpointModel)
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const updateOracleEndpointById = async (id, oracleEndpointModel) => {
+  try {
+    return await Db.from('oracleEndpoint').update({ oracleEndpointId: id }, oracleEndpointModel)
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const setIsActiveOracleEndpoint = async (oracleType, isActive) => {
+  try {
+    return await Db.from('oracleEndpoint').update({ oracleType }, { isActive })
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const destroyOracleEndpointById = async (oracleEndpointId) => {
+  try {
+    return await Db.from('oracleEndpoint').update({ oracleEndpointId }, { isActive: false })
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+module.exports = {
+  getOracleEndpointByType,
+  getOracleEndpointByTypeAndCurrency,
+  getOracleEndpointByCurrency,
+  getAllOracleEndpoint,
+  getOracleEndpointById,
+  getAllOracleEndpointsByMatchCondition,
+  createOracleEndpoint,
+  updateOracleEndpointById,
+  setIsActiveOracleEndpoint,
+  destroyOracleEndpointById
+}

package/src/models/oracle/oracleEndpointCached.js

@@ -0,0 +1,108 @@
+/*****
+ 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 ErrorHandler = require('@mojaloop/central-services-error-handling')
+const Cache = require('../../lib/cache')
+const Metrics = require('@mojaloop/central-services-metrics')
+const OracleEndpointUncached = require('./oracleEndpoint')
+
+let cacheClient
+
+const getCacheKey = (params) => {
+  return cacheClient.createKey(`${Object.values(params).join('__')}`)
+}
+
+const getOracleEndpointCached = async (params) => {
+  const histTimer = Metrics.getHistogram(
+    'model_oracleEndpoints',
+    'model_getOracleEndpointsCached - Metrics for oracle endpoints cached model',
+    ['success', 'queryName', 'hit']
+  ).startTimer()
+  const partyIdType = params.partyIdType || null
+  const currency = params.currency || null
+
+  // Do we have valid participants list in the cache ?
+  const cacheKey = getCacheKey(params)
+  let cachedEndpoints = cacheClient.get(cacheKey)
+  if (!cachedEndpoints) {
+    // No oracleEndpoint in the cache, so fetch from participant API
+    let oracleEndpoints
+    if (partyIdType && currency) {
+      oracleEndpoints = await OracleEndpointUncached.getOracleEndpointByTypeAndCurrency(partyIdType, currency)
+    } else if (currency) {
+      oracleEndpoints = await OracleEndpointUncached.getOracleEndpointByCurrency(currency)
+    } else {
+      oracleEndpoints = await OracleEndpointUncached.getOracleEndpointByType(partyIdType)
+    }
+    // store in cache
+    cacheClient.set(cacheKey, oracleEndpoints)
+    cachedEndpoints = oracleEndpoints
+    histTimer({ success: true, queryName: 'model_getOracleEndpointCached', hit: false })
+  } else {
+    // unwrap oracleEndpoints list from catbox structure
+    cachedEndpoints = cachedEndpoints.item
+    histTimer({ success: true, queryName: 'model_getOracleEndpointCached', hit: true })
+  }
+  return cachedEndpoints
+}
+
+/*
+  Public API
+*/
+exports.initialize = async () => {
+  /* Register as cache client */
+  const oracleEndpointCacheClientMeta = {
+    id: 'oracleEndpoints',
+    preloadCache: async () => Promise.resolve()
+  }
+
+  cacheClient = Cache.registerCacheClient(oracleEndpointCacheClientMeta)
+}
+
+exports.getOracleEndpointByTypeAndCurrency = async (partyIdType, currency) => {
+  try {
+    return await getOracleEndpointCached({ partyIdType, currency })
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+exports.getOracleEndpointByType = async (partyIdType) => {
+  try {
+    return await getOracleEndpointCached({ partyIdType })
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+exports.getOracleEndpointByCurrency = async (currency) => {
+  try {
+    return await getOracleEndpointCached({ currency })
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}