@mojaloop/central-ledger 19.14.0 → 20.1.0

package/src/settlement/shared/setup.js

@@ -0,0 +1,224 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2026 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>
+ - Miguel de Barros <miguel.debarros@modusbox.com>
+ - Rajiv Mothilal <rajiv.mothilal@modusbox.com>
+ - Valentin Genev <valentin.genev@modusbox.com>
+ --------------
+ ******/
+'use strict'
+
+const Config = require('../../lib/config')
+const Db = require('../lib/db')
+const Enums = require('../models/lib/enums')
+const ErrorHandling = require('@mojaloop/central-services-error-handling')
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const Hapi = require('@hapi/hapi')
+const { logger } = require('../shared/logger')
+const Plugins = require('./plugins')
+const RegisterHandlers = require('../handlers/register')
+
+const getEnums = (id) => {
+  return Enums[id]()
+}
+
+async function connectDatabase () {
+  logger.debug(`Connecting to DB ${JSON.stringify(Config.DATABASE)}`)
+  await Db.connect(Config.DATABASE)
+  const dbLoadedTables = Db._tables ? Db._tables.length : -1
+  logger.debug(`DB.connect loaded '${dbLoadedTables}' tables!`)
+}
+
+const createServer = async function (port, modules) {
+  try {
+    const server = new Hapi.Server({
+      port,
+      routes: {
+        validate: {
+          options: ErrorHandling.validateRoutes(),
+          failAction: async (request, h, err) => {
+            throw ErrorHandler.Factory.reformatFSPIOPError(err, ErrorHandler.Enums.FSPIOPErrorCodes.MALFORMED_SYNTAX)
+          }
+        },
+        payload: {
+          parse: true,
+          output: 'stream'
+        }
+      },
+      cache: [
+        {
+          provider: {
+            constructor: require('@hapi/catbox-memory').Engine,
+            options: {
+              partition: 'cache'
+            }
+          },
+          name: 'memCache'
+        }
+      ]
+    })
+    await connectDatabase()
+
+    server.method({
+      name: 'enums',
+      method: getEnums,
+      options: {
+        cache: {
+          cache: 'memCache',
+          expiresIn: 20 * 1000,
+          generateTimeout: 30 * 1000
+        }
+      }
+    })
+
+    server.ext([
+      {
+        type: 'onPreHandler',
+        method: (request, h) => {
+          server.log('request', request)
+          return h.continue
+        }
+      }
+    ])
+    await Plugins.registerPlugins(server)
+    await server.register(modules)
+    await server.start()
+
+    server.log('info', `Server running on ${server.info.host}:${server.info.port}`)
+    return server
+  } catch (err) {
+    logger.error(`createServer failed with error: ${err.message}`)
+    throw err
+  }
+}
+
+/**
+ * @function createHandlers
+ *
+ * @description Create method to register specific Handlers specified by the Module list as part of the Setup process
+ *
+ * @typedef handler
+ * @type {Object}
+ * @property {string} type The type of Handler to be registered
+ * @property {boolean} enabled True|False to indicate if the Handler should be registered
+ * @property {string[]} [fspList] List of FSPs to be registered
+ *
+ * @param {handler[]} handlers List of Handlers to be registered
+ * @returns {Promise<boolean>} Returns true if Handlers were registered
+ */
+const createHandlers = async (handlers) => {
+  let handlerIndex
+  const registerdHandlers = {
+    connection: {},
+    register: {},
+    ext: {},
+    start: new Date(),
+    info: {},
+    handlers
+  }
+
+  for (handlerIndex in handlers) {
+    const handler = handlers[handlerIndex]
+    let errorMessage
+    if (handler.enabled) {
+      logger.info(`Handler Setup - Registering ${JSON.stringify(handler)}!`)
+      switch (handler.type) {
+        case 'deferredSettlement':
+          await RegisterHandlers.deferredSettlement.registerSettlementWindowHandler()
+          break
+        case 'grossSettlement':
+          await RegisterHandlers.grossSettlement.registerTransferSettlementHandler()
+          break
+        case 'rules':
+          await RegisterHandlers.rules.registerRulesHandler()
+          break
+        default:
+          errorMessage = `Handler Setup - ${JSON.stringify(handler)} is not a valid handler to register!`
+          logger.error(errorMessage)
+          throw ErrorHandling.Factory.reformatFSPIOPError(errorMessage)
+      }
+    }
+  }
+
+  return registerdHandlers
+}
+
+/**
+ * @function initialize
+ *
+ * @description Setup method for API, Admin and Handlers. Note that the Migration scripts are called before connecting to the database to ensure all new tables are loaded properly.
+ *
+ * @typedef handler
+ * @type {Object}
+ * @property {string} type The type of Handler to be registered
+ * @property {boolean} enabled True|False to indicate if the Handler should be registered
+ * @property {string[]} [fspList] List of FSPs to be registered
+ *
+ * @param {string} service Name of service to start. Available choices are 'api', 'admin', 'handler'
+ * @param {number} port Port to start the HTTP Server on
+ * @param {object[]} modules List of modules to be loaded by the HTTP Server
+ * @param {boolean} runMigrations True to run Migration script, false to ignore them, only applicable for service types that are NOT 'handler'
+ * @param {boolean} runHandlers True to start Handlers, false to ignore them
+ * @param {handler[]} handlers List of Handlers to be registered
+ * @returns {object} Returns HTTP Server object
+ */
+const initialize = async function (options = { modules: [], runHandlers: false, handlers: [] }) {
+  const { service, port, modules, runHandlers, handlers } = options
+  let server
+  let error
+  switch (service) {
+    case 'api':
+      server = await createServer(port, modules)
+      break
+    case 'handler':
+      if (!Config.HANDLERS_API_DISABLED) {
+        server = await createServer(port, modules)
+      }
+      break
+    default:
+      error = ErrorHandling.Factory.createFSPIOPError(ErrorHandling.Enums.FSPIOPErrorCodes.VALIDATION_ERROR, `No valid service type ${service} found!`)
+      logger.error(error)
+      throw error
+  }
+  if (runHandlers) {
+    if (Array.isArray(handlers) && handlers.length > 0) {
+      await createHandlers(handlers)
+    } else {
+      await RegisterHandlers.registerAllHandlers()
+    }
+  }
+
+  return server
+}
+
+module.exports = {
+  initialize,
+  createServer,
+  __testonly__: {
+    getEnums
+  }
+}

