diff --git a/docs/docs/vara/get_started.md b/docs/docs/vara/get_started.md
new file mode 100644
index 00000000..2c55d1ac
--- /dev/null
+++ b/docs/docs/vara/get_started.md
@@ -0,0 +1,140 @@
+---
+title: Get Started
+
+slug: /vara/get_started
+---
+
+This guide will walk you through the essential steps to get started on our [platform](https://vara.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/vara/vara_connectwallet.jpg)
+
+2. Select your wallet provider (in this tutorial we are using SubWallet).
+ ![SubWallet](/img/docs/app/vara/vara_choosewallet.jpg)
+
+3. Follow the prompts to authorize the connection, and you are ready to go with your wallet connected.
+
+### Request airdrop from Vara Network Faucet
+
+To start interacting with the Invariant platform on the Vara Network testnet, you will need some [testnet tokens](/docs/vara/user_guide/faucet). You can request these tokens from the Vara Network Faucet.
+
+1. Open your web browser and navigate to the [Vara Network Faucet page](https://idea.gear-tech.io/programs?node=wss%3A%2F%2Ftestnet.vara.network).
+
+![A0 Faucet](/img/docs/app/vara/vara_faucetpage.png)
+
+2. Connect your wallet to the **Vara Network** portal.
+
+![Connect to Vara Faucet](/img/docs/app/vara/vara_connectfaucet.jpg)
+
+3. After connecting your wallet, click the icon under **"Transferable Balance"**.
+
+![Nightly wallet](/img/docs/app/vara/vara_faucetbalance.jpg)
+
+4. Click **"Get Test Balance"**
+
+![Paste adress](/img/docs/app/vara/vara_getbalance.jpg)
+
+5. Solve the captcha you are going to see after clicking **"Get Test Balance"** button.
+
+After few second, airdrop of testnet **TVARA** should be in your wallet.
+
+### Request airdrop from Invaraint Faucet
+
+Now that you have testnet tokens to approve transactions on the Vara Network 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/vara/vara_nav.jpg)
+
+2. Approve transaction in your wallet
+
+![Approve transaction](/img/docs/app/vara/vara_approvetransaction.jpg)
+
+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](/docs/vara/user_guide/how_to_add_liquidity) 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/vara/vara_selecttokens.jpg)
+
+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/vara/vara_selectfeetier.jpg)
+
+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/vara/vara_pricerange.jpg)
+
+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/vara/vara_depositamount.jpg)
+
+6. Click **"Add Position"** button
+
+![Add position](/img/docs/app/vara/vara_addpositionclick.jpg)
+
+### Exchange tokens
+
+Now you can use testnet tokens, that you received form Airdrop. This point will show you [how to perform swap](/docs/vara/user_guide/how_to_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/vara/vara_searchtoken.jpg)
+
+3. Enter the amount of tokens you want to swap. To swap all tokens from your wallet, simply click **“Max”**.
+
+![Swap](/img/docs/app/vara/vara_exchange.jpg)
+
+4. Click **"Exchange"** and confirm the transaction in your wallet. Your swapped tokens will appear in your wallet once the transaction is completed.
+
+![Swap](/img/docs/app/vara/vara_exchangelight.jpg)
+
+**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/vara/vara_insufficientbalance.jpg)
+
+- **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/vara/vara_insufficientliquidity.jpg)
+
+- **Insufficient volume** - this means that you probably did not enter any tokens in the exchange window.
+
+![Swap](/img/docs/app/vara/vara_insufficientvolume.jpg)
+
+### Claim fees
+
+As a liquidity provider, you can [claim your earned fees](/docs/vara/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.
+
+- Click on **"Claim Fee"** to initiate the transaction.
+
+![Claim fees](/img/docs/app/vara/vara_claimfee.jpg)
+
+- Confirm the transaction in your wallet.
+- Your claimed fees will be added to your wallet balance.
+
+### Close position
+
+If you want to [close your position](/docs/vara/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
+
+![Position details](/img/docs/app/vara/vara_closeposition.jpg)
diff --git a/docs/docs/vara/user_guide/faq_tutorial.md b/docs/docs/vara/user_guide/faq_tutorial.md
new file mode 100644
index 00000000..d1b5cc76
--- /dev/null
+++ b/docs/docs/vara/user_guide/faq_tutorial.md
@@ -0,0 +1,96 @@
+---
+title: FAQ
+
+slug: /vara/user_guide/faq_tutorial
+---
+
+
+
+
+ No, slippage tolerance only safeguards you from excessive costs. If the slippage benefits you,
+ the transaction will proceed without interruption and you can get more tokens then expected.
+
+ The fee is deducted upon initiating a transaction on Invariant, irrespective of its success or
+ failure. This fee covers processing the transaction. Even if the transaction fails, these costs
+ are incurred and not refunded to the user, but are smaller then in case of success.
+
+ Yes, you can claim fees from the liquidity pool whenever you desire. However, note that each fee
+ claim is a separate transaction incurring a small fee. Therefore, it's advisable to claim fees
+ only when necessary.
+
+ If your pool isn't indexed yet, ensuring the following will enable its indexing:
+
+ Is slippage tolerance effective for both minimizing losses and maximizing bonus token
+ acquisition?? #
+
+
+ Why was the fee deducted even though the transaction failed?{' '}
+ #
+
+
+ Can I claim fees at any time? #
+
+
+ Why isn't my pool indexed by the Jupiter aggregator? #
+
+
+
+ Once these criteria are met, Jupiter automatically lists your token within minutes (usually up
+ to ~30 min).
+
+ No, you can simply close your position, and the fees will be automatically claimed to your + wallet. +
++ Yes, the Invariant project underwent a security audit by the Soteria team. The audit focused on the Invariant Protocol v0.1.0 Eclipse smart contract program. Audit is available here: Invariant Protocol Audit. +
++The fees you earn on your liquidity position come from swaps initiated by other users on the platform, and the token you receive as a fee always corresponds to the token a user is giving up in their swap. For example, if you have a VARA/USDC liquidity position, you'll earn a fee in USDC when a user swaps USDC for VARA, and vice versa. This ensures your fees directly reflect the trading activity within your chosen pool. + +Users control the precision of their range orders. A tighter range (smaller difference between upper and lower limits) can generate higher fees if the price fluctuates within your set range. However, it also increases the risk of incomplete orders if the market price moves significantly before your entire range is filled. Conversely, a wider range (larger difference between upper and lower limits) results in lower fees but provides less control over the final execution price. + +When selecting a range for your orders, consider the characteristics of the assets involved. For stable coins, which typically have low volatility, a narrower range may be appropriate to capture smaller price movements and maintain stability in your liquidity provision. In contrast, for more dynamic coins with higher volatility, a wider range could be advantageous to accommodate larger price fluctuations and capture potential trading opportunities. Adjusting the range based on the stability and volatility of the assets allows you to optimize your liquidity provision strategy and adapt to market conditions effectively. + ++ +5. Choose between two options for adding **concentrated liquidity** and setting up the pool range. + +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 + +- [**Price range**](/docs/price_range) - Offers full customization, allowing you to set the liquidity range at any point, even on one side of the current price. This option utilizes movable flags on the chart to set the minimum and maximum price of the liquidity range. + +![pricerange](/img/docs/app/vara/vara_pricerange.jpg) + +#### Legend: + +
+ +- yellow bold line - represents current price. + +- lines labeled with min and max - represents the user-defined liquidity range for creating position in pool. + +You can switch view between Bar chart and Line chart. + ++ +7. Once you're ready, click **Add Liquidity** You'll then be prompted to confirm the transaction in your wallet. A small amount of **VARA** 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. + +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/vara/vara_positionslight.jpg) + +**In the position interface, we can read data regarding:** + +**FEE TIER** +![positions](/img/docs/app/vara/vara_positionfee.jpg) + +**Fee Tier** represents the percentage of fees you earn based on your share in the pool. It determines how much of the pool’s fee income you receive. + + +**RATIO** +![positions](/img/docs/app/vara/vara_positionratio.jpg) + +**Ratio** Ratio refers to the proportion of different assets within liquidity position. It indicates how each asset is distributed relative to the total amount. This balance is important because it affects how changes in the market impact the overall value of your position. + + +**MIN-MAX** +![positions](/img/docs/app/vara/vara_positionminmax.jpg) + +**Min-max** Range refers to the price per token within which your position earns fees. This range is defined by the minimum and maximum price limits for the token in your position. + + +**VALUE** +![positions](/img/docs/app/vara/vara_valuelight.jpg) + +**Value** is the total worth of your position, encompassing the initial amount of liquidity you contributed and any accumulated fees. This measure is important because it provides a complete picture of your financial performance. \ No newline at end of file diff --git a/docs/docs/vara/user_guide/how_to_add_liquidity/price_range.md b/docs/docs/vara/user_guide/how_to_add_liquidity/price_range.md new file mode 100644 index 00000000..aea57feb --- /dev/null +++ b/docs/docs/vara/user_guide/how_to_add_liquidity/price_range.md @@ -0,0 +1,13 @@ +--- +title: Price range + +slug: /vara/user_guide/price_range +--- + +For greater precision compared to uniform concentration, Invariant offers the option to manually set the price range of your liquidity pool, providing full customization of where you allocate your capital. + +![price range](/img/docs/app/a0/a0_range.png) + +To set the price range, simply drag the movable flags on the liquidity chart labeled as **MIN** and **MAX**. Alternatively, you can use buttons to adjust the min and max prices of the range. + +In cases where the price range does not cover the current market price, you can still create a specific liquidity pool by adding only one token from the pair. This allows users to participate in providing liquidity, even with a limited range, ensuring flexibility in managing assets within the decentralized exchange ecosystem. diff --git a/docs/docs/vara/user_guide/how_to_add_liquidity/uniform_concentration.md b/docs/docs/vara/user_guide/how_to_add_liquidity/uniform_concentration.md new file mode 100644 index 00000000..cde32be0 --- /dev/null +++ b/docs/docs/vara/user_guide/how_to_add_liquidity/uniform_concentration.md @@ -0,0 +1,13 @@ +--- +title: Uniform concentration + +slug: /vara/user_guide/uniform_concentration +--- + +Let's simplify the concept of uniform concentration to enhance transparency in liquidity provision. With uniform concentration, the liquidity range is symmetrically centered around the current token price. For instance, if the **USDT/USDC** pair is priced at **0.999** and we set the delta price to 0.1 percent, liquidity will be alocated in the range from **0.998** to **1**. + +![concentration](/img/docs/app/a0/a0_concentration.png) + +Maintaining such a position suggests the potential to earn significantly higher fees compared to providing liquidity across the full range. For a user-friendly experience, we've introduced a concentration slider, enabling users to symmetrically boost liquidity around the current price while maximizing efficiency. + +Liquidity positions are range-bound. If the price moves outside your set range after you add liquidity, your position will become inactive until the price returns within your chosen range. diff --git a/docs/docs/vara/user_guide/how_to_claim_fee.md b/docs/docs/vara/user_guide/how_to_claim_fee.md new file mode 100644 index 00000000..a2961db3 --- /dev/null +++ b/docs/docs/vara/user_guide/how_to_claim_fee.md @@ -0,0 +1,18 @@ +--- +title: How to claim fee? + +slug: /vara/user_guide/how_to_claim_fee +--- + +1. Once you've created a pool, navigate to the **"Liquidity"** section where you'll find a list of all your active pools. + + +2. Choose the pool from which you wish to claim fees. + +![positions](/img/docs/app/vara/vara_positionslight.jpg) + +3. Upon selecting a specific pool, locate the **Unclaimed fees** section. To collect your profits from the pool, simply click the **Claim fee** button. Any remaining fees will also be automatically returned to you when you close your position. + +![claimfee](/img/docs/app/vara/vara_claimfee.jpg) + +4. If you opt to collect your fees, you'll need to approve the transaction in your wallet. Once approved, the tokens will be transferred to your wallet address. That concludes the process! Remember, each claim incurs a blockchain transaction, so consider holding onto unclaimed fees to minimize extra fees. diff --git a/docs/docs/vara/user_guide/how_to_connect_your_wallet.md b/docs/docs/vara/user_guide/how_to_connect_your_wallet.md new file mode 100644 index 00000000..9002ceee --- /dev/null +++ b/docs/docs/vara/user_guide/how_to_connect_your_wallet.md @@ -0,0 +1,24 @@ +--- +title: How to connect your wallet? + +slug: /vara/user_guide/how_to_connect_your_wallet +--- + +Before engaging with Invariant, it's imperative to initiate the process by connecting one of our supported wallets. Follow these steps to integrate your wallet with our application: + +1. Start by locating the **Connect wallet** button positioned at the top-right corner of the screen. You'll find this button displayed in other areas throughout the app where connecting the wallet is necessary. + +![Connect wallet](/img/docs/app/vara/vara_connectwallet.jpg) + +2. Upon clicking **Connect wallet**, you'll be prompted to choose a supported wallet that operates on the Vara Network blockchain. This ensures seamless integration with Invariant. You have the flexibility to select a wallet from the list of detected options. + +![wallet list](/img/docs/app/vara/vara_choosewallet.jpg) + + + + +3. Once you've successfully connected your wallet, your wallet address will be prominently displayed at the top-right corner of the screen, giving you immediate access to your account information. + + ![wallet id](/img/docs/app/a0/a0_cornerwalletadress.png) + +By following these steps, you'll swiftly establish a secure connection between your preferred wallet and our platform, enabling you to engage in seamless transactions with ease. diff --git a/docs/docs/vara/user_guide/how_to_remove_liquidity.md b/docs/docs/vara/user_guide/how_to_remove_liquidity.md new file mode 100644 index 00000000..5a30ac33 --- /dev/null +++ b/docs/docs/vara/user_guide/how_to_remove_liquidity.md @@ -0,0 +1,18 @@ +--- +title: How to remove liquidity? + +slug: /vara/user_guide/how_to_remove_liquidity +--- + +1. To remove liquidity, simply click **Close position** in your active liquidity position. + +![close](/img/docs/app/vara/vara_closeposition.jpg) + +2. Next, you'll need to confirm the transaction in your wallet. + +After confirming the transaction in your wallet, you'll receive: + +- **Withdrawn liquidity** - You'll get back the tokens you provided as liquidity. +- **Unclaimed fees** (if any) - Any fees you haven't claimed yet will also be returned to you. + + diff --git a/docs/docs/vara/user_guide/how_to_swap.md b/docs/docs/vara/user_guide/how_to_swap.md new file mode 100644 index 00000000..d47f2527 --- /dev/null +++ b/docs/docs/vara/user_guide/how_to_swap.md @@ -0,0 +1,67 @@ +--- +title: How to swap? + +slug: /vara/user_guide/how_to_swap +--- + +Here's a step-by-step guide to get started: + +1. Navigate to the **Exchange** page. + +2. Select the tokens you wish to swap. For instance, if you want to swap **VARA** tokens, click on the **VARA** token. 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 **VARA** to **USDC**. + +![chose token](/img/docs/app/vara/vara_searchtoken.jpg) + +3. Enter the amount of tokens you want to swap. To swap all tokens from your wallet, simply click the **Max** button. + +![swap](/img/docs/app/vara/vara_exchange.jpg) + +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/vara/vara_exchangeprice.jpg) + + +- Here you can copy the address of the token you want to exchange to the clipboard. + +![copy address](/img/docs/app/vara/vara_contracts.jpg) + + +5. Review the **Transaction details** to see specific information about your transaction: + +![transaction details](/img/docs/app/vara/vara_transactiondetails.jpg) + +![transaction details2](/img/docs/app/vara/vara_transactiondetailsmodal.jpg) + +- **Exchange rate** - Indicates how much of one token you'll receive for another (e.g., **1 VARA** = **1.86 USDC**), helping you understand the trade's impact on your holdings. +- **Fee** - Represents the cost associated with using a particular liquidity pool to execute a transaction. It shows the amount paid to liquidity providers as an incentive for supplying liquidity. +- **Price impact** - Measures how much a trade affects the price of a cryptocurrency, providing insight into its potential market impact. +- **Slippage tolerance** - Sets the maximum difference between the expected and actual price of a trade, ensuring execution within a specified price range even if market conditions change. + +You can also swap the exchange rate by clicking on the token's price. + +![tokens ratio](/img/docs/app/vara/vara_varausdc.jpg) + +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%. +- Maximum possible value is 50%. +- Invariant remembers your slippage tolerance setting for future use, even after you close your browser. + +![slippage](/img/docs/app/vara/vara_slippage.jpg) + +![slippage settings](/img/docs/app/a0/a0_slippagesettings.png) + +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) + +8. Once you've configured everything, click **Exchange**. + +![exchange](/img/docs/app/vara/vara_exchangelight.jpg) + +9. Confirm the transaction in your wallet. + +![Transaction approve](/img/docs/app/vara/vara_approvetransaction.jpg) + +10. That's it! After a few seconds, you should see your swapped tokens in your wallet. diff --git a/docs/docs/vara/user_guide/interface.md b/docs/docs/vara/user_guide/interface.md new file mode 100644 index 00000000..ed091f78 --- /dev/null +++ b/docs/docs/vara/user_guide/interface.md @@ -0,0 +1,34 @@ +--- +title: Interface + +slug: /vara/user_guide/interface +--- + +This tutorial will explain and show you how to use all the features of Invariant - the AMM DEX utilizing Concentrated Liquidity Market Maker model on Vara Network blockchain. + +Below is a breakdown of the interface elements you'll encounter when using our platform. + +### Main features of Invariant + +![Main buttons](/img/docs/app/a0/a0_mainbuttons.png) + +**"Exchange"** - This tab allows you to swiftly exchange one cryptocurrency for another directly from your wallet. + +**"Liquidity"** - In the Liquidity tab, you can provide liquidity to the decentralized exchange by depositing pairs of tokens into liquidity pools. These pools facilitate trading and earn you a share of the transaction fees. + +**"Statistics"** - The Statistics tab provides essential statistical information about various tokens, pools, and trading pairs available on the platform. These data can provide valuable insights for decision-making regarding liquidity provision or market-making strategies. + +### Other features + +![Other buttons](/img/docs/app/vara/vara_navbar.png) + +**"Faucet"** - This tab allows you to swiftly exchange one cryptocurrency for another directly from your wallet. + +**"RPC"** - In the Liquidity tab, you can provide liquidity to the decentralized exchange by depositing pairs of tokens into liquidity pools. These pools facilitate trading and earn you a share of the transaction fees. + +**"Select Chain"** - You can switch between different blockchains networks using this button. + +**"Select Network"** - You can select a network. Currently, only Testnet is available. + +After connecting your wallet, in this place your wallet address will show up . + diff --git a/docs/docs/vara/user_guide/networks.md b/docs/docs/vara/user_guide/networks.md new file mode 100644 index 00000000..55095ff6 --- /dev/null +++ b/docs/docs/vara/user_guide/networks.md @@ -0,0 +1,13 @@ +--- +title: Networks + +slug: /vara/user_guide/networks +--- + +Blockchain networks come in many forms. These networks serve a variety of purposes, including testing, development, experimentation, and specialized applications. Invariant offers support for a testnet on Vara Network at the moment: + +![Main buttons](/img/docs/app/a0/a0_networks.png) + +- **Testnet** - Testnets, or testing networks, are intended for users to experiment and test applications in a controlled environment. + + diff --git a/docs/docs/vara/user_guide/stats.md b/docs/docs/vara/user_guide/stats.md new file mode 100644 index 00000000..3a193d11 --- /dev/null +++ b/docs/docs/vara/user_guide/stats.md @@ -0,0 +1,45 @@ +--- +title: Stats + +slug: /vara/user_guide/stats +--- + +In the Stats section, you'll discover vital information regarding your tokens and the market as a whole. Invariant offers several metrics to provide insight into the current market situation. + +### Stats of Invariant + +#### Volume + +Total value of trades conducted on the Invariant platform. Volume number is a value from last 24-hours. Each bar on the chart represents daily trading activity. + +![volume invariant](/img/docs/app/volume_invariant.png) + +#### Liquidity + +Measures the depth of the market and the ease of trading on Invariant. It indicates the availability of assets for buying or selling without significantly affecting their prices. Higher liquidity generally signifies a more active and efficient market, as there are more participants willing to trade assets at various price levels. + +![liquidity invariant](/img/docs/app/liquidity_invariant.png) + +#### Last 24-hours stats + +This section provides a snapshot of key metrics that represent the overall activity on the Invariant platform. + +- **Volume 24H** - This metric shows the total value of all tokens exchanged through Invariant transactions. + +- **TVL** - Total Value Locked represents the total value of assets locked within the Invariant platform for providing liquidity to various trading pairs. TVL is often used interchangeably with liquidity. + +- **Fees 24H** - Represents the total amount of fees collected by all liquidity providers on Invariant over the past 24 hours. + +![24 hours stats](/img/docs/app/stats.png) + +### Top tokens + +- **TVL 24H** - Total amount of presented token locked in all liquidity pools. + + ![top tokens](/img/docs/app/top_tokens.png) + +### Top pools + +- **7-days APY** - (Annual Percentage Yield) - denotes the anticipated annualized rate of return for liquidity to the pool. It reflects the estimated percentage increase in the value of assets deposited into the liquidity pool attributable to trading fees. In calculating APY, Invariant considers solely the volume from active liquidity pools over the last 7 days, separately for each one. + +![top pools](/img/docs/app/top_pools.png) diff --git a/docs/docs/vara/user_guide/troubleshooting.md b/docs/docs/vara/user_guide/troubleshooting.md new file mode 100644 index 00000000..7d349150 --- /dev/null +++ b/docs/docs/vara/user_guide/troubleshooting.md @@ -0,0 +1,22 @@ +--- +title: Troubleshooting + +slug: /vara/user_guide/troubleshooting +--- + +## Can't connect wallet - Chrome browser + +#### Problem: + +Try to click **Contect wallet** button, but nothing happens. + +#### Solution: + +Clear cache & cookies of Chrome browser: + +1. Open chrome dev-tools +2. Go to **Application** tab +3. Go to **Storage** +4. Click **Clear site data** + +![Clear site data](/img/docs/app/problem1.png) diff --git a/docs/sidebars.js b/docs/sidebars.js index 21f69af0..06450c30 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -221,6 +221,42 @@ module.exports = { label: 'VARA', collapsed: true, items: [ + + 'vara/get_started', + + { + type: 'category', + label: 'User Guide', + link: { + type: 'doc', + id: 'vara/installation' + }, + items: [ + 'vara/user_guide/interface', + 'vara/user_guide/networks', + 'vara/user_guide/how_to_connect_your_wallet', + 'vara/user_guide/faucet', + 'vara/user_guide/how_to_swap', + { + type: 'category', + label: 'How to add liquidity', + link: { + type: 'doc', + id: 'vara/user_guide/how_to_add_liquidity' + }, + items: [ + 'vara/user_guide/how_to_add_liquidity/uniform_concentration', + 'vara/user_guide/how_to_add_liquidity/price_range' + ] + }, + 'vara/user_guide/how_to_claim_fee', + 'vara/user_guide/how_to_remove_liquidity', + // 'aleph_zero/user_guide/stats', + 'vara/user_guide/troubleshooting', + 'vara/user_guide/faq_tutorial' + ] + }, + { type: 'category', label: 'For developers', diff --git a/docs/static/img/docs/app/vara/vara_addpositionclick.jpg b/docs/static/img/docs/app/vara/vara_addpositionclick.jpg new file mode 100644 index 00000000..8a325b3d Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_addpositionclick.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_approvetransaction.jpg b/docs/static/img/docs/app/vara/vara_approvetransaction.jpg new file mode 100644 index 00000000..0d1ad374 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_approvetransaction.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_choosewallet.jpg b/docs/static/img/docs/app/vara/vara_choosewallet.jpg new file mode 100644 index 00000000..a8706d1f Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_choosewallet.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_claimfee.jpg b/docs/static/img/docs/app/vara/vara_claimfee.jpg new file mode 100644 index 00000000..c731c530 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_claimfee.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_closeposition.jpg b/docs/static/img/docs/app/vara/vara_closeposition.jpg new file mode 100644 index 00000000..1ae41d80 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_closeposition.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_connectfaucet.jpg b/docs/static/img/docs/app/vara/vara_connectfaucet.jpg new file mode 100644 index 00000000..0a0436ae Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_connectfaucet.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_connectwallet.jpg b/docs/static/img/docs/app/vara/vara_connectwallet.jpg new file mode 100644 index 00000000..d96c7d79 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_connectwallet.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_contracts.jpg b/docs/static/img/docs/app/vara/vara_contracts.jpg new file mode 100644 index 00000000..963d8d86 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_contracts.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_depositamount.jpg b/docs/static/img/docs/app/vara/vara_depositamount.jpg new file mode 100644 index 00000000..91ff698b Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_depositamount.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_exchange.jpg b/docs/static/img/docs/app/vara/vara_exchange.jpg new file mode 100644 index 00000000..a412b044 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_exchange.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_exchangelight.jpg b/docs/static/img/docs/app/vara/vara_exchangelight.jpg new file mode 100644 index 00000000..56bd8cee Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_exchangelight.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_exchangeprice.jpg b/docs/static/img/docs/app/vara/vara_exchangeprice.jpg new file mode 100644 index 00000000..55d186f0 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_exchangeprice.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_faucetbalance.jpg b/docs/static/img/docs/app/vara/vara_faucetbalance.jpg new file mode 100644 index 00000000..468aad86 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_faucetbalance.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_faucetpage.png b/docs/static/img/docs/app/vara/vara_faucetpage.png new file mode 100644 index 00000000..c893746d Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_faucetpage.png differ diff --git a/docs/static/img/docs/app/vara/vara_getbalance.jpg b/docs/static/img/docs/app/vara/vara_getbalance.jpg new file mode 100644 index 00000000..6fc22cb4 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_getbalance.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_insufficientbalance.jpg b/docs/static/img/docs/app/vara/vara_insufficientbalance.jpg new file mode 100644 index 00000000..11baded4 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_insufficientbalance.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_insufficientliquidity.jpg b/docs/static/img/docs/app/vara/vara_insufficientliquidity.jpg new file mode 100644 index 00000000..e3be62f8 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_insufficientliquidity.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_insufficientvolume.jpg b/docs/static/img/docs/app/vara/vara_insufficientvolume.jpg new file mode 100644 index 00000000..c36a125a Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_insufficientvolume.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_marketidlight.jpg b/docs/static/img/docs/app/vara/vara_marketidlight.jpg new file mode 100644 index 00000000..08534ebe Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_marketidlight.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_nav.jpg b/docs/static/img/docs/app/vara/vara_nav.jpg new file mode 100644 index 00000000..3ff67d1d Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_nav.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_navbar.png b/docs/static/img/docs/app/vara/vara_navbar.png new file mode 100644 index 00000000..e636a76f Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_navbar.png differ diff --git a/docs/static/img/docs/app/vara/vara_positionfee.jpg b/docs/static/img/docs/app/vara/vara_positionfee.jpg new file mode 100644 index 00000000..03e7861b Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_positionfee.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_positionminmax.jpg b/docs/static/img/docs/app/vara/vara_positionminmax.jpg new file mode 100644 index 00000000..d477b18a Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_positionminmax.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_positionratio.jpg b/docs/static/img/docs/app/vara/vara_positionratio.jpg new file mode 100644 index 00000000..3549567a Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_positionratio.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_positionslight.jpg b/docs/static/img/docs/app/vara/vara_positionslight.jpg new file mode 100644 index 00000000..9be354fc Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_positionslight.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_pricerange.jpg b/docs/static/img/docs/app/vara/vara_pricerange.jpg new file mode 100644 index 00000000..16aa7b18 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_pricerange.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_searchtoken.jpg b/docs/static/img/docs/app/vara/vara_searchtoken.jpg new file mode 100644 index 00000000..155de33d Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_searchtoken.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_selectfeetier.jpg b/docs/static/img/docs/app/vara/vara_selectfeetier.jpg new file mode 100644 index 00000000..7bfb1097 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_selectfeetier.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_selecttokens.jpg b/docs/static/img/docs/app/vara/vara_selecttokens.jpg new file mode 100644 index 00000000..7dce9f12 Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_selecttokens.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_slippage.jpg b/docs/static/img/docs/app/vara/vara_slippage.jpg new file mode 100644 index 00000000..6fb56e0d Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_slippage.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_transactiondetails.jpg b/docs/static/img/docs/app/vara/vara_transactiondetails.jpg new file mode 100644 index 00000000..63cda48b Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_transactiondetails.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_transactiondetailsmodal.jpg b/docs/static/img/docs/app/vara/vara_transactiondetailsmodal.jpg new file mode 100644 index 00000000..a67ea93a Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_transactiondetailsmodal.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_valuelight.jpg b/docs/static/img/docs/app/vara/vara_valuelight.jpg new file mode 100644 index 00000000..dbefc55e Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_valuelight.jpg differ diff --git a/docs/static/img/docs/app/vara/vara_varausdc.jpg b/docs/static/img/docs/app/vara/vara_varausdc.jpg new file mode 100644 index 00000000..4433a42f Binary files /dev/null and b/docs/static/img/docs/app/vara/vara_varausdc.jpg differ