feat(mojaloop/#3885): add migrations for storing fxQuotes

audit-ci.jsonc

@@ -10,6 +10,7 @@
   "GHSA-7hx8-2rxv-66xv", // https://github.com/advisories/GHSA-7hx8-2rxv-66xv
   "GHSA-c429-5p7v-vgjp", // https://github.com/advisories/GHSA-c429-5p7v-vgjp
   "GHSA-g64q-3vg8-8f93", // https://github.com/advisories/GHSA-g64q-3vg8-8f93
-  "GHSA-mg85-8mv5-ffjr"  // https://github.com/advisories/GHSA-mg85-8mv5-ffjr
+  "GHSA-mg85-8mv5-ffjr", // https://github.com/advisories/GHSA-mg85-8mv5-ffjr
+  "GHSA-8hc4-vh64-cxmj"  // https://github.com/advisories/GHSA-8hc4-vh64-cxmj
   ]
 }

migrations/950109_fxQuote.js

@@ -0,0 +1,20 @@
+// Notes: these changes are required for the quoting-service and are not used by central-ledger
+'use strict'
+
+exports.up = (knex) => {
+  return knex.schema.hasTable('fxQuote').then((exists) => {
+    if (!exists) {
+      return knex.schema.createTable('fxQuote', (t) => {
+        t.string('conversionRequestId', 36).primary().notNullable()
+
+        // time keeping
+        t.dateTime('expirationDate').defaultTo(null).nullable().comment('Optional expiration for the requested transaction')
+        t.dateTime('createdDate').defaultTo(knex.fn.now()).notNullable().comment('System dateTime stamp pertaining to the inserted record')
+      })
+    }
+  })
+}
+
+exports.down = (knex) => {
+  return knex.schema.dropTableIfExists('fxQuote')
+}

migrations/950110_fxQuoteResponse.js

@@ -0,0 +1,26 @@
+'use strict'
+
+exports.up = (knex) => {
+  return knex.schema.hasTable('fxQuoteResponse').then((exists) => {
+    if (!exists) {
+      return knex.schema.createTable('fxQuoteResponse', (t) => {
+        t.bigIncrements('fxQuoteResponseId').primary().notNullable()
+
+        // reference to the original fxQuote
+        t.string('conversionRequestId', 36).notNullable()
+        t.foreign('conversionRequestId').references('conversionRequestId').inTable('fxQuote')
+
+        // ilpCondition sent in FXP response
+        t.string('ilpCondition', 256).notNullable()
+
+        // time keeping
+        t.dateTime('expirationDate').defaultTo(null).nullable().comment('Optional expiration for the requested transaction')
+        t.dateTime('createdDate').defaultTo(knex.fn.now()).notNullable().comment('System dateTime stamp pertaining to the inserted record')
+      })
+    }
+  })
+}
+
+exports.down = (knex) => {
+  return knex.schema.dropTableIfExists('fxQuoteResponse')
+}

migrations/950111_fxQuoteError.js

@@ -0,0 +1,23 @@
+// Notes: these changes are required for the quoting-service and are not used by central-ledger
+'use strict'
+
+exports.up = (knex) => {
+  return knex.schema.hasTable('fxQuoteError').then((exists) => {
+    if (!exists) {
+      return knex.schema.createTable('fxQuoteError', (t) => {
+        t.bigIncrements('fxQuoteErrorId').primary().notNullable()
+        t.string('conversionRequestId', 36).notNullable()
+        t.foreign('conversionRequestId').references('conversionRequestId').inTable('fxQuote')
+        t.bigInteger('fxQuoteResponseId').unsigned().defaultTo(null).nullable().comment('The response to the initial fxQuote')
+        t.foreign('fxQuoteResponseId').references('fxQuoteResponseId').inTable('fxQuoteResponse')
+        t.integer('errorCode').unsigned().notNullable()
+        t.string('errorDescription', 128).notNullable()
+        t.dateTime('createdDate').defaultTo(knex.fn.now()).notNullable()
+      })
+    }
+  })
+}
+
+exports.down = (knex) => {
+  return knex.schema.dropTableIfExists('quoteError')
+}

migrations/950113_fxQuoteDuplicateCheck.js

@@ -0,0 +1,18 @@
+// Notes: these changes are required for the quoting-service and are not used by central-ledger
+'use strict'
+
+exports.up = (knex) => {
+  return knex.schema.hasTable('fxQuoteDuplicateCheck').then((exists) => {
+    if (!exists) {
+      return knex.schema.createTable('fxQuoteDuplicateCheck', (t) => {
+        t.string('conversionRequestId', 36).primary().notNullable()
+        t.string('hash', 1024).defaultTo(null).nullable().comment('hash value received for the quote request')
+        t.dateTime('createdDate').defaultTo(knex.fn.now()).notNullable().comment('System dateTime stamp pertaining to the inserted record')
+      })
+    }
+  })
+}
+
+exports.down = (knex) => {
+  return knex.schema.dropTableIfExists('fxQuoteDuplicateCheck')
+}

