llamaxyz / llama

Llama is an onchain governance and access control framework for smart contracts.
https://llama.xyz
MIT License
47 stars 5 forks source link

refactor: rename `RoleCheckpoints` library to `BalanceCheckpoints` #427

Closed mds1 closed 1 year ago

mds1 commented 1 year ago

Ref https://github.com/llamaxyz/llama/pull/413#discussion_r1265669590

The RoleCheckpoints and SupplyCheckpoints names are a bit confusing to me. Both of them are role checkpoints but RoleCheckpoints are for PolicyholderRoles and SupplyCheckpoints are for the aggregate sums.

What do you think of BalanceCheckpoints and SupplyCheckpoints? Ref https://github.com/llamaxyz/llama/pull/413#discussion_r1256561849

Confirmed in discord that we're good with BalanceCheckpoints as the new library name

0xrajath commented 1 year ago

If we're trying to be more explicit, then I think we should call it QuantityExpirationCheckpoints. I don't think BalanceCheckpointsparticularly makes sense here.

cc: @AustinGreen @mds1

mds1 commented 1 year ago

That feels a bit long, could do QuantityExpirationCkpts or just UserCheckpoints. Ultimately I don't feel too strongly here so up to you all. The variable name is roleBalanceCkpts so calling this BalanceCheckpoints is consistent with that

0xrajath commented 1 year ago

Ah I see that makes sense. Final question: Should it be RoleBalanceCheckpoints and RoleSupplyCheckpoints to make it more explicit?

AustinGreen commented 1 year ago

I would just keep them one word each UserCheckpoints and SupplyCheckpoints sound the best to me