ZivoeTrancheToken.sol
Native Tranche Token
Introduction
This ERC20 contract outlines the tranche token functionality.
This contract should support the following functionalities:
Mintable.
Burnable.
Inherit the ownable library to handle temporary minterRole management.
This contract was adopted from the OpenZeppelin ERC20 Library.
For further documentation, see: https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20
State Variables
Type | Name | Description |
---|---|---|
mapping(address => bool) | _isMinter | Whitelist for accessibility to mint() function, exposed in isMinter() view function. |
Sections
isMinter() - Returns the whitelist status of account for accessibility to
mint()
function.
burn() - Burns $zTT (Zivoe Tranche Tokens).
changeMinterRole() - Update an account's permission for access to
mint()
function.mint() - Mints $zTT (Zivoe Tranche Tokens).
Read Functions
isMinter()
isMinter()
Returns the whitelist status of account for accessibility to mint()
function.
Type | Name | Description |
---|---|---|
address | account | The amount to deposit. |
Returns
Type | Name | Description |
---|---|---|
bool | minter | Returns true if account is allowed to access the |
Write Functions
burn()
burn()
Burns $zTT (Zivoe Tranche Tokens).
Type | Name | Description |
---|---|---|
uint256 | amount | The number of $zTT tokens to burn. |
changeMinterRole()
changeMinterRole()
Update an account's permission for access to mint()
function.
Type | Name | Description |
---|---|---|
address | account | The account to change permission for. |
bool | allowed | The permission to give account (true = permitted, false = prohibited). |
Emits the MinterUpdated() event.
mint()
mint()
Mints $zTT (Zivoe Tranche Tokens).
Type | Name | Description |
---|---|---|
address | account | The account to mint tokens for. |
uint256 | amount | The amount of $zTT tokens to mint for account. |
Events
MinterUpdated()
MinterUpdated()
Emitted during changeMinterRole()
Type | Indexed | Name | Description |
---|---|---|---|
address | True | account | The account who is receiving or losing the minter role. |
bool | False | allowed | If true, account receives minter privlidges, if false the account loses minter privlidges. |
Last updated