FIO Registration Site
- Eric Butz
Overview
The following outlines the work requirements for the FIO Registration Site project. The registration site allows wallets and exchanges who are integrating FIO Protocol to link their users to a 3rd party site to enable FIO Crypto Handle and FIO Domain registrations.
Registration Site
The registration site has has both an API interface that can be called by wallets and exchanges, a UI for users, and an "Admin UI" for managing the profiles of different wallets.
Reg Production: https://reg.fioprotocol.io/admin
Reg UAT: https://reg.fio.dev/admin
Reg UAT Testing: https://reg-testing.fio.dev/admin
API Documentation
Wallets and exchanges may either decide to create their own UI for handling FIO Crypto Handle and Domain registrations or they may link their users to the Registration UI.
The API documentation runs on Github Pages: https://developers.fioprotocol.io/pages/api/fio-reg-api/
In order to access the API, wallets and exchanges must first set up a wallet profile using the Admin UI.
Registration UI
Wallet and exchanges can link their users out to to the registration site. It is possible to pass in different parameters including the user’s FIO Public Key, the type of registration (address or domain) and the name of the referring wallet. For example:
Admin UI
There is also an administrative UI that enables:
Search for specific registrations (in case of failure, underpayment, etc)
Maintain admin users
The setup of new wallet and exchange profiles
Development Environment
The registration site is open-source on Github: https://github.com/fioprotocol/fio-registrations
Devops
The registration site is currently maintained on AWS. It consists of a production site, UAT site, and testing site each with:
RDS db.r5.xlarge
ECS container
EC2 (Fargate)
Application load balancer
Code pipeline
There are several services that monitor site performance and report to the FIO Discord Channel, including:
Site response time in seconds
The number of 5xx errors that the resource returns in the application
CPU utilization
RAM utilization
Scope of Work
There are two components of the Registration Site scope of work: development/QA and Devops/Infrastructure.
Development and QA
FIO is looking for a development partner to develop new features and maintain existing features for the FIO registration site. This includes:
Task | Description | KPI |
|---|---|---|
Critical bug fixes | Bugs that prevent crypto handle and domain registrations or other site features from being accessed or used. | 4 hour response and fixed in hot fix release within 12 hours |
Non-critical bugs | Non-critical bugs and minor fixes. | Fixed in next release cycle |
New features | New features proposed by FIO. | Feature would be scoped by development partner who would deliver a development plan and schedule |
Manual QA | Manual QA of site for every release to ensure no regressions have been introduced. | QA report produced for every release |
Project management | Management and reporting of project progress | Report that shows current bug/feature list and release schedule. |
Release management | Deployment of releases and hot fixes. This would utilize the current CI pipeline tied to Github. | Bi-monthly release cycle |
Integrator profile support | Add new integrators to site, manage API keys, make updates to existing integrator profiles as needed. |
|
Hosting and site monitoring | Create and maintain monitors for:
|
|
Future Projects |
|
|
Automated QA | Write automated QA regression tests (these do not currently exist) | Automated test suite that is run as part of CI pipeline |
Security testing | Security and penetration testing of site | Security report |
|
|
|
The current list of bugs/features is here (requires login): https://fioprotocol.atlassian.net/browse/BD-2430
Devops
Currently provided by FIO partner EZOps