Skip to content

Commit

Permalink
Merge pull request #59 from 0xSpaceShard/develop
Browse files Browse the repository at this point in the history
Develop
  • Loading branch information
0xSacha authored Jul 24, 2024
2 parents fd623ae + e653908 commit aa6d858
Show file tree
Hide file tree
Showing 30 changed files with 176 additions and 32 deletions.
17 changes: 12 additions & 5 deletions docs/concepts/guide/02-earn.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ There are several yield strategies with different underlying tokens and APR (Ann

![alt](/content/strategy_nsdai/strategy_nsdai.png)

**APR is the percentage of assets you will earn on your deposit after a year**. If you want to deposit $100 of a certain token in a strategy, if APR is 10% avergae you'll earn $10 after a year.
**APR is the percentage of assets you will earn on your deposit after a year**. If you want to deposit $100 of a certain token in a strategy, if APR is 10% average you'll earn $10 after a year.


**APR is not fixed**. APR can change based on several factor such as market condition or the net asset value of the L1 strategy.
Expand Down Expand Up @@ -61,14 +61,21 @@ And that's it, you should be able to see your balance of Nimbora yield token int

## How to request a withdrawal

Withdrawal are not synchronous such as deposits. Withdrawals take between 12 and 48 hours to be processed. A fast withdrawal option should arrive later on.
You can choose between two withdrawal options - Instant and Normal.

![alt](../../../static/content/strategy_nsdai/strategy_nsdai_withdraw_instant.png)

First, you need to decide on the amount you want to withdraw. This could be all or a portion of your assets.

![alt](/content/strategy_nsdai/strategy_nsdai_withdraw.png)
Instant withdrawals factor in the price impact and set slippage.

Once you've made up your mind, locate and click on the 'withdraw' button and follow the prompts on your wallet (Argent or Braavos) to complete the transaction.
![alt](../../../static/content/strategy_nsdai/strategy_nsdai_withdraw_normal.png)


Normal withdrawals are not synchronous such as deposits and take between 12 and 48 hours to be processed.

Once you have selected the withdraw tab, you will need to decide on the amount you want to withdraw. This could be all or a portion of your assets.

Click on the 'withdraw' button and follow the prompts on your wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) to complete the transaction.

![alt](/content/strategy_nsdai/strategy_nsdai_withdraw_wallet.png)

Expand Down
27 changes: 14 additions & 13 deletions docs/concepts/products/earn/01-strategy-sdai.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,6 @@ Once the transaction has been accepted on the network, a popup will appear at th

![alt](/content/strategy_nsdai/strategy_nsdai_deposit_confirm.png)


You can consult all of your recent tarnsactions in the wallet section. Your transaction should be here.

![alt](/content/strategy_nsdai/strategy_nsdai_deposit_recent.png)

And that's it, you should be able to see your balance of Nimbora yield token into the portfolio section or directly into your wallet browser.

## Your Earning Starts Immediately!
Expand All @@ -65,14 +60,20 @@ Your yield comes from several sources -  **nsDAI base yield** + **$STRK** **

## How to request a withdrawal

Withdrawal are not synchronous such as deposits. Withdrawals take between 12 and 48 hours to be processed. A fast withdrawal option should arrive later on.
You can choose between two withdrawal options - Instant and Normal.

![alt](../../../../static/content/strategy_nsdai/strategy_nsdai_withdraw_instant.png)

Instant withdrawals factor in the price impact and set slippage.

First, you need to decide on the amount you want to withdraw. This could be all or a portion of your assets.
![alt](../../../../static/content/strategy_nsdai/strategy_nsdai_withdraw_normal.png)

![alt](/content/strategy_nsdai/strategy_nsdai_withdraw.png)

Once you've made up your mind, locate and click on the 'withdraw' button and follow the prompts on your wallet (Argent or Braavos) to complete the transaction.
Normal withdrawals are not synchronous such as deposits and take between 12 and 48 hours to be processed.

