Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated user guide and get started #380

Merged
merged 2 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/docs/aleph_zero/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This guide will walk you through the essential steps to get started on our [plat

### Connect your wallet

To begin using Invariant, you'll need to connect your wallet. Follow these steps:
To begin using Invariant, you'll need to [connect your wallet](/docs/aleph_zero/user_guide/how_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)
Expand All @@ -20,7 +20,7 @@ To begin using Invariant, you'll need to connect your wallet. Follow these steps

### 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.
To start interacting with the Invariant platform on the Aleph Zero testnet, you will need some [testnet tokens](/docs/aleph_zero/user_guide/faucet). 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/).

Expand Down Expand Up @@ -58,7 +58,7 @@ Now that you have testnet tokens to approve transactions on the Aleph Zero Testn

### Add liquidity

Adding a liquidity position allows you to earn fees from trades on the Invariant DEX. To add a position follow these steps:
Adding a liquidity position allows you to earn fees from trades on the Invariant DEX. To [add a position](/docs/aleph_zero/user_guide/how_to_add_liquidity) follow these steps:

1. Go to the **"Liqudity"** tab and click on **"Add Position"** button.

Expand All @@ -84,7 +84,7 @@ Adding a liquidity position allows you to earn fees from trades on the Invariant

### 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.
Now you can use testnet tokens, that you received form Airdrop. This point will show you [how to perform swap](/docs/aleph_zero/user_guide/how_to_swap) with this tokens.

1. Navigate to **"Exchange tab"**.

Expand Down Expand Up @@ -114,7 +114,7 @@ Now you can use testnet tokens, that you received form Airdrop. This point will

### Claim fees

As a liquidity provider, you can claim your earned fees. To claim fees:
As a liquidity provider, you can [claim your earned fees](/docs/aleph_zero/user_guide/how_to_claim_fee). To claim fees:

- Navigate to the **"Liquidity"** section and open the position from which you want to claim fees.

Expand All @@ -127,6 +127,8 @@ As a liquidity provider, you can claim your earned fees. To claim fees:

### Close position

If you want to [close your position](/docs/aleph_zero/user_guide/how_to_remove_liquidity) and remove liquidity, you can do this even if your fees are unclaimed. The fees after closing the position will be sent to your wallet along with the liquidity.

- 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
Expand Down
42 changes: 40 additions & 2 deletions docs/docs/aleph_zero/user_guide/faucet.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,44 @@ title: Faucet
slug: /aleph_zero/user_guide/faucet
---

The Faucet button is designed to provide users with a simple and efficient way to obtain test tokens on a testnet environment. By clicking the button, you will receive a small airdrop of 2 USDC, 0.00005 BTC, and 0.0001 ETH. To receive airdrop, you need to solve a captcha. If the faucet does not work, it is most likely empty and will be refilled soon. For support or help, you can ask on our [Discord](https://discord.gg/w6hTeWTJvG).
To be able to claim an airdrop from the Invariant platform, we need to have TZERO (Testnet AZERO) to pay the network fee for the transaction. Therefore, we need to go through two steps to receive the airdrop.


# Aleph Zero Faucet

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)

1. 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.

# Invariant 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.



![Faucet](/img/docs/app/eclipse_faucet.png)
16 changes: 10 additions & 6 deletions docs/docs/aleph_zero/user_guide/how_to_add_liquidity.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ slug: /aleph_zero/user_guide/how_to_add_liquidity

![add position](/img/docs/app/a0/a0_addposition.png)

2. Select pair of tokens. We have chosen as an example the **AZERO/USDC** pair.
2. This will be your position identifier. It is called the **Market ID**.

![marketid](/img/docs/app/a0/a0_marketid.png)

3. Select pair of tokens. We have chosen as an example the **AZERO/USDC** pair.

