generated from AngleProtocol/boilerplate
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Puffer wrapper new contract (#98)
* feat: add fragment contract * rm: hardhat * fix: puffer wrapper * fix: bun std * feat: add sonic fragment * feat: fragment * feat: point token * fix: tests * fix: access control schema * fix: wrapper * fix: deployment * fix: updating script
- Loading branch information
Showing
11 changed files
with
575 additions
and
17 deletions.
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| // SPDX-License-Identifier: GPL-3.0 | ||
|
|
||
| pragma solidity ^0.8.7; | ||
|
|
||
| import "@openzeppelin/contracts/token/ERC20/ERC20.sol"; | ||
| import { IAccessControlManager } from "../../interfaces/IAccessControlManager.sol"; | ||
| import "../../utils/Errors.sol"; | ||
|
|
||
| /// @title PointToken | ||
| /// @author Angle Labs, Inc. | ||
| /// @notice Reference contract for points systems within Merkl | ||
| contract PointToken is ERC20 { | ||
| mapping(address => bool) public minters; | ||
| mapping(address => bool) public whitelistedRecipients; | ||
| IAccessControlManager public accessControlManager; | ||
| uint8 public allowedTransfers; | ||
|
|
||
| constructor( | ||
| string memory name_, | ||
| string memory symbol_, | ||
| address _minter, | ||
| address _accessControlManager | ||
| ) ERC20(name_, symbol_) { | ||
| if (_accessControlManager == address(0) || _minter == address(0)) revert Errors.ZeroAddress(); | ||
| accessControlManager = IAccessControlManager(_accessControlManager); | ||
| minters[_minter] = true; | ||
| } | ||
|
|
||
| modifier onlyGovernorOrGuardian() { | ||
| if (!accessControlManager.isGovernorOrGuardian(msg.sender)) revert Errors.NotGovernorOrGuardian(); | ||
| _; | ||
| } | ||
|
|
||
| modifier onlyMinter() { | ||
| if (!minters[msg.sender]) revert Errors.NotTrusted(); | ||
| _; | ||
| } | ||
|
|
||
| function mint(address account, uint256 amount) external onlyMinter { | ||
| _mint(account, amount); | ||
| } | ||
|
|
||
| function burn(address account, uint256 amount) external onlyMinter { | ||
| _burn(account, amount); | ||
| } | ||
|
|
||
| function mintBatch(address[] memory accounts, uint256[] memory amounts) external onlyMinter { | ||
| uint256 length = accounts.length; | ||
| for (uint256 i = 0; i < length; ++i) { | ||
| _mint(accounts[i], amounts[i]); | ||
| } | ||
| } | ||
|
|
||
| function toggleMinter(address minter) external onlyGovernorOrGuardian { | ||
| minters[minter] = !minters[minter]; | ||
| } | ||
|
|
||
| function toggleAllowedTransfers() external onlyGovernorOrGuardian { | ||
| allowedTransfers = 1 - allowedTransfers; | ||
| } | ||
|
|
||
| function toggleWhitelistedRecipient(address recipient) external onlyGovernorOrGuardian { | ||
| whitelistedRecipients[recipient] = !whitelistedRecipients[recipient]; | ||
| } | ||
|
|
||
| function _beforeTokenTransfer(address from, address to, uint256) internal view override { | ||
| if ( | ||
| allowedTransfers == 0 && | ||
| from != address(0) && | ||
| to != address(0) && | ||
| !whitelistedRecipients[from] && | ||
| !whitelistedRecipients[to] | ||
| ) revert Errors.NotAllowed(); | ||
| } | ||
| } |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| // SPDX-License-Identifier: GPL-3.0 | ||
|
|
||
| pragma solidity ^0.8.17; | ||
|
|
||
| import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol"; | ||
| import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol"; | ||
| import { IERC20 } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol"; | ||
|
|
||
| import { IAccessControlManager } from "../../interfaces/IAccessControlManager.sol"; | ||
| import { Errors } from "../../utils/Errors.sol"; | ||
|
|
||
| /// @title SonicFragment | ||
| /// @notice Contract for Sonic fragments which can be converted upon activation into S tokens | ||
| /// @author Angle Labs, Inc. | ||
| contract SonicFragment is ERC20 { | ||
| using SafeERC20 for IERC20; | ||
|
|
||
| /// @notice Contract handling access control | ||
| IAccessControlManager public immutable accessControlManager; | ||
| /// @notice Address for the S token | ||
| address public immutable sToken; | ||
|
|
||
| /// @notice Amount of S tokens sent on the contract at the activation of redemption | ||
| /// @dev Used to compute the exchange rate between fragments and S tokens | ||
| uint128 public sTokenAmount; | ||
| /// @notice Total supply of the contract | ||
| /// @dev Needs to be stored to compute the exchange rate between fragments and sTokens | ||
| uint120 public supply; | ||
| /// @notice Whether redemption for S tokens has been activated or not | ||
| uint8 public contractSettled; | ||
|
|
||
| constructor( | ||
| address _accessControlManager, | ||
| address recipient, | ||
| address _sToken, | ||
| uint256 _totalSupply, | ||
| string memory _name, | ||
| string memory _symbol | ||
| ) ERC20(_name, _symbol) { | ||
| // Zero address check | ||
| if (_sToken == address(0)) revert Errors.ZeroAddress(); | ||
| IAccessControlManager(_accessControlManager).isGovernor(msg.sender); | ||
| sToken = _sToken; | ||
| accessControlManager = IAccessControlManager(_accessControlManager); | ||
| supply = uint120(_totalSupply); | ||
| _mint(recipient, _totalSupply); | ||
| } | ||
|
|
||
| // ================================= MODIFIERS ================================= | ||
|
|
||
| /// @notice Checks whether the `msg.sender` has the governor role | ||
| modifier onlyGovernor() { | ||
| if (!accessControlManager.isGovernor(msg.sender)) revert Errors.NotAllowed(); | ||
| _; | ||
| } | ||
|
|
||
| /// @notice Activates the contract settlement and enables redemption of fragments into S | ||
| /// @dev Can only be called once | ||
| function settleContract(uint256 _sTokenAmount) external onlyGovernor { | ||
| if (contractSettled > 0) revert Errors.NotAllowed(); | ||
| contractSettled = 1; | ||
| IERC20(sToken).safeTransferFrom(msg.sender, address(this), sTokenAmount); | ||
| sTokenAmount = uint128(_sTokenAmount); | ||
| } | ||
|
|
||
| /// @notice Recovers leftover tokens after sometime | ||
| function recover(uint256 amount, address recipient) external onlyGovernor { | ||
| IERC20(sToken).safeTransfer(recipient, amount); | ||
| sTokenAmount = 0; | ||
| } | ||
|
|
||
| /// @notice Redeems fragments against S based on a predefined exchange rate | ||
| function redeem(uint256 amount, address recipient) external returns (uint256 amountToSend) { | ||
| uint128 _sTokenAmount = sTokenAmount; | ||
| if (_sTokenAmount == 0) revert Errors.NotAllowed(); | ||
| _burn(msg.sender, amount); | ||
| amountToSend = (amount * _sTokenAmount) / supply; | ||
| IERC20(sToken).safeTransfer(recipient, amountToSend); | ||
| } | ||
| } |
Oops, something went wrong.