Once you have selected the withdraw tab, you will need to decide on the amount you want to withdraw. This could be all or a portion of your assets.

Click on the 'withdraw' button and follow the prompts on your wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) to complete the transaction.

![alt](/content/strategy_nsdai/strategy_nsdai_withdraw_wallet.png)

Expand All @@ -81,14 +82,14 @@ Once the transaction has been accepted on the network, a popup will appear at th

![alt](/content/strategy_nsdai/strategy_nsdai_withdraw_confirm.png)

You can consult all of your recent transactions in the wallet section. Your transaction should be here.

![alt](/content/strategy_nsdai/strategy_nsdai_withdraw_recent.png)

And that's it, you should see your pending request in the navbar.

![alt](/content/strategy_nsdai/strategy_nsdai_withdraw_pending.png)

You can consult all of your recent transactions in the wallet section. Your transaction should be here.

![alt](/content/strategy_nsdai/strategy_nsdai_withdraw_recent.png)

Nimbora takes over the task of processing this request. This involves preparing your assets in order to be transferred back to your wallet, a process that is handled entirely behind the scenes to ensure a smooth and efficient operation. Once the request is ready to be claimed, Nimbora relayer will handle it and send it directly into your wallet.

### What is sDAI
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: sSTRK
title: sSTRK Strategy
sidebar_position: 4
sidebar_position: 2
sidebar_class_name: hidden
---

Expand Down
118 changes: 118 additions & 0 deletions docs/concepts/products/earn/03-strategy-angle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
---
id: nstUSD
title: nstUSD Strategy
sidebar_position: 3
sidebar_class_name: hidden
---

**This strategy allows users to leverage their USDC holdings** by minting stUSD, generating yields through RWAs and DeFi assets in Angle Protocol’s reserves.

## About Angle
[Angle](https://www.angle.money/) is a DeFi Protocol specializing in building resilient stablecoin infrastructures. The Protocol’s main products are USDA, the most reliable USD stablecoin, and EURA (formerly agEUR), the most traded Euro stablecoin. Known for its innovative stablecoin mechanisms and reliability, Angle is ranked among the safest DeFi protocols on DeFiSafety. Backed by Andreessen Horowitz (a16z), Angle operates as a Decentralized Autonomous Organization (DAO), ensuring community-driven governance with its veANGLE token used for voting governance proposals. Angle Labs, the main contributor to Angle Protocol, also powers [Merkl](https://merkl.xyz/), a platform enabling foundations, DAOs, and protocols such as Arbitrum, Uniswap, or Aave to create tailored and efficient on-chain incentive programs to optimize their liquidity and growth.


## Get Started

Visit Nimbora dApp via invite link and connect your Starknet wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)).



![alt](../../../../static/content/strategy_nstusd/main.png)


Enter the amount of ETH you want to deposit, or click on the small buttons below the box (25%, 50%, 75%, 100%) to set a desired percentage of the balance you want to deposit.


Enter the amount you want to deposit or click on the buttons to set a desired percentage of your balance you want to deposit.

![alt](../../../../static/content/strategy_nstusd/deposit.png)


When you've selected the token amount to deposit, click on "deposit" and follow the prompts on your wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) to complete the transaction.

![alt](../../../../static/content/strategy_nstusd/deposit_confrm.png)


Once the transaction has been accepted on the network, a popup will appear at the bottom right of the screen to let you know.

![alt](../../../../static/content/strategy_nstusd/deposit_accepted.png)


And that's it, you should be able to see your balance of Nimbora yield token into the portfolio section or directly into your wallet browser.

## Your Earning Starts Immediately!

Your yield comes from several sources -  **nstUSD base yield****$STRK** **incentives** + **Nimbora** **boost.**

**Here's an APR breakdown of the nstUSD strategy**

![alt](../../../../static/content/strategy_nstusd/main.png)

