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.

Sign up for GitHub

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 extra dev notes about purpose and intention of contract. #43

Merged
merged 1 commit into from
Oct 7, 2024
Merged

Add extra dev notes about purpose and intention of contract. #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions contracts/ChildChainGaugeInjectorV2.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ import "@openzeppelin/contracts/proxy/utils/Initializable.sol";
* @notice This contract is meant to run/manage a single token. This is almost always the case for a DAO trying to use such a thing.
* @notice This contract will only function if it is configured as the distributor for a token/gauge it is operating on.
* @notice This contract is Ownable and has lots of sweep functionality to allow the owner to work with the contract or get tokens out should there be a problem.
* @dev This contract is intended to be a helper to aid an incentives manager in working with Balancer gauges.
* @dev It's intent is to provide maximum flexibility to the owner, not make any guarantees about the future on-chain.
* @dev A number of safeguards are available to help the owner from making mistakes.
* @dev Any contract that will be an owner of this contract should either have passthrough functions to change owner, or sweep all funds.
Copy link
Collaborator

Choose a reason for hiding this comment

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

overall all these tags are great additions! ✅

the more info/context the better, specially for any corner cases 👍

imo L23, L24 may fall within @dev, while L21 AND 22. can stay as is

* see https://docs.chain.link/chainlink-automation/utility-contracts/
*/
contract ChildChainGaugeInjectorV2 is
Expand Down
Loading