Seeking front-end and back-end volunteer developers to complete the integration. |
Goals
- The ultimate goal is to enable the development of a low-cost money transfer service leveraging Apache Fineract (Mifos X) and the Stellar protocol for cross-border remittances and money transfers.
- The first and simplest use case would be to do an in-country money services between the two accounts of two clients at different financial institutions but both using Mifos and Stellar (a transfer between clients within the same institution doesn't need to utilize Stellar)
Background and strategic fit
What are we aiming to achieve with the Mifos/Stellar integration?
See https://docs.google.com/presentation/d/1-tdUsMBErylm7lRnDzdlFwVU3M63IoWq722YTVyp8D4/pub?start=false&loop=false&delayms=3000
Resources for developers
Existing Work Done on Integration to Date:
Assumptions
- Money transfer will be between clients belonging to two different financial institutions both having Mifos X and Stellar installed.
- Money transfer for first use case will be a transfer initiated by staff.
Requirements specification
The UI Screens in the Mifos X Web App and the remaining back-end work in the Apache Fineract platform need to be built out for. Use Case
API design requirements
Fluent interface wrapping JAXB. API documentation via Javadoc.
# | Title | User Story | Importance | Notes |
---|
1 | Configure Stellar Gateway | As a Mifos X System Administrator, I want to configure my Mifos X installation with Stellar Gateway as an External Service. | Must Have | - Additional considerations or noteworthy references (links, issues)
|
2 | Define Hook for Stellar Payload | As a Mifos X System Administrator, I need to define the wook which sends the information to Stellar needed to initiate the transfer. | | |
3 | Initiate Transfer | As a user of Mifos I need to be able to initiate a transfer via Stellar from a client's savings account | | |
4 | Execute Transfer | As a user of Mifos, I need to be able to execute a transfer from a Mifos savings account to another external savings account via Stellar | | |
5 | Receive Incoming Transfer | As a user I must be able to view successful and failed incoming transfers to savings accounts within Mifos | | |
6 | Self-Service transfer | As a client, I want to initiate a transfer from my own savings account via Stellar from the Mifos Self-Service Android App | | |
7 | | | | |
Design
Mockups can be found at https://openmf.mybalsamiq.com/projects/stellaruimockups/grid
Questions
Below is a list of questions to be addressed as a result of this requirements document:
Questions proposed by Jenny Yang after review of existing code:
- Stellar Connector is solely implemented by Myrle. Development team should understand it first before integrate with it.
- Additional features identified in the meeting, such as searching, should be evaluated and added to Stellar Conenctor.
- The repository was last updated 7 month ago. Test cases should be run to ensure the interface with Stella are still up to date and valid.
- Additional test cases to simulate Community App Integration, like the API calls from the 5 mock up screen, should be developed.
- Stellar Connector Interface Specification (for Community App integration), and Stellar Connector Technical Approach Document (for Stellar Connector maintenance), should be drafted.
- Stellar Integration design should be presented to Myrle for review and approval before the actual development starts.
Not Doing