Merge pull request #378 from invariant-labs/a0-getstarted

A0 getstarted
invariant-labs · Aug 28, 2024 · d6b1b94 · d6b1b94
2 parents e6c494b + b80b51b
commit d6b1b94
Show file tree

Hide file tree

Showing 31 changed files with 135 additions and 0 deletions.
diff --git a/docs/docs/aleph_zero/get_started.md b/docs/docs/aleph_zero/get_started.md
@@ -0,0 +1,134 @@
+---
+title: Get Started
+
+slug: /aleph_zero/get_started
+---
+
+This guide will walk you through the essential steps to get started on our [platform](https://azero.invariant.app/), from connecting your wallet and requesting an airdrop to adding a liquidity position, swapping tokens, claiming fees, and closing your position. If you encounter any issues, check out the more detailed User Guide. If you have any questions, feel free to join our community on [Invariant's Discord](https://discord.gg/w6hTeWTJvG) for support. Please note that this walkthrough is on the testnet.
+
+### Connect your wallet
+
+To begin using Invariant, you'll need to connect your wallet. Follow these steps:
+
+1. Click on the **"Connect wallet"** button at the top right corner of the page or or in the swap area.
+   ![Connect wallet](/img/docs/app/a0/a0_connectwallet.png)
+
+2. Select your wallet provider (we highly recommend using [Nightly](https://nightly.app/)).
+   ![Nightly](/img/docs/app/a0/a0_nightly.png)
+
+3. Follow the prompts to authorize the connection, and you are ready to go with your wallet connected.
+
+### Request airdrop from Aleph Zero Faucet
+
+To start interacting with the Invariant platform on the Aleph Zero testnet, you will need some test tokens. You can request these tokens from the Aleph Zero Faucet.
+
+1. Open your web browser and navigate to the [Aleph Zero Faucet page](https://faucet.test.azero.dev/).
+
+![A0 Faucet](/img/docs/app/a0/a0_a0faucet.png)
+
+2. Open your Nightly wallet.
+
+![Nightly wallet](/img/docs/app/a0/a0_wallet.png)
+
+3. Copy your wallet address to clipboard.
+
+![Nightly wallet](/img/docs/app/a0/a0_walletadress.png)
+
+4. Paste your wallet address in Aleph Zero Faucet and solve the captcha.
+
+![Paste adress](/img/docs/app/a0/a0_a0faucetadress.png)
+
+5. Click **“Make it rain”** button.
+
+After few second, airdrop of testnet AZERO should be in your wallet.
+
+### Request airdrop from Invaraint Faucet
+
+Now that you have testnet tokens to approve transactions on the Aleph Zero Testnet, you can request an airdrop from Invariant. You will receive testnet BTC, ETH, and USDC.
+
+1. Click the **"Faucet"** button on Invariant site.
+
+![Buttons](/img/docs/app/a0/a0_buttons.png)
+
+2. Approve transaction in your wallet
+
+![Approve transaction](/img/docs/app/a0/a0_transactionapprove.png)
+
+3. After a while, you should have airdropped tokens in your wallet.
+
+### Add liquidity
+
+Adding a liquidity position allows you to earn fees from trades on the Invariant DEX. To add a position follow these steps:
+
+1. Go to the **"Liqudity"** tab and click on **"Add Position"** button.
+
+![Add position](/img/docs/app/a0/a0_addposition.png)
+
+2. Choose the tokens you want to provide liquidity for.
+
+![Select tokens](/img/docs/app/a0/a0_azerousdc.png)
+
+3. Select fee tier. The fee tier determines the percentage of tokens deducted from a user who makes a swap, thus defining the amount of fees you will earn when a user utilizes your liquidity in the swap. Each fee tier represents a different liquidity pool.
+
+![Fee tier](/img/docs/app/a0/a0_feetier.png)
+
+4. Specify the price range within which you want to provide liquidity This range determines where your tokens will be active in the market. You will earn fees only when trades occur within this range. Adjust the min and max price sliders to set your range.
+
+![Price range](/img/docs/app/a0/a0_pricerange.png)
+
+5. Enter the amount you want to contribute to the liquidity pool. Please note that you need to provide both tokens in the correct ratio.
+
+![Deposit amount](/img/docs/app/a0/a0_depositamount.png)
+
+6. Click **"Add Position"** button
+
+### Exchange tokens
+
+Now you can use testnet tokens, that you received form Airdrop. This point will show you how to perform swap with this tokens.
+
+1. Navigate to **"Exchange tab"**.
+
+2. Select the tokens you wish to swap. A modal will appear where you can choose a specific token by either entering its name or selecting one from the list. Additionally, you can add a token by clicking the plus button and providing its token address. In this example, we're swapping from AZERO to USDC.
+
+![Swap](/img/docs/app/a0/a0_selecttoken.png)
+
+3. Enter the amount of tokens you want to swap. To swap all tokens from your wallet, simply click **“Max”**.
+
+![Swap](/img/docs/app/a0/a0_exchange.png)
+
+4. Click **"Exchange"** and confirm the transaction in your wallet. Your swapped tokens will appear in your wallet once the transaction is completed.
+
+**Potential problems:**
+
+- **Insufficient balance** - this means that your balance is smaller than the amount of tokens you want to swap. To fix this, try swapping fewer tokens.
+
+![Swap](/img/docs/app/a0/a0_insufficientbalance.png)
+
+- **Insufficient liquidity** - this means that there is not enough liquidity in the pool to perform your swap. To fix this, add more liquidity or decrease the amount of tokens you want to swap.
+
+![Swap](/img/docs/app/a0/a0_insufficientliquidity.png)
+
+- **Insufficient volume** - this means that you probably did not enter any tokens in the exchange window.
+
+![Swap](/img/docs/app/a0/a0_insufficientvolume.png)
+
+### Claim fees
+
+As a liquidity provider, you can claim your earned fees. To claim fees:
+
+- Navigate to the **"Liquidity"** section and open the position from which you want to claim fees.
+
+- Click on **"Claim Fee"** to initiate the transaction.
+
+![Claim fees](/img/docs/app/a0/a0_claimfee.png)
+
+- Confirm the transaction in your wallet.
+- Your claimed fees will be added to your wallet balance.
+
+### Close position
+
+- Navigate to the **"Liquidity"** section and open the position which you want to close.
+
+- Click **"Close Position"** and confirm the transaction in your wallet. Deposited tokens as well as unclaimed fees will be transferred to your wallet
+
+![Position details](/img/docs/app/a0/a0_closeposition.png)
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -131,6 +131,7 @@ module.exports = {
       label: 'Aleph Zero',
       collapsed: true,
       items: [
+        'aleph_zero/get_started',
         'aleph_zero/installation',
         'aleph_zero/overview',
         'aleph_zero/sdk',

diff --git a/docs/static/img/docs/app/a0/a0_a0faucet.png b/docs/static/img/docs/app/a0/a0_a0faucet.png
diff --git a/docs/static/img/docs/app/a0/a0_a0faucetadress.png b/docs/static/img/docs/app/a0/a0_a0faucetadress.png
diff --git a/docs/static/img/docs/app/a0/a0_addposition.png b/docs/static/img/docs/app/a0/a0_addposition.png
diff --git a/docs/static/img/docs/app/a0/a0_azerousdc.png b/docs/static/img/docs/app/a0/a0_azerousdc.png
diff --git a/docs/static/img/docs/app/a0/a0_buttons.png b/docs/static/img/docs/app/a0/a0_buttons.png
diff --git a/docs/static/img/docs/app/a0/a0_claimfee.png b/docs/static/img/docs/app/a0/a0_claimfee.png
diff --git a/docs/static/img/docs/app/a0/a0_closeposition.png b/docs/static/img/docs/app/a0/a0_closeposition.png
diff --git a/docs/static/img/docs/app/a0/a0_concentration.png b/docs/static/img/docs/app/a0/a0_concentration.png
diff --git a/docs/static/img/docs/app/a0/a0_connectwallet.png b/docs/static/img/docs/app/a0/a0_connectwallet.png
diff --git a/docs/static/img/docs/app/a0/a0_depositamount.png b/docs/static/img/docs/app/a0/a0_depositamount.png
diff --git a/docs/static/img/docs/app/a0/a0_exchange.png b/docs/static/img/docs/app/a0/a0_exchange.png
diff --git a/docs/static/img/docs/app/a0/a0_feetier.png b/docs/static/img/docs/app/a0/a0_feetier.png
diff --git a/docs/static/img/docs/app/a0/a0_feetierposition.png b/docs/static/img/docs/app/a0/a0_feetierposition.png
diff --git a/docs/static/img/docs/app/a0/a0_insufficientbalance.png b/docs/static/img/docs/app/a0/a0_insufficientbalance.png
diff --git a/docs/static/img/docs/app/a0/a0_insufficientliquidity.png b/docs/static/img/docs/app/a0/a0_insufficientliquidity.png
diff --git a/docs/static/img/docs/app/a0/a0_insufficientvolume.png b/docs/static/img/docs/app/a0/a0_insufficientvolume.png
diff --git a/docs/static/img/docs/app/a0/a0_minmax.png b/docs/static/img/docs/app/a0/a0_minmax.png
diff --git a/docs/static/img/docs/app/a0/a0_nightly.png b/docs/static/img/docs/app/a0/a0_nightly.png
diff --git a/docs/static/img/docs/app/a0/a0_positions.png b/docs/static/img/docs/app/a0/a0_positions.png
diff --git a/docs/static/img/docs/app/a0/a0_pricerange.png b/docs/static/img/docs/app/a0/a0_pricerange.png
diff --git a/docs/static/img/docs/app/a0/a0_range.png b/docs/static/img/docs/app/a0/a0_range.png
diff --git a/docs/static/img/docs/app/a0/a0_ratio.png b/docs/static/img/docs/app/a0/a0_ratio.png
diff --git a/docs/static/img/docs/app/a0/a0_selecttoken.png b/docs/static/img/docs/app/a0/a0_selecttoken.png
diff --git a/docs/static/img/docs/app/a0/a0_slippage.png b/docs/static/img/docs/app/a0/a0_slippage.png
diff --git a/docs/static/img/docs/app/a0/a0_tokensratio.png b/docs/static/img/docs/app/a0/a0_tokensratio.png
diff --git a/docs/static/img/docs/app/a0/a0_transactionapprove.png b/docs/static/img/docs/app/a0/a0_transactionapprove.png
diff --git a/docs/static/img/docs/app/a0/a0_transactiondetail.png b/docs/static/img/docs/app/a0/a0_transactiondetail.png
diff --git a/docs/static/img/docs/app/a0/a0_wallet.png b/docs/static/img/docs/app/a0/a0_wallet.png
diff --git a/docs/static/img/docs/app/a0/a0_walletadress.png b/docs/static/img/docs/app/a0/a0_walletadress.png