Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

draft/docs-init #79

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/src/0_introduction.md
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
## Carrot Savings

Welcome to the Carrot Savings App documentation! Buckle up, because this isn't your typical product manual. We built the Carrot App with a passion for transparency and want to share the journey with you, step-by-step. It's all part of our mission to push the boundaries on ownership and trust in DeFi. Here's the thing: we don't own the Carrot, there are no shareholders – everyone owns their own Carrot, making it truly MyFi.

This guide will introduce the Carrot App and take you behind the scenes of its development.

## The Carrot in a Nutshell

the Carrot Savings App is a self-hosted interchain yield aggregator designed to offer you the best stablecoin yields available.
Unlike traditional DeFi Apps where users engage with a single or a suite of smart contracts deployed on-chain, the Carrot App is a self-hosted application, allowing you to configure the application to your needs with improved trustlessness.

### Key Features (the Good Stuff):

- Effortless Onboarding: Forget the complexities of traditional DeFi manual interactions and micromanagement of your funds. Carrot Savings eliminates the need to understand intricate smart contracts or manage multiple protocols.
- Streamlined Installation: Install the app on your Abstract account with ease, similar to installing apps on your phone.
- Predefined Strategies: Leverage pre-configured, optimized yield strategies for maximum returns.
- Automated Management: Sit back and relax while the app automatically compounds your yield and manages your stablecoins.
36 changes: 36 additions & 0 deletions docs/src/1_how_it_works.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# How it works

## Version 1

The first version of Carrot Savings utilizes a single strategy: managing USDC (USDC - Noble) / USDC (USDC.axl) liquidity on Osmosis.

Here's the process:

1. Installation: The user installs the Carrot Savings App on their Abstract account
![create account](create_account.png).

---

2. Deposit & Authorization: The user deposits some USDC into the app and grants it authorization rights. These rights allow the app to perform specific actions on their behalf, like swapping tokens or creating liquidity pools.
![deposit](deposit.png)

---

3. Strategy Execution: The app swaps the deposited USDC (Noble) for the optimal ratio of USDC (USDC) / USDC.axl. Then, it creates a liquidity position on behalf of the user on Osmosis.
![position](position_osmosis.png)

---

4. Autocompounding: Since autocompounding is permissionless, the Carrot Savings team manages a bot that automatically compounds the yield generated for all users.
![dashboard](dashboard.png)

---

5. Funds withdrawal: The user can withdraw anytime their funds from the liquidity pool on Osmosis back to their account.
![withdraw](withdraw.png)

---

## Diagram

![diagram](version_1.png)
Loading
Loading