Create a UI for Pool Maintenance similar to Yam.Tools

README.md

@@ -1,111 +1,79 @@
-# 🍠  YAM Protocol  🍠
-## The Protocol
-Yam is an experimental protocol building upon the most exciting innovations in programmable money and governance. Built by a team of DeFi natives, it seeks to create:
-
-•	an elastic supply to seek eventual price stability<br/>
-•	a governable treasury to further support stability<br/>
-•	fully on-chain governance to enable decentralized control and evolution from Day 1<br/>
-•	a fair distribution mechanism that incentivizes key community members to actively take the reins of governance
-
-At its core, YAM is an elastic supply cryptocurrency, which expands and contracts its supply in response to market conditions, initially targeting 1 USD per YAM. This stability mechanism includes one key addition to existing elastic supply models such as Ampleforth: a portion of each supply expansion is used to buy yCurve (a high-yield USD-denominated stablecoin) and add it to the Yam treasury, which is controlled via Yam community governance.
-
-We have built Yam to be a minimally viable monetary experiment, and at launch there will be zero value in the YAM token. After deployment, it is entirely dependent upon YAM holders to determine its value and future development. We have employed a fork of the Compound governance module, which will ensure all updates to the Yam protocol happen entirely on-chain through community voting.
+# 🦐  Shrimp Gem DAO Protocol  🦐
 
