Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Apr20] Technical Debt Week #867

Closed
mratsim opened this issue Apr 7, 2020 · 2 comments
Closed

[Apr20] Technical Debt Week #867

mratsim opened this issue Apr 7, 2020 · 2 comments
Labels
❗ high priority Important feature for NBC
Milestone

Comments

@mratsim
Copy link
Contributor

mratsim commented Apr 7, 2020

In preparation for audit we need to pay our technical debt.

Goals:

  • After audit it will be significantly harder to change the codebase if we don't want to invalidate the audit.
  • The codebase has accumulated cruft, in particular when pushing for the tesnet in March 2019 and the interop event in September 2019. Cleaning this up will help documentation which will help auditors getting up to speed with our codebase.
  • Part of the codebase has poor test coverage. In the future we will likely require significant refactoring, with a well covered test suite, those refactorings will be much less likely to introduce regressions and those will be easier to narrow down too.

This is a meta-issue, please create linked issues in the relevant codebase with desired concrete and actionable outcomes.
In particular "improve network stability" is not enough.

Identified targets:

  1. Simplification of the codebase to ease debuggability:
  • Usage and/or debugging of macros in network protocols
  1. Improve test coverage of:
  • block pool
  • validator pool
  • attestation pool
@mratsim
Copy link
Contributor Author

mratsim commented Jun 3, 2020

@mratsim
Copy link
Contributor Author

mratsim commented Jun 3, 2020

Additionally all the result/error and Exceptions refactorings

@mratsim mratsim closed this as completed Jun 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
❗ high priority Important feature for NBC
Projects
None yet
Development

No branches or pull requests

2 participants