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

Comment issues #52

Closed
ducthotran2010 opened this issue Nov 4, 2022 · 4 comments · Fixed by #77
Closed

Comment issues #52

ducthotran2010 opened this issue Nov 4, 2022 · 4 comments · Fixed by #77
Assignees

Comments

@ducthotran2010
Copy link
Contributor

ducthotran2010 commented Nov 4, 2022

    I think we need a more detailed explanation for these three functions, in order to differentiate the usage of these three.

Originally posted by @nxqbao in #22 (comment)

/**
* @dev Deprecates the pool.
*
* Requirements:
* - The method caller is validator contract.
*
* Emits the event `PoolsDeprecated` and `Unstaked` events.
* Emits the event `StakedAmountDeprecated` if the contract cannot transfer RON back to the pool admin.
*
*/
function deprecatePools(address[] calldata _pools) external;

@ducthotran2010
Copy link
Contributor Author

ducthotran2010 commented Nov 4, 2022

    Unclear comments

Originally posted by @nxqbao in #22 (comment)

* - The total number of schedules is not larger than `maxSchedules()`.

@ducthotran2010
Copy link
Contributor Author

    Should list what will be done when wrapping up an epoch.

Originally posted by @nxqbao in #22 (comment)

/**
* @dev Wraps up the current epoch.
*
* Requirements:
* - The method must be called when the current epoch is ending.
* - The epoch is not wrapped yet.
* - The method caller is coinbase.
*
* Emits the event `MiningRewardDistributed` when some validator has reward distributed.
* Emits the event `StakingRewardDistributed` when some staking pool has reward distributed.
* Emits the event `BlockProducerSetUpdated` when the epoch is wrapped up.
* Emits the event `BridgeOperatorSetUpdated` when the epoch is wrapped up at period ending.
* Emits the event `ValidatorSetUpdated` when the epoch is wrapped up at period ending, and the validator set gets updated.
* Emits the event `WrappedUpEpoch`.
*
*/
function wrapUpEpoch() external payable;

@ducthotran2010
Copy link
Contributor Author

    1. `. IE: scheduling maintenance.`

=> , e.g. scheduling maintenance.

  1. Unclear document

Originally posted by @nxqbao in #22 (comment)

@ducthotran2010
Copy link
Contributor Author

    This doc is out date

Originally posted by @ducthotran2010 in #22 (comment)

nxqbao added a commit that referenced this issue Nov 11, 2022
@nxqbao nxqbao linked a pull request Nov 11, 2022 that will close this issue
nxqbao added a commit that referenced this issue Nov 13, 2022
@nxqbao nxqbao closed this as completed in bc4ebf7 Nov 13, 2022
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 a pull request may close this issue.

2 participants