Skip to content

mojaloop/simulator

Repository files navigation

simulators

Git Commit Git Releases Docker pulls CircleCI

Simulators that act as mock payer fsp and payee fsp which interact with the Switch.

Environmental Vars for FSP Simulator configuration

Variable Description Default
PARTIES_ENDPOINT Mojaloop Callback Endpoint for Parties 'http://localhost:1080'
QUOTES_ENDPOINT Mojaloop Callback Endpoint for Quotes 'http://localhost:1080'
TRANSFERS_ENDPOINT Mojaloop Callback Endpoint for Transfers 'http://localhost:1080'
TRANSFERS_FULFIL_RESPONSE_DISABLED Flag to disable the Fulfil response callback to the TRANSFER_ENDPOINT 'false'
ILP_SECRET Secret used for ILP packet, condition and fufil generation 'Quaixohyaesahju3thivuiChai5cahng'
MOCK_JWS_SIGNATURE Mock JWS SIgnature used for PUT messages 'abcJjvNrkyK2KBieDUbGfhaBUn75aDUATNF4joqA8OLs4QgSD7i6EO8BIdy6Crph3LnXnTM20Ai1Z6nt0zliS_qPPLU9_vi6qLb15FOkl64DQs9hnfoGeo2tcjZJ88gm19uLY_s27AJqC1GH1B8E2emLrwQMDMikwQcYvXoyLrL7LL3CjaLMKdzR7KTcQi1tCK4sNg0noIQLpV3eA61kess'

Environment Variables for Metrics configuration

Variable Description Default
METRICS_DISABLED Flag to disable the Prometheus Metric collection end-point false
METRICS_PREFIX Prefix for all Prometheus Metrics 'moja_sim_'
METRICS_TIMEOUT Prometheus Metric collection timeout 5000
METRICS_SERVICENAME Prometheus Metric serviceName label applied to all Simulator metrics simulator

Building Docker image:

$ VER=v1.0.6-snapshot; docker build -t mojaloop/simulator:$VER .; docker push mojaloop/simulator:$VER

Run in Docker (in Dev)

$ docker-compose up

or (to rebuild the docker image if source code has been modified)

$ docker-compose up --build

Auditing Dependencies

We use npm-audit-resolver along with npm audit to check dependencies for vulnerabilities, and keep track of resolved dependencies with an audit-resolv.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-resolv.json to ensure that CircleCI will build correctly.