VaultToken

Inherits: Initializable ↗, ERC20Upgradeable, VaultState, IVaultToken

Defines the token functionality for the Vault

State Variables

This empty reserved space is put in place to allow future versions to add new variables without shifting down storage in the inheritance chain. See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps

uint256[50] private __gap

Returns the amount of tokens in existence.

function totalSupply() external view override returns (uint256);

Returns the amount of tokens owned by account.

function balanceOf(address account) external view returns (uint256);

Internal function for minting shares

function _mintShares(address owner, uint256 shares) internal virtual override;

Parameters

Name	Type	Description
`owner`	`address`	The address of the owner to mint shares to
`shares`	`uint256`	The number of shares to mint

Internal function for burning shares

function _burnShares(address owner, uint256 shares) internal virtual override;

Parameters

Name	Type	Description
`owner`	`address`	The address of the owner to burn shares for
`shares`	`uint256`	The number of shares to burn

Internal function that must be used to process exit queue

function _updateExitQueue() internal virtual override returns (uint256 burnedShares);

Returns

Name	Type	Description
`burnedShares`	`uint256`	The total amount of burned shares

Moves amount of tokens from from to to. Emits a Transfer event.

function _transfer(address from, address to, uint256 amount) internal virtual override;

Initializes the VaultToken contract

function __VaultToken_init(string memory _name, string memory _symbol) internal onlyInitializing;

Parameters

Name	Type	Description
`_name`	`string`	The name of the ERC20 token
`_symbol`	`string`	The symbol of the ERC20 token