Skip to content

Angstrom review / refactor#6

Merged
EndymionJkb merged 16 commits intorouter-tests-and-renamingfrom
angstrom-updates-v2
Sep 16, 2025
Merged

Angstrom review / refactor#6
EndymionJkb merged 16 commits intorouter-tests-and-renamingfrom
angstrom-updates-v2

Conversation

@EndymionJkb
Copy link
Contributor

@EndymionJkb EndymionJkb commented Sep 12, 2025

Description

Built on the original PR #1, this adds a ton of documentation (had to deep dive to understand and be able to review it properly), and also does a fair bit of refactoring. Specifically:

  1. Adds a BaseTest layer and helpers (e.g., to make an account a node), saving a lot of duplicate code
  2. Renames internal variables to be more specific about what they mean
  3. Retains error names (even though I really don't like them!) for compatibility
  4. Separates things that were combined together; e.g., using modifiers for simple checks, encapsulating the block setting in unlockAngstrom, and taming all the various unlock functions for clarity, mostly meaning renaming them semantically.
  5. Providing a single external manual unlock
  6. Adding getters for internal state
  7. No semantic changes to tests - just incorporating the base test and helpers

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • Dependency changes
  • Code refactor / cleanup
  • Optimization: [ ] gas / [ ] bytecode
  • Documentation or wording changes
  • Other

Checklist:

  • The diff is legible and has no extraneous changes
  • Complex code has been commented, including external interfaces
  • Tests have 100% code coverage
  • The base branch is either main, or there's a description of how to merge

Issue Resolution

@EndymionJkb EndymionJkb requested a review from jubeira September 12, 2025 15:42
Copy link
Collaborator

@joaobrunoah joaobrunoah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! For sure it's better organized.

}

mapping(address => bool) internal _nodes;
modifier onlyWhenLocked() {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, nice!

@EndymionJkb EndymionJkb merged commit 6b24bc5 into router-tests-and-renaming Sep 16, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants