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

Consolidate key logic into fewer locations #18236

Open
5 of 15 tasks
mhess-swl opened this issue Mar 7, 2025 · 0 comments · May be fixed by #18237
Open
5 of 15 tasks

Consolidate key logic into fewer locations #18236

mhess-swl opened this issue Mar 7, 2025 · 0 comments · May be fixed by #18237
Assignees
Milestone

Comments

@mhess-swl
Copy link
Contributor

Background

There are numerous places in the codebase where logic for handling Ed25519 and Secp256k1 (ECDSA) keys. This ticket represents a refactoring effort to consolidate said logic into fewer locations, both so 1) the logic isn't as difficult to find and 2) we reduce duplication.

Acceptance Criteria

  1. Common key logic is refactored into fewer places
  2. Logic specific to key types (Ed25519, Secp256k1) is separated from common key logic
  3. Key reads and writes for both key types use the same (read/write) algorithms

Keys are fundamental throughout our unit and hapi test suites, so ensuring that existing tests all pass should be sufficient to verify correctness.

Dependencies

None

Definition of Ready (DoR) Checklist

  • Clear acceptance criteria
  • Clear and detailed description
  • Dependencies identified
  • Links to documentation
  • Should be completable in 2-3 Days
  • Initial draft of Low-level design document
  • At least high level test plan
  • Groomed/Estimated

Definition of Done (DoD) Checklist

  • Acceptance Criteria complete
  • No Codacy issues greater than minor (in new code)
  • JavaDocs updated/created
  • Code commented
  • Unit tests created/updated
  • 80% test code coverage (in new code)
  • Happy Path and major negative cases in HAPI tests as applicable
@mhess-swl mhess-swl self-assigned this Mar 7, 2025
@mhess-swl mhess-swl added this to the v0.61 milestone Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant