finos / open-reg-tech-us-lcr

Open Reg Tech: US LCR

FINOS Open Reg Tech - LCR

Welcome to the Open Reg Tech implementation of the US Liquidity Coverage Ratio (LCR). The goal of the project is to establish the delivery and collaboration of regulations in code.

Documentation

The Documentation Is a good place to read about the LCR regulation and how this project implements it.

In addition, FINOS runs a server with the Latest Interactive LCR to explore the implementation for non-technical users.

Using the LCR

The LCR can be generated into any target language or platform supported by Morphir. See the Morphir Documentation on Generating for details on available generators.

As a convenience, this project includes configuration for generating into Scala with Maven. To use it, ensure that Maven is installed and run:

mvn build

to build a library .jar file that can be included in a Scala or Java project.

Status

The current implementation is almost complete. We've left a small portion incomplete so that we can finish the remainder as a community. This will provide experience and insight on the experience of the community collaborating on regulations.

Tentative Roadmap

1. Agree on the regulation (LCR)
2. Contribute existing LCR implementation into a new project in FINOS (done)
3. Implement the remainder of the LCR as a Open Reg Tech SIG team effort
4. Decide on an execution environment (i.e., Spark)
5. Enable procurement of the data with Legend
6. Demonstrate the complete solution.

Contributing

1. Fork it (https://github.com/finos/open-reg-tech-us-lcr/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Read our contribution guidelines and Community Code of Conduct
4. Commit your changes (git commit -am 'Add some fooBar')
5. Push to the branch (git push origin feature/fooBar)
6. Create a new Pull Request

NOTE: Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool (or EasyCLA). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.

Need an ICLA? Unsure if you are covered under an existing CCLA? Email [email protected]

License

Copyright 2022 Fintech Open Source Foundation

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0

open-reg-tech-us-lcr's Issues

https://lcr-interactive.finos.org is down

It seems that the LCR-interactive Docker image built by the Github action (on every push on main) is currently broken, and as a consequence, also https://lcr-interactive.finos.org is down

To reproduce the issue:

git clone https://github.com/finos/open-reg-tech-us-lcr.git
cd open-reg-tech-us-lcr
docker build . -t morphir-lcr
docker run --name morphir-lcr-container -p 3000:3000 morphir-lcr:latest

If you access http://localhost:3000 you should get a "Connection Reset" issue.

Besides finding the issue and addressing it, I suggest that we

1. Update our ECS deployment so that deployed versions point to a specific image SHA; this way a deployed version will not change with new image releases and we'll guarantee stability for https://lcr-interactive.finos.org
2. Monitor https://lcr-interactive.finos.org (using existing FINOS monitoring tools)

Consider automating ECS rolling deployment when a new LCR image is built

The publish-docker GHA allows to publish automatically the LCR Docker image on every code change.

However, the ECS cluster that serves https://lcr-interactive.finos.org/ doesn't get redeployed using the new image definition; in order to achieve such automation, there are some AWS GitHub Actions that are documented on https://aws.amazon.com/blogs/containers/create-a-ci-cd-pipeline-for-amazon-ecs-with-github-actions-and-aws-codebuild-tests/

Tasks:

• Define GHA code
• Configure IAM credentials
• Setup GitHub Secrets accordingly