Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 1.81 KB

README.md

File metadata and controls

42 lines (30 loc) · 1.81 KB

yNote-contracts


Development

Clone repository

git clone repo-url 

Install Dependencies

npm install

Start local blockchain

ganache-cli

Compile Contracts

truffle compile

Run Tests

truffle test

About contracts :

yNoteToken contract

yNote token is a BEP20 compatible token present on the Binance Smart Chain. The contract inherits methods from the BEP20 contract and Ownable contract.

yNoteSeedMaster contract

yNoteSeedMaster contract is the master contract that holds the seed pool addresses and makes it possible for users to deposit seed pool tokens and earn yNote tokens in return after the staking period has ended. The staking period for the seed pools has a duration of 7 days. The users can stake multiple times for which their reward will be calculated accordingly and the entire reward sum will be given to the user when they harvest the tokens after the sale ends. Users can withdraw their staked tokens during the staking period, but their rewards will be locked until the sale ends. After the staking period ends, users can harvest their tokens and will be rewarded with yNote tokens on the basis of their amount staked and duration for which they were staked for.

yNoteLPMaster contract

yNoteLPMaster contract is the master contract that holds the LP pool addresses and makes it possible for users to deposit LP pool tokens and earn yNote tokens in return. The deposit and withdraw operations are a little different from that of the yNoteSeedMaster contract. Here, the users can deposit multiple times and everytime they deposit(or withdraw), except the first deposit, the yNote token rewards that are generated till that time are sent to users account instead of summing up. Users are able to partially withdraw their tokens too.