282 update readme in contacts #83
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull Request Test Coverage Report for Build 11934523793Details
💛 - Coveralls |
R-Santev
requested changes
Nov 20, 2024
| CHILD_RPC= | ||
| CHILD_TEST_RPC= | ||
| HYDRA_TESTNET_RPC= | ||
| HYDRA_CHAIN_RPC= | ||
|
|
||
| # An Etherscan API key is needed for verifying contracts on Ethereum (testnets/mainnet), |
There was a problem hiding this comment.
you can update based on our explorer method
README.md
Outdated
| - The epoch increases at the begining of the last block of an epoch, which results in the following: | ||
| - If a user changes its stake (or delegation) in the last block of an epoch X, the change will be applied on its voting power (or valdiator status) at epoch X + 2, because actually he made the balance change in epoch x + 1 | ||
| - The epoch increases at the beginning of the last block of an epoch, which results in the following: | ||
| - If a user changes its stake (or delegation) in the last block of an epoch X, the change will be applied on its voting power (validator uptime if he is new staker) at epoch X + 2, because actually he made the balance change in epoch x + 1 |
There was a problem hiding this comment.
Suggested change
| - If a user changes its stake (or delegation) in the last block of an epoch X, the change will be applied on its voting power (validator uptime if he is new staker) at epoch X + 2, because actually he made the balance change in epoch x + 1 | |
| - If a user changes its stake (or delegation) in the last block of an epoch X, the change will be applied on its voting power (or validator status) at epoch X + 2, because actually he made the balance change in epoch x + 1 |
README.md
Outdated
|
|
||
| Saving the values of the APR, bonuses and price of Hydra | ||
|
|
||
| - Macro Factor: used to multiply the base APR and adjust the APR for positions depending on the price movement between 310 days and last 115 days |
There was a problem hiding this comment.
Suggested change
| - Macro Factor: used to multiply the base APR and adjust the APR for positions depending on the price movement between 310 days and last 115 days | |
| - Macro Factor: used to multiply the base APR and adjust the APR for positions depending on the price movement between the last 310 days and 115 days |
README.md
Outdated
| Saving the values of the APR, bonuses and price of Hydra | ||
|
|
||
| - Macro Factor: used to multiply the base APR and adjust the APR for positions depending on the price movement between 310 days and last 115 days | ||
| - Price: updates the price for the contracts (update is possible only thru PriceOracle) and triggers update on bonuses depending on the price change, it also can guard bonuses by changing their values to default in critical situations |
There was a problem hiding this comment.
Suggested change
| - Price: updates the price for the contracts (update is possible only thru PriceOracle) and triggers update on bonuses depending on the price change, it also can guard bonuses by changing their values to default in critical situations | |
| - Price: updates the price for the contracts (update is possible only through PriceOracle) and triggers an update on bonuses depending on the price change, it also can guard bonuses by changing their values to default in critical situations |
| - Liquid Delegation - handles actions within the Lydra token, including minting, burning, calculating liquidity Debts and more. | ||
| - Vested Delegation - handling vested positions (thru Managers), swapping, delegating, cutting and more. | ||
|
|
||
| #### HydraStaking: |
There was a problem hiding this comment.
Move staking before delegation
README.md
Outdated
|
|
||
| #### HydraVault: | ||
|
|
||
| A contract that is used for keeping Dao Incentive funds and distributes them to a contract |
There was a problem hiding this comment.
Suggested change
| A contract that is used for keeping Dao Incentive funds and distributes them to a contract | |
| A contract that is used for keeping DAO Incentive funds and distributes them to a contract |
README.md
Outdated
|
|
||
| #### LiquidityToken: | ||
|
|
||
| An ERC20 that represent the staked/delegated Hydra, could be used for trading, while waiting for the potions to grow. |
There was a problem hiding this comment.
Suggested change
| An ERC20 that represent the staked/delegated Hydra, could be used for trading, while waiting for the potions to grow. | |
| An ERC20 that represent the staked/delegated Hydra, could be used for trading, while waiting for the position to grow. |
README.md
Outdated
|
|
||
| #### PriceOracle: | ||
|
|
||
| A oracle that validators vote from, agreeing on a specific price and updating it on the APR calculator. |
There was a problem hiding this comment.
Suggested change
| A oracle that validators vote from, agreeing on a specific price and updating it on the APR calculator. | |
| An oracle that validators vote from, agreeing on a specific price and updating it on the APR calculator. |
R-Santev
approved these changes
Nov 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update Readme
Update example.env
Update Hardhat config