package/src/settlement/utils/truthyProperty.js

@@ -0,0 +1,37 @@
+/*****
+ 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>
+
+ * Valentin Genev <valentin.genev@modusbox.com>
+ --------------
+ ******/
+
+module.exports = (obj) => {
+  if (obj && typeof obj !== 'object') return true
+  if (obj && Object.keys(obj).length) {
+    for (const key of Object.keys(obj)) {
+      if (key && obj[key]) return true
+    }
+  }
+  return false
+}

package/src/shared/legacyUtilShim.js

@@ -0,0 +1,20 @@
+'use strict'
+
+/* istanbul ignore file: environment-dependent shim — which branches run depends on the Node.js version */
+
+// Shim: the legacy util.is* type-check helpers were removed in Node.js >= 23,
+// but hapi-openapi@3.0.0 and its enjoi dependency (both unmaintained, latest
+// releases) still call them during plugin registration / schema resolution.
+const util = require('node:util')
+
+/* eslint-disable n/no-deprecated-api */
+if (typeof util.isObject !== 'function') {
+  util.isObject = (obj) => obj !== null && typeof obj === 'object'
+}
+if (typeof util.isUndefined !== 'function') {
+  util.isUndefined = (obj) => obj === undefined
+}
+if (typeof util.isNumber !== 'function') {
+  util.isNumber = (obj) => typeof obj === 'number'
+}
+/* eslint-enable n/no-deprecated-api */

package/src/shared/plugins.js

