@mojaloop/central-ledger 19.14.0 → 20.1.0

package/{migrations → src/migrations}/900101_foreign-keys.js

@@ -32,14 +32,14 @@
 exports.up = function (knex) {
   // foreign keys sorted alphabetically by table name
   return knex.schema
-  .table('transferExtension', (t) => {
-    t.foreign('transferErrorId').references('transferError.transferErrorId')
-  })
+    .table('transferExtension', (t) => {
+      t.foreign('transferErrorId').references('transferError.transferErrorId')
+    })
 }
 
 exports.down = function (knex) {
   return knex.schema
-  .table('transferExtension', (t) => {
-    t.dropForeign('transferErrorId')
-  })
+    .table('transferExtension', (t) => {
+      t.dropForeign('transferErrorId')
+    })
 }

package/{migrations → src/migrations}/910100_feature904DDL.js

@@ -59,25 +59,25 @@ const migrateDDL = async (knex) => {
   const tableNameSuffix = Time.getYMDString(new Date())
 
   // drop foreign keys to make names available to replacing table
-  await knex.schema.table(`transferExtension`, (t) => {
+  await knex.schema.table('transferExtension', (t) => {
     t.dropForeign('transferid')
     t.dropForeign('transfererrorid')
     t.dropForeign('transferfulfilmentid')
   })
   // drop foreign keys to make names available to replacing table
-  await knex.schema.table(`transferFulfilment`, (t) => {
+  await knex.schema.table('transferFulfilment', (t) => {
     t.dropForeign('transferid')
     t.dropForeign('settlementwindowid')
     t.dropForeign('transferfulfilmentid')
   })
   // drop foreign keys to make names available to replacing table
-  await knex.schema.table(`transferError`, (t) => {
-      t.dropForeign('transferstatechangeid')
-      t.dropForeign('transfererrorduplicatecheckid')
+  await knex.schema.table('transferError', (t) => {
+    t.dropForeign('transferstatechangeid')
+    t.dropForeign('transfererrorduplicatecheckid')
   })
   // drop foreign keys to make names available to replacing table
-  await knex.schema.table(`transferErrorDuplicateCheck`, (t) => {
-      t.dropForeign('transferid')
+  await knex.schema.table('transferErrorDuplicateCheck', (t) => {
+    t.dropForeign('transferid')
   })
   // rename   current tables to preserve currently stored data
   await knex.schema.renameTable('transferExtension', `transferExtension${tableNameSuffix}`)

package/{migrations → src/migrations}/910101_feature904DataMigration.js

@@ -29,7 +29,7 @@
 
 'use strict'
 const Time = require('@mojaloop/central-services-shared').Util.Time
-const Config = require('../src/lib/config')
+const Config = require('../lib/config')
 const RUN_DATA_MIGRATIONS = Config.DB_RUN_DATA_MIGRATIONS
 
 const tableNameSuffix = Time.getYMDString(new Date())

package/{migrations → src/migrations}/910102_feature949DataMigration.js

@@ -28,7 +28,7 @@
  ******/
 
 'use strict'
-const Config = require('../src/lib/config')
+const Config = require('../lib/config')
 const RUN_DATA_MIGRATIONS = Config.DB_RUN_DATA_MIGRATIONS
 
 /**

package/{migrations → src/migrations}/910103_feature1093SettlementByCurrency.js

@@ -30,14 +30,14 @@
 'use strict'
 
 exports.up = async (knex, Promise) => {
-  await knex.schema.hasTable('ledgerAccountType').then(function(exists) {
+  await knex.schema.hasTable('ledgerAccountType').then(function (exists) {
     if (exists) {
       return knex.schema.alterTable('ledgerAccountType', (t) => {
         t.boolean('isSettleable').defaultTo(false).notNullable()
       })
     }
   })
-  await knex.schema.hasTable('ledgerEntryType').then(function(exists) {
+  await knex.schema.hasTable('ledgerEntryType').then(function (exists) {
     if (exists) {
       return knex.schema.alterTable('ledgerEntryType', (t) => {
         t.integer('ledgerAccountTypeId').unsigned().nullable()
@@ -45,7 +45,7 @@ exports.up = async (knex, Promise) => {
       })
     }
   })
-  await knex.schema.hasTable('settlement').then(function(exists) {
+  await knex.schema.hasTable('settlement').then(function (exists) {
     if (exists) {
       return knex.schema.alterTable('settlement', (t) => {
         t.integer('settlementModelId').unsigned().nullable()

package/{migrations → src/migrations}/940101_quotePartyIdInfoExtension-2522.js

@@ -27,40 +27,40 @@
   --------------
   ******/
 
- // Notes: these changes are required for the quoting-service and are not used by central-ledger
- // This implements [Central-ledger migration scripts should configure the Quote Party table to utf8 follow-up #2522](https://github.com/mojaloop/project/issues/2522)
- // Referencing for MySQL Documentation: https://dev.mysql.com/doc/refman/5.6/en/alter-table.html#alter-table-character-set
- 'use strict'
+// Notes: these changes are required for the quoting-service and are not used by central-ledger
+// This implements [Central-ledger migration scripts should configure the Quote Party table to utf8 follow-up #2522](https://github.com/mojaloop/project/issues/2522)
+// Referencing for MySQL Documentation: https://dev.mysql.com/doc/refman/5.6/en/alter-table.html#alter-table-character-set
+'use strict'
 
- const characterSet = 'utf8mb4'
- const coalition = 'utf8mb4_unicode_ci'
+const characterSet = 'utf8mb4'
+const coalition = 'utf8mb4_unicode_ci'
 
- exports.up = async (knex) => {
-   console.log(`WARNING: Migration script 940101_quotePartyIdInfoExtension-2522.js is converting quotePartyIdInfoExtension table to use the following character set ${characterSet} with ${coalition} collation`)
-   return knex.schema.hasTable('quotePartyIdInfoExtension').then(async (exists) => {
-     if (exists) {
-       try {
-       const result = await knex.select(knex.raw(`
+exports.up = async (knex) => {
+  console.log(`WARNING: Migration script 940101_quotePartyIdInfoExtension-2522.js is converting quotePartyIdInfoExtension table to use the following character set ${characterSet} with ${coalition} collation`)
+  return knex.schema.hasTable('quotePartyIdInfoExtension').then(async (exists) => {
+    if (exists) {
+      try {
+        const result = await knex.select(knex.raw(`
          CCSA.character_set_name, CCSA.collation_name
          FROM information_schema.TABLES T,
          information_schema.COLLATION_CHARACTER_SET_APPLICABILITY CCSA
          WHERE CCSA.collation_name = T.table_collation
          AND T.table_name = "quotePartyIdInfoExtension";
        `))
-       console.log(`WARNING: Migration script 940101_quotePartyIdInfoExtension-2522.js - take note of the current configuration if you wish to revert= ${JSON.stringify(result)}`)
-       await knex.raw(`
+        console.log(`WARNING: Migration script 940101_quotePartyIdInfoExtension-2522.js - take note of the current configuration if you wish to revert= ${JSON.stringify(result)}`)
+        await knex.raw(`
          ALTER TABLE quotePartyIdInfoExtension CONVERT TO CHARACTER
          SET ${characterSet} COLLATE ${coalition}
        `)
-       } catch (err) {
-         console.log(`ERROR: Migration script 940101_quotePartyIdInfoExtension-2522.js - converting quotePartyIdInfoExtension table to use the following character set ${characterSet} with ${coalition} collation has failed!`)
-         console.error(err)
-         throw err
-       }
-     }
-   })
- }
+      } catch (err) {
+        console.log(`ERROR: Migration script 940101_quotePartyIdInfoExtension-2522.js - converting quotePartyIdInfoExtension table to use the following character set ${characterSet} with ${coalition} collation has failed!`)
+        console.error(err)
+        throw err
+      }
+    }
+  })
+}
 
- exports.down = (knex) => {
-   console.log('WARNING: Migration script 940101_quotePartyIdInfoExtension-2522.js must manually be reversed')
- }
+exports.down = (knex) => {
+  console.log('WARNING: Migration script 940101_quotePartyIdInfoExtension-2522.js must manually be reversed')
+}

package/{migrations → src/migrations}/950101_transferParticipantStateChange.js

@@ -30,12 +30,12 @@
 'use strict'
 
 exports.up = async (knex) => {
-  return await knex.schema.hasTable('transferParticipantStateChange').then(function(exists) {
+  return await knex.schema.hasTable('transferParticipantStateChange').then(function (exists) {
     if (!exists) {
       return knex.schema.createTable('transferParticipantStateChange', (t) => {
         t.bigIncrements('transferParticipantStateChangeId').primary().notNullable()
         t.bigInteger('transferParticipantId').notNullable().unsigned()
-        t.foreign('transferParticipantId','tt_transferParticipantId_fk').references('transferParticipantId').inTable('transferParticipant')
+        t.foreign('transferParticipantId', 'tt_transferParticipantId_fk').references('transferParticipantId').inTable('transferParticipant')
         t.string('settlementWindowStateId', 50)
         t.foreign('settlementWindowStateId').references('settlementWindowStateId').inTable('settlementWindowState')
         t.string('reason', 512).defaultTo(null).nullable()

package/{migrations → src/migrations}/950102_settlementModel-adjustPosition.js

@@ -30,7 +30,7 @@
 'use strict'
 
 exports.up = async (knex) => {
-  return await knex.schema.hasTable('settlementModel').then(function(exists) {
+  return await knex.schema.hasTable('settlementModel').then(function (exists) {
     if (exists) {
       return knex.schema.alterTable('settlementModel', (t) => {
         t.boolean('adjustPosition').defaultTo(false).notNullable()
@@ -40,7 +40,7 @@ exports.up = async (knex) => {
 }
 
 exports.down = function (knex) {
-  return knex.schema.alterTable('settlementModel',(t) => {
+  return knex.schema.alterTable('settlementModel', (t) => {
     t.dropColumn('adjustPosition')
   })
 }

package/{migrations → src/migrations}/950103_dropTransferParticipantStateChange.js

@@ -34,13 +34,13 @@ exports.up = async (knex) => {
   return knex.schema.dropTableIfExists('transferParticipantStateChange')
 }
 
-exports.down = async function(knex, Promise) {
-  return await knex.schema.hasTable('transferParticipantStateChange').then(function(exists) {
+exports.down = async function (knex, Promise) {
+  return await knex.schema.hasTable('transferParticipantStateChange').then(function (exists) {
     if (!exists) {
       return knex.schema.createTable('transferParticipantStateChange', (t) => {
         t.bigIncrements('transferParticipantStateChangeId').primary().notNullable()
         t.bigInteger('transferParticipantId').notNullable().unsigned()
-        t.foreign('transferParticipantId','tt_transferParticipantId_fk').references('transferParticipantId').inTable('transferParticipant')
+        t.foreign('transferParticipantId', 'tt_transferParticipantId_fk').references('transferParticipantId').inTable('transferParticipant')
         t.string('settlementWindowStateId', 50)
         t.foreign('settlementWindowStateId').references('settlementWindowStateId').inTable('settlementWindowState')
         t.string('reason', 512).defaultTo(null).nullable()

package/{migrations → src/migrations}/950104_settlementModel-settlementAccountTypeId.js

@@ -30,11 +30,11 @@
 'use strict'
 
 exports.up = async (knex) => {
-  await knex.schema.hasTable('settlementModel').then(async function(tableExists) {
+  await knex.schema.hasTable('settlementModel').then(async function (tableExists) {
     if (tableExists) {
       await knex.schema.hasColumn('settlementModel', 'settlementAccountTypeId')
         .then(async (columnExists) => {
-          if (!columnExists){
+          if (!columnExists) {
             await knex.schema.alterTable('settlementModel', (t) => {
               t.integer('settlementAccountTypeId').unsigned().defaultTo(null)
             })
@@ -66,7 +66,7 @@ exports.up = async (knex) => {
 }
 
 exports.down = function (knex) {
-  return knex.schema.alterTable('settlementModel',(t) => {
+  return knex.schema.alterTable('settlementModel', (t) => {
     t.dropColumn('settlementAccountTypeId')
   })
 }

package/src/migrations/950107_settlementWindowContent_foreign_settlementModel.js

@@ -0,0 +1,63 @@
+/*****
+ 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
+ - Valentin Genev <valentin.genev@modusbox.com>
+ --------------
+ ******/
+
+'use strict'
+
+exports.up = async (knex) => {
+  return await knex.schema.hasTable('settlementWindowContent').then(async function (exists) {
+    if (exists) {
+      await knex.schema.hasColumn('settlementWindowContent', 'settlementModelId')
+        .then(async (columnExists) => {
+          if (!columnExists) {
+            return knex.schema.alterTable('settlementWindowContent', (t) => {
+              t.integer('SettlementModelId').unsigned().defaultTo(null)
+              t.foreign('SettlementModelId').references('SettlementModelId').inTable('settlementModel')
+            })
+          }
+        })
+    }
+  })
+}
+
+exports.down = async function (knex) {
+  return await knex.schema.hasTable('settlementWindowContent').then(async function (exists) {
+    if (exists) {
+      await knex.schema.hasColumn('settlementWindowContent', 'settlementModelId')
+        .then(async (columnExists) => {
+          if (columnExists) {
+            return knex.schema
+              .alterTable('settlementWindowContent', (t) => {
+                t.dropForeign('SettlementModelId')
+                t.dropColumn('SettlementModelId')
+              })
+          }
+        })
+    }
+  })
+}

package/{migrations → src/migrations}/950108_participantProxy.js

@@ -35,11 +35,10 @@
 'use strict'
 
 exports.up = async (knex) => {
-  return await knex.schema.hasTable('participant').then(function(exists) {
+  return await knex.schema.hasTable('participant').then(function (exists) {
     if (exists) {
       return knex.schema.alterTable('participant', (t) => {
         t.boolean('isProxy').defaultTo(false).notNullable()
-
       })
     }
   })

package/{migrations → src/migrations}/950120_fxQuoteConversionTerms_sourceAmount_nullable.js

@@ -63,4 +63,4 @@ exports.down = function (knex) {
           })
         })
     })
-}
+}

package/{migrations → src/migrations}/960100_create_externalParticipant.js

@@ -27,7 +27,7 @@
  **********/
 
 exports.up = async (knex) => {
-  return knex.schema.hasTable('externalParticipant').then(function(exists) {
+  return knex.schema.hasTable('externalParticipant').then(function (exists) {
     if (!exists) {
       return knex.schema.createTable('externalParticipant', (t) => {
         t.bigIncrements('externalParticipantId').primary().notNullable()
@@ -42,7 +42,7 @@ exports.up = async (knex) => {
 }
 
 exports.down = function (knex) {
-  return knex.schema.hasTable('externalParticipant').then(function(exists) {
+  return knex.schema.hasTable('externalParticipant').then(function (exists) {
     if (!exists) {
       return knex.schema.dropTableIfExists('externalParticipant')
     }

package/{migrations → src/migrations}/960110_alter_transferParticipant__addFiled_externalParticipantId.js

@@ -29,7 +29,7 @@
 const EP_ID_FIELD = 'externalParticipantId'
 
 exports.up = async (knex) => {
-  return knex.schema.hasTable('transferParticipant').then(function(exists) {
+  return knex.schema.hasTable('transferParticipant').then(function (exists) {
     if (exists) {
       return knex.schema.alterTable('transferParticipant', (t) => {
         t.bigint(EP_ID_FIELD).unsigned().nullable()
@@ -41,7 +41,7 @@ exports.up = async (knex) => {
 }
 
 exports.down = async (knex) => {
-  return knex.schema.hasTable('transferParticipant').then(function(exists) {
+  return knex.schema.hasTable('transferParticipant').then(function (exists) {
     if (exists) {
       return knex.schema.alterTable('transferParticipant', (t) => {
         t.dropIndex(EP_ID_FIELD)

package/{migrations → src/migrations}/961001_transferForwarded.js

@@ -30,7 +30,7 @@
 'use strict'
 
 exports.up = async (knex) => {
-  return await knex.schema.hasTable('transferForwarded').then(function(exists) {
+  return await knex.schema.hasTable('transferForwarded').then(function (exists) {
     if (!exists) {
       return knex.schema.createTable('transferForwarded', (t) => {
         t.bigIncrements('transferForwardedId').primary().notNullable()

package/{migrations → src/migrations}/961002_fxTransferForwarded.js

@@ -30,7 +30,7 @@
 'use strict'
 
 exports.up = async (knex) => {
-  return await knex.schema.hasTable('fxTransferForwarded').then(function(exists) {
+  return await knex.schema.hasTable('fxTransferForwarded').then(function (exists) {
     if (!exists) {
       return knex.schema.createTable('fxTransferForwarded', (t) => {
         t.bigIncrements('fxTransferForwardedId').primary().notNullable()

package/src/models/participant/externalParticipant.int.ts

@@ -0,0 +1,85 @@
+import { after, before, describe, it } from "node:test"
+import assert from "node:assert"
+import Harness from '../../testing/harness'
+import { Snapshot } from "../../testing/snapshot"
+import * as ApiHelpers from '../../testing/api-helpers'
+
+import externalParticipant from './externalParticipant'
+const db = require('../../lib/db')
+const harness = Harness.getInstance()
+
+describe('models/participant/externalParticipant', () => {
+  before(async () => {
+    await harness.up()
+    await harness.setupGlobals()
+  })
+
+  after(async () => {
+    await harness.teardownGlobals()
+    await harness.down()
+  })
+
+  it('Should throw error on inserting a record without related proxyId in participant table.', async () => {
+    try {
+      await externalParticipant.create({
+        proxyId: 0,
+        name: 'name'
+      })
+    } catch (err: any) {
+      assert(err)
+      assert(err.extensions)
+      assert(err.extensions[0])
+
+      Snapshot.from(`{
+        "key": "system",
+        "value": "[\\"db\\"]"
+      }`).checkStringUnwrap(JSON.stringify(err.extensions[0], null, 2))
+
+      assert(err.apiErrorCode)
+      assert(err.apiErrorCode.code)
+      assert(err.apiErrorCode.code === '2001')
+      return
+    }
+
+    throw new Error('Expected test failure.')
+  })
+
+  it('Should not throw error on inserting a record, if the name already exists', async () => {
+    // First create the hub + a participant.
+    const createHubPayload: ApiHelpers.CreateHubPayload = {
+      currencies: ['USD'],
+      settlementModels: [{
+        name: `DEFERRED_MULTILATERAL_NET_USD`,
+        settlementGranularity: "NET",
+        settlementInterchange: "MULTILATERAL",
+        settlementDelay: "DEFERRED",
+        currency: 'USD',
+        requireLiquidityCheck: true,
+        ledgerAccountType: "POSITION",
+        settlementAccountType: "SETTLEMENT",
+        autoPositionReset: true
+      }]
+    }
+    await ApiHelpers.createHub(harness, createHubPayload)
+    await ApiHelpers.createDfsp(harness, {
+      name: 'dfsp_f',
+      currencies: ['USD'],
+      isProxy: false,
+      initialPostionsAndLimits: [
+        {
+          initialPosition: 0,
+          value: 100000
+        }
+      ],
+      deposits: [10000]
+    })
+
+    const { participantId } = await db.from('participant').findOne({})
+    const result = await externalParticipant.create({
+      name: `epName-${Date.now()}`,
+      proxyId: participantId,
+    })
+
+    assert(result)
+  })
+})

package/src/models/participant/facade.js

@@ -389,7 +389,8 @@ const getParticipantLimitByParticipantCurrencyLimit = async (participantId, curr
               participantId,
               currencyId: participantCurrency.currencyId,
               participantLimitTypeId: participantLimitRow.participantLimitTypeId,
-              value: participantLimitRow.value
+              value: participantLimitRow.value,
+              thresholdAlarmPercentage: participantLimitRow.thresholdAlarmPercentage
             }
           }
         }
@@ -413,7 +414,8 @@ const getParticipantLimitByParticipantCurrencyLimit = async (participantId, curr
             'participant.participantId AS participantId',
             'pc.currencyId AS currencyId',
             'pl.participantLimitTypeId as participantLimitTypeId',
-            'pl.value AS value'
+            'pl.value AS value',
+            'pl.thresholdAlarmPercentage AS thresholdAlarmPercentage'
           ).first()
       })
     }

package/src/models/participant/participantCurrencyCached.js

@@ -28,7 +28,7 @@
 'use strict'
 
 const Cache = require('../../lib/cache')
-const Config = require('../../../src/lib/config')
+const Config = require('../../lib/config')
 const ParticipantCurrencyModel = require('../../models/participant/participantCurrency')
 const rethrow = require('../../shared/rethrow')
 

package/src/models/position/facade.js

@@ -213,9 +213,15 @@ const prepareChangeParticipantPositionTransaction = async (transferList) => {
           reservedValue: new MLNumber(initialParticipantPosition.reservedValue).subtract(sumTransfersInBatch).toFixed(Config.AMOUNT.SCALE),
           changedDate: transactionTimestamp
         })
+
         // TODO this limit needs to be clarified
-        if (processedPositionValue.toNumber() > liquidityCover.multiply(participantLimit.thresholdAlarmPercentage).toNumber()) {
-          limitAlarms.push(participantLimit)
+        // It appears that participantLimit.thresholdAlarmPercentage is always undefined.
+        // @mojaloop/ml-number@11.1.5 broke this line since it throws when an undefined value is
+        // passed in. For now, I'm putting in a placeholder of 1.
+        if (participantLimit.thresholdAlarmPercentage) {
+          if (processedPositionValue.toNumber() > liquidityCover.multiply(participantLimit.thresholdAlarmPercentage).toNumber()) {
+            limitAlarms.push(participantLimit)
+          }
         }
         histTimerUpdateParticipantPositionEnd({ success: true, queryName: 'facade_prepareChangeParticipantPositionTransaction_transaction_UpdateParticipantPosition' })
         /*