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.

Sign up for GitHub

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

Jump to bottom

Renamings for consistency #1134

Open
4 tasks
PaulRBerg opened this issue Jan 6, 2025 · 1 comment
Open
4 tasks

Renamings for consistency #1134

PaulRBerg opened this issue Jan 6, 2025 · 1 comment
Assignees
@PaulRBerg
Labels
effort: low Easy or tiny task that takes less than a day. priority: 3 Nice-to-have. Willing to ship without this. type: refactor Change that neither fixes a bug nor adds a feature. work: clear Sense-categorize-respond. The relationship between cause and effect is clear.

Comments

@PaulRBerg
Copy link
Member

PaulRBerg commented Jan 6, 2025 •
edited
Loading

It would be nice if we can get these refactors included in the current release (Lockup v2.0.0). I'll ask the auditors, but if they balk, I'd be OK with leaving this for v2.1.0

  • Rename VestingMath to StreamingMath
  • Shorten the model names to LL, LT, and LD
    • In this function series: from calculateLockupLinearStreamedAmount to calculateStreamedAmountLL
    • And from checkCreateLockupLinear to checkCreateLL

There are two issues with the current names:

  1. We maintain a duplicity of naming modalities for the models: (i) the longer form ("Lockup Linear"), and (ii) the short form ("LL")
  2. There's an inconsistent ordering: some functions contain the model in the middle, while others contain it at as a suffix
@PaulRBerg PaulRBerg added effort: low Easy or tiny task that takes less than a day. priority: 3 Nice-to-have. Willing to ship without this. type: refactor Change that neither fixes a bug nor adds a feature. work: clear Sense-categorize-respond. The relationship between cause and effect is clear. labels Jan 6, 2025
@PaulRBerg PaulRBerg self-assigned this Jan 6, 2025
@PaulRBerg PaulRBerg changed the title Non-essential renamings Renamings for consistency Jan 8, 2025
@smol-ninja
Copy link
Member

Since you have assigned it to yourself @PaulRBerg, should I add it to the next Sprint or are you interested into doing it before the release?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@PaulRBerg PaulRBerg

Labels
effort: low Easy or tiny task that takes less than a day. priority: 3 Nice-to-have. Willing to ship without this. type: refactor Change that neither fixes a bug nor adds a feature. work: clear Sense-categorize-respond. The relationship between cause and effect is clear.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@smol-ninja @PaulRBerg