[CENT-392] write README for MINT p0 #229
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
o-a-hudson
reviewed
Oct 19, 2018
doc/masterminter.md
Outdated
| @@ -0,0 +1,101 @@ | |||
| # MasterMinter contract | |||
| The MasterMinter is a governance contract. It delegates the functionality | |||
| of the `masterMinter` role in the Centre USDC contract to multiple addresses. | |||
There was a problem hiding this comment.
I think we always use the upper case of CENTRE.
doc/masterminter.md
Outdated
| contract to call minter management functions on the FiatToken contract: | ||
|
|
||
| - `configureMinter(minter, allowance)` - Enables the `minter` and sets its minting allowance. | ||
| - `removeMinter(minter)` - Disables the `minter` and sets its mintingallowance to 0. |
There was a problem hiding this comment.
"mintingallowance" looks like a typo.
doc/masterminter.md
Outdated
| The private keys to the `AllowanceController` and `SecurityController` should stay in cold storage. | ||
| This configuration lets the Controller keep multiple warm `incrementMinterAllowance` transactions on hand, | ||
| as well as the `removeMinter` transaction in case of a problem. Broadcasting the `removeMinter` transaction | ||
| will cause all future `incrementMinterAllowance` transactions to `throw`. Since there two types |
There was a problem hiding this comment.
Looks like there should be "the"
|
Fixed all typos detected by @o-a-hudson |
o-a-hudson
approved these changes
Oct 22, 2018
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.
The file doc/masterminter.md is a README file explaining the usage and functionality of the MasterMinter contract.