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

WIP #135

Closed
wants to merge 4 commits into from
Closed

WIP #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4e4c5e6
WIP
vrde Nov 14, 2023
b8cff73
Rename init function
vrde Nov 14, 2023
06ec9df
WIP
vrde Nov 14, 2023
7f46171
Fix inheritance
vrde Nov 14, 2023
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
100 changes: 17 additions & 83 deletions contracts/GovernanceToken/GovernanceToken.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ pragma solidity 0.8.16;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
import "./GovernanceTokenSnapshot.sol";
import { Roles } from "../extensions/Roles.sol";
import "../extensions/DAORoles.sol";
import "../extensions/HasRole.sol";

/**
* @title GovernanceToken
Expand All @@ -16,7 +13,7 @@ import "../extensions/HasRole.sol";
* functionality for voting, minting, burning, wrapping/unwrapping, and settling tokens. Only authorized
* roles (as defined in DAORoles contract) can call certain functions such as mint, burn, wrap, unwrap, and others.
*/
contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
contract GovernanceToken is Initializable, GovernanceTokenSnapshot {
IShareholderRegistry internal _shareholderRegistry;

event DepositStarted(
Expand All @@ -37,21 +34,17 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
/**
* @notice Initializes a new GovernanceToken instance with the provided roles, name, and symbol.
* @dev Sets the roles, ERC20 name and symbol using provided args and calls the internal `_initialize` function.
* @param roles DAORoles instance that controls roles within the token contract.
* @param daoRegistry DAORegistry instance that controls roles within the token contract.
* @param name string for the ERC20 token name of GovernanceToken.
* @param symbol string for the ERC20 token symbol of GovernanceToken.
*/
function initialize(
DAORoles roles,
DAORegistry daoRegistry,
string memory name,
string memory symbol
) public initializer {
require(
address(roles) != address(0),
"GovernanceToken: 0x0 not allowed"
);
__DAORegistryProxy_init(daoRegistry);
_initialize(name, symbol);
_setRoles(roles);
}

/// @custom:oz-upgrades-unsafe-allow constructor
Expand All @@ -71,82 +64,23 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
public
virtual
override
onlyRole(Roles.RESOLUTION_ROLE)
onlyResolutionManager
returns (uint256)
{
return _snapshot();
}

/**
* @notice Set address of the Voting logic for the contract.
* @dev Can be called only by the operator role.
* @param voting IVoting instance that controls the voting logic.
*/
function setVoting(
IVoting voting
)
external
virtual
onlyRole(Roles.OPERATOR_ROLE)
zeroCheck(address(voting))
{
_setVoting(voting);
}

/**
* @notice Set the shareholder registry contract address.
* @dev Can be called only by the operator role.
* @param shareholderRegistry IShareholderRegistry instance that maintains the shareholder data.
*/
function setShareholderRegistry(
IShareholderRegistry shareholderRegistry
) external virtual onlyRole(Roles.OPERATOR_ROLE) {
_shareholderRegistry = shareholderRegistry;
}

/**
* @notice Set the settlement period for token deposits.
* @dev Can be called only by the operator role.
* @param settlementPeriod_ uint256 representing the settlement period in seconds.
*/
function setSettlementPeriod(
uint256 settlementPeriod_
) external virtual onlyRole(Roles.OPERATOR_ROLE) {
) external virtual onlyResolutionManager {
settlementPeriod = settlementPeriod_;
}

/**
* @notice Set the external token reference for wrapping into the GovernanceToken.
* @dev Can be called only by the operator role.
* @param tokenExternalAddress Address of the external token to wrap into GovernanceToken.
*/
function setTokenExternal(
address tokenExternalAddress
)
external
virtual
onlyRole(Roles.OPERATOR_ROLE)
zeroCheck(tokenExternalAddress)
{
_setTokenExternal(tokenExternalAddress);
}

/**
* @notice Set redemption controller.
* @dev Can be called only by the operator role.
* @param redemption IRedemptionController instance that controls token redemption.
*/
function setRedemptionController(
IRedemptionController redemption
)
external
virtual
onlyRole(Roles.OPERATOR_ROLE)
zeroCheck(address(redemption))
{
_setRedemptionController(redemption);
}

/**
* @notice Mint new governance tokens for the given address.
* @dev Can be called only by the resolution role.
Expand All @@ -156,7 +90,7 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
function mint(
address to,
uint256 amount
) public virtual onlyRole(Roles.RESOLUTION_ROLE) {
) public virtual onlyResolutionManager {
_mint(to, amount);

if (
Expand All @@ -165,7 +99,7 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
to
)
) {
_redemptionController.afterMint(to, amount);
getRedemptionController().afterMint(to, amount);
}
}

Expand All @@ -178,7 +112,7 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
function burn(
address from,
uint256 amount
) public virtual onlyRole(Roles.MARKET_ROLE) {
) public virtual onlyInternalMarket {
_burn(from, amount);
}

Expand All @@ -191,7 +125,7 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
function wrap(
address from,
uint256 amount
) public virtual onlyRole(Roles.MARKET_ROLE) {
) public virtual onlyInternalMarket {
_wrap(from, amount);
}

Expand All @@ -206,7 +140,7 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
address from,
address to,
uint256 amount
) public virtual onlyRole(Roles.MARKET_ROLE) {
) public virtual onlyInternalMarket {
_unwrap(from, to, amount);
}

Expand All @@ -228,7 +162,7 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
function mintVesting(
address to,
uint256 amount
) public virtual onlyRole(Roles.RESOLUTION_ROLE) {
) public virtual onlyResolutionManager {
_mintVesting(to, amount);
}

Expand All @@ -241,7 +175,7 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
function setVesting(
address to,
uint256 amount
) public virtual onlyRole(Roles.OPERATOR_ROLE) {
) public virtual onlyResolutionManager {
_setVesting(to, amount);
}

Expand All @@ -259,7 +193,7 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
public
virtual
override(ERC20Upgradeable, IERC20Upgradeable)
onlyRole(Roles.MARKET_ROLE)
onlyInternalMarket
returns (bool)
{
return super.transfer(to, amount);
Expand All @@ -281,7 +215,7 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
public
virtual
override(ERC20Upgradeable, IERC20Upgradeable)
onlyRole(Roles.MARKET_ROLE)
onlyInternalMarket
returns (bool)
{
return super.transferFrom(from, to, amount);
Expand All @@ -303,7 +237,7 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
uint256 amount
) internal virtual override {
super._afterTokenTransfer(from, to, amount);
_voting.afterTokenTransfer(from, to, amount);
getVoting().afterTokenTransfer(from, to, amount);

// Invariants
require(
Expand Down Expand Up @@ -346,7 +280,7 @@ contract GovernanceToken is Initializable, HasRole, GovernanceTokenSnapshot {
*/
function _wrap(address from, uint amount) internal virtual {
require(
tokenExternal.transferFrom(from, address(this), amount),
getNeokingdomToken().transferFrom(from, address(this), amount),
"GovernanceToken: transfer failed"
);
require(amount > 0, "GovernanceToken: attempt to wrap 0 tokens");
Expand Down
33 changes: 9 additions & 24 deletions contracts/GovernanceToken/GovernanceTokenBase.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
import "../RedemptionController/IRedemptionController.sol";
import "../Voting/IVoting.sol";
import "../InternalMarket/InternalMarket.sol";
import "../extensions/DAORoles.sol";
import "../extensions/DAORegistryProxy.sol";
import "./IGovernanceToken.sol";

abstract contract GovernanceTokenBase is ERC20Upgradeable, IGovernanceToken {
abstract contract GovernanceTokenBase is
ERC20Upgradeable,
IGovernanceToken,
DAORegistryProxy
{
event VestingSet(address to, uint256 amount);

IVoting internal _voting;
IRedemptionController internal _redemptionController;
INeokingdomToken public tokenExternal;

function _initialize(
string memory name,
string memory symbol
Expand All @@ -26,21 +26,6 @@ abstract contract GovernanceTokenBase is ERC20Upgradeable, IGovernanceToken {
// In theory they should be burned or added to a pool
mapping(address => uint256) internal _vestingBalance;

// mapping(address => uint256) internal _unlockedBalance;
function _setVoting(IVoting voting) internal {
_voting = voting;
}

function _setRedemptionController(
IRedemptionController redemptionController
) internal virtual {
_redemptionController = redemptionController;
}

function _setTokenExternal(address tokenExternalAddress) internal {
tokenExternal = INeokingdomToken(tokenExternalAddress);
}

function _beforeTokenTransfer(
address from,
address to,
Expand All @@ -57,7 +42,7 @@ abstract contract GovernanceTokenBase is ERC20Upgradeable, IGovernanceToken {
}

function _mint(address to, uint256 amount) internal virtual override {
tokenExternal.mint(address(this), amount);
getNeokingdomToken().mint(address(this), amount);
super._mint(to, amount);
}

Expand All @@ -69,14 +54,14 @@ abstract contract GovernanceTokenBase is ERC20Upgradeable, IGovernanceToken {

function _unwrap(address from, address to, uint amount) internal virtual {
require(
tokenExternal.transfer(to, amount),
getNeokingdomToken().transfer(to, amount),
"GovernanceToken: transfer failed"
);
super._burn(from, amount);
}

function _burn(address from, uint amount) internal virtual override {
tokenExternal.burn(amount);
getNeokingdomToken().burn(amount);
super._burn(from, amount);
}

Expand Down
Loading
Loading