Giter Site home page Giter Site logo

beefyfinance / beefy-v2 Goto Github PK

View Code? Open in Web Editor NEW
46.0 46.0 88.0 175.92 MB

Beefy is a Decentralized, Multichain Yield Optimizer that allows its users to earn compound interest on their crypto holdings. Beefy earns you the highest APYs with safety and efficiency in mind.

Home Page: https://app.beefy.com

HTML 0.06% Shell 0.01% TypeScript 99.94%

beefy-v2's People

Contributors

0xcmdrkeen avatar 1932293 avatar alltradesz avatar asdemt avatar bowlingotter avatar brknrobot avatar bustinjieber420 avatar cartman-dev avatar defidebauchery avatar derlomo avatar epete-epete avatar erenjaegar77 avatar frondoto avatar kaicode2 avatar kexleybeefy avatar lodelux avatar mirthfutures avatar mo0o0d avatar moonster-bsc avatar pablobeefy avatar prevostc avatar pumpingghost avatar reflectivechimp avatar roman-monk avatar schnarkus avatar seguido avatar shatterproof avatar sirbeefalot avatar tilty-mctiltface avatar wivern-co-uk avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

beefy-v2's Issues

SafetyCard 'How is it calculated' should lead somewhere

Within a vault's page there's a "How is it calculated?" button. It currently does nothing. It should lead to our docs, a section explaining the safety score.

Screen Shot 2021-07-10 at 15 26 02

There is a doc that outlines the score here. We should add it to the docs somewhere and link it. It can probably be improved a bit to be more intuitive for users.

Pre-launch CSS polish

Go over the entire app and make sure that the CSS looks as sharp as possible. Review mobile/desktop, various popular browsers, etc.

Delay changing the user network until they take an action.

Right now when we enter a vault page of a vault with a different chain than our connected chain, it asks us to change network. This means that we can't really see the details of vaults from different chains without constantly switching networks.

It's not technically necessary for you to be connected to a chain until you take an action, the app already works like this. What do we think about delaying network switch request in the flow until the user tries to take an action?

If the vault chain is different from current chain then just show the deposit/withdraw buttons as "Switch network".

Add tooltip to 'Safety Score' on home page

Current
Screen Shot 2021-08-05 at 21 36 27

Target
Screen Shot 2021-08-05 at 21 36 36

The name should not change to 'Beefy risk score'.

The tooltip should have a text of: 'The purpose of the safety score is to educate users when making a decision to enter a particular Beefy vault. The Safety Score is not necessarily perfect, but it is another tool that helps the user. The safety score that a vault can get goes from 1 to 10. The best possible score is 10 and the worst is 0.'

safety score tooltip

We need to add a small tooltip explaining the safety score, in the vault list

Screen Shot 2021-07-14 at 21 58 12

Remove/Replace user historical data placeholders from the UI

The original design intended to display a separation of vault balance between what the user deposited and their yield. We're going to implement this feature post-launch. Remove the components from the UI and possibly add something to fill the space if it looks too empty.

Style global TVL

Add a little bit of styling to the global TVL in the vault list.

Screen Shot 2021-07-07 at 16 14 20

The design from DeepWorks didn't include it, so we have to improvise. But maybe a little bit of padding and size will be enough.

Add data for SafetyScore

Context

We now have a SafetyScore to inform users of possible risks each vault has. An explanation behind the design of the score can be found in this document.

Even though the score is implemented, most vaults don't have any type of risk data at the moment. We should fill out data for at least the last 20-30 vaults to show off the feature and its benefits.

How to

The only modifications needed are within the vault config files. Vaults now have an extra array called "risks". That array has to be populated by risk qualities that the vault has. The keys to add should be taken from the risks.js file.

An example of a filled out vault is the BSC BIFI Maxi:

{
    id: 'bifi-maxi',
    ...
    risks: ['COMPLEXITY_LOW', 'BATTLE_TESTED', 'IL_NONE', 'MCAP_MEDIUM', 'AUDIT', 'CONTRACTS_VERIFIED'],
    ...
}

Remove unused vars and warnings

Insted have some warning in the console like this

image

The idea is get this

image

Tip : We can use alt+shitft+o to remove all the unused imports, vars, etc...

Homepage Portfolio vaults list

Show deposited vaults from all chains using the rpc connections (walletReducer.rpc['bsc'] or heco etc.) available and the connected address of user (walletReducer.address).

Vault page: Boost

Port the boost from v1 with additional changes:

  • Make periodFinish readable from blockchain not config.
  • Make sure vault deposited amount is visible even if you join boost pool.

boost explainer tooltip

In the boost widget within the vault page there is a small "?". Clicking on it should open up a tooltip with some text explaining a little bit what a boost is and what to do.

