-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refreshes Retype-generated documentation.
Process triggered by vfat0.
- Loading branch information
Retype GitHub Action
committed
May 2, 2024
1 parent
1fc93ed
commit a3de0db
Showing
8 changed files
with
275 additions
and
22 deletions.
There are no files selected for viewing
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
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
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| [[{"i":"vfatio-documentation","l":"vfat.io Documentation","p":["vfat.io is a portfolio management app","You can view your positions for multiple wallets across all EVM chains","You can interact with them (Stake / Unstake / Claim / etc)","You can find new opportunities in our Yield page","To get started, head over to vfat.io and either Connect your wallet, or enter an address or ENS name:","Landing Page"]}],[{"l":"Portfolio View","p":["Main view After connecting your wallet, or entering a 0x address or ENS name, you are shown that wallet's positions on all chains. You can see the balance, current price and $ total for each position.","You can search for a specific token:","Token search","And filter by chain or balance type:","Filter options","You can add multiple addresses using the add button:","Add addresses","When viewing multiple wallets, you can see a breakdown of which wallet holds which asset by expanding the asset row:","Sub-balances","Clicking on the link next to a token price brings up the liquidity page, for example Mainnet USDC","Token liquidity"]}],[{"l":"Yield View","p":["Compare yield products across DeFi, enter and exit positions, compound your earnings in 1 click. All from one interface.","vfat.io lets you choose from a plethora of DeFi products, and offers intuitive and seamless interaction. No more convoluted series of transactions such as swapping, adding liquidity and staking needed to start earning yield. No more having to use 3 or 4 websites and getting a PhD in invariants to accomplish the above. Simply choose the pool you want and click Deposit.","At launch two projects are supported, Velodrome on Optimism and Aerodrome on Base.","Each pool in these projects is comprised of two tokens, and can be either stable (token prices should be similar) or volatile (all other pools). The total value locked (TVL), chain, and APR are shown for each pool.","After connecting your wallet and choosing a pool you want to enter, you can do so in one click by using the Deposit button at the end of the row. There is a pre-selected amount of ETH to quick deposit, which can be adjusted by the drop-down menu:","Quick Deposit","Alternatively by clicking anywhere on a pool row, it is loaded into the action menu:","Action Menu","There you can enter a custom ETH amount to deposit, or choose a different token to deposit with. Select your preferred slippage, and view the route taken by expanding the Deposit details box.","Route View","After depositing, you can also view your position in the Deposits tab at the top:","Position View","The quick actions on the right allow you to Compound your earnings, or Exit back to ETH. Selecting the row brings up more options such as withdrawing to a different token, or harvesting any earnings and optionally converting them to ETH or a different token.","Harvest"]},{"l":"Contract Infrastructure","p":["vfat.io Yield is powered by Sickle, a self-custodied contract that is deployed on each chain when making your first deposit. Sickle can perform complex actions in a single transaction, as defined in Strategy contracts, such as the inaugural Aerodrome Strategy.","Contracts have been audited by yAudit. Please note smart contracts bear risk regardless of audits, and there is always the underlying risk of the pool entered."]},{"l":"Fee Structure","p":["Sickle charges 9 basis points (0.09%) on deposits and withdrawals, and 90 bps (0.9%) on compounds and harvests."]}]] | ||
| [[{"i":"vfatio-documentation","l":"vfat.io Documentation","p":["vfat.io is a portfolio management app","You can view your positions for multiple wallets across all EVM chains","You can interact with them (Stake / Unstake / Claim / etc)","You can find new opportunities in our Yield page","To get started, head over to vfat.io and either Connect your wallet, or enter an address or ENS name:","Landing Page"]}],[{"l":"Portfolio View","p":["Main view After connecting your wallet, or entering a 0x address or ENS name, you are shown that wallet's positions on all chains. You can see the balance, current price and $ total for each position.","You can search for a specific token:","Token search","And filter by chain or balance type:","Filter options","You can add multiple addresses using the add button:","Add addresses","When viewing multiple wallets, you can see a breakdown of which wallet holds which asset by expanding the asset row:","Sub-balances","Clicking on the link next to a token price brings up the liquidity page, for example Mainnet USDC","Token liquidity"]}],[{"l":"Sickle","p":["Sickle is a smart contract wallet, deployed for each vfat.io user on each chain in order to manage their yield farming positions. It is similar to DSProxy.","It is deployed by the SickleFactory, the first time a user opens a position on a chain.","It has a Multicall function which batches actions together such as swapping, adding liquidity, staking etc. This function is gated, it can only be called by strategies registered in SickleRegistry, and it can only target contracts also registered in SickleRegistry.","Strategies are multicall recipes. Their functions can either be called by anyone if they don't require a deployed Sickle ( deposit) or only by Sickle owners ( withdraw, harvest, compound, etc).","The currently deployed ones are:","FarmStrategy is the main strategy, its functions include deposit and withdraw(swapping in any token onto a staked liquidity position, or swapping out to any token), as well as harvest(claiming rewards and swapping them) or compound, each of which can be done in a single transaction. It also offers combined actions exit(harvest + withdraw) and rebalance(withdraw one position and deposit into another).","SimpleFarmStrategy has deposit, withdraw, harvest and exit, but it doesn't do any swaps. It can be used to deposit/withdraw the LP token itself, and to harvest the reward token.","NftFarmStrategy has depositErc721 and withdrawErc721 for depositing an ERC721 token or withdrawing it directly from a staking contract.","SweepStrategy allows you to sweep any tokens that have been left in your Sickle, or sent there by accident."]}],[{"l":"Yield View","p":["Compare yield products across DeFi, enter and exit positions, compound your earnings in 1 click. All from one interface.","vfat.io lets you choose from a plethora of DeFi products, and offers intuitive and seamless interaction. No more convoluted series of transactions such as swapping, adding liquidity and staking needed to start earning yield. No more having to use 3 or 4 websites and getting a PhD in invariants to accomplish the above. Simply choose the pool you want and click Deposit.","At launch two projects are supported, Velodrome on Optimism and Aerodrome on Base.","Each pool in these projects is comprised of two tokens, and can be either stable (token prices should be similar) or volatile (all other pools). The total value locked (TVL), chain, and APR are shown for each pool.","After connecting your wallet and choosing a pool you want to enter, you can do so in one click by using the Deposit button at the end of the row. There is a pre-selected amount of ETH to quick deposit, which can be adjusted by the drop-down menu:","Quick Deposit","Alternatively by clicking anywhere on a pool row, it is loaded into the action menu:","Action Menu","There you can enter a custom ETH amount to deposit, or choose a different token to deposit with. Select your preferred slippage, and view the route taken by expanding the Deposit details box.","Route View","After depositing, you can also view your position in the Deposits tab at the top:","Position View","The quick actions on the right allow you to Compound your earnings, or Exit back to ETH. Selecting the row brings up more options such as withdrawing to a different token, or harvesting any earnings and optionally converting them to ETH or a different token.","Harvest"]},{"l":"Contract Infrastructure","p":["vfat.io Yield is powered by Sickle, a self-custodied contract that is deployed on each chain when making your first deposit. Sickle can perform complex actions in a single transaction, as defined in Strategy contracts, such as the inaugural Aerodrome Strategy.","Contracts have been audited by yAudit. Please note smart contracts bear risk regardless of audits, and there is always the underlying risk of the pool entered."]},{"l":"Fee Structure","p":["Sickle charges 9 basis points (0.09%) on deposits and withdrawals, and 90 bps (0.9%) on compounds and harvests."]}]] |
Oops, something went wrong.