migrations/950114_fxQuoteResponseDuplicateCheck.js

@@ -0,0 +1,21 @@
+// Notes: these changes are required for the quoting-service and are not used by central-ledger
+'use strict'
+
+exports.up = (knex) => {
+  return knex.schema.hasTable('fxQuoteResponseDuplicateCheck').then((exists) => {
+    if (!exists) {
+      return knex.schema.createTable('fxQuoteResponseDuplicateCheck', (t) => {
+        t.bigIncrements('fxQuoteResponseId').primary().unsigned().comment('The response to the initial quote')
+        t.foreign('fxQuoteResponseId').references('fxQuoteResponseId').inTable('fxQuoteResponse')
+        t.string('conversionRequestId', 36).notNullable()
+        t.foreign('conversionRequestId').references('conversionRequestId').inTable('fxQuote')
+        t.string('hash', 255).defaultTo(null).nullable().comment('hash value received for the quote response')
+        t.dateTime('createdDate').defaultTo(knex.fn.now()).notNullable().comment('System dateTime stamp pertaining to the inserted record')
+      })
+    }
+  })
+}
+
+exports.down = (knex) => {
+  return knex.schema.dropTableIfExists('fxQuoteResponseDuplicateCheck')
+}

migrations/950115_fxQuoteConversionTerms.js

@@ -0,0 +1,33 @@
+'use strict'
+
+exports.up = (knex) => {
+  return knex.schema.hasTable('fxQuoteConversionTerms').then((exists) => {
+    if (!exists) {
+      return knex.schema.createTable('fxQuoteConversionTerms', (t) => {
+        t.string('conversionId').primary().notNullable()
+
+        // reference to the original fxQuote
+        t.string('conversionRequestId', 36).notNullable()
+        t.foreign('conversionRequestId').references('conversionRequestId').inTable('fxQuote')
+
+        t.integer('amountTypeId').unsigned().notNullable().comment('This is part of the transaction type that contains valid elements for - Amount Type')
+        t.foreign('amountTypeId').references('amountTypeId').inTable('amountType')
+        t.string('initiatingFsp', 255)
+        t.string('counterPartyFsp', 255)
+        t.decimal('sourceAmount', 18, 4).notNullable()
+        t.string('sourceCurrency', 3).notNullable()
+        t.foreign('sourceCurrency').references('currencyId').inTable('currency')
+        t.decimal('targetAmount', 18, 4).notNullable()
+        t.string('targetCurrency', 3).notNullable()
+        t.foreign('targetCurrency').references('currencyId').inTable('currency')
+
+        // time keeping
+        t.dateTime('createdDate').defaultTo(knex.fn.now()).notNullable().comment('System dateTime stamp pertaining to the inserted record')
+      })
+    }
+  })
+}
+
+exports.down = (knex) => {
+  return knex.schema.dropTableIfExists('fxQuoteConversionTerms')
+}

migrations/950116_fxQuoteConversionTermExtension.js

@@ -0,0 +1,21 @@
+// Notes: these changes are required for the quoting-service and are not used by central-ledger
+'use strict'
+
+exports.up = (knex) => {
+  return knex.schema.hasTable('fxQuoteConversionTermExtension').then((exists) => {
+    if (!exists) {
+      return knex.schema.createTable('fxQuoteConversionTermExtension', (t) => {
+        t.bigIncrements('fxQuoteConversionTermExtension').primary().notNullable()
+        t.string('conversionId', 36).notNullable()
+        t.foreign('conversionId').references('conversionId').inTable('fxQuoteConversionTerms')
+        t.string('key', 128).notNullable()
+        t.text('value').notNullable()
+        t.dateTime('createdDate').defaultTo(knex.fn.now()).notNullable().comment('System dateTime stamp pertaining to the inserted record')
+      })
+    }
+  })
+}
+
+exports.down = (knex) => {
+  return knex.schema.dropTableIfExists('fxQuoteConversionTermExtension')
+}

migrations/950117_fxQuoteResponseConversionTerms.js

