hiero-ledger / hiero-ledger/hiero-consensus-node

Rename `SequenceSet` and `SequenceMap` data structures

Open
#26,915 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Tech Debt Reduced
Dominant language
Java
Stars
407
Forks
226
Avg merge
3d 4h
Merged PRs (30d)
210

Description

These data structures were created to keep track of events (or other items) that have a number that only ever increases in value over time but also can be repeated among items. This was called the sequence number, and for events it is always birth round.

Since the data structures were created, we added a `sequenceNumber` field to events which makes these data structure very confusing. Rename the structures and the currently named `sequenceNumber` inside of them to something else that does not collide with an events field. Some ideas are below, but there are probably better ones:

- `OrderedGroupSet/Map`
- `IncreasingGroupSet/Map`

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the repository for the SequenceSet and SequenceMap declarations and every use of their sequenceNumber member. Review the surrounding event code to choose names that do not collide with the event field, then rename the structures and member consistently and run the affected tests and build to confirm all references compile.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.