@mojaloop/central-ledger 19.14.0 → 20.1.0

package/src/settlement/models/settlement/index.js

@@ -0,0 +1,55 @@
+/*****
+ 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>
+ - Miguel de Barros <miguel.debarros@modusbox.com>
+ - Rajiv Mothilal <rajiv.mothilal@modusbox.com>
+ - Valentin Genev <valentin.genev@modusbox.com>
+ --------------
+ ******/
+'use strict'
+
+const settlementFacade = require('./facade')
+const settlementModel = require('./settlement')
+const settlementTransferParticipantModel = require('./settlementTransferParticipant')
+const participantCurrencyModel = require('./participantCurrency')
+const settlementParticipantCurrencyModel = require('./settlementParticipantCurrency')
+
+module.exports = {
+  create: settlementModel.create,
+  triggerSettlementEvent: settlementFacade.triggerSettlementEvent,
+  getByParams: settlementFacade.getByParams,
+  getById: settlementFacade.getById,
+  putById: settlementFacade.putById,
+  abortById: settlementFacade.abortById,
+  getSettlementTransferParticipantBySettlementId: settlementTransferParticipantModel.getBySettlementId,
+  settlementParticipantCurrency: settlementFacade.settlementParticipantCurrency,
+  settlementSettlementWindow: settlementFacade.settlementSettlementWindow,
+  checkParticipantAccountExists: participantCurrencyModel.checkParticipantAccountExists,
+  getAccountInSettlement: settlementParticipantCurrencyModel.getAccountInSettlement,
+  abortByIdStateAborted: settlementFacade.abortByIdStateAborted,
+  getTransferCommitedAccount: settlementFacade.getTransferCommitedAccount
+}

package/src/settlement/models/settlement/participantCurrency.js

@@ -0,0 +1,48 @@
+/*****
+ 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>
+ * Valentin Genev <valentin.genev@modusbox.com>
+ * Deon Botha <deon.botha@modusbox.com>
+ --------------
+ ******/
+
+'use strict'
+
+const Db = require('../../lib/db')
+
+const checkParticipantAccountExists = async ({ participantId, accountId }, enums = {}) => {
+  return Db.from('participantCurrency').query(builder => {
+    return builder
+      .select('participantCurrencyId')
+      .where({ participantId })
+      .andWhere('participantCurrencyId', accountId)
+      .andWhere('ledgerAccountTypeId', enums.ledgerAccountTypes.POSITION)
+      .first()
+  })
+}
+
+module.exports = {
+  checkParticipantAccountExists
+}

package/src/settlement/models/settlement/settlement.js

@@ -0,0 +1,49 @@
+/*****
+ 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>
+ * Valentin Genev <valentin.genev@modusbox.com>
+ * Deon Botha <deon.botha@modusbox.com>
+ --------------
+ ******/
+
+'use strict'
+
+const Db = require('../../lib/db')
+
+const create = async (settlement) => {
+  return Db.from('settlement').insert({
+    reason: settlement.reason,
+    createdDate: settlement.createdDate
+  })
+}
+
+const getById = async (id) => {
+  return Db.from('settlement').findOne({ settlementId: id })
+}
+
+module.exports = {
+  create,
+  getById
+}

package/src/settlement/models/settlement/settlementModel.js

@@ -0,0 +1,44 @@
+/*****
+ 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
+ - Georgi Georgiev <georgi.georgiev@modusbox.com>
+ --------------
+ ******/
+'use strict'
+
+const Db = require('../../lib/db')
+
+const getByName = async (name) => {
+  return Db.from('settlementModel').findOne({ name, isActive: 1 })
+}
+
+const getAll = async () => {
+  return await Db.from('settlementModel').find({ isActive: 1 })
+}
+
+module.exports = {
+  getByName,
+  getAll
+}

package/src/settlement/models/settlement/settlementParticipantCurrency.js

@@ -0,0 +1,61 @@
+/*****
+ 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>
+ * Valentin Genev <valentin.genev@modusbox.com>
+ * Deon Botha <deon.botha@modusbox.com>
+ --------------
+ ******/
+
+'use strict'
+
+const Db = require('../../lib/db')
+
+const getAccountInSettlement = async ({ settlementId, accountId }) => {
+  const result = await Db.from('settlementParticipantCurrency').query(builder => {
+    return builder
+      .select('settlementParticipantCurrencyId')
+      .where({ settlementId })
+      .andWhere('participantCurrencyId', accountId)
+      .first()
+  })
+  return result
+}
+
+const getBySettlementAndAccount = async (settlementId, accountId) => {
+  const result = await Db.from('settlementParticipantCurrency').query(builder => {
+    return builder
+      .innerJoin('settlementParticipantCurrencyStateChange AS spcsc', 'spcsc.settlementParticipantCurrencyStateChangeId', 'settlementParticipantCurrency.currentStateChangeId')
+      .select('settlementParticipantCurrency.*', 'spcsc.settlementStateId', 'spcsc.reason', 'spcsc.externalReference')
+      .where({ settlementId })
+      .andWhere('participantCurrencyId', accountId)
+      .first()
+  })
+  return result
+}
+
+module.exports = {
+  getAccountInSettlement,
+  getBySettlementAndAccount
+}

package/src/settlement/models/settlement/settlementStateChange.js

@@ -0,0 +1,44 @@
+/*****
+ 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>
+ --------------
+ ******/
+
+'use strict'
+
+const Db = require('../../lib/db')
+
+const getBySettlementId = async (id) => {
+  const knex = await Db.getKnex()
+  return knex('settlementStateChange')
+    .where('settlementId', id)
+    .orderBy('settlementStateChangeId', 'desc')
+    .select('*')
+    .first()
+}
+
+module.exports = {
+  getBySettlementId
+}

package/src/settlement/models/settlement/settlementTransferParticipant.js

@@ -0,0 +1,46 @@
+/*****
+ 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>
+ * Valentin Genev <valentin.genev@modusbox.com>
+ * Deon Botha <deon.botha@modusbox.com>
+ * Rajiv Mothilal <rajiv.mothilal@modusbox.com>
+ * Miguel de Barros <miguel.debarros@modusbox.com>
+ --------------
+ ******/
+
+'use strict'
+
+const Db = require('../../lib/db')
+
+module.exports = {
+  getBySettlementId: async function ({ settlementId }) {
+    return Db.from('settlementTransferParticipant').query(builder => {
+      return builder
+        .select()
+        .distinct('settlementWindowId', 'participantCurrencyId')
+        .where({ settlementId })
+    })
+  }
+}