crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Finished removing outdated contract comments

Browse Source
This commit is contained in:
Greg Hysen 2019-09-25 12:10:49 -07:00
parent ca2e9bed27
commit b9b135cfa2
8 changed files with 2 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
contracts/staking/README.md
View File

@ -22,7 +22,6 @@ The contracts can be found in `contracts/src`.
* vaults/ | This contains the vaults (like the Zrx Token Vault). * vaults/ | This contains the vaults (like the Zrx Token Vault).
``` ```
## Installation ## Installation
**Install** **Install**

12
contracts/staking/contracts/src/ZrxVault.sol
View File

@ -28,18 +28,6 @@ import "./libs/LibStakingRichErrors.sol";
import "./interfaces/IZrxVault.sol"; import "./interfaces/IZrxVault.sol";
/// @dev This vault manages Zrx Tokens.
/// When a user mints stake, their Zrx Tokens are deposited into this vault.
/// Similarly, when they burn stake, their Zrx Tokens are withdrawn from this vault.
/// The contract also includes management of the staking contract
/// and setting the vault to "Catastrophic Failure Mode".
/// Catastrophic Failure Mode should only be set iff there is
/// non-recoverable corruption of the staking contracts. If there is a
/// recoverable flaw/bug/vulnerability, simply detach the staking contract
/// by setting its address to `address(0)`. In Catastrophic Failure Mode, only withdrawals
/// can be made (no deposits). Once Catastrophic Failure Mode is invoked,
/// it cannot be returned to normal mode; this prevents corruption of related
/// state in the staking contract.
contract ZrxVault is contract ZrxVault is
Authorizable, Authorizable,
IZrxVault IZrxVault

4
contracts/staking/contracts/src/fees/MixinExchangeManager.sol
View File

@ -24,10 +24,6 @@ import "../interfaces/IStakingEvents.sol";
import "../immutable/MixinStorage.sol"; import "../immutable/MixinStorage.sol";
/// @dev This mixin contains logic for managing exchanges.
/// Any exchange contract that connects to the staking contract
/// must be added here. When an exchange contract is deprecated
/// then it should be removed.
contract MixinExchangeManager is contract MixinExchangeManager is
IStakingEvents, IStakingEvents,
MixinStorage MixinStorage

12
contracts/staking/contracts/src/interfaces/IZrxVault.sol
View File

@ -19,18 +19,6 @@
pragma solidity ^0.5.9; pragma solidity ^0.5.9;
/// @dev This vault manages Zrx Tokens.
/// When a user mints stake, their Zrx Tokens are deposited into this vault.
/// Similarly, when they burn stake, their Zrx Tokens are withdrawn from this vault.
/// The contract also includes management of the staking contract
/// and setting the vault to "Catastrophic Failure Mode".
/// Catastrophic Failure Mode should only be set iff there is
/// non-recoverable corruption of the staking contracts. If there is a
/// recoverable flaw/bug/vulnerability, simply detach the staking contract
/// by setting its address to `address(0)`. In Catastrophic Failure Mode, only withdrawals
/// can be made (no deposits). Once Catastrophic Failure Mode is invoked,
/// it cannot be returned to normal mode; this prevents corruption of related
/// state in the staking contract.
interface IZrxVault { interface IZrxVault {
/// @dev Emmitted whenever a StakingProxy is set in a vault. /// @dev Emmitted whenever a StakingProxy is set in a vault.

1
contracts/staking/contracts/src/stake/MixinStake.sol
View File

@ -24,7 +24,6 @@ import "../staking_pools/MixinStakingPool.sol";
import "../libs/LibStakingRichErrors.sol"; import "../libs/LibStakingRichErrors.sol";
/// @dev This mixin contains logic for managing ZRX tokens and Stake.
contract MixinStake is contract MixinStake is
MixinStakingPool MixinStakingPool
{ {

2
contracts/staking/contracts/src/stake/MixinStakeBalances.sol
View File

@ -24,8 +24,6 @@ import "../interfaces/IStructs.sol";
import "./MixinStakeStorage.sol"; import "./MixinStakeStorage.sol";
/// @dev This mixin contains logic for querying stake balances.
/// **** Read MixinStake before continuing ****
contract MixinStakeBalances is contract MixinStakeBalances is
MixinStakeStorage MixinStakeStorage
{ {

5
contracts/staking/contracts/src/sys/MixinFinalizer.sol
View File

@ -27,11 +27,6 @@ import "../interfaces/IStructs.sol";
import "../staking_pools/MixinStakingPoolRewards.sol"; import "../staking_pools/MixinStakingPoolRewards.sol";
/// @dev This mixin contains functions related to finalizing epochs.
/// Finalization occurs AFTER the current epoch is ended/advanced and
/// over (potentially) multiple blocks/transactions. This pattern prevents
/// the contract from stalling while we finalize rewards for the previous
/// epoch.
contract MixinFinalizer is contract MixinFinalizer is
MixinStakingPoolRewards MixinStakingPoolRewards
{ {

6
contracts/staking/contracts/src/sys/MixinScheduler.sol
View File

@ -25,12 +25,6 @@ import "../immutable/MixinStorage.sol";
import "../interfaces/IStakingEvents.sol"; import "../interfaces/IStakingEvents.sol";
/// @dev This mixin contains logic for time-based scheduling.
/// All processes in the system are segmented into time intervals, called epochs.
/// Epochs have a fixed minimum time period that is configured when this contract is deployed.
/// The current epoch only changes by calling this contract, which can be invoked by anyone.
/// Epochs serve as the basis for all other time intervals, which provides a more stable
/// and consistent scheduling metric than time. TimeLocks, for example, are measured in epochs.
contract MixinScheduler is contract MixinScheduler is
IStakingEvents, IStakingEvents,
MixinStorage MixinStorage