Skip to content

mojaloop/quoting-service

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Quoting Service

Git Commit Git Releases Docker pulls CircleCI

The Quoting Service was donated by the Mowali project working in collaboration with Orange and MTN. The original author of this service is James Bush ([email protected]).

The Quoting service is now part of the Mojaloop project and deployment.

The service provided by the API resource /quotes is calculation of possible fees and FSP commission involved in performing an interoperable financial transaction. Both the Payer and Payee FSP should calculate their part of the quote to be able to get a total view of all the fees and FSP commission involved in the transaction.

Contents

Services Sequence overview

Quoting Service Sequence diagram

Quoting Service Sequence diagram

Running Locally

Please follow the instruction in Onboarding Document to setup and run the service locally.

Auditing Dependencies

We use npm-audit-resolver along with npm audit to check dependencies for node vulnerabilities, and keep track of resolved dependencies with an audit-resolve.json file.

To start a new resolution process, run:

npm run audit:resolve

You can then check to see if the CI will pass based on the current dependencies with:

npm run audit:check

And commit the changed audit-resolve.json to ensure that CircleCI will build correctly.

Container Scans

As part of our CI/CD process, we use anchore-cli to scan our built docker container for vulnerabilities upon release.

If you find your release builds are failing, refer to the container scanning in our shared Mojaloop CI config repo. There is a good chance you simply need to update the mojaloop-policy-generator.js file and re-run the circleci workflow.

For more information on anchore and anchore-cli, refer to:

Automated Releases

As part of our CI/CD process, we use a combination of CircleCI, standard-version npm package and github-release CircleCI orb to automatically trigger our releases and image builds. This process essentially mimics a manual tag and release.

On a merge to master, CircleCI is configured to use the mojaloopci github account to push the latest generated CHANGELOG and package version number.

Once those changes are pushed, CircleCI will pull the updated master, tag and push a release triggering another subsequent build that also publishes a docker image.

Potential problems

  • There is a case where the merge to master workflow will resolve successfully, triggering a release. Then that tagged release workflow subsequently failing due to the image scan, audit check, vulnerability check or other "live" checks.

    This will leave master without an associated published build. Fixes that require a new merge will essentially cause a skip in version number or require a clean up of the master branch to the commit before the CHANGELOG and bump.

    This may be resolved by relying solely on the previous checks of the merge to master workflow to assume that our tagged release is of sound quality. We are still mulling over this solution since catching bugs/vulnerabilities/etc earlier is a boon.

  • It is unknown if a race condition might occur with multiple merges with master in quick succession, but this is a suspected edge case.

How to use quoting-service JSON rules

About rules.json

The rules.json file acts as a rules engine and enables you to define arbitrary rules that will accept or reject quotes. A rule is defined as an object with a title, a conditions object, and an event object. A rule specifies that if certain conditions are met, then the specified event will be generated.

The rules engine used by the quoting-service is an off-the-shelf rules engine, called json-rules-engine. For detailed information on how to write rules, see the json-rules-engine documentation. This page only focuses on those details that are relevant for adding support for new currencies.

Conditions

Conditions are a combination of facts, paths, operators, and values.

Each rule's conditions must have either an all or an any operator at its root, containing an array of conditions. The all operator specifies that all conditions must be met for the rule to be applied. The any operator only requires one condition to be met for the rule to be applied.

Operators within the individual conditions can take the following values:

  • equal: fact must equal value (string or numeric value)
  • notEqual: fact must not equal value (string or numeric value)
  • in: fact must be included in value (an array)
  • notIn: fact must not be included in value (an array)
  • contains: fact (an array) must include value
  • doesNotContain: fact (an array) must not include value

Events

Event objects must have a type property, and an optional params property. There are two types of events:

  • INTERCEPT_QUOTE: Used for redirecting quote requests.
  • INVALID_QUOTE_REQUEST: Used for validation rules. You do not have to use this type of event when adding support for new currencies.

Configuration – an example

  [
    {
        "title": "This is UGX -> ZMW transfer rule",
        "conditions": {
          "all": [
              {
                "fact": "headers",
                "path": "$.fspiop-source",
                "operator": "notIn",
                "value":[
                    "DFSPUGX",
                    "DFSPZMW"
                ]
              },
              {
                "fact": "payer",
                "path": "$.accounts[?(@.ledgerAccountType == 'POSITION' && @.isActive  == 1)].currency",
                "operator": "equal",
                "value": "UGX"
              },
              {
                "fact": "payee",
                "path": "$.accounts[?(@.ledgerAccountType == 'POSITION' && @.isActive  == 1)].currency",
                "operator": "equal",
                "value": "ZMW"
              }
          ]
        },
        "event":{
          "type": "INTERCEPT_QUOTE",
          "params":{
              "rerouteToFsp": "DFSPUGX",
              "additionalHeaders": {
                "x-fspiop-sourcecurrency": "UGX",
                "x-fspiop-destinationcurrency": "ZMW"
              }
          }
        }
    },
    {
      "title": "Payee fsp should have only one active account",
      "conditions": {
        "all": [
          {
            "any": [
              {
                "fact": "payload",
                "path": "$.amount.currency",
                "operator": "notIn",
                "value": {
                  "fact": "payer",
                  "path": "$.accounts[?(@.ledgerAccountType == \"POSITION\" && @.isActive  == 1)].currency"
                }
              },
              {
                "fact": "payload",
                "path": "$.amount.currency",
                "operator": "notIn",
                "value": {
                  "fact": "payee",
                  "path": "$.accounts[?(@.ledgerAccountType == \"POSITION\" && @.isActive  == 1)].currency"
                }
              }
            ]
          },
          {
            "fact": "payee",
            "path": "$.accounts[?(@.ledgerAccountType == \"POSITION\" && @.isActive  == 1)]",
            "operator": "isArray",
            "value": true
          }
        ]
      },
      "event": {
        "type": "INVALID_QUOTE_REQUEST",
        "params": {
          "FSPIOPError": "PAYEE_ERROR",
          "message": "Payee FSP has more than 1 active currency account. Switch does not support more than 1 active currency account for Forex Requests"
        }
      }
    }
  ]

Additional Notes

N/A