From b9b135cfa2f32888021f88f9cba1d56e368e8b03 Mon Sep 17 00:00:00 2001 From: Greg Hysen Date: Wed, 25 Sep 2019 12:10:49 -0700 Subject: [PATCH] Finished removing outdated contract comments --- contracts/staking/README.md | 3 +-- contracts/staking/contracts/src/ZrxVault.sol | 12 ------------ .../contracts/src/fees/MixinExchangeManager.sol | 4 ---- .../staking/contracts/src/interfaces/IZrxVault.sol | 12 ------------ contracts/staking/contracts/src/stake/MixinStake.sol | 1 - .../contracts/src/stake/MixinStakeBalances.sol | 2 -- .../staking/contracts/src/sys/MixinFinalizer.sol | 7 +------ .../staking/contracts/src/sys/MixinScheduler.sol | 6 ------ 8 files changed, 2 insertions(+), 45 deletions(-) diff --git a/contracts/staking/README.md b/contracts/staking/README.md index eed97bdd07..025fabc9ea 100644 --- a/contracts/staking/README.md +++ b/contracts/staking/README.md @@ -22,7 +22,6 @@ The contracts can be found in `contracts/src`. * vaults/ | This contains the vaults (like the Zrx Token Vault). ``` - ## Installation **Install** @@ -83,4 +82,4 @@ yarn lint ```bash yarn test -``` \ No newline at end of file +``` diff --git a/contracts/staking/contracts/src/ZrxVault.sol b/contracts/staking/contracts/src/ZrxVault.sol index 7945568ae3..7e3be7532f 100644 --- a/contracts/staking/contracts/src/ZrxVault.sol +++ b/contracts/staking/contracts/src/ZrxVault.sol @@ -28,18 +28,6 @@ import "./libs/LibStakingRichErrors.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 Authorizable, IZrxVault diff --git a/contracts/staking/contracts/src/fees/MixinExchangeManager.sol b/contracts/staking/contracts/src/fees/MixinExchangeManager.sol index 939dba3230..16801ef558 100644 --- a/contracts/staking/contracts/src/fees/MixinExchangeManager.sol +++ b/contracts/staking/contracts/src/fees/MixinExchangeManager.sol @@ -24,10 +24,6 @@ import "../interfaces/IStakingEvents.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 IStakingEvents, MixinStorage diff --git a/contracts/staking/contracts/src/interfaces/IZrxVault.sol b/contracts/staking/contracts/src/interfaces/IZrxVault.sol index 4d6c7ba5c4..2e4596170c 100644 --- a/contracts/staking/contracts/src/interfaces/IZrxVault.sol +++ b/contracts/staking/contracts/src/interfaces/IZrxVault.sol @@ -19,18 +19,6 @@ 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 { /// @dev Emmitted whenever a StakingProxy is set in a vault. diff --git a/contracts/staking/contracts/src/stake/MixinStake.sol b/contracts/staking/contracts/src/stake/MixinStake.sol index 05329b1806..46149f3bbc 100644 --- a/contracts/staking/contracts/src/stake/MixinStake.sol +++ b/contracts/staking/contracts/src/stake/MixinStake.sol @@ -24,7 +24,6 @@ import "../staking_pools/MixinStakingPool.sol"; import "../libs/LibStakingRichErrors.sol"; -/// @dev This mixin contains logic for managing ZRX tokens and Stake. contract MixinStake is MixinStakingPool { diff --git a/contracts/staking/contracts/src/stake/MixinStakeBalances.sol b/contracts/staking/contracts/src/stake/MixinStakeBalances.sol index da20cdb8b4..9d227c6741 100644 --- a/contracts/staking/contracts/src/stake/MixinStakeBalances.sol +++ b/contracts/staking/contracts/src/stake/MixinStakeBalances.sol @@ -24,8 +24,6 @@ import "../interfaces/IStructs.sol"; import "./MixinStakeStorage.sol"; -/// @dev This mixin contains logic for querying stake balances. -/// **** Read MixinStake before continuing **** contract MixinStakeBalances is MixinStakeStorage { diff --git a/contracts/staking/contracts/src/sys/MixinFinalizer.sol b/contracts/staking/contracts/src/sys/MixinFinalizer.sol index e051dfd426..0db85a3e4c 100644 --- a/contracts/staking/contracts/src/sys/MixinFinalizer.sol +++ b/contracts/staking/contracts/src/sys/MixinFinalizer.sol @@ -27,11 +27,6 @@ import "../interfaces/IStructs.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 MixinStakingPoolRewards { @@ -96,7 +91,7 @@ contract MixinFinalizer is } /// @dev Instantly finalizes a single pool that was active in the previous - /// epoch, crediting it rewards for members and withdrawing operator's + /// epoch, crediting it rewards for members and withdrawing operator's /// rewards as WETH. This can be called by internal functions that need /// to finalize a pool immediately. Does nothing if the pool is already /// finalized or was not active in the previous epoch. diff --git a/contracts/staking/contracts/src/sys/MixinScheduler.sol b/contracts/staking/contracts/src/sys/MixinScheduler.sol index dfa4564b4e..90f76c22f9 100644 --- a/contracts/staking/contracts/src/sys/MixinScheduler.sol +++ b/contracts/staking/contracts/src/sys/MixinScheduler.sol @@ -25,12 +25,6 @@ import "../immutable/MixinStorage.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 IStakingEvents, MixinStorage