Merge pull request #24 from 0xSpaceShard/develop

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,41 @@
+---
+id: first_steps
+title: First Steps
+sidebar_position: 1
+---
+
+## 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).
+
+
+## Connect to Nimbora
+
+The process begins by visiting the Nimbora platform at https://app.nimbora.io/
+
+Click “**Connect Wallet**” in the top right corner 
+
+![Untitled](https://i.imgur.com/SaXJ9qq.png) 
+
+Select one of the two available wallet options ([Braavos](https://braavos.app/) or [ArgentX](https://argent.xyz/)) 
+
+![Untitled](https://i.imgur.com/pwjsKxV.png)
+
+For the sake of this tutorial we will be using **Argent X** wallet extension. 
+
+![Untitled](https://i.imgur.com/517pTc6.png)
+
+Follow the notification prompt and click on “**Connect**” 
+
+![Untitled](https://i.imgur.com/pnBwOEo.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](https://i.imgur.com/31dDkrK.png)

docs/concepts/guide/02-earn.md

@@ -0,0 +1,80 @@
+---
+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/earn.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. 
+
+**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/hdeposit.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.
+
+![alt](/content/rdeposit.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)
+
+
+You can consult all of your recent deposits in the wallet section, your transaction should be here. 
+
+![alt](/content/cdeposit.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
+
+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](/content/hwithdraw.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)
+
+
+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)
+
+You can consult all of your recent deposits in the wallet section, your transaction should be here. 
+
+![alt](/content/cwithdraw.png)
+
+And that's it, you should see your pending request in the navbar.
+
+![alt](/content/pwithdraw.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-borrow.md

@@ -0,0 +1,80 @@
+---
+id: borrow
+title: Borrow
+sidebar_position: 3
+---
+
+## Understanding the Borrow Section
+
+There are 2 cards (troves) with 2 different TCR (total collateral ratio). The CR is not fixed, as its value is pegged to the ETH price. That is why the screenshot below might not match the current numbers you will see once you open the troves. 
+
+![Untitled](https://i.imgur.com/ERJ3ast.png)
+
+**TCR is the percentage of assets you need to lock up as collateral when borrowing**. If you want to borrow $100 and the TCR is 676%, you must provide $676 worth of assets as collateral.
+
+Lets take as an example this image above - trove 604 TCR will require **less collateral** compared to Trove 910 CR, but Trove 910 TCR is **more secure** than Trove 604 .
+
+Consider this scenario: if all troves were open when the ETH price was at $1600, Trove 910 would have a higher tolerance for price fluctuations compared to Trove 604, allowing it to withstand a more significant drop in ETH price before facing liquidation.
+
+Once the collateral is deposited and locked, users can borrow against it according to the platform's loan-to-value ratio.   If the value of the collateral falls below certain thresholds, the system may automatically liquidate the assets to repay the loan. 
+
+
+### **Which trove should you select?**
+
+This depends on how much LUSD you want to borrow and ongoing initiatives. 
+
+The left trove offers a unique opportunity for users to borrow with minimal transaction costs, subsidized by the [Nimbora x Liquity](https://medium.com/@Nimbora/defi-spring-just-got-better-earn-strk-with-nimbora-x-liquity-d7e881f22c38) collaboration.
+
+## How to borrow
+
+
+Enter the amount you want to supply or click on the buttons to set a desired percentage of your balance you want to deposit. You can also directly enter the amount of LUSD you want to borrow, both fields can be used. 
+
+
+![alt](/content/hborrow.png)
+
+Finally, when you've selected the amount, click on "borrow" and follow the prompts on your wallet (Argent or Braavos) to complete the transaction.
+
+
+![alt](/content/rborrow.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/fborrow.png)
+
+You can consult all of your recent borrow in the wallet sections, your transaction should be here. 
+
+![alt](/content/cborrow.png)
+
+And that's it, your borrow request has been sent, you can see it in pending orders section.
+
+![alt](/content/pborrow.png)
+
+Borrow should be processed within a day, LUSD will be directly sent to your wallet. 
+
+
+## Repay the Loan
+
+First, you need to decide on the amount you want to repay. This could be all of your debt or only a portion of it.
+
+![alt](/content/hrepay.png)
+
+Once you've made up your mind, locate and click on the 'repay' button and follow the prompts on your wallet (Argent or Braavos) to complete the transaction.
+
+![alt](/content/rrepay.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/frepay.png)
+
+You can consult all of your recent repays in the wallet sections, your transaction should be here. 
+
+![alt](/content/crepay.png)
+
+And that's it, your repay request has been sent, you can see it in pending orders section.
+
+![alt](/content/prepay.png)
+
+Repay should be processed within a day, ETH will be directly sent to your wallet. 
+