-
Notifications
You must be signed in to change notification settings - Fork 31
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
Add vocabluary of coin and ost instead of base token and token #686
Add vocabluary of coin and ost instead of base token and token #686
Conversation
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 one 🙌
One major question, though: is it ok to change the interface? Or is this for release 0.11
? The events of OSTPrime
were renamed.
@benjaminbollen is it ok to change event name in the OST Prime contract? |
contracts/gateway/OSTPrime.sol
Outdated
/** Emitted whenever OST Prime token is converted to OST Prime base token. */ | ||
event TokenUnwrapped( | ||
/** Emitted whenever OST is converted to coin. */ | ||
event OSTUnwrapped( |
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.
TokenUnwrapped
is still correct, because the ERC20 token is unwrapped to become a base coin. Please update the comment along the same line
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.
please revisit with more diligence. we want to rename it to "base coin", and whenever OST is mentioned it should be specified whether it is "OST base coin" or "OST EIP20 token". thanks
…lso reverted event name changes
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.
LGTM, thanks!
Fixes #685
Updated code documentation with terminology of
coin
andost
instead ofbase token
andtoken
.Also updated
TokenWrapped
toOSTWrapped
andTokenUnwrapped
toOSTUnwrapped