@@ -0,0 +1,37 @@
+'use strict'
+
+exports.up = (knex) => {
+  return knex.schema.hasTable('fxQuoteResponseConversionTerms').then((exists) => {
+    if (!exists) {
+      return knex.schema.createTable('fxQuoteResponseConversionTerms', (t) => {
+        t.string('conversionId').primary().notNullable()
+
+        // reference to the original fxQuote
+        t.string('conversionRequestId', 36).notNullable()
+        t.foreign('conversionRequestId').references('conversionRequestId').inTable('fxQuote')
+
+        // reference to the original fxQuoteResponse
+        t.bigIncrements('fxQuoteResponseId', 36).notNullable()
+        t.foreign('fxQuoteResponseId').references('fxQuoteResponseId').inTable('fxQuoteResponse')
+
+        t.integer('amountTypeId').unsigned().notNullable().comment('This is part of the transaction type that contains valid elements for - Amount Type')
+        t.foreign('amountTypeId').references('amountTypeId').inTable('amountType')
+        t.string('initiatingFsp', 255)
+        t.string('counterPartyFsp', 255)
+        t.decimal('sourceAmount', 18, 4).notNullable()
+        t.string('sourceCurrency', 3).notNullable()
+        t.foreign('sourceCurrency').references('currencyId').inTable('currency')
+        t.decimal('targetAmount', 18, 4).notNullable()
+        t.string('targetCurrency', 3).notNullable()
+        t.foreign('targetCurrency').references('currencyId').inTable('currency')
+
+        // time keeping
+        t.dateTime('createdDate').defaultTo(knex.fn.now()).notNullable().comment('System dateTime stamp pertaining to the inserted record')
+      })
+    }
+  })
+}
+
+exports.down = (knex) => {
+  return knex.schema.dropTableIfExists('fxQuoteResponseConversionTerms')
+}

migrations/950118_fxQuoteResponseConversionTermExtension.js

@@ -0,0 +1,21 @@
+// Notes: these changes are required for the quoting-service and are not used by central-ledger
+'use strict'
+
+exports.up = (knex) => {
+  return knex.schema.hasTable('fxQuoteResponseConversionTermExtension').then((exists) => {
+    if (!exists) {
+      return knex.schema.createTable('fxQuoteResponseConversionTermExtension', (t) => {
+        t.bigIncrements('fxQuoteResponseConversionTermExtension').primary().notNullable()
+        t.string('conversionId', 36).notNullable()
+        t.foreign('conversionId').references('conversionId').inTable('fxQuoteResponseConversionTerms')
+        t.string('key', 128).notNullable()
+        t.text('value').notNullable()
+        t.dateTime('createdDate').defaultTo(knex.fn.now()).notNullable().comment('System dateTime stamp pertaining to the inserted record')
+      })
+    }
+  })
+}
+
+exports.down = (knex) => {
+  return knex.schema.dropTableIfExists('fxQuoteResponseConversionTermExtension')
+}

migrations/950119_fxCharge.js

@@ -0,0 +1,27 @@
+'use strict'
+
+exports.up = (knex) => {
+  return knex.schema.hasTable('fxCharge').then((exists) => {
+    if (!exists) {
+      return knex.schema.createTable('fxCharge', (t) => {
+        t.bigIncrements('fxChargeId').primary().notNullable()
+        t.string('chargeType', 32).notNullable().comment('A description of the charge which is being levied.')
+
+        // fxCharge should only be sent back in the response to an fxQuote
+        // so reference the terms in fxQuoteResponse `conversionTerms`
+        t.string('conversionId', 36).notNullable()
+        t.foreign('conversionId').references('conversionId').inTable('fxQuoteResponseConversionTerms')
+
+        t.decimal('sourceAmount', 18, 4).nullable().comment('The amount of the charge which is being levied, expressed in the source currency.')
+        t.string('sourceCurrency', 3).nullable().comment('The currency in which the source amount charge is being levied.')
+
+        t.decimal('targetAmount', 18, 4).nullable().comment('The amount of the charge which is being levied, expressed in the target currency.')
+        t.string('targetCurrency', 3).nullable().comment('The currency in which the target amount charge is being levied.')
+      })
+    }
+  })
+}
+
+exports.down = (knex) => {
+  return knex.schema.dropTableIfExists('fxCharge')
+}

package.json

@@ -113,7 +113,7 @@
     "glob": "10.4.3",
     "hapi-auth-basic": "5.0.0",
     "hapi-auth-bearer-token": "8.0.0",
-    "hapi-swagger": "17.2.1",
+    "hapi-swagger": "17.3.0",
     "ilp-packet": "2.2.0",
     "knex": "3.1.0",
     "lodash": "4.17.21",
@@ -133,7 +133,7 @@
     "jsdoc": "4.0.3",
     "jsonpath": "1.1.1",
     "nodemon": "3.1.4",
-    "npm-check-updates": "17.0.3",
+    "npm-check-updates": "17.0.6",
     "nyc": "17.0.0",
     "pre-commit": "1.2.2",
     "proxyquire": "2.1.3",