-## Audits
-
-None. Contributors have given their best efforts to ensure the security of these contracts, but make no guarantees. It has been spot checked by just a few pairs of eyes. It is a probability - not just a possibility - that there are bugs. That said, minimal changes were made to the staking/distribution contracts that have seen hundreds of millions flow through them via SNX, YFI, and YFI derivatives. The reserve contract is excessively simple as well. We prioritized staked assets' security first and foremost.
+![](https://i.imgur.com/rBqjTu1.jpg)
 
-The original devs encourage governance to fund a bug bounty/security audit
+## The Protocol
+The whale fights the shrimp, and it has never changed since ancient times. Who said shrimp can't fight big whales? As long as we are united!
 
-The token itself is largely based on COMP and Ampleforth which have undergone audits - but we made non-trivial changes.
+Shrimp is a community that gathers all investors. We share the latest Pump tokens and collectively discuss the latest DeFi technology! Anyone who holds 3000 $Shrimp Coins or equivalent to 4000 $USD can make a Advanced Pool. All Shrimp Holders will start marketing your token! why? Because we are a group of people who want to fight whales.
 
-The rebaser may also have bugs - but has been tested in multiple scenarios. It is restricted to Externally Owned Accounts (EOAs) calling the rebase function for added security. SafeMath is used everywhere.
 
-If you feel uncomfortable with these disclousures, don't stake or hold YAM. If the community votes to fund an audit, or the community is gifted an audit, there is no assumption that the original devs will be around to implement fixes, and is entirely at their discretion.
+## Level of ocean
+🐋 Humpback Whale = 5000 BTC or more  
+🐋 Whale = 1000 - 5000 BTC  
+🦈 Shark = 500 - 1000 BTC  
+🐬 Dolphin = 100 - 500 BTC  
+🐠 Fish = 50 - 100 BTC  
+🐙 Octopus = 10 - 50 BTC  
+🦀 Crab = 1 - 10 BTC  
+🦐 Shrimp = less then 1 BTC (We are here)
 
-## The Token
-The core YAM token uses yCRV as the reserve currency, which is roughly a $1 peg. Each supply expansion (referred to as an inflating rebase), a portion of tokens is minted and used to build up the treasury. This treasury is then in complete ownership of YAM holders via governance.
+## About Developer
+Xixi's address: [0xaa447A04b15AFF261e0683f293A1b731c5c10c9B](https://etherscan.io/address/0xaa447A04b15AFF261e0683f293A1b731c5c10c9B)
 
 
-## Distribution
-Rather than allocating a portion of the supply to the founding team, YAM is being distributed in the spirit of YFI: no premine, no founder shares, no VC interests — simply equal-opportunity staking distribution to attract a broad and vision-aligned community to steward the future of the protocol and token.
+## Shirmp Token Info
+Total Shrimp Coin：248,725.6 Shrimp ([More Info](https://github.com/shrimp-finance/shrimp-protocol/wiki/Total-Shrimp:-248,725.6-%F0%9F%A6%90)  )  
+The last total amount update: 2020/09/11 + 4,494.92 🦐 
 
-The initial distribution of YAM will be evenly distributed across eight staking pools: WETH, YFI, MKR, LEND, LINK, SNX, COMP, and ETH/APML Uniswap v2 LP tokens. These pools were chosen intentionally to reach a broad swath of the overall DeFi community, as well as specific communities with a proven commitment to active governance and an understanding of complex tokenomics.
+Genesis Distribution Pool：Genesis Staked pool(Dice, Eth, Cream, YFI, Comp, UNI Pool)    
+Genesis Distribution Period：2020/08/13 ~ 2020/08/19(It's all over, only Uni pool is left)
 
-Following the launch of the initial distribution pools, a second distribution wave will be incentivized through a YAM/yCRV Uniswap pool. This pool will allow Uniswap's TWAP-based oracle to provide necessary input as the basis for rebase calculations, as well as provide liquidity for the rebase to purchase yCurve for the treasury.
+## Advanced Pool Info
+Anyone can create an advanced pool by placing at least 3000 🦐 Shrimp or equivalent to 4000 $USD and pointing to a minimum of 3 days.
 
+We have the purest cryptocurrency shrimp community in the world and can help you market your project.
+There is no more efficient marketing method than this. Hurry up and join the shrimp community. Let's take a look at your project, 👀?
 
-## Rebases
+## Governance([More info](https://github.com/shrimp-finance/shrimp-protocol/wiki/Shrimp-Governance))
+Governance is entirely dictated by Shrimp holders from the start. Upon deployment, ownership of all Shrimp protocol contracts will be reliquished to the timelocked Governance contract or removed entirely. At the very least, this can be seen as a reference implementation for a truly decentralized protocol.
 
-Rebases are controlled by an external contract called the Rebaser. This is comparable to Ampleforth's `monetaryPolicy` contract. It dictates how large the rebase is and what happens on the rebase. The YAM token just changes the supply based on what this contract provides it.
+Anybody with 5% of Shrimp to their address can propose a governance action; these are simple or complex sets of actions, such as adding support for a new shrimping pool, changing an Advanced Pool fee.
 
-There are a requirements before rebases are active:
-<br />
-•	Liquid YAM/yCRV market<br/>
-•	`init_twap()`<br/>
-•	`activate_rebasing()`<br/>
+## Admin keys Holder([More info](https://github.com/shrimp-finance/shrimp-protocol/wiki/Community-Authorization---Multisig-Wallet))
+[Xixi Huang](https://twitter.com/superdxixi) - (Founder) - Founder of Dice.Finance  
+[Andersson Michael](https://twitter.com/betpirateio) - (Partner) - Founder of Betpirate.io  
+Tom Chu - (Team) - Technical Lead of Shrimp.Finance  
+[Marcos](https://twitter.com/mdelriovila) - (Shrimp Community) - Telegram admins of Shrimp  
+[Mojo](https://twitter.com/BitnAlts) - (Tacos Community) - Telegram admins of TACO
 
-Following the launch of the second pool, rebasing can begin its activation phase. This begins with `init_twap()` on the rebaser contract. Anyone can call this at anytime once there is a YAM/yCRV Uniswap V2 market. The oracle is designed to be 12 hours between checkpoints. Given that, 12 hours after `init_twap()` is called, anyone can call `activate_rebasing()`. This turns rebasing on, permanently. Now anyone can call `rebase()` when `inRebaseWindow() == true;`.
+## Other protocol information：
+Shrimp Trade: [Uniswap](https://app.uniswap.org/#/swap?inputCurrency=0x38c4102d11893351ced7ef187fcf43d33eb1abe6&outputCurrency=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2)  
+Shrimp Price Chart: [Chartex](https://uniswap.chartex.pro/?symbol=UNISWAP:SHRIMP)  
+Shrimp Token Listed: [Coingecko](https://www.coingecko.com/en/coins/shrimp-finance)
 
-In a rebase, the order of operations are:
-<br />
-•	ensure in rebase window<br/>
-•	calculate how far off price is from the peg<br/>
-•	dampen the rebase by the rebaseLag<br/>
-•	if positive calculate protocol mint amount<br/>
-•	change scaling factor, (in/de)flating the supply<br/>
-•	sync uniswap, mint, sell to uniswap, transfer excess YAM and bought yCRV to reserves<br/>
-•	call any extra functions governance adds in the future (i.e. Balancer gulps)<br/>
+## Audits
 
+None. Contributors have given their best efforts to ensure the security of these contracts, but make no guarantees. It has been spot checked by just a few pairs of eyes. It is a probability - not just a possibility - that there are bugs. That said, minimal changes were made to the staking/distribution contracts that have seen hundreds of millions flow through them via SNX, YFI, and YFI derivatives. The reserve contract is excessively simple as well. We prioritized staked assets' security first and foremost.
 
-## Governance
-Governance is entirely dictated by YAM holders from the start. Upon deployment, ownership of all YAM protocol contracts was reliquished to the timelocked Governance contract or removed entirely. At the very least, this can be seen as a reference implementation for a truly decentralized protocol.
+The original devs encourage governance to fund a bug bounty/security audit
 
-# Development
-### Building
-This repo uses truffle. Ensure that you have truffle installed. Given the composability aspect of this
+The token itself is largely based on COMP which have undergone audits - but we made non-trivial changes.
 
-Then, to build the contracts run:
-```
-$ truffle compile
-```
 
+If you feel uncomfortable with these disclousures, don't stake or hold Shrimp. If the community votes to fund an audit, or the community is gifted an audit, there is no assumption that the original devs will be around to implement fixes, and is entirely at their discretion.
 
 
-To run tests, run against a single test package, i.e.:
-```
-$ sh startBlockchain.sh
-$ truffle migrate --network distribution
-$ python scripts/clean.py
-$ cd jsLib
-$ jest deployment
-$ jest token
-$ jest rebase
-$ jest governance
-$ jest governorAlpha
-$ jest distribution
-```
-The need to run one-by-one seems to be a limitation of jest + ganache.
+## Distribution
+Rather than allocating a portion of the supply to the founding team, Shrimp is being distributed in the spirit of YFI: no premine, no founder shares, no VC interests — simply equal-opportunity staking distribution to attract a broad and vision-aligned community to steward the future of the protocol and token.
 
-The distribution tests require specific tokens. These are acquired by using the ganache unlock_account function. If you receive fails, the owner likely decreased their ownership of that token. Just replace any instances of that address with another holder of the token.
+The initial distribution of Shrump will be evenly distributed across 6 staking pools: WETH, DICE, CREAM, COMP, YFI, and ETH/SHRIMP Uniswap v2 LP tokens. These pools were chosen intentionally to reach a broad swath of the overall DeFi community, as well as specific communities with a proven commitment to active governance and an understanding of complex tokenomics.
 
-Note: some governance tests require a different ganache setup. You will encounter a warning (but not a failed test) if the wrong type of ganache is setup. To run the correct one:
-```
-$ sh startBlockchainMining.sh
-$ truffle migrate --network distribution
-$ python scripts/clean.py
-$ cd jsLib
-$ jest governance
-```
 
 
 #### Attributions
 Much of this code base is modified from existing works, including:
 
 [Compound](https://compound.finance) - Jumping off point for token code and governance
 
-[Ampleforth](https://ampleforth.org) - Initial rebasing mechanism, modified to better suit the YAM protocol
-
-[Synthetix](https://synthetix.io) - Rewards staking contract
-
-[YEarn](https://yearn.finance)/[YFI](https://ygov.finance) - Initial fair distribution implementation
+[Yam](https://yam.finance/) - Token Distribution Pool

yam-www/package.json → shrimp-www/package.json

@@ -15,6 +15,7 @@
     "react-circular-progressbar": "^2.0.3",
     "react-countdown": "^2.2.1",
     "react-dom": "^16.13.1",
+    "react-hook-form": "^6.4.0",
     "react-router-dom": "^5.2.0",
     "react-scripts": "3.4.1",
     "styled-components": "^5.1.1",

shrimp-www/public/index.html

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html lang="en" style="display: grid;">
+
+<head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta name="description" content="For the SHRIMP(ing) community." />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <link href="https://fonts.googleapis.com/css2?family=Nunito:wght@400;700&display=swap" rel="stylesheet">
+    <meta name="twitter:image" content="https://shrimp.finance/hero.png" />
+    <meta name="twitter:description" content="SHRIMP(ing) community is the biggest Gem DAO in ethereum, once your coin is listed in the Advanced pools, it will be over the moon. Everyone has 5% Shrimp and willing burn 1% Shrimp can list your Advanced pools for a week." />
+    <meta name="twitter:card" content="summary" />
+    <meta name="twitter:title" content="SHRIMP - First Gem DAO Community." />
+    <!-- Global site tag (gtag.js) - Google Analytics -->
+    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-175287457-1"></script>
+    <script>
+    window.dataLayer = window.dataLayer || [];
+
+    function gtag() {
+        dataLayer.push(arguments);
+    }
+    gtag('js', new Date());
+    gtag('config', 'UA-175287457-1');
+    </script>
+    <title>Shrimp.Finance - First Gem DAO for ethereum community.</title>
+</head>
+
+<body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+</body>
+
+</html>

yam-www/public/manifest.json → shrimp-www/public/manifest.json

@@ -6,19 +6,9 @@
       "src": "favicon.ico",
       "sizes": "64x64 32x32 24x24 16x16",
       "type": "image/x-icon"
-    },
-    {
-      "src": "logo192.png",
-      "type": "image/png",
-      "sizes": "192x192"
-    },
-    {
-      "src": "logo512.png",
-      "type": "image/png",
-      "sizes": "512x512"
     }
   ],
-  "start_url": ".",
+  "start_url": "/",
   "display": "standalone",
   "theme_color": "#000000",
   "background_color": "#ffffff"

yam-www/src/App.tsx → shrimp-www/src/App.tsx

@@ -18,6 +18,10 @@ import useModal from './hooks/useModal'
 
 import Farms from './views/Farms'
 import Home from './views/Home'
+import Adverts from './views/Advertisements';
+import Vote from './views/Gov'
+import Farm from './views/Farm/Farm'
+import Stats from './views/Stats/Stats'
 
 import theme from './theme'
 
@@ -29,9 +33,21 @@ const App: React.FC = () => {
           <Route path="/" exact>
             <Home />
           </Route>
-          <Route path="/farms">
+          <Route path="/farms" exact>
             <Farms />
           </Route>
+          <Route path="/farms/:farmId">
+            <Farm />
+          </Route>
+          <Route path="/Vote" exact>
+            <Vote />
+          </Route>
+          <Route path="/Adverts" exact>
+            <Adverts />
+          </Route>
+          <Route path="/Stats" exact>
+            <Stats />
+          </Route>
         </Switch>
       </Router>
       <Disclaimer />
@@ -42,6 +58,7 @@ const App: React.FC = () => {
 const Providers: React.FC = ({ children }) => {
   return (
     <ThemeProvider theme={theme}>
+      {/* change the ChainId below here for the preffered network when testing, 1 main 3 ropsten */}
       <UseWalletProvider chainId={1}>
         <YamProvider>
           <TransactionProvider>
@@ -67,9 +84,9 @@ const Disclaimer: React.FC = () => {
 
   useEffect(() => {
     const seenDisclaimer = localStorage.getItem('disclaimer')
-    if (!seenDisclaimer) {
+    // if (!seenDisclaimer) {
       onPresentDisclaimerModal()
-    }
+    // }
   }, [])
 
   return (

yam-www/src/components/DisclaimerModal/DisclaimerModal.tsx → shrimp-www/src/components/DisclaimerModal/DisclaimerModal.tsx

@@ -23,27 +23,31 @@ const DisclaimerModal: React.FC<DisclaimerModal> = ({ onConfirm, onDismiss }) =>
     if (step === 'disclaimer') {
       return (
         <div>
-          <p>Audits: None.</p>
-          <p>While the initial creators of the Yam protocol have made reasonable efforts to attempt to ensure the security of the contracts, including forking much of the codebase from existing well-audited projects and soliciting review from friends, nothing approaching the rigor of a formal audit has been conducted at this time.</p>
-          <p>We STRONGLY urge caution to anyone who chooses to engage with these contracts.</p>
+          <p>Audits: None. (This project is in beta. Use at your own risk.)</p>
+          <p>🦐 New Advanced Pool will start on 2020/09/12 10:00:00 UTC+0, welcome <a href="https://sashimi.cool/" target="_blank">Sashimi</a> onto the plate. 🦐 </p>
+          {/* <p>🍣 New Advanced Pool will start on 2020/09/01 10:00:00 UTC+0, welcome <a href="https://app.sushiswap.org/" target="_blank">SHRIMP_SUSHI_UNI_LP</a> on board. 🍣 </p> */}
+          <br/><p>🚨 For more information on the inflation of Uniswap LP pool tokens, please visit <a href="https://github.com/shrimp-finance/shrimp-protocol/wiki/Total-Shrimp:-248,725.6-%F0%9F%A6%90" target="_blank">Github Wiki</a></p>
+          <p>💡 Any token in Advanced Pool does not constitute an investment opinion, Shrimp Group is only responsible for basic quick check! Please evaluate yourself carefully before buying!</p>
         </div>
       )
     } else {
       return (
         <div>
-          <p>Attention YAM Uniswap LPs</p>
-          <p>The only Uniswap pool that is compatible with YAM is YAM/yCRV (Curve yPool tokens)</p>
+          <p>Attention SHRIMP Uniswap LPs</p>
+          <p>The only Uniswap pool that is compatible with SHRIMP is SHRIMP/WETH</p>
           <p>Providing liquidity for other Uniswap pools is dangerous</p>
-          <p>You will LOSE your share of rebases</p>
         </div>
       )
     }
   }, [step])
 
   const button = useMemo(() => {
     if (step === 'disclaimer') {
+      // return (
+      //   <Button text="Next" variant="secondary" onClick={() => setStep('uniswap')} />
+      // )
       return (
-        <Button text="Next" variant="secondary" onClick={() => setStep('uniswap')} />
+        <Button text="I understand" onClick={handleConfirm} />
       )
     } else {
       return (

shrimp-www/src/components/Footer/components/Nav.tsx

@@ -0,0 +1,31 @@
+import React from 'react'
+import styled from 'styled-components'
+
+const Nav: React.FC = () => {
+  return (
+    <StyledNav>
+      <StyledLink href="https://github.com/shrimp-finance/shrimp-protocol">Github</StyledLink>
+      <StyledLink href="https://twitter.com/FinanceShrimp">Twitter</StyledLink>
+      <StyledLink href="https://t.me/shrimping">Telegram</StyledLink>
+      <StyledLink href="https://www.coingecko.com/en/coins/shrimp-finance">Coingecko</StyledLink>
+      <StyledLink href="https://app.uniswap.org/#/swap?inputCurrency=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2&outputCurrency=0x38c4102d11893351ced7ef187fcf43d33eb1abe6">Uniswap</StyledLink>
+    </StyledNav>
+  )
+}
+
+const StyledNav = styled.nav`
+  align-items: center;
+  display: flex;
+`
+
+const StyledLink = styled.a`
+  color: ${props => props.theme.color.grey[400]};
+  padding-left: ${props => props.theme.spacing[3]}px;
+  padding-right: ${props => props.theme.spacing[3]}px;
+  text-decoration: none;
+  &:hover {
+    color: ${props => props.theme.color.grey[500]};
+  }
+`
+
+export default Nav