![azerousdc](/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.
4. 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.

![feetier](/img/docs/app/a0/a0_feetier.png)

Expand All @@ -31,9 +35,9 @@ When selecting a range for your orders, consider the characteristics of the asse

</blockquote>

4. Choose between two options for adding **concentrated liquidity** and setting up the pool range.
5. Choose between two options for adding **concentrated liquidity** and setting up the pool range.

5. Provide an amount of tokens. The amount of tokens is interdependent, as the result of multiplying them must always yield the same outcome.
6. Provide an amount of tokens. The amount of tokens is interdependent, as the result of multiplying them must always yield the same outcome.

- [**Uniform liquidity**](/docs/uniform_concentration) - Ideal for beginners, this option evenly distributes liquidity on both sides of the current price. It utilizes a simple slider to inform you about the potential increase in fees compared to the full range with the same amount of tokens

Expand All @@ -53,9 +57,9 @@ You can switch view between <b>Bar chart</b> and <b>Line chart</b>.

</blockquote>

6. Once you're ready, click **Add Liquidity** You'll then be prompted to confirm the transaction in your wallet. A small amount of **AZERO** will be deducted from your wallet as a deposit to create your liquidity pool and position. If the pool already exists, this fee is only for creating your position, not for pool creation itself. Most of this fee will be returned to you when you decide to close your position. However, currently, closing the entire pool is not possible.
7. Once you're ready, click **Add Liquidity** You'll then be prompted to confirm the transaction in your wallet. A small amount of **AZERO** will be deducted from your wallet as a deposit to create your liquidity pool and position. If the pool already exists, this fee is only for creating your position, not for pool creation itself. Most of this fee will be returned to you when you decide to close your position. However, currently, closing the entire pool is not possible.

7. In the **liquidity position list**, you can easily identify your active positions. These positions will have their fee highlighted in green, indicating that they are currently generating fees.
8. In the **liquidity position list**, you can easily identify your active positions. These positions will have their fee highlighted in green, indicating that they are currently generating fees.

![positions](/img/docs/app/a0/a0_positions.png)

Expand Down
32 changes: 32 additions & 0 deletions docs/docs/aleph_zero/user_guide/how_to_list_your_token.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: How to list your token?

slug: /aleph_zero/user_guide/how_to_list_your_token
---


If you want your token to be traded on Invariant, you can add it in a simple, fast and permissionless way. In the following steps, we will explain how to do this.

# Adding your token to the tokens list

1. Click on the **“Expand”** button.

![slippage](/img/docs/app/a0/a0_expand.png)


2. Click on the **“Plus”** button.

![plus button](/img/docs/app/a0/a0_plusbutton.jpg)


3. Copy the address of the token you want to add on Invariant and then click **"Add"** button.

![add button](/img/docs/app/a0/a0_addbutton.jpg)

4. Done. Your token should now be visible on the list.


# Creating liquidity pool for your token


Now, if you want your token to be exchangeable by other users, you need to create a liquidity pool for it. To do this, follow the instructions for [adding a position](/docs/aleph_zero/user_guide/how_to_add_liquidity).
25 changes: 19 additions & 6 deletions docs/docs/aleph_zero/user_guide/how_to_swap.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,20 @@ Here's a step-by-step guide to get started:

![swap](/img/docs/app/a0/a0_exchange.png)

4. Review the **Transaction details** to see specific information about your transaction:
4. Check the **current price** of the tokens and their **contract addresses**. We highly recommend checking if the contract addresses of the tokens are correct to avoid any mistakes.

![price window](/img/docs/app/a0/a0_pricewindow.jpg)


- Here you can copy the address of the token you want to exchange to the clipboard.

![copy address](/img/docs/app/a0/a0_copyadress.jpg)

- Clicking this little icon next to the **token ticker** will redirect you to the token details [aScan](https://ascan.alephzero.org/testnet) page, the Aleph Zero token explorer.

![redirections](/img/docs/app/a0/a0_redirecticons.jpg)

5. Review the **Transaction details** to see specific information about your transaction:

![transaction details](/img/docs/app/a0/a0_transactiondetail.png)

Expand All @@ -35,7 +48,7 @@ You can also swap the exchange rate by clicking on the token's price.

![tokens ratio2](/img/docs/app/a0/a0_tokensratio2.png)

5. In the top right corner, you can optionally set your slippage tolerance (defaults to 1%).
6. In the top right corner, you can optionally set your slippage tolerance (defaults to 1%).

- This value is a percentage, where 1% is represented by 1.
- Clicking the **Auto** button sets the slippage tolerance to 1%.
Expand All @@ -46,16 +59,16 @@ You can also swap the exchange rate by clicking on the token's price.

![slippage settings](/img/docs/app/a0/a0_slippagesettings.png)

1. Before initiating a swap, you have the option to refresh token prices by clicking the **"refresh button"**. This action helps mitigate the risk of encountering high slippage during the transaction by providing updated pricing information.
7. Before initiating a swap, you have the option to refresh token prices by clicking the **"refresh button"**. This action helps mitigate the risk of encountering high slippage during the transaction by providing updated pricing information.

![refresher](/img/docs/app/a0/a0_refresher.png)

7. Once you've configured everything, click **Exchange**.
8. Once you've configured everything, click **Exchange**.

![exchange](/img/docs/app/a0/a0_exchange.png)

8. Confirm the transaction in your wallet.
9. Confirm the transaction in your wallet.

![Transaction approve](/img/docs/app/a0/a0_transactionapprove.png)

9. That's it! After a few seconds, you should see your swapped tokens in your wallet.
10. That's it! After a few seconds, you should see your swapped tokens in your wallet.
5 changes: 3 additions & 2 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ module.exports = {
'aleph_zero/user_guide/interface',
'aleph_zero/user_guide/networks',
'aleph_zero/user_guide/how_to_connect_your_wallet',
// 'aleph_zero/user_guide/faucet',
'aleph_zero/user_guide/faucet',
'aleph_zero/user_guide/how_to_swap',
{
type: 'category',
Expand All @@ -155,8 +155,9 @@ module.exports = {
'aleph_zero/user_guide/how_to_claim_fee',
'aleph_zero/user_guide/how_to_remove_liquidity',
// 'aleph_zero/user_guide/stats',
'aleph_zero/user_guide/how_to_list_your_token',
'aleph_zero/user_guide/troubleshooting',
// 'aleph_zero/user_guide/faq_tutorial'
'aleph_zero/user_guide/faq_tutorial'
]
},
'aleph_zero/get_started',
Expand Down
Binary file added docs/static/img/docs/app/a0/a0_a0faucetadress.jpg
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 docs/static/img/docs/app/a0/a0_addbutton.jpg
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 docs/static/img/docs/app/a0/a0_buttons.jpg
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 docs/static/img/docs/app/a0/a0_copyadress.jpg
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 docs/static/img/docs/app/a0/a0_expand.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 docs/static/img/docs/app/a0/a0_marketid.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 docs/static/img/docs/app/a0/a0_plusbutton.jpg
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 docs/static/img/docs/app/a0/a0_pricewindow.jpg
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 docs/static/img/docs/app/a0/a0_redirecticons.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading