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.

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

Merged

Conversation

0xsarvesh
Copy link
Contributor

Fixes #685

Updated code documentation with terminology of coin and ost instead of base token and token.

Also updated TokenWrapped to OSTWrapped and TokenUnwrapped to OSTUnwrapped

@schemar schemar self-assigned this Apr 1, 2019
Copy link
Contributor

@schemar schemar left a 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.

contracts/gateway/OSTPrime.sol Outdated Show resolved Hide resolved
contracts/gateway/OSTPrime.sol Outdated Show resolved Hide resolved
contracts/gateway/OSTPrime.sol Outdated Show resolved Hide resolved
@schemar schemar removed their assignment Apr 1, 2019
@0xsarvesh
Copy link
Contributor Author

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?
we discussed that TokenWrapped and TokenUnwrapped should be changed to OSTWrapped and OSTUnwrapped.

/** Emitted whenever OST Prime token is converted to OST Prime base token. */
event TokenUnwrapped(
/** Emitted whenever OST is converted to coin. */
event OSTUnwrapped(
Copy link
Contributor

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

Copy link
Contributor

@benjaminbollen benjaminbollen left a 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

contracts/gateway/OSTPrime.sol Outdated Show resolved Hide resolved
contracts/gateway/EIP20CoGateway.sol Outdated Show resolved Hide resolved
contracts/gateway/EIP20CoGateway.sol Outdated Show resolved Hide resolved
contracts/gateway/OSTPrime.sol Outdated Show resolved Hide resolved
contracts/gateway/OSTPrime.sol Outdated Show resolved Hide resolved
contracts/gateway/OSTPrime.sol Outdated Show resolved Hide resolved
contracts/gateway/OSTPrime.sol Outdated Show resolved Hide resolved
contracts/gateway/OSTPrime.sol Outdated Show resolved Hide resolved
Copy link
Contributor

@benjaminbollen benjaminbollen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@benjaminbollen benjaminbollen merged commit 43f4680 into OpenST:develop Apr 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants