@mojaloop/central-ledger 19.14.0 → 20.1.0

package/src/settlement/lib/utility.js

@@ -0,0 +1,243 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * Georgi Georgiev <georgi.georgiev@modusbox.com>
+ * Lazola Lucas <lazola.lucas@modusbox.com>
+ * Rajiv Mothilal <rajiv.mothilal@modusbox.com>
+ * Miguel de Barros <miguel.debarros@modusbox.com>
+
+ --------------
+ ******/
+
+'use strict'
+
+/**
+ * @module src/handlers/lib
+ */
+
+const Config = require('../../lib/config')
+const KafkaConfig = Config.KAFKA_CONFIG
+const { logger } = require('../shared/logger')
+const idGenerator = require('@mojaloop/central-services-shared').Util.id
+const Kafka = require('./kafka/index')
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const generateULID = idGenerator({ type: 'ulid' })
+/**
+ * The Producer config required
+ *
+ * @description This ENUM is for the PRODUCER of the topic being created
+ *
+ * @enum {object} ENUMS~PRODUCER
+ * @property {string} PRODUCER - PRODUCER config to be fetched
+ */
+const PRODUCER = 'PRODUCER'
+
+/**
+ * The Notification config required
+ *
+ * @description This ENUM is for the notification message being created
+ *
+ * @enum {object} ENUMS~NOTIFICATION
+ * @property {string} NOTIFICATION - notification to be used to update metadata
+ */
+const NOTIFICATION = 'notification'
+
+/**
+ * The EVENT config required
+ *
+ * @description This ENUM is for the topic being created
+ *
+ * @enum {object} ENUMS~EVENT
+ * @property {string} EVENT - event to be used get the config for Kafka
+ */
+const EVENT = 'event'
+
+/**
+ * The STATE constant
+ *
+ * I believe that this is a temporary solution
+ *
+ * This ENUM is for the state of the message being created
+ *
+ * @enum {object} ENUMS~STATE
+ * @property {string} STATE - used for the state of the message
+ */
+const STATE = {
+  SUCCESS: {
+    status: 'success',
+    code: 0,
+    description: 'action successful'
+  },
+  FAILURE: {
+    status: 'error',
+    code: 999,
+    description: 'action failed'
+  }
+}
+
+/**
+ * ENUMS
+ *
+ * @description Global ENUMS object
+ *
+ * @enum {string} ENUMS
+ * @property {string} PRODUCER - This ENUM is for the PRODUCER
+ */
+const ENUMS = {
+  PRODUCER,
+  NOTIFICATION,
+  STATE,
+  EVENT
+}
+
+/**
+ * @function GetKafkaConfig
+ *
+ * @description participantTopicTemplate called which generates a participant topic name from the 3 inputs, which are used in the placeholder participant topic template found in the default.json
+ *
+ * @param {string} flow - This is required for the config for the Stream Processing API. Example: 'CONSUMER' ie: note the case of text
+ * @param {string} functionality - the functionality flow. Example: 'TRANSFER' ie: note the case of text
+ * @param {string} action - the action that applies to the flow. Example: 'PREPARE' ie: note the case of text
+ *
+ * @returns {string} - Returns topic name to be created, throws error if failure occurs
+ */
+const getKafkaConfig = (flow, functionality, action) => {
+  try {
+    const flowObject = KafkaConfig[flow]
+    const functionalityObject = flowObject[functionality]
+    const actionObject = functionalityObject[action]
+    actionObject.config.logger = logger
+    return actionObject.config
+  } catch (err) {
+    throw ErrorHandler.Factory.createInternalServerFSPIOPError(`No config found for those parameters flow='${flow}', functionality='${functionality}', action='${action}'`, err)
+  }
+}
+
+/**
+ * @function updateMessageProtocolMetadata
+ *
+ * @param {object} messageProtocol - The current messageProtocol from kafka
+ * @param {string} metadataType - the type of flow. Example: 'notification'
+ * @param {string} metadataAction - the action flow. Example: 'prepare'
+ * @param {object} state - the state of the message being passed.
+ * Example:
+ * SUCCESS: {
+ *   status: 'success',
+ *   code: 0,
+ *   description: 'action successful'
+ * }
+ *
+ * @returns {object} - Returns updated messageProtocol
+ */
+const updateMessageProtocolMetadata = (messageProtocol, metadataType, metadataAction, state) => {
+  if (!messageProtocol.metadata) {
+    messageProtocol.metadata = {
+      event: {
+        id: generateULID(),
+        type: metadataType,
+        action: metadataAction,
+        state
+      }
+    }
+  } else {
+    messageProtocol.metadata.event.responseTo = messageProtocol.metadata.event.id
+    messageProtocol.metadata.event.id = generateULID()
+    messageProtocol.metadata.event.type = metadataType
+    messageProtocol.metadata.event.state = state
+  }
+  return messageProtocol
+}
+
+/**
+ * @function GeneralTopicTemplate
+ *
+ * @description Generates a general topic name from the 2 inputs, which are used in the placeholder general topic template found in the default.json
+ *
+ * @param {string} functionality - the functionality flow. Example: 'transfer'
+ * @param {string} action - the action that applies to the flow. Example: 'prepare'
+ *
+ * @returns {string} - Returns topic name to be created, throws error if failure occurs
+ */
+const generalTopicTemplate = (functionality, action) => {
+  try {
+    return Config.KAFKA_CONFIG.TOPIC_TEMPLATES.GENERAL_TOPIC_TEMPLATE.TEMPLATE
+      .replace('{{functionality}}', functionality || '')
+      .replace('{{action}}', action || '')
+  } catch (err) {
+    logger.error(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+/**
+ * @function createGeneralTopicConfig
+ *
+ * @param {string} functionality - the functionality flow. Example: 'transfer' ie: note the case of text
+ * @param {string} action - the action that applies to the flow. Example: 'prepare' ie: note the case of text
+ * @param {number} partition - optional partition to produce to
+ * @param {*} opaqueKey - optional opaque token, which gets passed along to your delivery reports
+ *
+ * @returns {object} - Returns newly created general topicConfig
+ */
+const createGeneralTopicConf = (functionality, action, partition = 0, opaqueKey = 0) => {
+  return {
+    topicName: generalTopicTemplate(functionality, action),
+    key: generateULID(),
+    partition,
+    opaqueKey
+  }
+}
+
+/**
+ * @function produceGeneralMessage
+ *
+ * @async
+ * @description This is an async method that produces a message against a generated Kafka topic. it is called multiple times
+ *
+ * Kafka.Producer.produceMessage called to persist the message to the configured topic on Kafka
+ * Utility.updateMessageProtocolMetadata called updates the messages metadata
+ * Utility.createGeneralTopicConf called dynamically generates the general topic configuration
+ * Utility.getKafkaConfig called dynamically gets Kafka configuration
+ *
+ * @param {string} functionality - the functionality flow. Example: 'transfer' ie: note the case of text
+ * @param {string} action - the action that applies to the flow. Example: 'prepare' ie: note the case of text
+ * @param {object} message - a list of messages to consume for the relevant topic
+ * @param {object} state - state of the message being produced
+ *
+ * @returns {object} - Returns a boolean: true if successful, or throws and error if failed
+ */
+const produceGeneralMessage = async (functionality, action, message, state) => {
+  const functionalityMapped = functionality
+  const actionMapped = action
+  return Kafka.Producer.produceMessage(updateMessageProtocolMetadata(message, functionality, action, state),
+    createGeneralTopicConf(functionalityMapped, actionMapped),
+    getKafkaConfig(ENUMS.PRODUCER, functionalityMapped.toUpperCase(), actionMapped.toUpperCase()))
+}
+
+exports.ENUMS = ENUMS
+exports.getKafkaConfig = getKafkaConfig
+exports.updateMessageProtocolMetadata = updateMessageProtocolMetadata
+exports.createGeneralTopicConf = createGeneralTopicConf
+exports.produceGeneralMessage = produceGeneralMessage
+exports.generalTopicTemplate = generalTopicTemplate

package/src/settlement/models/ilpPackets/ilpPacket.js

@@ -0,0 +1,42 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * ModusBox
+ - Lazola Lucas <lazola.lucas@modusbox.com>
+ --------------
+ ******/
+'use strict'
+
+const Db = require('../../lib/db')
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const { logger } = require('../../shared/logger')
+
+exports.getById = async (id) => {
+  try {
+    return await Db.from('ilpPacket').find({ transferId: id })
+  } catch (err) {
+    logger.error(err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}

package/src/settlement/models/lib/enums.js

@@ -0,0 +1,192 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * ModusBox
+ - Deon Botha <deon.botha@modusbox.com>
+ - Georgi Georgiev <georgi.georgiev@modusbox.com>
+ - Valentin Genev <valentin.genev@modusbox.com>
+ --------------
+ ******/
+'use strict'
+
+const Db = require('../../lib/db')
+
+module.exports = {
+  headers: {
+    FSPIOP: {
+      SWITCH: 'central-switch'
+    }
+  },
+
+  ledgerAccountTypes: async function () {
+    const ledgerAccountTypeEnum = {}
+    const ledgerAccountTypeEnumsList = await Db.from('ledgerAccountType').find({})
+    if (ledgerAccountTypeEnumsList) {
+      for (const state of ledgerAccountTypeEnumsList) {
+        ledgerAccountTypeEnum[`${state.name}`] = state.ledgerAccountTypeId
+      }
+      return ledgerAccountTypeEnum
+    }
+  },
+  ledgerEntryTypes: async function () {
+    const ledgerEntryTypeEnum = {}
+    const ledgerEntryTypeEnumsList = await Db.from('ledgerEntryType').find({})
+    if (ledgerEntryTypeEnumsList) {
+      for (const state of ledgerEntryTypeEnumsList) {
+        ledgerEntryTypeEnum[`${state.name}`] = state.ledgerEntryTypeId
+      }
+      return ledgerEntryTypeEnum
+    }
+  },
+  participantLimitTypes: async function () {
+    const participantLimitTypeEnum = {}
+    const participantLimitTypeEnumsList = await Db.from('participantLimitType').find({})
+    if (participantLimitTypeEnumsList) {
+      for (const state of participantLimitTypeEnumsList) {
+        participantLimitTypeEnum[`${state.name}`] = state.participantLimitTypeId
+      }
+      return participantLimitTypeEnum
+    }
+  },
+  settlementDelay: async function () {
+    const settlementDelayName = {}
+
+    const settlementDelayNamesList = await Db.from('settlementDelay').find({})
+    if (settlementDelayNamesList) {
+      for (const record of settlementDelayNamesList) {
+        settlementDelayName[`${record.name}`] = record.settlementDelayId
+      }
+      return settlementDelayName
+    }
+  },
+  settlementDelayEnums: async function () {
+    const settlementDelayEnum = {}
+
+    const settlementDelayEnumsList = await Db.from('settlementDelay').find({})
+    if (settlementDelayEnumsList) {
+      for (const record of settlementDelayEnumsList) {
+        settlementDelayEnum[`${record.name}`] = record.name
+      }
+      return settlementDelayEnum
+    }
+  },
+  settlementGranularity: async function () {
+    const settlementGranularityName = {}
+
+    const settlementGranularityNamesList = await Db.from('settlementGranularity').find({})
+    if (settlementGranularityNamesList) {
+      for (const record of settlementGranularityNamesList) {
+        settlementGranularityName[`${record.name}`] = record.settlementGranularityId
+      }
+      return settlementGranularityName
+    }
+  },
+  settlementGranularityEnums: async function () {
+    const settlementGranularityEnum = {}
+
+    const settlementGranularityEnumsList = await Db.from('settlementGranularity').find({})
+    if (settlementGranularityEnumsList) {
+      for (const record of settlementGranularityEnumsList) {
+        settlementGranularityEnum[`${record.name}`] = record.name
+      }
+      return settlementGranularityEnum
+    }
+  },
+  settlementInterchange: async function () {
+    const settlementInterchangeName = {}
+
+    const settlementInterchangeNamesList = await Db.from('settlementInterchange').find({})
+    if (settlementInterchangeNamesList) {
+      for (const record of settlementInterchangeNamesList) {
+        settlementInterchangeName[`${record.name}`] = record.settlementInterchangeId
+      }
+      return settlementInterchangeName
+    }
+  },
+  settlementInterchangeEnums: async function () {
+    const settlementInterchangeEnum = {}
+
+    const settlementInterchangeEnumsList = await Db.from('settlementInterchange').find({})
+    if (settlementInterchangeEnumsList) {
+      for (const record of settlementInterchangeEnumsList) {
+        settlementInterchangeEnum[`${record.name}`] = record.name
+      }
+      return settlementInterchangeEnum
+    }
+  },
+  settlementStates: async function () {
+    const settlementStateEnum = {}
+
+    const settlementStateEnumsList = await Db.from('settlementState').find({})
+    if (settlementStateEnumsList) {
+      for (const state of settlementStateEnumsList) {
+        settlementStateEnum[`${state.enumeration}`] = state.settlementStateId
+      }
+      return settlementStateEnum
+    }
+  },
+  settlementWindowStates: async function () {
+    const settlementWindowStateEnum = {}
+    const settlementWindowStateEnumsList = await Db.from('settlementWindowState').find({})
+    if (settlementWindowStateEnumsList) {
+      for (const state of settlementWindowStateEnumsList) {
+        settlementWindowStateEnum[`${state.enumeration}`] = state.settlementWindowStateId
+      }
+      return settlementWindowStateEnum
+    }
+  },
+  transferParticipantRoleTypes: async function () {
+    const transferParticipantRoleTypeEnum = {}
+    const transferParticipantRoleTypeEnumsList = await Db.from('transferParticipantRoleType').find({})
+    if (transferParticipantRoleTypeEnumsList) {
+      for (const state of transferParticipantRoleTypeEnumsList) {
+        transferParticipantRoleTypeEnum[`${state.name}`] = state.transferParticipantRoleTypeId
+      }
+      return transferParticipantRoleTypeEnum
+    }
+  },
+  transferStateEnums: async function () {
+    const transferStateEnum = {}
+    const transferStateEnumsList = await Db.from('transferState').find({})
+    if (transferStateEnumsList) {
+      for (const state of transferStateEnumsList) {
+        // apply distinct even though final result would contain distinct values
+        if (!transferStateEnum[`${state.enumeration}`]) {
+          transferStateEnum[`${state.enumeration}`] = state.enumeration
+        }
+      }
+      return transferStateEnum
+    }
+  },
+  transferStates: async function () {
+    const transferStateEnum = {}
+    const transferStateEnumsList = await Db.from('transferState').find({})
+    if (transferStateEnumsList) {
+      for (const state of transferStateEnumsList) {
+        transferStateEnum[`${state.transferStateId}`] = state.transferStateId
+      }
+      return transferStateEnum
+    }
+  }
+}

package/src/settlement/models/misc/migrationLock.js

@@ -0,0 +1,53 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * Lewis Daly <lewis@vesselstech.com>
+ --------------
+ ******/
+
+'use strict'
+
+const Db = require('../../lib/db')
+
+/**
+ * @function getIsMigrationLocked
+ *
+ * @description Gets whether or not the database is locked based on the migration_lock
+ * @returns {Promise<boolean>} - true if locked, false if not. Rejects if an error occours
+ */
+const getIsMigrationLocked = async () => {
+  const result = await Db.from('migration_lock').query(async builder => {
+    builder.select('is_locked AS isLocked')
+      .orderBy('index', 'desc')
+      .first()
+
+    return builder
+  })
+
+  return result.isLocked
+}
+
+module.exports = {
+  getIsMigrationLocked
+}