-
Notifications
You must be signed in to change notification settings - Fork 1
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
π feat(domain-config): Domain config for Tokens/LendingProtocols etc #51
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
piotrwitek
requested changes
Oct 13, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wanted to propose improved naming conventions for better readibility and maintainability of the code.
- Enums usually use a singular form
DenominationSymbol
instead ofDenominationSymbols
, a lot of inconsistency here for example:LendingProtocol
enum is singular butNetworks
enum is plurar
- It would be great to use a single convention and the singular form is preferable across the industry, e.g. check TS docs for reference: https://www.typescriptlang.org/docs/handbook/enums.html
- Dictionaries usually use different conventions than arrays:
tokens
- I would expect that to return and array of tokens, but in reality it returns a dictionary mapping symbols to tokens- I would like to propose to use clearer convention to name such dictionaries for example take a look at
tokensByNetwork
Which actually uses a pretty clear convention that on a first glance tell me that it contains a mapping of tokens with network as key - So I would rename
tokens
totokenByTokenSymbol
- Also adding simple description comment for each dictionary object would be great but good name using convention should be enough
piotrwitek
reviewed
Oct 13, 2023
piotrwitek
reviewed
Oct 13, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice, docs looks solid now π
piotrwitek
reviewed
Oct 13, 2023
piotrwitek
reviewed
Oct 13, 2023
piotrwitek
reviewed
Oct 13, 2023
piotrwitek
reviewed
Oct 13, 2023
piotrwitek
approved these changes
Oct 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes π·ββοΈ
Separate PR [Is out of date] -> (https://github.com/OasisDEX/oasis-borrow/pull/2973/files) have created a custom script to parse the config object and generate enums/interfaces for it.