There are two contracts in this repository. One is an LFT token contract that follows the ERC20 standard and the other is a vesting contract that holds tokens for stakeholders like the Team, community, investor, public sale, private sale, etc.
This contract holds and releases the pre-minted tokens for each stakeholder. The "VESTING" folder contains all contracts for vesting operations
The contract in VestingMaster.sol is the master contract that imports VestingTeamStorage.sol. The "VestingMaster" contract imports and creates child contracts for each stakeholder vesting. For example, the child contract for the "TEAM" vesting is created as VestingTeam.sol. Similarly, child contracts for other stakeholders are created, with only the parameter values differing between them.
The VestingMaster.sol contract has functions such as:
- IERC20address() for assigning LFT address to "_token"
- assignToken() function assigns a specified amount of tokens to the Member, but it only tracks the allocation and does not actually allocate tokens to the Member's real wallet. The tokens remain within the contract until the vesting time is reached.
- getTokenInfo() to retrieve information about token allocation and release into wallets.
- release() the function is called by the owner in particular intervals (TBD). The function iterates through each member in memberAddress and releases tokens if the vesting period is reached.
The VestingTeam.sol contract is an upgradable child contract of the Vesting Master contract, using VestingTeamProxy.sol. The VestingTeamStorage.sol contract contains all state variables required for vesting. It includes:
- IERC20 _token - hold the address of LFT token contract
- membersAddress - holds wallet addresses of members to whom tokens are assigned.
- totalNumberVesting - total vesting periods
- vestingTime- Unix time stamp which represents each vesting time. Tokens will be released to the actual member wallet based on this vesting time.
- vestingPercentage - Value is taken as a percentage. Each value corresponds to each vesting time. Only the given percentage of tokens can be released to the member's real wallet when the respective vesting time is reached.
- teamMember- it is a mapping which tracks the total tokens assigned and released against each member wallet.
totalNumberVesting , vestingTime and vestingPercentage are initialsed in the proxy contract
The VestingTeamproxy.sol contract is the proxy for the VestingTeam contract, with its address used for TEAM vesting activities. The fallback function allows calling functions in the VestingTeam contract from the VestingTeamProxy.
The proxy contract intialises all state variables in vestingTeamStorage.
- vestingTeamaddress - the contract address of vestingTeam. With fallback function, proxy contract execute functions in vestingTeam contract.
- _vestingTime - vesting time for TEAM is given as UNIX timestamp
- _vestingPercentage- vesting percentage for TEAM corresponding to each timestamp
- _totalNumberVesting - total number of vesting
- updateContractAddress() - function which is used in proxy to change the main contract address(vestingTeamaddress).
(Files in the folder TOKEN are of LFT token)
The main contract of LFT token is in LedgerFiToken.sol, which imports ERC20Burnable contract. All state variables are created and intialised in LedgerFiTokenStorage.sol
-
maxSupply - holds the max supply of token ,for LFT its 500000000 (500 millions) tokens
-
preMinedToken- the value shows the total number of tokens that need to be pre-minted for different stakeholders (like advisors, investors, team, private Sale, public Sale etc.). Fixed percentages of preMinedToken will be minted for each stakeholder group(like advisors,investors, team, private Sale, public Sale etc.).
The below-given addresses are the vesting contract address related to each stakeholder (like Team, Advisor, SeedSale, PublicSale, etc). On the deployment of LFT tokens, predefined percentages of pre-minted token (preMinedToken) are assigned to these contract addresses. (Currently dummy value is given)
vestingTeamAddress ,vestingAdvisorsAddress, vestingSeedSaleAddress ,vestingPublicSaleAddress,vestingCommunityAddress , vestingMarketingAddress, vestingEcosystemAddress ,vestingExchangeAddress , vestingPMLAddress
The below given percentages indicates the vesting percentage of each stakeholders
vestingTeamPercent ,vestingAdvisorsPercent ,vestingSeedSalePercent, vestingPublicSalePercent, vestingCommunityPercent ,vestingMarketingPercent ,vestingEcosystemPercent ,vestingExchangePercent ,vestingPMLPercent
-
burnTokenAddress- Contract address which holds unallocated token that to be burned
-
burnThreshold- This data is used after integrating the LFT minting triggers with, LedgerMail and LedgerChat. In tokenomics, when tokens are awarded to users as a reward for sending mail, some tokens may not be allocated. These tokens will be moved to the burnTokenAddress contract by invoking the addBurnTokenCount function and will be burned when the contract balance reaches the burnThreshold
The main contract of LFT token is in LedgerFiToken.sol, which imports ERC20Burnable contract. All state variables are created and intialised in LedgerFiTokenStorage.sol
- mintVesting() - which mint the given percentage of tokens into vesting contracts corresponding to each stakeholder.
- mint() for minting the given amount of token into the given address. This will be used after integrating LFT with LedgerMail. User rewards are minted with this.
- addBurnTokenCount - the unallocated tokens are minted to the burnTokenAddress contract by calling this function and those allocated tokens will be burned when the balance reaches burnThreshold