@mojaloop/central-ledger 17.5.0 → 17.6.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [17.6.0](https://github.com/mojaloop/central-ledger/compare/v17.5.0...v17.6.0) (2023-12-20)
+
+
+### Features
+
+* **mojaloop/#3524:** add reserve action to fulfil logic ([#992](https://github.com/mojaloop/central-ledger/issues/992)) ([eb82c33](https://github.com/mojaloop/central-ledger/commit/eb82c33c0572214a73930d8357102928c59e016f)), closes [mojaloop/#3524](https://github.com/mojaloop/project/issues/3524)
+
 ## [17.5.0](https://github.com/mojaloop/central-ledger/compare/v17.4.1...v17.5.0) (2023-12-13)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-ledger",
-  "version": "17.5.0",
+  "version": "17.6.0",
   "description": "Central ledger hosted by a scheme to record and settle transfers",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -128,7 +128,7 @@
     "jsdoc": "4.0.2",
     "jsonpath": "1.1.1",
     "nodemon": "3.0.2",
-    "npm-check-updates": "16.14.11",
+    "npm-check-updates": "16.14.12",
     "nyc": "15.1.0",
     "pre-commit": "1.2.2",
     "proxyquire": "2.1.3",

package/src/domain/position/binProcessor.js

@@ -53,12 +53,16 @@ const participantFacade = require('../../models/participant/facade')
  */
 const processBins = async (bins, trx) => {
   const transferIdList = []
-  await iterateThroughBins(bins, (_accountID, _action, item) => {
+  const reservedActionTransferIdList = []
+  await iterateThroughBins(bins, (_accountID, action, item) => {
     if (item.decodedPayload?.transferId) {
       transferIdList.push(item.decodedPayload.transferId)
     // get transferId from uriParams for fulfil messages
     } else if (item.message?.value?.content?.uriParams?.id) {
       transferIdList.push(item.message.value.content.uriParams.id)
+      if (action === Enum.Events.Event.Action.RESERVE) {
+        reservedActionTransferIdList.push(item.message.value.content.uriParams.id)
+      }
     }
   })
   // Pre fetch latest transferStates for all the transferIds in the account-bin
@@ -131,6 +135,12 @@ const processBins = async (bins, trx) => {
     Enum.Accounts.LedgerEntryType.PRINCIPLE_VALUE
   )
 
+  // Pre fetch transfers for all reserve action fulfils
+  const reservedActionTransfers = await BatchPositionModel.getTransferByIdsForReserve(
+    trx,
+    reservedActionTransferIdList
+  )
+
   let notifyMessages = []
   let limitAlarms = []
 
@@ -142,7 +152,7 @@ const processBins = async (bins, trx) => {
       array2.every((element) => array1.includes(element))
     // If non-prepare/non-commit action found, log error
     // We need to remove this once we implement all the actions
-    if (!isSubset(['prepare', 'commit'], actions)) {
+    if (!isSubset(['prepare', 'commit', 'reserve'], actions)) {
       Logger.isErrorEnabled && Logger.error('Only prepare/commit actions are allowed in a batch')
       // throw new Error('Only prepare action is allowed in a batch')
     }
@@ -167,11 +177,12 @@ const processBins = async (bins, trx) => {
 
     // If fulfil action found then call processPositionPrepareBin function
     const fulfilActionResult = await PositionFulfilDomain.processPositionFulfilBin(
-      accountBin.commit,
+      [accountBin.commit, accountBin.reserve],
       accumulatedPositionValue,
       accumulatedPositionReservedValue,
       accumulatedTransferStates,
-      latestTransferInfoByTransferId
+      latestTransferInfoByTransferId,
+      reservedActionTransfers
     )
 
     // Update accumulated values

package/src/domain/position/fulfil.js

@@ -4,6 +4,7 @@ const Config = require('../../lib/config')
 const Utility = require('@mojaloop/central-services-shared').Util
 const MLNumber = require('@mojaloop/ml-number')
 const Logger = require('@mojaloop/central-services-logger')
+const TransferObjectTransform = require('../../domain/transfer/transform')
 
 /**
  * @function processPositionFulfilBin
@@ -11,7 +12,7 @@ const Logger = require('@mojaloop/central-services-logger')
  * @async
  * @description This is the domain function to process a bin of position-fulfil messages of a single participant account.
  *
- * @param {array} binItems - an array of objects that contain a position fulfil message and its span. {message, span}
+ * @param {array} commitReserveFulfilBins - an array containing commit and reserve action bins
  * @param {number} accumulatedPositionValue - value of position accumulated so far from previous bin processing
  * @param {number} accumulatedPositionReservedValue - value of position reserved accumulated so far, not used but kept for consistency
  * @param {object} accumulatedTransferStates - object with transfer id keys and transfer state id values. Used to check if transfer is in correct state for processing. Clone and update states for output.
@@ -19,11 +20,12 @@ const Logger = require('@mojaloop/central-services-logger')
  * @returns {object} - Returns an object containing accumulatedPositionValue, accumulatedPositionReservedValue, accumulatedTransferStateChanges, accumulatedTransferStates, resultMessages, limitAlarms or throws an error if failed
  */
 const processPositionFulfilBin = async (
-  binItems,
+  commitReserveFulfilBins,
   accumulatedPositionValue,
   accumulatedPositionReservedValue,
   accumulatedTransferStates,
-  transferInfoList
+  transferInfoList,
+  reservedActionTransfers
 ) => {
   const transferStateChanges = []
   const participantPositionChanges = []
@@ -31,109 +33,117 @@ const processPositionFulfilBin = async (
   const accumulatedTransferStatesCopy = Object.assign({}, accumulatedTransferStates)
   let runningPosition = new MLNumber(accumulatedPositionValue)
 
-  if (binItems && binItems.length > 0) {
-    for (const binItem of binItems) {
-      let transferStateId
-      let reason
-      let resultMessage
-      const transferId = binItem.message.value.content.uriParams.id
-      const payeeFsp = binItem.message.value.from
-      const payerFsp = binItem.message.value.to
-      const transfer = binItem.decodedPayload
-      Logger.isDebugEnabled && Logger.debug(`processPositionFulfilBin::transfer:processingMessage: ${JSON.stringify(transfer)}`)
-      Logger.isDebugEnabled && Logger.debug(`accumulatedTransferStates: ${JSON.stringify(accumulatedTransferStates)}`)
-      // Inform payee dfsp if transfer is not in RECEIVED_FULFIL state, skip making any transfer state changes
-      if (accumulatedTransferStates[transferId] !== Enum.Transfers.TransferInternalState.RECEIVED_FULFIL) {
-        // forward same headers from the prepare message, except the content-length header
-        // set destination to payeefsp and source to switch
-        const headers = { ...binItem.message.value.content.headers }
-        headers[Enum.Http.Headers.FSPIOP.DESTINATION] = payeeFsp
-        headers[Enum.Http.Headers.FSPIOP.SOURCE] = Enum.Http.Headers.FSPIOP.SWITCH.value
-        delete headers['content-length']
-
-        const fspiopError = ErrorHandler.Factory.createInternalServerFSPIOPError(
-          `Invalid State: ${accumulatedTransferStates[transferId]} - expected: ${Enum.Transfers.TransferInternalState.RECEIVED_FULFIL}`
-        ).toApiErrorObject(Config.ERROR_HANDLING)
-        const state = Utility.StreamingProtocol.createEventState(
-          Enum.Events.EventStatus.FAILURE.status,
-          fspiopError.errorInformation.errorCode,
-          fspiopError.errorInformation.errorDescription
-        )
-
-        const metadata = Utility.StreamingProtocol.createMetadataWithCorrelatedEvent(
-          transferId,
-          Enum.Kafka.Topics.NOTIFICATION,
-          Enum.Events.Event.Action.FULFIL,
-          state
-        )
-
-        resultMessage = Utility.StreamingProtocol.createMessage(
-          transferId,
-          payeeFsp,
-          Enum.Http.Headers.FSPIOP.SWITCH.value,
-          metadata,
-          headers,
-          fspiopError,
-          { id: transferId },
-          'application/json'
-        )
-      } else {
-        const transferInfo = transferInfoList[transferId]
-
-        // forward same headers from the prepare message, except the content-length header
-        const headers = { ...binItem.message.value.content.headers }
-        delete headers['content-length']
-
-        const state = Utility.StreamingProtocol.createEventState(
-          Enum.Events.EventStatus.SUCCESS.status,
-          null,
-          null
-        )
-        const metadata = Utility.StreamingProtocol.createMetadataWithCorrelatedEvent(
-          transferId,
-          Enum.Kafka.Topics.TRANSFER,
-          Enum.Events.Event.Action.COMMIT,
-          state
-        )
-
-        resultMessage = Utility.StreamingProtocol.createMessage(
-          transferId,
-          payerFsp,
-          payeeFsp,
-          metadata,
-          headers,
-          transfer,
-          { id: transferId },
-          'application/json'
-        )
-
-        transferStateId = Enum.Transfers.TransferState.COMMITTED
-        // Amounts in `transferParticipant` for the payee are stored as negative values
-        runningPosition = new MLNumber(runningPosition.add(transferInfo.amount).toFixed(Config.AMOUNT.SCALE))
-
-        const participantPositionChange = {
-          transferId, // Need to delete this in bin processor while updating transferStateChangeId
-          transferStateChangeId: null, // Need to update this in bin processor while executing queries
-          value: runningPosition.toNumber(),
-          reservedValue: accumulatedPositionReservedValue
-        }
-        participantPositionChanges.push(participantPositionChange)
-        binItem.result = { success: true }
-      }
+  for (const binItems of commitReserveFulfilBins) {
+    if (binItems && binItems.length > 0) {
+      for (const binItem of binItems) {
+        let transferStateId
+        let reason
+        let resultMessage
+        const transferId = binItem.message.value.content.uriParams.id
+        const payeeFsp = binItem.message.value.from
+        const payerFsp = binItem.message.value.to
+        const transfer = binItem.decodedPayload
+        Logger.isDebugEnabled && Logger.debug(`processPositionFulfilBin::transfer:processingMessage: ${JSON.stringify(transfer)}`)
+        Logger.isDebugEnabled && Logger.debug(`accumulatedTransferStates: ${JSON.stringify(accumulatedTransferStates)}`)
+        // Inform payee dfsp if transfer is not in RECEIVED_FULFIL state, skip making any transfer state changes
+        if (accumulatedTransferStates[transferId] !== Enum.Transfers.TransferInternalState.RECEIVED_FULFIL) {
+          // forward same headers from the prepare message, except the content-length header
+          // set destination to payeefsp and source to switch
+          const headers = { ...binItem.message.value.content.headers }
+          headers[Enum.Http.Headers.FSPIOP.DESTINATION] = payeeFsp
+          headers[Enum.Http.Headers.FSPIOP.SOURCE] = Enum.Http.Headers.FSPIOP.SWITCH.value
+          delete headers['content-length']
+
+          const fspiopError = ErrorHandler.Factory.createInternalServerFSPIOPError(
+            `Invalid State: ${accumulatedTransferStates[transferId]} - expected: ${Enum.Transfers.TransferInternalState.RECEIVED_FULFIL}`
+          ).toApiErrorObject(Config.ERROR_HANDLING)
+          const state = Utility.StreamingProtocol.createEventState(
+            Enum.Events.EventStatus.FAILURE.status,
+            fspiopError.errorInformation.errorCode,
+            fspiopError.errorInformation.errorDescription
+          )
+
+          const metadata = Utility.StreamingProtocol.createMetadataWithCorrelatedEvent(
+            transferId,
+            Enum.Kafka.Topics.NOTIFICATION,
+            Enum.Events.Event.Action.FULFIL,
+            state
+          )
+
+          resultMessage = Utility.StreamingProtocol.createMessage(
+            transferId,
+            payeeFsp,
+            Enum.Http.Headers.FSPIOP.SWITCH.value,
+            metadata,
+            headers,
+            fspiopError,
+            { id: transferId },
+            'application/json'
+          )
+        } else {
+          const transferInfo = transferInfoList[transferId]
+
+          // forward same headers from the prepare message, except the content-length header
+          const headers = { ...binItem.message.value.content.headers }
+          delete headers['content-length']
 
-      resultMessages.push({ binItem, message: resultMessage })
+          const state = Utility.StreamingProtocol.createEventState(
+            Enum.Events.EventStatus.SUCCESS.status,
+            null,
+            null
+          )
+          const metadata = Utility.StreamingProtocol.createMetadataWithCorrelatedEvent(
+            transferId,
+            Enum.Kafka.Topics.TRANSFER,
+            Enum.Events.Event.Action.COMMIT,
+            state
+          )
 
-      if (transferStateId) {
-        const transferStateChange = {
-          transferId,
-          transferStateId,
-          reason
+          resultMessage = Utility.StreamingProtocol.createMessage(
+            transferId,
+            payerFsp,
+            payeeFsp,
+            metadata,
+            headers,
+            transfer,
+            { id: transferId },
+            'application/json'
+          )
+
+          if (binItem.message.value.metadata.event.action === Enum.Events.Event.Action.RESERVE) {
+            resultMessage.content.payload = TransferObjectTransform.toFulfil(
+              reservedActionTransfers[transferId]
+            )
+          }
+
+          transferStateId = Enum.Transfers.TransferState.COMMITTED
+          // Amounts in `transferParticipant` for the payee are stored as negative values
+          runningPosition = new MLNumber(runningPosition.add(transferInfo.amount).toFixed(Config.AMOUNT.SCALE))
+
+          const participantPositionChange = {
+            transferId, // Need to delete this in bin processor while updating transferStateChangeId
+            transferStateChangeId: null, // Need to update this in bin processor while executing queries
+            value: runningPosition.toNumber(),
+            reservedValue: accumulatedPositionReservedValue
+          }
+          participantPositionChanges.push(participantPositionChange)
+          binItem.result = { success: true }
         }
-        transferStateChanges.push(transferStateChange)
-        Logger.isDebugEnabled && Logger.debug(`processPositionFulfilBin::transferStateChange: ${JSON.stringify(transferStateChange)}`)
 
-        accumulatedTransferStatesCopy[transferId] = transferStateId
-        Logger.isDebugEnabled && Logger.debug(`processPositionFulfilBin::accumulatedTransferStatesCopy:finalizedTransferState ${JSON.stringify(transferStateId)}`)
+        resultMessages.push({ binItem, message: resultMessage })
+
+        if (transferStateId) {
+          const transferStateChange = {
+            transferId,
+            transferStateId,
+            reason
+          }
+          transferStateChanges.push(transferStateChange)
+          Logger.isDebugEnabled && Logger.debug(`processPositionFulfilBin::transferStateChange: ${JSON.stringify(transferStateChange)}`)
+
+          accumulatedTransferStatesCopy[transferId] = transferStateId
+          Logger.isDebugEnabled && Logger.debug(`processPositionFulfilBin::accumulatedTransferStatesCopy:finalizedTransferState ${JSON.stringify(transferStateId)}`)
+        }
       }
     }
   }

package/src/models/position/batch.js

@@ -32,6 +32,8 @@
 
 const Db = require('../../lib/db')
 const Logger = require('@mojaloop/central-services-logger')
+const TransferExtensionModel = require('../transfer/transferExtension')
+const { Enum } = require('@mojaloop/central-services-shared')
 
 const startDbTransaction = async () => {
   const knex = await Db.getKnex()
@@ -141,6 +143,47 @@ const bulkInsertParticipantPositionChanges = async (trx, participantPositionChan
   return await knex.batchInsert('participantPositionChange', participantPositionChangeList).transacting(trx)
 }
 
+const getTransferByIdsForReserve = async (trx, transferIds) => {
+  if (transferIds && transferIds.length > 0) {
+    try {
+      const knex = await Db.getKnex()
+      const query = await knex('transfer')
+        .transacting(trx)
+        .leftJoin('transferStateChange AS tsc', 'tsc.transferId', 'transfer.transferId')
+        .leftJoin('transferState AS ts', 'ts.transferStateId', 'tsc.transferStateId')
+        .leftJoin('transferFulfilment AS tf', 'tf.transferId', 'transfer.transferId')
+        .leftJoin('transferError as te', 'te.transferId', 'transfer.transferId') // currently transferError.transferId is PK ensuring one error per transferId
+        .whereIn('transfer.transferId', transferIds)
+        .select(
+          'transfer.*',
+          'tsc.createdDate AS completedTimestamp',
+          'ts.enumeration as transferStateEnumeration',
+          'tf.ilpFulfilment AS fulfilment',
+          'te.errorCode',
+          'te.errorDescription'
+        )
+      const transfers = {}
+      for (const transfer of query) {
+        transfer.extensionList = await TransferExtensionModel.getByTransferId(transfer.transferId)
+        if (transfer.errorCode && transfer.transferStateEnumeration === Enum.Transfers.TransferState.ABORTED) {
+          if (!transfer.extensionList) transfer.extensionList = []
+          transfer.extensionList.push({
+            key: 'cause',
+            value: `${transfer.errorCode}: ${transfer.errorDescription}`.substr(0, 128)
+          })
+        }
+        transfer.isTransferReadModel = true
+        transfers[transfer.transferId] = transfer
+      }
+      return transfers
+    } catch (err) {
+      Logger.isErrorEnabled && Logger.error(err)
+      throw err
+    }
+  }
+  return {}
+}
+
 module.exports = {
   startDbTransaction,
   getLatestTransferStateChangesByTransferIdList,
@@ -149,5 +192,6 @@ module.exports = {
   bulkInsertTransferStateChanges,
   bulkInsertParticipantPositionChanges,
   getAllParticipantCurrency,
-  getTransferInfoList
+  getTransferInfoList,
+  getTransferByIdsForReserve
 }