Technical Debt List

[bryce-mcmath]

"Leave the campsite better than you found it"
- Boy Scouts

This is an ongoing list of noted technical debt, ordered roughly by which fix would have the most positive impact. If you are a Bifold maintainer, feel free to add to this list, if you are not you should still be able to add a comment with your suggestion and one of the maintainers will add it on your behalf.

Proof request logic

• nested many functions deep across different files
• includes some misnomers
• possibly move some processing to Credo
• currently very fragile while supporting many UI features like revocation notices, missing attributes, unsatisfied predicates, missing credentials, etc.

Onboarding logic

• prefer migrations rather than extra checks eg. rather than handle store values being more than one type, migrate existing users to the latest type that is expected as part of the loadState call / storage service fetch
• onboarding steps might be better as an ordered array of steps with metadata
• simplify the many effect dependencies and messy functions that determine where to pick up if the user has not finished onboarding, this is mostly a problem in the splash screen

Simplify OCA logic

• generalize useBranding hook and maker wider use of it
• possibly move more of the logic into the oca package

Navigation structure / componentization

• screen components should be very simple and only contain and pass down navigation logic
• reusable components, not reusable screens
• every entry in the Screens enum should only be for one screen, none used more than once in different stacks. eg. Screens.EnterPIN being used in two separate stacks for both wallet unlock and biometrics change confirmation would become Screens.EnterPIN for the former and Screens.VerifyPIN for the latter, with only components in common
• this will make test writing easier and tests more isolated

Refactor mainStack into it's own file

• this is a simple one, it is currently unlike all the other stacks and is tightly coupled with its parent RootStack component
• current approach is at risk of causing re-rendering issues

Folder structure

• replace legacy with just core
• move app to samples folder
• rename App to src

Releases

• Move to @bifold namespace (or @bifold-wallet, whichever is available)
• Add the ability to publish major, minor, and patch stable releases, as well as alpha releases (currently we only publish alpha releases)

[bryce-mcmath]

@MosCD3 @fc-santos @timbl-ont @jcdrouin21 @thiagoromanos FYI. Feel free to add to or comment on this list