Develop

.github/workflows/deploy-docusaurus.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   build-and-deploy:
-    runs-on: ubuntu-latest
+    runs-on: [self-hosted, '${{ vars.RUNNER }}']
     steps:
     - uses: actions/checkout@v2
       with:

.github/workflows/deploy-vercel.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   deploy-to-vercel:
-    runs-on: ubuntu-latest
+    runs-on: [self-hosted, '${{ vars.RUNNER }}']
     steps:
       - name: Checkout code
         uses: actions/checkout@v2

.github/workflows/workflow.yml

@@ -10,7 +10,7 @@ env:
 
 jobs:
   deploy:
-    runs-on: ubuntu-latest
+    runs-on: [self-hosted, '${{ vars.RUNNER }}']
     if: github.ref_name == ${{ github.ref_name }}
     steps:
       - name: Deploy the service to "${{ github.ref_name }}"
@@ -37,8 +37,8 @@ jobs:
                   git fetch && \
                   git checkout ${{ github.ref_name }} && \
                   git reset --hard origin/${{ github.ref_name }} && \
-                  docker-compose -f docker-compose.yml pull && \
-                  docker-compose -f docker-compose.yml up -d --build
+                  docker compose -f docker-compose.yml pull && \
+                  docker compose -f docker-compose.yml up -d --build
               else
                   echo "Directory does not exist, aborting script."
                   exit 1

docs/concepts/guide/01-first-steps.md

