improve: readme content

kuco23 · Nov 22, 2024 · 5188269 · 5188269
1 parent 3dd0418
commit 5188269
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,17 @@
 # Kuco Coin
 
-This is an implementation of a non-meme token on Avalanche. It has real world functionalities, like things and such, so it's definitely not a pyramid scheme. The code has also been audited by the author during implementation.
+This is an implementation of a non-meme token on Avalanche. It has real world functionalities, like things and such, so it's definitely not a pyramid scheme. The code has been audited by the author during implementation.
 
-## Deployment
+## Thanks to
+- Avalanche for honestly being the best chain,
+- Uniswap for deploying their V2 on Avalanche,
+- People that developed [Namari](https://onepagelove.com/namari) for their free template hacked into KucoCoin frontend,
+- To tis guy for [this awesome pen](https://codepen.io/Rplus/pen/abPLGx),
+- To this guy for the [spiral animation](https://jsfiddle.net/j08691/CKWrN/),
+- To this guy for the [windows95 error tab in css](https://codepen.io/jkantner/pen/oNypPOZ),
+- To this guy that updated [UniwapV2 for Solidity 0.8.4](https://github.com/islishude/uniswapv2-solc0.8).
+
+## Deploying contracts + frontend
 
 To deploy the contract and frontend, do the following:
 
@@ -23,7 +32,7 @@ To deploy the contract and frontend, do the following:
 > **Note**
 > If you change `<investmentInterestBips>` or `<retractFeeBips>` you have to manually find the sections in `packages/frontend/index.html` where those values are directly referenced (in `kuconomics` section).
 
-## Testing
+## Testing on forked avalanche mainnet
 
 You can test the frontend on a locally run avalanche fork, which comes with a funded account specified by the private key `0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80`, which we'll refer to as `PRIVATE_KEY` in the following steps.
 
@@ -44,23 +53,13 @@ To configure investment and retract periods, you have to also navigate to `src/t
 
 inside `contracts` workspace.
 
-## Thanks to
-- Avalanche for honestly being the best chain,
-- Uniswap for deploying their V2 on Avalanche,
-- People that developed [Namari](https://onepagelove.com/namari) for their free template hacked into KucoCoin frontend,
-- To tis guy for [this awesome pen](https://codepen.io/Rplus/pen/abPLGx),
-- To this guy for the [spiral animation](https://jsfiddle.net/j08691/CKWrN/),
-- To this guy for the [windows95 error tab in css](https://codepen.io/jkantner/pen/oNypPOZ),
-- To this guy that updated [UniwapV2 for Solidity 0.8.4](https://github.com/islishude/uniswapv2-solc0.8).
-
 ## To do
-- [x] Modal for wallet balance,
-- [x] Button for period data fetching,
-- [ ] KucoCoin burn front-end integration,
-- [x] KucoCoin freeze implementation,
-- [x] disable retract button if it is overdue (and show a tooltip),
-- [x] better error display,
-- [ ] format error display,
-- [x] get svg links for metamask and avalanche,
-- [ ] error display "can't read properties of undefined" when metamask is not installed,
-- [ ] copy kucocoin address to clipboard.
+- [x] Modal for wallet balance;
+- [x] Button for period data fetching;
+- [x] KucoCoin freeze implementation;
+- [x] Disable retract button if it is overdue (and show a tooltip);
+- [x] Better error display;
+- [ ] Format error display;
+- [x] Get svg links for metamask and avalanche;
+- [ ] Error display "can't read properties of undefined" when metamask is not installed;
+- [ ] Copy kucocoin address to clipboard.
diff --git a/packages/contracts/README.md b/packages/contracts/README.md
@@ -1,8 +1,14 @@
 # KucoCoin Contracts
 
-## Economics
+This workspace contains the contracts for the KucoCoin token.
 
-Note that the fee on KucoCoin investment return profit is set to 5%.
-This number is chosen because it gives users a chance to profit
-if they invest and sell up to 4.5% of the total AVAX liquidity on the liquidity pool,
-otherwise slippage causes negative profits.
+## Testing
+
+Run hardhat tests with
+```bash
+yarn test test/kucocoin.test.ts
+```
+
+## Non-sarcastic KucoCoin economics
+
+KucoCoin investment return interest is set to 5%. This number is chosen because it gives users a chance to profit if they invest and sell up to 4.5% of the total AVAX liquidity on the liquidity pool, otherwise slippage causes negative profits. There is a possibility to sybil small investments with rewards effectively less affected by slippage. Assuming the KucoCoin price does not skyrocket, the amount of small investments would have to be too many to be profitable once avalanche fees are taken into account.
diff --git a/packages/frontend/README.md b/packages/frontend/README.md
@@ -13,4 +13,5 @@ Icon library was generated with [icomoon](https://icomoon.io/), see the [stackov
 - [x] Metamask icon renders fucked on some devices, replace with EIP-6963 drop-down;
 - [ ] Navigation-based scrolldown is not accurate;
 - [ ] On some outdated mobile browsers the page stretches left and right;
-- [x] Z-index of the top border seems to not cover the navbar.
+- [x] Z-index of the top border seems to not cover the navbar;
+- [ ] Z-index problem between error modal and retraction button hover.