1. **Base**: Represents default strategy yield that auto-compounds daily.
2. **Boost**: Represents incentives provided by the Nimbora team using the [Starknet Catalyst grant](https://medium.com/@Nimbora/nimbora-and-starknet-catalyst-program-14cc7f2f1ab5) that are claimable every two weeks.
3. **Incentives**: Represents incentives provided by the Starknet Foundation as a part of the [DeFi Spring 2.0](https://medium.com/@Nimbora/introducing-defi-spring-2-0-bigger-bolder-better-364bb96b02d6) that are claimable every two weeks.


## How to request a withdrawal
You can choose between two withdrawal options - Instant and Normal.

![alt](../../../../static/content/strategy_nstusd/withdraw.png)

Instant withdrawals factor in the price impact and set slippage.

![alt](../../../../static/content/strategy_nstusd/withdraw_normal.png)


Normal withdrawals are not synchronous such as deposits and take between 12 and 48 hours to be processed.

Once you have selected the withdraw tab, you will need to decide on the amount you want to withdraw. This could be all or a portion of your assets.

Click on the 'withdraw' button and follow the prompts on your wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) to complete the transaction.

![alt](../../../../static/content/strategy_nstusd/withdraw_confirm.png)

Once the transaction has been accepted on the network, a popup will appear at the bottom right of the screen to let you know.

![alt](../../../../static/content/strategy_nstusd/withdraw_accept.png)

You can consult all of your recent transactions in the wallet section. Your transaction should be here.

![alt](../../../../static/content/strategy_nstusd/recent.png)

And that's it, you should see your pending request in the navbar.

![alt](../../../../static/content/strategy_nstusd/withdraw_pending.png)

Nimbora takes over the task of processing this request. This involves preparing your assets in order to be transferred back to your wallet, a process that is handled entirely behind the scenes to ensure a smooth and efficient operation. Once the request is ready to be claimed, Nimbora relayer will handle it and send it directly into your wallet.


### Stay Tuned for Upgrades

Keep an eye on our updates as we roll out new features and advanced strategies to enhance your earning potential.

**Join our [Discord](http://discord.gg/nimbora) for alpha and early notifications 🚀**

[![Nimbora Discord](../../../../static/content/stategy_sstrk/Discord.png)](https://discord.gg/nimbora)


Stay tuned for updates as we continue to bring more 1-click yield strategies to life. Follow [Nimbora on X](https://x.com/Nimbora_) (Twitter) or [Medium](https://medium.com/@Nimbora).

# **About Nimbora**

Nimbora is a Starknet-based omnichain 1-click yield strategies platform that enables users to engage with Layer 1 protocols at a fraction of the cost. Discover the best of Ethereum protocols and optimize your DeFi strategies with Nimbora.

🐧🌐 [Website](https://www.nimbora.io/)

🐧👨‍💻 [DApp](https://app.nimbora.io/)

🐧🐦 [Twitter](https://twitter.com/Nimbora_)

🐧👋 [Discord](http://discord.gg/nimbora)

🐧💼 [LinkedIn](https://www.linkedin.com/company/nimbora/)

🐧📖 [Medium](https://medium.com/@Nimbora)

🐧🗞️ [Docs](https://docs.nimbora.io/)

🐧🛡 [Audit](https://github.com/0xSpaceShard/nimbora_audit_report_yield_dex/blob/main/Nimbora%20Audit%20Report.pdf)
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: pendle
title: Pendle Strategy
sidebar_position: 2
sidebar_position: 4
sidebar_class_name: hidden
---

Expand Down
14 changes: 10 additions & 4 deletions docs/concepts/products/earn/pendle_lp_integration/01-etherfi.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,20 @@ You can always check your leaderboard position and Nimbora points breakdown by c

## How to Withdraw

Withdrawal are not synchronous such as deposits. Withdrawals take between 12 and 48 hours to be processed. A fast withdrawal option should arrive later on.
You can choose between two withdrawal options - Instant and Normal.

![alt](../../../../../static/content/strategy_npeeth/npeeth_withdraw_normal.png)

First, you need to decide on the amount you want to withdraw. This could be all or a portion of your assets.
Instant withdrawals factor in the price impact and set slippage.

![alt](../../../../../static/content/strategy_npeeth/npeeth_withdraw.png)
![Untitled](../../../../../static/content/strategy_npeeth/npeeth_withdraw_instant.png)

Once you've made up your mind, locate and click on the 'withdraw' button and follow the prompts on your wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) to complete the transaction.

Normal withdrawals are not synchronous such as deposits and take between 12 and 48 hours to be processed.

Once you have selected the withdraw tab, you will need to decide on the amount you want to withdraw. This could be all or a portion of your assets.

Click on the 'withdraw' button and follow the prompts on your wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) to complete the transaction.

![alt](../../../../../static/content/strategy_npeeth/npeeth_withdraw_wallet.png)

Expand Down
13 changes: 9 additions & 4 deletions docs/concepts/products/earn/pendle_lp_integration/02-puffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,19 @@ You can always check your leaderboard position and Nimbora points breakdown by c

## How to Withdraw[](https://docs.nimbora.io/docs/concepts/products/earn/pendle_lp_integration/nppETH#how-to-withdraw)

Withdrawal are not synchronous such as deposits. Withdrawals take between 12 and 48 hours to be processed. A fast withdrawal option should arrive later on.

First, you need to decide on the amount you want to withdraw. This could be all or a portion of your assets.
You can choose between two withdrawal options - Instant and Normal.

![Untitled](../../../../../static/content/stategy_nppeth/withdraw.png)

Instant withdrawals factor in the price impact and set slippage.

![Untitled](../../../../../static/content/stategy_nppeth/withdraw_normal.png)

Normal withdrawals are not synchronous such as deposits and take between 12 and 48 hours to be processed.

Once you have selected the withdraw tab, you will need to decide on the amount you want to withdraw. This could be all or a portion of your assets.

Once you've made up your mind, locate and click on the 'withdraw' button and follow the prompts on your wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) to complete the transaction.
Click on the 'withdraw' button and follow the prompts on your wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) to complete the transaction.

![Untitled](../../../../../static/content/stategy_nppeth/withdraw_confirm.png)

Expand Down
15 changes: 11 additions & 4 deletions docs/concepts/products/earn/pendle_lp_integration/03-flux_usdc.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,21 @@ You can always check your leaderboard position and Nimbora points breakdown by c

## How to Withdraw[](https://docs.nimbora.io/docs/concepts/products/earn/pendle_lp_integration/npfUSDC#how-to-withdraw)

Withdrawal are not synchronous such as deposits. Withdrawals take between 12 and 48 hours to be processed. A fast withdrawal option should arrive later on.

First, you need to decide on the amount you want to withdraw. This could be all or a portion of your assets.
You can choose between two withdrawal options - Instant and Normal.

![Untitled](../../../../../static/content/strategy_npfusdc/withdraw.png)


Once you've made up your mind, locate and click on the 'withdraw' button and follow the prompts on your wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) to complete the transaction.
Instant withdrawals factor in the price impact and set slippage.

![Untitled](../../../../../static/content/strategy_npfusdc/withdraw_normal.png)


Normal withdrawals are not synchronous such as deposits and take between 12 and 48 hours to be processed.

Once you have selected the withdraw tab, you will need to decide on the amount you want to withdraw. This could be all or a portion of your assets.

Click on the 'withdraw' button and follow the prompts on your wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) to complete the transaction.

![Untitled](../../../../../static/content/strategy_npfusdc/withdraw_confirm.png)

Expand Down
Binary file modified static/content/stategy_nppeth/withdraw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/content/stategy_nppeth/withdraw_normal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/content/strategy_npeeth/npeeth_withdraw.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/content/strategy_npfusdc/withdraw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/content/strategy_nstusd/deposit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/content/strategy_nstusd/main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/content/strategy_nstusd/points.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/content/strategy_nstusd/points_main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/content/strategy_nstusd/recent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/content/strategy_nstusd/withdraw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aa6d858

Please sign in to comment.