@@ -42,7 +42,7 @@ const Inert = require('@hapi/inert')
 const Vision = require('@hapi/vision')
 const Blipp = require('blipp')
 const ErrorHandling = require('@mojaloop/central-services-error-handling')
-const { APIDocumentation, loggingPlugin } = require('@mojaloop/central-services-shared').Util.Hapi
+const { APIDocumentation, loggingPlugin, HapiEventPlugin } = require('@mojaloop/central-services-shared').Util.Hapi
 const Config = require('../lib/config')
 const { logger } = require('./logger')
 
@@ -51,7 +51,7 @@ const registerPlugins = async (server) => {
     await server.register({
       plugin: APIDocumentation,
       options: {
-        documentPath: Path.resolve(__dirname, '../api/interface/swagger.json')
+        pathToSwaggerFile: Path.resolve(process.cwd(), 'src/api/interface/swagger.json')
       }
     })
   }
@@ -77,7 +77,7 @@ const registerPlugins = async (server) => {
     plugin: require('hapi-auth-bearer-token')
   })
 
-  await server.register([Inert, Vision, Blipp, ErrorHandling])
+  await server.register([Inert, Vision, Blipp, ErrorHandling, HapiEventPlugin])
 
   await server.register({
     plugin: loggingPlugin,

package/src/shared/results.ts

@@ -0,0 +1,22 @@
+/**
+ * Convenience Types for QueryResult
+ * When T is void, result property is omitted
+ */
+
+export type QueryResultSuccess<T> = T extends void
+  ? { type: 'SUCCESS' }
+  : { type: 'SUCCESS'; result: T }
+
+export type QueryResultFailure = {
+  type: 'FAILURE',
+  error: Error
+}
+
+export type QueryResult<T> = QueryResultSuccess<T> | QueryResultFailure
+
+export function failureWithError(error: any): QueryResultFailure {
+  return {
+    type: 'FAILURE',
+    error
+  }
+}

package/src/shared/results.unit.ts

@@ -0,0 +1,38 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2026 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>.
+
+ * TigerBeetle
+ - Lewis Daly <lewis@tigerbeetle.com>
+ --------------
+
+ ******/
+
+import { describe, it } from 'node:test'
+import assert from 'node:assert'
+import { failureWithError } from './results' 
+
+describe('shared/results', () => {
+  it('builds a failureWithError', () => {
+    const result = failureWithError(new Error('test error'))
+    assert(result.type === 'FAILURE')
+    assert(result.error.message === 'test error')
+  })
+})

package/src/shared/setup.js

@@ -33,6 +33,10 @@
 
 'use strict'
 
+// Defensive: apply the legacy util shim at service bootstrap. The hapi-openapi
+// route plugins also require it themselves; keep those requires so the modules
+// stay self-contained when loaded directly (e.g. by tests).
+require('./legacyUtilShim')
 const Hapi = require('@hapi/hapi')
 const MongoUriBuilder = require('mongo-uri-builder')
 const ObjStoreDb = require('@mojaloop/object-store-lib').Db
@@ -203,6 +207,15 @@ const createHandlers = async (handlers) => {
           await RegisterHandlers.bulk.registerBulkGetHandler()
           break
         }
+        case 'deferredSettlement':
+          await RegisterHandlers.deferredSettlement.registerSettlementWindowHandler()
+          break
+        case 'grossSettlement':
+          await RegisterHandlers.grossSettlement.registerTransferSettlementHandler()
+          break
+        case 'rules':
+          await RegisterHandlers.rules.registerRulesHandler()
+          break
         default: {
           const error = `Handler Setup - ${JSON.stringify(handler)} is not a valid handler to register!`
           Logger.isErrorEnabled && Logger.error(error)
@@ -302,7 +315,7 @@ const initialize = async function ({ service, port, modules = [], runMigrations
     if (Config.PROXY_CACHE_CONFIG?.enabled) {
       await ProxyCache.disconnect()
     }
-    process.exit(1)
+    throw err
   }
 }