@@ -0,0 +1,52 @@
+---
+id: first_steps
+title: First Steps
+sidebar_position: 1
+---
+
+## Getting Started on Starknet[](https://docs.nimbora.io/docs/concepts/guide/first_steps#getting-started-on-starknet)
+
+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: 
+
+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 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).
+
+## Getting started with Nimbora
+
+Launch Nimbora at https://app.nimbora.io/. 
+
+Nimbora is in alpha stage, so you will need a referral code to access the dApp.
+![Untitled](../../../static/content/first_steps/nimbora%20referral.png)
+
+You can [join our Discord](https://discord.gg/nimbora) and ask for an invite in the #invites channel.
+[![Nimbora Discord](../../../static/content/first_steps/Discord.png)](https://discord.gg/nimbora)
+
+Once you’ve secured the invite, click “Connect Wallet” in the top right corner.
+
+![Untitled](../../../static/content/first_steps/connect%20wallet.png) 
+
+Select one of the available wallet options ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) 
+
+![Untitled](../../../static/content/first_steps/avaliable%20wallets.png)
+
+Follow the notification prompt and click on “**Connect**” 
+
+![Untitled](../../../static/content/first_steps/notification%20prompt.png)
+
+### This enable Nimbora to:
+
+- Read your wallet address
+- Request transactions
+
+*You will still need to sign any new transaction*
+
+Voila! “**Connect wallet**”  will be replaced with your wallet address, indicating you are successfully connected. 
+
+![Untitled](../../../static/content/first_steps/connection%20success.png)

docs/concepts/guide/02-earn.md

@@ -0,0 +1,85 @@
+---
+id: earn
+title: Earn
+sidebar_position: 2
+sidebar_class_name: hidden
+---
+
+## Understanding the Earn Section
+
+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/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% 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.
+
+**Here's an APR breakdown of the nsDAI strategy**
+
+![alt](/content/strategy_nsdai/apr_breakdown.png)
+
+1. **Base**: Represents default strategy yield that auto-compounds daily. We take a 20% performance fee. The APRs displayed are what you actually receive, as our performance fee has already been accounted for.
+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 week at the [rewards page](https://app.nimbora.io/rewards/).
+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 week at the [rewards page](https://app.nimbora.io/rewards/).
+4. **Extra: Ekubo LP** Providing Nimbora yield bearing tokens as liquidity on Ekubo is tracked and added to the total claimable STRK amount at the [rewards page](https://app.nimbora.io/rewards/).
+
+**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.
+
+**Total value locked**. The total value locked (TVL) is the total amount of assets held in the strategy converted in USD.
+
+Choose the strategy that you want and click on the card for next steps
+
+## How 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](/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 ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) to complete the transaction.
+
+![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/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/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.
+
+## How to request a withdrawal
+
+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.
+
+![alt](../../../static/content/strategy_nsdai/strategy_nsdai_withdraw_normal.png)
+
+Normal withdrawals are not synchronous such as deposits and take between 24 and 72 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)
+
+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/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/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)
+
+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.

docs/concepts/guide/03-points.md

@@ -0,0 +1,121 @@
+---
+id: points
+title: Points
+sidebar_position: 3
+---
+## What are Nimbora Points?[](https://docs.nimbora.io/docs/concepts/guide/points#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.
+
+### 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.
+
+### Types of Nimbora Points:
+[](https://docs.nimbora.io/docs/concepts/guide/points#types-of-crypto-points)
+
+
+- **Earn Points**: Earn points for depositing assets to any of our earn strategies.
+- **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.
+
+## How are on-chain points calculated?[](https://docs.nimbora.io/docs/concepts/guide/points#how-are-on-chain-points-calculated)
+
+### Earn[](https://docs.nimbora.io/docs/concepts/guide/points#earn)
+
+The earn points are calculated daily based user assets deposited in all earn troves. 
+
+**Example**:
+
+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. 
+
+![Untitled](https://i.ibb.co/12QVsLr/Untitled-29.png)
+
+The median daily price sourced from Pragma oracles (if not stablecoin) is utilized in this calculation process.
+
+| Day | nsDAI balance | USD equivalent | Points  |
+| --- | --- | --- | --- |
+| 1 | 3000 | 3000 | 3000 |
+| 2 | 3000 | 3200 | 3200 |
+| 3 | 3000 | 3400 | 3400 |
+| / | Total points  |  | 9600 |
+
+
+### Referral
+
+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 points are calculated based on the referral relation between users.
+
+For example, we have this referral table:
+
+| Referral | Invited User |
+| --- | --- |
+| Alice | Bob |
+| Alice | Carlo |
+| Bob | Sarah |
+| Carlo | Alex |
+
+and this is the daily points per user
+
+| User | Points |
+| --- | --- |
+| Alice | 100 |
+| Bob | 200 |
+| Carlo | 300 |
+| Sarah | 100 |
+| Alex | 100 |
+
+First, we boost the users’ points
+
+`referral points = (User points * boost) + (10% Bob + 10% Carlo + 5% Sarah + 5% Alex)`
+
+Using the boosted points we calculate the referral points.
+
+- `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.
+
+| User | Alice | Bob | Carlo | Sarah | Alex | TOTAL |
+| --- | --- | --- | --- | --- | --- | --- |
+| Alice | - | 22 | 33 | 11 | 11 | 77 |
+| Bob | - | - | - | 11 | - | 11 |
+| Carlo | - | - | - | - | 11 | 11 |
+| Sarah | - | - | - | - | - | - |
+| Alex | - | - | - | - | - | - |
+
+### Rank[](https://docs.nimbora.io/docs/concepts/guide/points#rank)
+
+Rank points represent extra points earned based on your leaderboard position, with the top performers having higher earning rate. 
+
+This table represents points bonus based on the leaderboard position: 
+
+| Leaderboard | Boost % |
+| --- | --- |
+| 1-50 | 20% |
+| 51-150 | 15% |
+| 151-500 | 10% |
+| 501-1000 | 5% |
+| 1001+ | 0% |
+
+This table represents points breakdown with the Rank points taken into account:
+
+| Leaderboard | Earn points | Referral points | % boost | Rank points | Total |
+| --- | --- | --- | --- | --- | --- |
+| 1-50   | 100 | 50 | 20% | 30 | 180 |
+| 51-150 | 80  | 0  | 15% | 12 | 92  |
+| 151-500| 70  | 10 | 10% | 8  | 88  |
+| 501-1000| 30 | 0  | 5%  | 2  | 32  |
+| 1001+  | 30  | 0  | 0%  | 0  | 30  |
+
+
+`Info: When users have the same points the register timestamp is used to order them.`