Screen Shot 2021-07-14 at 21 11 08

Clicking on a vault should reset scroll position to top

When you're scrolling through vaults in the home page and click on one, it doesn't reset scroll position to top. This means that you land on the vault detail page at an awkward position. We should bring the browser back to top when navigating to a vault.

Finish the Deposit/Withdraw modals

The last modal of the Deposit and Withdraw has a few little details missing.

  1. On both Deposit and Withdrawal flows "Go to my portfolio" should lead to the vault list (With the portfolio open if possible).

  2. On both Deposit and Withdrawal flows the asset name in the modal is missing compared with the design. I think it's a little clearer if we add it:

Screen Shot 2021-07-07 at 16 55 44

  1. On the Deposit modal, there are two inconsistencies that I noticed. The first is that the modal says "Withdrawal successful" even though it's a deposit. The other one is that the number displayed was slightly higher than my actual deposit.

My deposit:
Screen Shot 2021-07-07 at 16 46 03

Modal I got:
Screen Shot 2021-07-07 at 16 46 31

Implement estimated transaction costs

BeefyV2 displays what the estimated cost of using a vault will be. This helps smaller users estimate the total cost of using a vault. There are times where withdrawing can be too expensive for some users and it's better if they know it beforehand.

Screen Shot 2021-07-14 at 21 12 21

Separate 'TVL' and 'APY' stats a little bit more

The mobile display is great now, but on larger screens those two stats are sticking a little bit too close to each other. I would maintain the same distance between the 4 stats on mid/large screens.

Screen Shot 2021-08-05 at 21 46 01

Highligh vaults where the user has deposited

Vaults where a user has made a deposit should look a little different in the main vault list.

  1. The background is clearer / highlighed.
  2. The CTA says "Deposit / Withdraw" instead of just "Deposit".
  3. There is a small component showing how much the person has deposited.

Screen Shot 2021-07-13 at 00 14 24

In the image, the first vault has a user deposit and the second one doesn't

Add 'See Details' soft CTA to vault items

In the Figma, the vault items have a small CTA that directs to the vault page. It'd be good to add it in case some people find "Deposit" as too threatening.

I know that having two CTAs directing to the same thing is not ideal. Eventually the 'Deposit' CTA will open a quick overlay to do deposits without having to lead the vault page.

We can hide the 'See Details' CTA in the mobile screen if it's redundant given the screen size.

Screen Shot 2021-08-05 at 21 26 01

Change <a/> in StrategyCard.js

instead of using a <a/> tag to display the community audited and audited
We can use a <Box/> component from Material ui and don't get more the error

From this
image

To This
image

Add translations

Need to setup "react-i18next" translations throughout the templates

Add Husky pre-commit hook

I'm having to solve some indent conflicts on most merges, it'd be good to add husky to make sure all commits have the same code style.

Add data for StrategyCard

We now have descriptive texts explaining the various strategies implemented. The template texts can be found in stratText.js.

I filled out a template for the most popular LP strat. We should add templates for a few other popular strategies, like the single asset recursive supply/borrow strat. Or a reward pool farming strat.

We need to add data to the vault config files as well. Vaults should have a field specifying which strategy they implement, like stratType:'StratLP'.

If anyone has another implementation that doesn't require adding to the config files, it could be better. For example the strategies could implement introspection with ERC 165 or similar.

Make APY sort work

The APY sort in the vault list doesn't seem to be working. It returns the same order as "default" sort.

Screen Shot 2021-07-07 at 16 21 32

Port "Buy Token" feature

Currently the "Buy Token" button within a vault page doesn't do anything. We should either hide it initially or port the feature from V1.

Screen Shot 2021-07-13 at 00 12 48

On the vault page, improve UX of 'Network Change' button.

When a user is connected to the wrong network we display a disabled 'Network Change' button. We could enhance it and replicate the functionality of BeefyV1 where we give them a button that says "Switch to network" and lets them easily switch.

Screen Shot 2021-08-05 at 21 50 26

Add data for more tokens

We now provide info on the assets involved with a particular vault. For example a MATIC-USDC vault displays information about both MATIC and USDC. This can better inform the user as to whether they want to deposit in a vault or not.

Similar to other new features, even though the feature itself is implemented, we don't have much data. This means that most "TokenCard" components will appear with empty descriptions:

Screen Shot 2021-07-07 at 18 41 21

To add data for a token you need to go to the address-book package, and fill out the website and description keys for the token in one of the tokens.ts files

Finish mobile menu

There are a few missing from the mobile menu:

  1. "Home" and "Docs" links are broken.
  2. You can't see the connected address or connect button. So you can't login to the app or change accounts.
  3. Language switch doesn't show up
  4. There is no styling, only the default one.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.