diff --git a/docs/concepts/guide/01-first-steps.md b/docs/concepts/guide/01-first-steps.md index 05de335..bab685b 100644 --- a/docs/concepts/guide/01-first-steps.md +++ b/docs/concepts/guide/01-first-steps.md @@ -4,26 +4,36 @@ title: First Steps sidebar_position: 1 --- -## Getting Started on Starknet +## Getting Started on Starknet[](https://docs.nimbora.io/docs/concepts/guide/first_steps#getting-started-on-starknet) -The first step consists of installing Starknet wallets and bridging funds to your account. The entire setup process is explained in detail [here](https://www.starknet.io/en/content/getting-started-using-starknet-setting-up-a-starknet-wallet). +1. The first step is installing a Starknet wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)). +2. Deposit funds (ETH on Starknet for starters) to your account. +3. To interact with Starknet dApps, you will need to deploy your account. +The process can be done with the following steps: -## Connect to Nimbora +1. Deposit ETH on Starknet to your wallet address. +2. Send ETH to your own or external address. +3. Your wallet will be ready to use as soon as the transaction is processed. -The process begins by visiting the Nimbora platform at https://app.nimbora.io/ +The entire setup process, including bridging of the funds is explained in detail [here](https://www.starknet.io/en/content/getting-started-using-starknet-setting-up-a-starknet-wallet). -Click “**Connect Wallet**” in the top right corner +## Getting started with Nimbora -![Untitled](https://i.imgur.com/SaXJ9qq.png) +Launch Nimbora at https://app.nimbora.io/. + +Nimbora is in alpha stage, so you will need a referral code to access the dApp. +![Untitled](https://i.ibb.co/J5mnmTv/Screenshot-549.png) -Select one of the two available wallet options ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) +You can [join our Discord](https://www.notion.so/Nimbora-MKT-Dashboard-e5cd8af2cd214955b1067075b3888c28?pvs=21) and ask for an invite in the #invites channel. -![Untitled](https://i.imgur.com/pwjsKxV.png) +Once you’ve secured the invite, click “Connect Wallet” in the top right corner. + +![Untitled](https://i.imgur.com/SaXJ9qq.png) -For the sake of this tutorial we will be using **Argent X** wallet extension. +Select one of the available wallet options ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) -![Untitled](https://i.imgur.com/517pTc6.png) +![Untitled](https://i.ibb.co/ftRGfGr/Screenshot-548.png) Follow the notification prompt and click on “**Connect**” diff --git a/docs/concepts/guide/02-earn.md b/docs/concepts/guide/02-earn.md index 68b7d7d..9b1d35b 100644 --- a/docs/concepts/guide/02-earn.md +++ b/docs/concepts/guide/02-earn.md @@ -9,12 +9,21 @@ sidebar_class_name: hidden There are several yield strategies with different underlying tokens and APR (Annual Percentage Rate). Each card represent a certain strategy, it can be a lending pool, a strategy aggregator, an AMM liquidity pool... -![alt](/content/earn.png) +![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 not fixed**. APR can change based on several factor such as market condition or the net asset value of the L1 strategy. +**Here's an APR breakdown of the nsDAI strategy** + +![alt](https://i.ibb.co/P4Vbc55/Screenshot-556.png) + +1. **Base**: Represents default strategy yield. +2. **Boost**: Represents incentives added by the Nimbora team to enable higher APR. +3. **Incentives**: Represents incentives provided by the Starknet Foundation. + **Underlying protocols**. Underlying protocols linked to the strategy are displayed, you can choose the one you are the most comfortable with. **Underlying token**. The underlying token is the token used to deposit into the strategy, strategy yield bearing token is correlated to the underlying, just providing additional rewards. @@ -28,25 +37,24 @@ Choose the strategy that you want and click on the card for next steps 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](/content/hdeposit.png) +![alt](/content/strategy_nsdai/strategy_nsdai_deposit.png) -When you've selected the token amount to deposit, click on "deposit" and follow the prompts on your wallet (Argent or Braavos) to complete the transaction. +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](/content/rdeposit.png) +![alt](/content/strategy_nsdai/strategy_nsdai_deposit_wallet.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](/content/fdeposit.png) +![alt](/content/strategy_nsdai/strategy_nsdai_deposit_confirm.png) You can consult all of your recent deposits in the wallet section, your transaction should be here. -![alt](/content/cdeposit.png) - +![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. +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. @@ -57,24 +65,24 @@ Withdrawal are not synchronous such as deposits they take an average of 1 day to First, you need to decide on the amount you want to withdraw. This could be all or a portion of your assets. -![alt](/content/hwithdraw.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. -![alt](/content/rwithdraw.png) +![alt](/content/strategy_nsdai/strategy_nsdai_withdraw_wallet.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](/content/fwithdraw.png) +![alt](/content/strategy_nsdai/strategy_nsdai_withdraw_confirm.png) You can consult all of your recent deposits in the wallet section, your transaction should be here. -![alt](/content/cwithdraw.png) +![alt](/content/strategy_nsdai/strategy_nsdai_withdraw_recent.png) And that's it, you should see your pending request in the navbar. -![alt](/content/pwithdraw.png) +![alt](/content/strategy_nsdai/strategy_nsdai_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. +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. diff --git a/docs/concepts/guide/04-points.md b/docs/concepts/guide/04-points.md index 183f9a2..1ef20bf 100644 --- a/docs/concepts/guide/04-points.md +++ b/docs/concepts/guide/04-points.md @@ -3,69 +3,83 @@ id: points title: Points sidebar_position: 4 --- +## What are Nimbora Points?[](https://docs.nimbora.io/docs/concepts/guide/points#what-are-crypto-points) +![Untitled](https://i.ibb.co/LzNKDpn/Untitled-27.png) -## What are Crypto Points? +Nimbora points are designed to incentivize and reward users for actively engaging with our platform. These points serve as a metric for off-chain measuring user activity and contribution within the Nimbora ecosystem, providing rewards based on participation levels. -**Crypto points**, within the context of Nimbora Protocol, are digital units designed to incentivize and reward users for actively engaging with our platform. These points serve as a metric for off-chain measuring user activity and contribution within the Nimbora ecosystem, providing insights and rewards based on participation levels. +### Key Features of Nimbora Points:[](https://docs.nimbora.io/docs/concepts/guide/points#key-features-of-crypto-points) +1. **Incentivization**: Points encourage participation and engagement by rewarding users for their contributions to the Nimbora ecosystem. These contributions may include providing liquidity (borrow and yield strategies) or promoting adoption (referrals) +2. **Utility**: Beyond their monetary value, Nimbora points will offer utility within the Nimbora ecosystem. Users will be able to utilize these tokens to access premium features and get additional rewards. -### Key Features of Crypto Points: +### Types of Nimbora Points: +[](https://docs.nimbora.io/docs/concepts/guide/points#types-of-crypto-points) -1. **Incentivization**: Crypto points encourage participation and engagement by rewarding users for their contributions to the Nimbora ecosystem. These contributions may include providing liquidity or promoting adoption. +![Untitled](https://i.ibb.co/qDFcNpc/Untitled-28.png) -2. **Utility**: Beyond their monetary value, crypto points offer utility within the Nimbora ecosystem. Users can utilize these tokens to access premium features and get for additional rewards. +- **Earn Points**: Earn points for depositing assets to any of our earn strategies. +- **Borrow Points**: Earn points for borrowing LUSD against ETH in our borrow module. +- **Referral Points**: Earn a fraction of the points your referrals and their invitees make. +- **Rank Points**: Earn extra points based on your leaderboard position, with the top performers having higher earning rate. -### Types of Crypto Points: +## How are on-chain points calculated?[](https://docs.nimbora.io/docs/concepts/guide/points#how-are-on-chain-points-calculated) -- **Borrow Points**: Earn points while using borrow strategies. -- **Earn Points**: Earn points while using earn strategies. -- **Rank Points**: Earn points based on your performance. -- **Referral Points**: Earn points by inviting your friends. -- **Social Points**: Earn points by engaging with the protocol (unactivated for now). +### Earn[](https://docs.nimbora.io/docs/concepts/guide/points#earn) -## How are on-chain points calculated? +The earn points are calculated daily based user assets deposited in all earn troves. -### Borrow +**Example**: -The borrow points are calculated based on the daily user collateral `ETH` deposited in all Liquity troves. We use the ETH median daily price fetched from Pragma oracles to calculate the pts. +nsDAI strategy enables users to put their DAI to use. Users participating in the strategy will get nsDAI token - representing `DAI`-equivalent yield-bearing tokens. -| Day | User’s daily ETH collateral balance | ETH price USD | earn pts | -| --- | --- | --- | --- | -| 1 | 1 | 3000 | 3000 | -| 2 | 0.5 | 3200 | 1600 | -| 3 | 0 | 2800 | 0 | -| / | total pts earn | | 4600 | +![Untitled](https://i.ibb.co/12QVsLr/Untitled-29.png) -### Earn +The median daily price sourced from Pragma oracles (if not stablecoin) is utilized in this calculation process. -We employ a similar methodology to calculate the points for Yield DEX strategies. In the Sdai strategy, we determine the points by converting the balance of `DAI`-equivalent yield-bearing tokens. The median daily price sourced from Pragma oracles (if not stablecoin) is utilized in this calculation process. - -| Day | nsDAI balance | USD equivalent | pts earn | +| Day | nsDAI balance | USD equivalent | Points | | --- | --- | --- | --- | | 1 | 3000 | 3000 | 3000 | | 2 | 3000 | 3200 | 3200 | | 3 | 3000 | 3400 | 3400 | -| / | total pts earn | | 9600 | +| / | Total points | | 9600 | + +### Borrow[](https://docs.nimbora.io/docs/concepts/guide/points#borrow) + +The borrow points are calculated based on the daily user collateral `ETH` deposited in all Liquity troves. + +![Untitled](https://i.ibb.co/tby62s0/Untitled-32.png) + +We use the ETH median daily price fetched from Pragma oracles to calculate the pts. + +| Day | User’s daily ETH collateral balance | ETH price USD | Earn points | +| --- | --- | --- | --- | +| 1 | 1 | 3000 | 3000 | +| 2 | 0.5 | 3200 | 1600 | +| 3 | 0 | 2800 | 0 | +| / | total points earn | | 4600 | ### Referral -Before calculating the referral pts for each user, a boost is applied to the on-chain users pts (borrow + earn). By default, the boost is `10%`, but some users who used partner links (boosted links) can receive a higher boost. +Before calculating the referral points for each user, a boost is applied to the on-chain users pts (borrow + earn). By default, the boost is `10%`, but strategic partners and users joining through them can receive a higher boost. + +![Untitled](https://i.ibb.co/Gxj7TsW/Untitled-30.png) -The referral pts are calculated based on the referral relation between users. +The referral points are calculated based on the referral relation between users. For example, we have this referral table: -| parent | child | +| Referral | Invited User | | --- | --- | | Alice | Bob | | Alice | Carlo | | Bob | Sarah | | Carlo | Alex | -and this is the daily pts per user +and this is the daily points per user -| User | pts | +| User | Points | | --- | --- | | Alice | 100 | | Bob | 200 | @@ -73,28 +87,20 @@ and this is the daily pts per user | Sarah | 100 | | Alex | 100 | -First, we boost the users’ pts +First, we boost the users’ points -| User | pts | -| --- | --- | -| Alice | 100 | -| Bob | 200 | -| Carlo | 300 | -| Sarah | 100 | -| Alex | 100 | - -`referral pts = (User points * boost) + (10% Bob + 10% Carlo + 5% Sarah + 5% Alex)` +`referral points = (User points * boost) + (10% Bob + 10% Carlo + 5% Sarah + 5% Alex)` -Using the boosted pts we calculate the referral pts. +Using the boosted points we calculate the referral points. -- `Alice` receives: - - `10%` from `Bob` and `Carlo`direct child - - `5%` from `Sarah` and `Alex` first child of a direct child. -- `Bob` receives: - - `10%` from `Sarah` direct child -- `Carlo` receives: - - `10%` from `Alex` direct child -- `Sarah` and `Alex` receive nothing because they don’t have a child. +- `Alice` receives: + - `10%` from `Bob` and `Carlo` direct invitee + - `5%` from `Sarah` and `Alex` first invitee of a direct invitee. +- `Bob` receives: + - `10%` from `Sarah` direct invitee +- `Carlo` receives: + - `10%` from `Alex` direct invitee +- `Sarah` and `Alex` receive nothing haven’t invited anyone. The following table was calculated using boosted balances. @@ -106,46 +112,29 @@ The following table was calculated using boosted balances. | Sarah | - | - | - | - | - | - | | Alex | - | - | - | - | - | - | -### Rank +### Rank[](https://docs.nimbora.io/docs/concepts/guide/points#rank) -This is the user’s total pts +Rank points represent extra points earned based on your leaderboard position, with the top performers having higher earning rate. -| User | earn pts | borrow pts | referral pts | total pts | -| --- | --- | --- | --- | --- | -| Alice | 50 | 50 | 87 | 187 | -| Bob | 150 | 50 | 31 | 231 | -| Carlo | 100 | 200 | 41 | 341 | -| Sarah | 80 | 20 | 10 | 110 | -| Alex | 30 | 70 | 10 | 110 | +![Untitled](https://i.ibb.co/3TSwx37/Screenshot-550.png) +This table represents points bonus based on the leaderboard position: -Sort the users by total pts ( the following are only examples for more details about prod setup check this [[link](https://www.notion.so/Point-system-Tech-bbaba9b312f4402d842547bb4579a8e4?pvs=21)]) - -1. The first receives 20% boost -2. The second receives 15% boost -3. The second receives 10% boost -4. The second receives 5% boost -5. The second receives 0% boost - -`Info: When users have the same pts the register timestamp is used to order them.` - -| Rank | user | total pts | rank pts | -| --- | --- | --- | --- | -| 1 | Carlo | 341 | 68 | -| 2 | Bob | 221 | 33 | -| 3 | Alice | 187 | 18 | -| 4 | Sarah | 110 | 5 | -| 5 | Alex | 110 | 0 | - -So, the total pts earn by each user during the last 24 hours: +| Leaderboard | Boost % | +| --- | --- | +| 1-50 | 20% | +| 51-200 | 15% | +| 201-500 | 10% | +| 501-1000 | 5% | +| 1001+ | 0% | -| Rank | total pts | rank pts | -| --- | --- | --- | -| 1 | 341 | 68 | -| 2 | 221 | 33 | -| 3 | 187 | 18 | -| 4 | 110 | 5 | -| 5 | 110 | 0 | +This table represents points breakdown with the Rank points taken into the account: -### Social +| Leaderboard | Earn points | Borrow points | Referral points | % boost | Rank points | Total | +| --- | --- | --- | --- | --- | --- | --- | +| 1-50 | 100 | 50 | 50 | 20% | 40 | 240 | +| 51-200 | 80 | 20 | 0 | 15% | 15 | 115 | +| 201-500 | 70 | 0 | 10 | 10% | 8 | 88 | +| 501-1000 | 30 | 10 | 0 | 5% | 2 | 42 | +| 1001+ | 30 | 5 | 0 | 0% | 0 | 35 | -TBD \ No newline at end of file +`Info: When users have the same points the register timestamp is used to order them.` \ No newline at end of file diff --git a/docs/concepts/guide/05-referral.md b/docs/concepts/guide/05-referral.md new file mode 100644 index 0000000..03207c6 --- /dev/null +++ b/docs/concepts/guide/05-referral.md @@ -0,0 +1,51 @@ +--- +id: referrals +title: Referrals +sidebar_position: 5 +--- + +## The Nimbora Affiliation Program + +Referrals, within the context of Nimbora Protocol, are a vital component of our self-service affiliate program, designed to reward users for expanding our community. By referring new users, participants can earn additional points through a boosted calculation system, enhancing their overall earnings and helping to grow the Nimbora ecosystem. + +When a user invites others to join Nimbora, they become the "parent" in the referral relationship, and the new user becomes their "child." This relationship forms a referral network where points are distributed based on user activity and their connections. For example, when a direct referral (child) earns points, a percentage of these points is also credited to the referring user (parent). This incentivizes users to actively recruit new members and support their engagement on the platform. + +The Nimbora referral program is structured to provide significant benefits for active participants. Points earned through referrals are not just a flat rate; they are boosted by a percentage, which increases the more active the referred users are. This means that users who bring in highly engaged new members can see substantial rewards, promoting a vibrant and growing community. + +Additionally, special boosted referral links can offer higher percentage rewards, encouraging users to utilize these links for maximum benefit. This layered incentive system ensures that both new and existing users are motivated to participate and contribute to the ongoing success and expansion of Nimbora. + +### How to find a referral link + +- Join our Discord community, and find some in the [Invite section](https://discord.com/channels/1157580917917892640/1242045588384514048) + +- Explore partner protocols' social media channels, where referral links are often shared with additional boosts. Here are some examples of our partners: Spark, OnlyDust, Kakarot, StaknetQuest, zkLend, Herodotus, Carmine, Pragma. + + +### How to consume a referral link + +- For now, access to the dapp requires a mandatory referral code. Access to the [Dapp](https://app.nimbora.io/referral/). + + ![Consume Referral](/content/refCode.png) + + +- Enter the referral code you found. Note that using a link will auto-complete the field. Finally sign a message and Voila! You are now referred and ready to start the aventure! + + ![Consume Referral](/content/refJoin.png) + + +### How to Become a Referrer + +1. Head to the app points section: [Nimbora Points](https://app.nimbora.io/points/) +2. Find the box labeled "Refer a Friend." + + ![Refer a Friend](/content/ref.png) + +3. Click the copy button to get your referral link, or directly click the X icon to share it with your community instantly. You can customize the tweet as you like. + +### Benefits + +Before calculating the referral points for each user, a boost is applied to the on-chain user's points (borrow + earn). By default, the boost is 10%, but some users who use partner links (boosted links) can receive a higher boost. + +For more details, check the [points section](/docs/concepts/guide/points). + + diff --git a/docs/concepts/introduction.md b/docs/concepts/introduction.md index b4245db..b4450cc 100644 --- a/docs/concepts/introduction.md +++ b/docs/concepts/introduction.md @@ -80,4 +80,7 @@ Building upon Starknet brings a paradigm shift to Ethereum transactions through - **Cost-Effective Transactions:** Drastically lowering the cost barrier for participation. - **Enhanced User Experience:** Providing intuitive and seamless interactions (Native Account Abstraction). - **Developer-Friendly Ecosystem:** Fostering an environment conducive to innovation and expansion. -- **Swift and Efficient Operations:** Streamlining processes across the blockchain for improved performance. \ No newline at end of file +- **Swift and Efficient Operations:** Streamlining processes across the blockchain for improved performance. +## Nimbora Security Audits: + +Nimbora has been audited by the Cairo Security Clan. Get the report [here](https://github.com/0xSpaceShard/nimbora_audit_report_yield_dex/blob/main/Nimbora%20Audit%20Report.pdf). \ No newline at end of file diff --git a/docs/concepts/links.md b/docs/concepts/links.md index 5f86b56..440cf2e 100644 --- a/docs/concepts/links.md +++ b/docs/concepts/links.md @@ -10,14 +10,12 @@ sidebar_position: 4 - 🌐 [Website](https://www.nimbora.io/) - 👨‍💻 [DApp](https://app.nimbora.io/) -- 🔐[Audit](https://github.com/0xSpaceShard/nimbora_audit_report_yield_dex/blob/main/Nimbora_Audit_Report_Yield_Dex.pdf) - 🐦 [Twitter](https://twitter.com/Nimbora_) - 👋 [Discord](http://discord.gg/nimbora) - 💼 [LinkedIn](https://www.linkedin.com/company/nimbora/) - ✉️ [Newsletter](https://bit.ly/nimboranewsletter) - 📖 [Medium](https://medium.com/@Nimbora) - - +- 🛡 [Audit](https://github.com/0xSpaceShard/nimbora_audit_report_yield_dex/blob/main/Nimbora%20Audit%20Report.pdf) ## **Need Help?** diff --git a/docs/concepts/products/earn/01-strategy-sdai.md b/docs/concepts/products/earn/01-strategy-sdai.md index 9d99702..0ed26ab 100644 --- a/docs/concepts/products/earn/01-strategy-sdai.md +++ b/docs/concepts/products/earn/01-strategy-sdai.md @@ -1,20 +1,20 @@ --- -id: sdai -title: sDAI Strategy +id: nsdai +title: nsDai Strategy sidebar_position: 1 sidebar_class_name: hidden --- -**This strategy allows users to leverage their DAI holdings** by depositing them into an sDAI vault, which is a specialized financial vehicle. This depositing action allows their DAI to be put to work, generating potential profits over time. The approach combines the security of DAI, a stablecoin, with the revenue-generating power of DeFi strategies. This mechanism is designed to provide users with a more effective way to maximize the potential return on their DAI investments. +**This strategy allows users to leverage their DAI holdings** by depositing them into an sDai vault, which is a specialized financial vehicle. This depositing action allows their DAI to be put to work, generating potential profits over time. The approach combines the security of DAI, a stablecoin, with the revenue-generating power of DeFi strategies. This mechanism is designed to provide users with a more effective way to maximize the potential return on their DAI investments. -This strategy is straightforward as the logic is very simple: it consists of depositing tokens into DSR to acquire SDAI. +This strategy is straightforward as the logic is very simple: it consists of depositing tokens into DSR to acquire sDai. ![alt](/content/sdai.png) ### Source of yields - - Maker Protocol fees coming fron DAI borrow and treasury earning. + - Maker Protocol fees coming from DAI borrow and treasury earning. ### What is sDAI diff --git a/hiddenStrategies/01-strategy-pendle.md b/docs/concepts/products/earn/02-strategy-pendle.md similarity index 100% rename from hiddenStrategies/01-strategy-pendle.md rename to docs/concepts/products/earn/02-strategy-pendle.md diff --git a/docs/concepts/products/earn/pendle_lp_integration/01-etherfi.md b/docs/concepts/products/earn/pendle_lp_integration/01-etherfi.md new file mode 100644 index 0000000..f569b9f --- /dev/null +++ b/docs/concepts/products/earn/pendle_lp_integration/01-etherfi.md @@ -0,0 +1,105 @@ +--- +id: npeEth +title: npeEth Strategy +sidebar_position: 1 +sidebar_class_name: hidden +--- + +**Pendle LP strategy, earn with ETH** + +Liquid restaking on Ethereum repurposes staked ether to validate external systems like rollups or oracles, enhancing the ecosystem's security. Liquid Restaking Tokens (LRTs) act as a buffer against slashing events and offer higher yields than native staking. They simplify participation, manage risks, and conserve gas by batch-collecting rewards. This innovation democratizes staking, challenging established leaders, and offers growth potential, albeit with capped deposits in some systems. Overall, it diversifies Ethereum's staking landscape while bolstering its security and efficiency. + +weETH is the wrapped version of eETH, the etherfi native token, which serves as a liquid staking derivative token. eETH streamlines the staking process by enabling automatic restaking and offering various benefits to users. This includes rewards from both EtherFi and EigenLayer, simplifying the staking experience and providing additional incentives for participation in the DeFi ecosystem. + +Yield come from several sources: + - Ethereum execution and consensus layer staking rewards + - Loyalty points + - EigenLayer restaking rewards + + + +## Get Started + +Visit Nimbora dApp via invite link and connect your Starknet wallet ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)). + + + +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. + +![Untitled](../../../../../static/content/strategy_npeeth/npeeth_home.png) + +When you've selected the token amount to deposit, click on "Deposit" 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_npeeth/npeeth_deposit.png) + +Once the transaction has been accepted on the network, a popup will appear at the bottom left of the screen to let you know. + +![Untitled](../../../../../static/content/strategy_npeeth/npeeth_confirmation.png) + +As a result, you will receive npeETH, which is Liquid Restaking Token (LRT). And that's it, you should be able to see your balance of Nimbora Yield Token in the portfolio section or directly into your wallet browser. + +![Untitled](../../../../../static/content/strategy_npeeth/npeeth_wallet.png) + +## Your Earning Starts Immediately! + +Your yield comes from several sources -  **10% pETH base yield** + **$STRK** **incentives** + **Nimbora** **boost.** + +![Untitled](../../../../../static/content/strategy_npeeth/npeeth_yieldbreakdown.png) + + +With this strategy you are also earning points for 3 protocols: 1x Nimbora, 3x EtherFi, 1x EigenLayer. +![Untitled](../../../../../static/content/strategy_npeeth/npeeth_points_variety.png) + +Remember, holding Nimbora yield-bearing tokens gets points based on your balance. The more and longer you hold, the more points you accumulate. + +You can always check your leaderboard position and Nimbora points breakdown by clicking on ‘Points’ section in the upper right corner at app.nimbora.io + +![Untitled](../../../../../static/content/strategy_npeeth/npeeth_points.png) + +## How to Withdraw + +Withdrawal are not synchronous such as deposits they take an average of 1 day 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. + +![alt](../../../../../static/content/strategy_npeeth/npeeth_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. + +![alt](../../../../../static/content/strategy_npeeth/npeeth_withdraw_wallet.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_npeeth/npeeth_withdraw_confirm.png) + +You can consult all of your recent deposits in the wallet section, your transaction should be here. + +![alt](../../../../../static/content/strategy_npeeth/npeeth_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 EtherFI + + + - Non-Custodial Staking: EtherFi disrupts the decentralized finance (DeFi) space by offering non-custodial Ethereum staking. Users maintain full control over their keys, ensuring security and independence in the staking process. This approach contrasts with traditional custodial services where users relinquish control of their assets to third-party entities. + - Integration with EigenLayer for Enhanced Yields: EtherFi collaborates with EigenLayer, a protocol that increases rewards and boosts the value of DeFi by supporting simpler restaking. Through this integration, users can earn additional yields on top of Ethereum's staking rewards without locking up their assets, promoting flexibility and maximizing earning potential. + + + +### Understanding Risks Associated with EtherFi + +1. **Smart Contract Risks**: + - Though EtherFi's smart contracts are crafted carefully, audited, and thoroughly tested, there always exist risks in interacting with smart contracts on the Ethereum network. + +2. **Key Management Risks**: + - With EtherFi's desktop and decentralized web applications, efforts are made to utilize the latest, safest methods for key encryption and protection. However, EtherFi cannot guarantee or represent that their methods are or will remain 100% secure. Additionally, the responsibility for key management lies in the hands of the user, and preventing user errors, while a primary aim, is virtually impossible. + +3. **Regulatory Risks**: + - EtherFi believes in the potential of the Ethereum network to become the settlement layer for global financial markets. However, this conviction does not guarantee the future. Cryptocurrencies, including Ethereum, have faced increased governmental scrutiny as they transition from niche to mainstream. Regulatory risks include, but are not limited to: + - Bans on cloud service providers offering services to crypto-related enterprises. + - Bans on ISPs providing crypto-related services. + - Onerous taxes levied on various network transactions. diff --git a/hiddenStrategies/pendle_lp_integration/_category_.json b/docs/concepts/products/earn/pendle_lp_integration/_category_.json similarity index 100% rename from hiddenStrategies/pendle_lp_integration/_category_.json rename to docs/concepts/products/earn/pendle_lp_integration/_category_.json diff --git a/docs/sdks/sdk/guides/withdrawing_strategy.md b/docs/sdks/sdk/guides/withdrawing_strategy.md index cd43b6d..775c94c 100644 --- a/docs/sdks/sdk/guides/withdrawing_strategy.md +++ b/docs/sdks/sdk/guides/withdrawing_strategy.md @@ -11,7 +11,7 @@ First, you call the `requestWithdrawal` function, specifying the number of share After the withdrawal request is processed and finalized on the StarkNet network, you can claim the withdrawal by calling the `claimWithdrawal` function which moves the tokens back to your Ethereum account. :::info -The **Underlying** asset represent the tokens users will use to deposit within a strategy. For example, the underlying token for the sDAI strategy is DAI. +The **Underlying** asset represent the tokens users will use to deposit within a strategy. For example, the underlying token for the nsDai strategy is DAI. ::: ### Request Withdrawal diff --git a/hiddenStrategies/pendle_lp_integration/01-etherfi.md b/hiddenStrategies/pendle_lp_integration/01-etherfi.md deleted file mode 100644 index 70e440a..0000000 --- a/hiddenStrategies/pendle_lp_integration/01-etherfi.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -id: etherfi -title: EtherFi LRT -sidebar_position: 1 -sidebar_class_name: hidden ---- - -**Pendle LP stratgy, earn with ETH** - -Liquid restaking on Ethereum repurposes staked ether to validate external systems like rollups or oracles, enhancing the ecosystem's security. Liquid Restaking Tokens (LRTs) act as a buffer against slashing events and offer higher yields than native staking. They simplify participation, manage risks, and conserve gas by batch-collecting rewards. This innovation democratizes staking, challenging established leaders, and offers growth potential, albeit with capped deposits in some systems. Overall, it diversifies Ethereum's staking landscape while bolstering its security and efficiency. - - - -weETH is the wrapped version of eETH, the etherfi native token, which serves as a liquid staking derivative token. eETH streamlines the staking process by enabling automatic restaking and offering various benefits to users. This includes rewards from both EtherFi and EigenLayer, simplifying the staking experience and providing additional incentives for participation in the DeFi ecosystem. - -Yield come from several sources: - - Ethereum execution and consensus layer staking rewards - - loyalty points - - EigenLayer restaking rewards - - - - - -### What is EtherFI - - - - Non-Custodial Staking: EtherFi disrupts the decentralized finance (DeFi) space by offering non-custodial Ethereum staking. Users maintain full control over their keys, ensuring security and independence in the staking process. This approach contrasts with traditional custodial services where users relinquish control of their assets to third-party entities. - - Integration with EigenLayer for Enhanced Yields: EtherFi collaborates with EigenLayer, a protocol that increases rewards and boosts the value of DeFi by supporting simpler restaking. Through this integration, users can earn additional yields on top of Ethereum's staking rewards without locking up their assets, promoting flexibility and maximizing earning potential. - - -### Understanding Risks Associated with EtherFi - -1. **Smart Contract Risks**: - - Though EtherFi's smart contracts are crafted carefully, audited, and thoroughly tested, there always exist risks in interacting with smart contracts on the Ethereum network. - -2. **Key Management Risks**: - - With EtherFi's desktop and decentralized web applications, efforts are made to utilize the latest, safest methods for key encryption and protection. However, EtherFi cannot guarantee or represent that their methods are or will remain 100% secure. Additionally, the responsibility for key management lies in the hands of the user, and preventing user errors, while a primary aim, is virtually impossible. - -3. **Regulatory Risks**: - - EtherFi believes in the potential of the Ethereum network to become the settlement layer for global financial markets. However, this conviction does not guarantee the future. Cryptocurrencies, including Ethereum, have faced increased governmental scrutiny as they transition from niche to mainstream. Regulatory risks include, but are not limited to: - - Bans on cloud service providers offering services to crypto-related enterprises. - - Bans on ISPs providing crypto-related services. - - Onerous taxes levied on various network transactions. diff --git a/static/content/cdeposit.png b/static/content/cdeposit.png deleted file mode 100644 index 43067e7..0000000 Binary files a/static/content/cdeposit.png and /dev/null differ diff --git a/static/content/cwithdraw.png b/static/content/cwithdraw.png deleted file mode 100644 index ba86878..0000000 Binary files a/static/content/cwithdraw.png and /dev/null differ diff --git a/static/content/earn.png b/static/content/earn.png deleted file mode 100644 index 30ce4a0..0000000 Binary files a/static/content/earn.png and /dev/null differ diff --git a/static/content/fdeposit.png b/static/content/fdeposit.png deleted file mode 100644 index f57faf6..0000000 Binary files a/static/content/fdeposit.png and /dev/null differ diff --git a/static/content/fwithdraw.png b/static/content/fwithdraw.png deleted file mode 100644 index 162615e..0000000 Binary files a/static/content/fwithdraw.png and /dev/null differ diff --git a/static/content/hdeposit.png b/static/content/hdeposit.png deleted file mode 100644 index ecb133a..0000000 Binary files a/static/content/hdeposit.png and /dev/null differ diff --git a/static/content/hwithdraw.png b/static/content/hwithdraw.png deleted file mode 100644 index 587c0e7..0000000 Binary files a/static/content/hwithdraw.png and /dev/null differ diff --git a/static/content/pwithdraw.png b/static/content/pwithdraw.png deleted file mode 100644 index f2edfc5..0000000 Binary files a/static/content/pwithdraw.png and /dev/null differ diff --git a/static/content/rdeposit.png b/static/content/rdeposit.png deleted file mode 100644 index 1f0ef17..0000000 Binary files a/static/content/rdeposit.png and /dev/null differ diff --git a/static/content/ref.png b/static/content/ref.png new file mode 100644 index 0000000..1c3bd79 Binary files /dev/null and b/static/content/ref.png differ diff --git a/static/content/refCode.png b/static/content/refCode.png new file mode 100644 index 0000000..57171ef Binary files /dev/null and b/static/content/refCode.png differ diff --git a/static/content/refJoin.png b/static/content/refJoin.png new file mode 100644 index 0000000..fa569b7 Binary files /dev/null and b/static/content/refJoin.png differ diff --git a/static/content/rwithdraw.png b/static/content/rwithdraw.png deleted file mode 100644 index 80b9d9e..0000000 Binary files a/static/content/rwithdraw.png and /dev/null differ diff --git a/static/content/sdai_strategy/dai_deposit.jpeg b/static/content/sdai_strategy/dai_deposit.jpeg deleted file mode 100644 index c2de4c6..0000000 Binary files a/static/content/sdai_strategy/dai_deposit.jpeg and /dev/null differ diff --git a/static/content/sdai_strategy/deposit_tx.jpeg b/static/content/sdai_strategy/deposit_tx.jpeg deleted file mode 100644 index 401a9b8..0000000 Binary files a/static/content/sdai_strategy/deposit_tx.jpeg and /dev/null differ diff --git a/static/content/sdai_strategy/sdai_request_withdrawal.jpeg b/static/content/sdai_strategy/sdai_request_withdrawal.jpeg deleted file mode 100644 index ff1bcb2..0000000 Binary files a/static/content/sdai_strategy/sdai_request_withdrawal.jpeg and /dev/null differ diff --git a/static/content/sdai_strategy/sdai_return.jpeg b/static/content/sdai_strategy/sdai_return.jpeg deleted file mode 100644 index bd7af8d..0000000 Binary files a/static/content/sdai_strategy/sdai_return.jpeg and /dev/null differ diff --git a/static/content/sdai_strategy/sdai_roi.jpeg b/static/content/sdai_strategy/sdai_roi.jpeg deleted file mode 100644 index 0ceaa0a..0000000 Binary files a/static/content/sdai_strategy/sdai_roi.jpeg and /dev/null differ diff --git a/static/content/sdai_strategy/sdai_strategy.jpeg b/static/content/sdai_strategy/sdai_strategy.jpeg deleted file mode 100644 index cd8b80a..0000000 Binary files a/static/content/sdai_strategy/sdai_strategy.jpeg and /dev/null differ diff --git a/static/content/sdai_strategy/wallet_access_history.jpeg b/static/content/sdai_strategy/wallet_access_history.jpeg deleted file mode 100644 index 458528d..0000000 Binary files a/static/content/sdai_strategy/wallet_access_history.jpeg and /dev/null differ diff --git a/static/content/strategy_npeeth/npeeth_confirmation.png b/static/content/strategy_npeeth/npeeth_confirmation.png new file mode 100644 index 0000000..83b81dc Binary files /dev/null and b/static/content/strategy_npeeth/npeeth_confirmation.png differ diff --git a/static/content/strategy_npeeth/npeeth_deposit.png b/static/content/strategy_npeeth/npeeth_deposit.png new file mode 100644 index 0000000..b36a682 Binary files /dev/null and b/static/content/strategy_npeeth/npeeth_deposit.png differ diff --git a/static/content/strategy_npeeth/npeeth_home.png b/static/content/strategy_npeeth/npeeth_home.png new file mode 100644 index 0000000..9f4d19b Binary files /dev/null and b/static/content/strategy_npeeth/npeeth_home.png differ diff --git a/static/content/strategy_npeeth/npeeth_points.png b/static/content/strategy_npeeth/npeeth_points.png new file mode 100644 index 0000000..a396afa Binary files /dev/null and b/static/content/strategy_npeeth/npeeth_points.png differ diff --git a/static/content/strategy_npeeth/npeeth_points_variety.png b/static/content/strategy_npeeth/npeeth_points_variety.png new file mode 100644 index 0000000..0e3daf1 Binary files /dev/null and b/static/content/strategy_npeeth/npeeth_points_variety.png differ diff --git a/static/content/strategy_npeeth/npeeth_wallet.png b/static/content/strategy_npeeth/npeeth_wallet.png new file mode 100644 index 0000000..9869d23 Binary files /dev/null and b/static/content/strategy_npeeth/npeeth_wallet.png differ diff --git a/static/content/strategy_npeeth/npeeth_withdraw.png b/static/content/strategy_npeeth/npeeth_withdraw.png new file mode 100644 index 0000000..48f5045 Binary files /dev/null and b/static/content/strategy_npeeth/npeeth_withdraw.png differ diff --git a/static/content/strategy_npeeth/npeeth_withdraw_confirm.png b/static/content/strategy_npeeth/npeeth_withdraw_confirm.png new file mode 100644 index 0000000..0a114f5 Binary files /dev/null and b/static/content/strategy_npeeth/npeeth_withdraw_confirm.png differ diff --git a/static/content/strategy_npeeth/npeeth_withdraw_recent.png b/static/content/strategy_npeeth/npeeth_withdraw_recent.png new file mode 100644 index 0000000..c27ca0e Binary files /dev/null and b/static/content/strategy_npeeth/npeeth_withdraw_recent.png differ diff --git a/static/content/strategy_npeeth/npeeth_withdraw_wallet.png b/static/content/strategy_npeeth/npeeth_withdraw_wallet.png new file mode 100644 index 0000000..2fba229 Binary files /dev/null and b/static/content/strategy_npeeth/npeeth_withdraw_wallet.png differ diff --git a/static/content/strategy_npeeth/npeeth_yieldbreakdown.png b/static/content/strategy_npeeth/npeeth_yieldbreakdown.png new file mode 100644 index 0000000..9841eb9 Binary files /dev/null and b/static/content/strategy_npeeth/npeeth_yieldbreakdown.png differ diff --git a/static/content/strategy_nsdai/strategy_nsdai.png b/static/content/strategy_nsdai/strategy_nsdai.png new file mode 100644 index 0000000..8c9da9e Binary files /dev/null and b/static/content/strategy_nsdai/strategy_nsdai.png differ diff --git a/static/content/strategy_nsdai/strategy_nsdai_deposit.png b/static/content/strategy_nsdai/strategy_nsdai_deposit.png new file mode 100644 index 0000000..b045709 Binary files /dev/null and b/static/content/strategy_nsdai/strategy_nsdai_deposit.png differ diff --git a/static/content/strategy_nsdai/strategy_nsdai_deposit_confirm.png b/static/content/strategy_nsdai/strategy_nsdai_deposit_confirm.png new file mode 100644 index 0000000..3920467 Binary files /dev/null and b/static/content/strategy_nsdai/strategy_nsdai_deposit_confirm.png differ diff --git a/static/content/strategy_nsdai/strategy_nsdai_deposit_recent.png b/static/content/strategy_nsdai/strategy_nsdai_deposit_recent.png new file mode 100644 index 0000000..286d70e Binary files /dev/null and b/static/content/strategy_nsdai/strategy_nsdai_deposit_recent.png differ diff --git a/static/content/strategy_nsdai/strategy_nsdai_deposit_wallet.png b/static/content/strategy_nsdai/strategy_nsdai_deposit_wallet.png new file mode 100644 index 0000000..004822b Binary files /dev/null and b/static/content/strategy_nsdai/strategy_nsdai_deposit_wallet.png differ diff --git a/static/content/strategy_nsdai/strategy_nsdai_withdraw.png b/static/content/strategy_nsdai/strategy_nsdai_withdraw.png new file mode 100644 index 0000000..c8900e8 Binary files /dev/null and b/static/content/strategy_nsdai/strategy_nsdai_withdraw.png differ diff --git a/static/content/strategy_nsdai/strategy_nsdai_withdraw_confirm.png b/static/content/strategy_nsdai/strategy_nsdai_withdraw_confirm.png new file mode 100644 index 0000000..d7d218b Binary files /dev/null and b/static/content/strategy_nsdai/strategy_nsdai_withdraw_confirm.png differ diff --git a/static/content/strategy_nsdai/strategy_nsdai_withdraw_pending.png b/static/content/strategy_nsdai/strategy_nsdai_withdraw_pending.png new file mode 100644 index 0000000..a41c8c5 Binary files /dev/null and b/static/content/strategy_nsdai/strategy_nsdai_withdraw_pending.png differ diff --git a/static/content/strategy_nsdai/strategy_nsdai_withdraw_recent.png b/static/content/strategy_nsdai/strategy_nsdai_withdraw_recent.png new file mode 100644 index 0000000..580ad22 Binary files /dev/null and b/static/content/strategy_nsdai/strategy_nsdai_withdraw_recent.png differ diff --git a/static/content/strategy_nsdai/strategy_nsdai_withdraw_wallet.png b/static/content/strategy_nsdai/strategy_nsdai_withdraw_wallet.png new file mode 100644 index 0000000..2419499 Binary files /dev/null and b/static/content/strategy_nsdai/strategy_nsdai_withdraw_wallet.png differ