kylefang/alexlab-doc
1
0
Fork 0
mirror of https://github.com/alexgo-io/alexlab-doc.git synced 2026-01-12 14:34:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

fixed capitalization, brokens links and separated stake and farm how tos into sections

Browse Source
This commit is contained in:
maquirriaincf
2025-02-21 15:44:04 -03:00
parent 95d107d36d
commit d62712d0fa
23 changed files with 375 additions and 372 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@@ -87,7 +87,7 @@ Just as Bitcoin is the “gold standard” of crypto, ALEX will become gold stan
Chiente Hsu: [https://x.com/RuleBasedInvest](https://x.com/RuleBasedInvest)
<!-- Rachel: [https://twitter.com/rachel\_alexgo](https://twitter.com/rachel_alexgo) -->
Rachel: [https://twitter.com/rachel_alexgo](https://twitter.com/rachel_alexgo)
### Verified Tag on Discord for Team Authenticity&#x20;

27
docs/SUMMARY.md
View File

@@ -10,32 +10,35 @@
## What Can You Do?
* [💰 Bitcoin Swaps](product-features/bitcoin-swaps/README.md)
* [💡 Key concepts](product-features/bitcoin-swaps/key-concepts.md)
* [🧑‍🏫 How to swap](product-features/bitcoin-swaps/how-to.md)
* [💡 Key Concepts](product-features/bitcoin-swaps/key-concepts.md)
* [📖 How to Swap](product-features/bitcoin-swaps/how-to.md)
* [❓ FAQs](product-features/bitcoin-swaps/faqs.md)
* [🔄 Stacks Swaps](product-features/stacks-swaps/README.md)
* [💡 Key concepts](product-features/stacks-swaps/key-concepts.md)
* [🧑‍🏫 How to swap](product-features/stacks-swaps/how-to.md)
* [💡 Key Concepts](product-features/stacks-swaps/key-concepts.md)
* [📖 How to Swap](product-features/stacks-swaps/how-to.md)
* [❓ FAQs](product-features/stacks-swaps/faqs.md)
* [🐋 Liquidity Pools](product-features/liquidity-pools/README.md)
* [💡 Key concepts](product-features/liquidity-pools/key-concepts.md)
* [↘️ How to add liquidity](product-features/liquidity-pools/how-to-add.md)
* [↖️ How to remove liquidity](product-features/liquidity-pools/how-to-remove.md)
* [💡 Key Concepts](product-features/liquidity-pools/key-concepts.md)
* [↘️ How to Add liquidity](product-features/liquidity-pools/how-to-add.md)
* [↖️ How to Remove Liquidity](product-features/liquidity-pools/how-to-remove.md)
* [❓ FAQs](product-features/liquidity-pools/faqs.md)
* [🌾 Farming](product-features/farming/README.md)
* [💡 Key concepts](product-features/farming/key-concepts.md)
* [🧑‍🏫 How to farm & harvest](product-features/farming/how-to.md)
* [💡 Key Concepts](product-features/farming/key-concepts.md)
* [↘️ How to Farm](product-features/farming/how-to-farm.md)
* [↖️ How to Harvest](product-features/farming/how-to-harvest.md)
* [❓ FAQs](product-features/farming/faqs.md)
* [⚓ Stake](product-features/staking/README.md)
* [💡 Key concepts](product-features/staking/key-concepts.md)
* [🧑‍🏫 How to stake](product-features/staking/how-to.md)
* [💡 Key Concepts](product-features/staking/key-concepts.md)
* [↘️ How to Stake](product-features/staking/how-to-stake.md)
* [↖️ How to Harvest](product-features/staking/how-to-harvest.md)
* [⚙️ How to Auto Stake](product-features/staking/how-to-auto-stake.md)
* [❓ FAQs](product-features/staking/faqs.md)
## What Can You Do as a Project Owner?
* [🚀 Launch Your Project](features/launchpad/join-the-alex-launchpad.md)
* [💦 Create Your Own Pool](product-features/self-service-listing.md)
* [🧑‍🌾 Add Farming to Your Pool](product-features/self-service-farming.md)
* [🚜 Add Farming to Your Pool](product-features/self-service-farming.md)
## Security

2
docs/getting-started/join-the-community.md
View File

@@ -50,7 +50,7 @@ These are the only official profiles of ALEX team members on X (formerly Twitter
Chiente Hsu: [https://x.com/RuleBasedInvest](https://x.com/RuleBasedInvest)
<!-- Rachel: [https://twitter.com/rachel\_alexgo](https://twitter.com/rachel_alexgo) -->
Rachel: [https://twitter.com/rachel_alexgo](https://twitter.com/rachel_alexgo)
### Discord

6
docs/product-features/bitcoin-swaps/how-to.md
View File

@@ -77,17 +77,17 @@ If you want to adjust the **Swap Slippage**, select the "Edit" button to the rig
<figure><img src="../../.gitbook/assets/bitcoin-swap/bitcoin-swap-transaction-settings.png" alt="" width="375"><figcaption><p>Transaction Settings panel example, with slippage tolerance set to 2%.</p></figcaption></figure>
</div>
### Step 4: Confirm Transaction
### Step 4: Confirm the Swap
Once you're ready to move ahead, select the `Swap` button which will bring up the Confirmation panel. This panel provides a final overview of your transaction details, allowing you to double-check price, route, fees and slippage. If everything looks good, click `Confirm` 😎.
### Step 5: Confirm Transaction in your Wallet
### Step 5: Confirm the Transaction in Your Wallet
After clicking `Confirm`, you will need to confirm the transaction in your wallet. Here, your Bitcoin wallet is interacting with the ALEX smart contract and is asking you for approval. Scroll through the wallet transaction window, review it and confirm the transaction. By doing this, you are allowing the wallet to sign and broadcast the transaction.
<div><figure><img src="../../.gitbook/assets/bitcoin-swap/bitcoin-swap-wallet-confirm-1.png" alt="" width="375"><figcaption><p>Transfer amounts involved and expandable details.</p></figcaption></figure> <figure><img src="../../.gitbook/assets/bitcoin-swap/bitcoin-swap-wallet-confirm-2.png" alt="" width="375"><figcaption><p>Inputs and outputs and confirmation button.</p></figcaption></figure></div>
### Step 6: Wait for Confirmation <a href="#step-7" id="step-7"></a>
### Step 6: Wait for Transaction Confirmation <a href="#step-7" id="step-7"></a>
Wait for the transaction to be confirmed on the network.

3
docs/product-features/farming/README.md
View File

@@ -26,7 +26,8 @@ To get started with farming, you first deposit two tokens into a liquidity pool,
## Explore
{% content-ref url="key-concepts.md" %} [key-concepts.md](key-concepts.md) {% endcontent-ref %}
{% content-ref url="how-to.md" %} [how-to.md](how-to.md) {% endcontent-ref %}
{% content-ref url="how-to-farm.md" %} [how-to-farm.md](how-to-farm.md) {% endcontent-ref %}
{% content-ref url="how-to-harvest.md" %} [how-to-harvest.md](how-to-harvest.md) {% endcontent-ref %}
{% content-ref url="faqs.md" %} [faqs.md](faqs.md) {% endcontent-ref %}
<!--

91
docs/product-features/farming/how-to.md → docs/product-features/farming/how-to-farm.md
View File

@@ -4,7 +4,7 @@ description: >-
rewards and remove LP tokens from the farm.
---
# 🧑‍🏫 How to farm & harvest
# 🧑‍🏫 How to Farm
Yield farming takes a few easy steps to get set up. It works very similar to standard staking, with the key difference being that the tokens you stake are LP tokens. As with traditional staking, you lock up your tokens for a certain period (measured in cycles) and earn rewards over time. After each cycle (except for the first cooldown one), you will have rewards available to harvest.
@@ -14,14 +14,14 @@ With this information in mind, choose the guide that best fits your needs.
## Guides
* [🐥 Getting started (from scratch)](#hatched_chick-getting-started)
* [🌻 How to put LP tokens in a farm (stake)](#sunflower-how-to-put-lp-tokens-in-a-farm-stake)
* [🚜 Harvesting your farming rewards](#tractor-harvesting-your-farming-rewards)
* [🛎️ Withdrawing LP tokens (unstake)](#bellhop-withdrawing-lp-tokens-unstake)
* [🐥 Getting Started (From Scratch)](#hatched_chick-getting-started)
* [🌻 How to Put LP Tokens in a Farm (Stake)](#sunflower-how-to-put-lp-tokens-in-a-farm-stake)
* [🚜 Harvesting Your Farming Rewards](how-to-harvest.md)
* [🛎️ Withdrawing LP Tokens (Unstake)](how-to-harvest.md#bellhop-withdrawing-lp-tokens-unstake)
## :hatched\_chick: Getting started
## :hatched\_chick: Getting Started
### Finding your farm
### Finding Your Farm
Before proceeding, choose a farm that aligns with your goals. Go to [https://app.alexlab.co/](https://app.alexlab.co/) and navigate to the Earn -> Farm tab.
@@ -44,7 +44,7 @@ You'll see a list of all the available farms along with key information. You can
Once you find a farm that fits your goals, note the **Trading Pair** (e.g., STX-aBTC) as you will need it in the next step.
### Providing liquidity to get LP tokens
### Providing Liquidity to Get LP Tokens
Now that you've chosen a farm to stake in, you'll need LP tokens, which are obtained by adding liquidity to a pool.
@@ -57,19 +57,19 @@ Now that you've chosen a farm to stake in, you'll need LP tokens, which are obta
We have a [Guide to Adding Liquidity](../liquidity-pools/how-to-add.md) that you can follow to obtain LP tokens.
## :sunflower: How to put LP tokens in a farm (stake)
## :sunflower: How to Put LP Tokens in a Farm (Stake)
If you have LP tokens, you're ready to start staking them in a farm and earning rewards!
### Step 1
### Step 1: Go to the Farm Page
Go to the [Farms page](https://app.alexlab.co/farm) and locate your farm of interest. You can access it by navigating to [https://app.alexlab.co/](https://app.alexlab.co/) and selecting the Earn -> Farm tab.
Go to the [Farm page](https://app.alexlab.co/farm) and locate your farm of interest. You can access it by navigating to [https://app.alexlab.co/](https://app.alexlab.co/) and selecting the Earn -> Farm tab.
At the top of the farm list, you'll see the farms suggested by the ALEX Lab Platform based on your LP tokens balance. In the example below, the suggested farm is STX-ALEX. This indicated that the user has provided liquidity in the STX-ALEX pool and has LP tokens available for farming.
<figure><img src="../../.gitbook/assets/farming/suggested-farms.png" alt=""><figcaption><p>Example of farm suggestions. This user is a STX-ALEX pool provider and possesses STX-ALEX LP tokens that can be staked in the STX-ALEX farm.</p></figcaption></figure>
### Step 2
### Step 2: Select Farm
Select the farm you want to stake in from the farm list.
@@ -79,9 +79,9 @@ Select the farm you want to stake in from the farm list.
When hovering over a farm, you may notice a "+ Stake LP" button. This serves as a visual indicator for the selected farm. Clicking it will take you to the same screen as clicking anywhere on the farm's row.
{% endhint %}
### Step 3
### Step 3: Enter LP Tokens to Stake
Once you have selected the farm, enter the amount of LP tokens you would like to stake, or click "Max" to use all available LP Tokens.
Once you have selected the farm, enter the amount of LP tokens you would like to stake, or click `Max` to use all available LP Tokens.
Next, choose the number of reward cycles you want to lock your tokens into the farm. Each cycle is approximately 3.5 days.
@@ -91,15 +91,15 @@ Next, choose the number of reward cycles you want to lock your tokens into the f
Your staked amount will start generating yield from the next upcoming cycle, as the current cycle is in "cooldown" period. To maximize the APR you earn, it's best to stake for longer cycle periods to avoid missing out on any reward cycles due to this cooldown cycle. That's why 32-cycle staking is recommended if your goal is to maximize earnings.
{% endhint %}
### Step 4
### Step 4: Confirm Stake
Once you have entered the amount, click the "Stake" button. Confirmation panel will appear. Here you can double check amount and reward cycles. If everything looks okay, click "Confirm" 😎
Once you have entered the amount, click the `Stake` button. Confirmation panel will appear. Here you can double check amount and reward cycles. If everything looks okay, click `Confirm`. 😎
<figure><img src="../../.gitbook/assets/farming/confirm-staking-panel.png" alt="" width="375"><figcaption></figcaption></figure>
### Step 5
### Step 5: Confirm the Transaction in Your Wallet
After clicking "Confirm", you will need to confirm the transaction in your wallet. Remember that farming locks up LP tokens in a smart contract for the selected number of reward cycles.
After clicking `Confirm`, you will need to confirm the transaction in your wallet. Remember that farming locks up LP tokens in a smart contract for the selected number of reward cycles.
At this point, your Stacks wallet is interacting with ALEX smart contract and is asking you for approval. Scroll through the wallet transaction window, review it and confirm the transaction. By doing this, you are allowing the wallet to sign and broadcast the transaction.
@@ -112,7 +112,7 @@ To be completely sure, you can check:
<figure><img src="../../.gitbook/assets/farming/stake-tokens-function-args.png" alt="" width="375"><figcaption><p>Wallet pop-up with function arguments and confirmation button.</p></figcaption></figure>
### Step 6
### Step 6: Wait for Transaction Confirmation
Wait for the transaction to be confirmed on the network.
@@ -130,61 +130,16 @@ Recommended to track transaction status:
<div><figure><img src="../../.gitbook/assets/farming/leather-tx-pending.png" alt="" width="375"><figcaption><p>Transaction pending displayed on Leather wallet.</p></figcaption></figure> <figure><img src="../../.gitbook/assets/farming/leather-tx-success.png" alt="" width="375"><figcaption><p>Transaction completed.</p></figcaption></figure></div>
### Step 7
### Step 7: Check Active Farms
After successfully staking your LP tokens in a farm, you will be able to see your active farms in the "My Farms" panel on the main [Farms page](https://app.alexlab.co/farm).
<figure><img src="../../.gitbook/assets/farming/my-farms.png" alt=""><figcaption><p>Example of the "My Farms" panel. Here you will find all your active farms; click on any of them for detailed information.</p></figcaption></figure>
By clicking on a farm, you will access the "My Farming" dashboard for that specific farm, which includes detailed metrics. On the right side of the dashborad, you will see that the current cycle has no earnings and no farming tokens. The reason you can't join the current reward cycle is that it had already started prior to your participation. However, once you successfully stake your LP into the farm, it gets registered for the next cycle. This assures you a proportional share of the farm rewards based on the number of LP tokens you have staked. This is why it's convenient to stake for long periods: every time you stake, you must wait for the current cycle to end before you start generating rewards in the next cycle.
By clicking on a farm, you will access the `My Farming` dashboard for that specific farm, which includes detailed metrics. On the right side of the dashborad, you will see that the current cycle has no earnings and no farming tokens. The reason you can't join the current reward cycle is that it had already started prior to your participation. However, once you successfully stake your LP into the farm, it gets registered for the next cycle. This assures you a proportional share of the farm rewards based on the number of LP tokens you have staked. This is why it's convenient to stake for long periods: every time you stake, you must wait for the current cycle to end before you start generating rewards in the next cycle.
For more info on the "My Farming" dashboard and metrics, we recommend reading the [Key concepts](key-concepts.md) page.
For more info on the `My Farming` dashboard and metrics, we recommend reading the [Key concepts](key-concepts.md) page.
<figure><img src="../../.gitbook/assets/farming/my-farming.png" alt=""><figcaption><p>Example of the "My Farming" dashboard for the STX-ALEX farm. The user has just staked, so it is in the cooldown period.</p></figcaption></figure>
Now that you have your tokens staked on a farm, you rewards are growing 🌱. Be patient 🧘 and when the time comes, check out the following guide on how to harvest your rewards.
## :tractor: Harvesting your farming rewards
Farming will earn you rewards over time.
At the end of every staking cycle (525 blocks, approximately 3.5 days), rewards will be available to harvest. To claim your rewards, follow these steps:
1. Go to the [Farms page](https://app.alexlab.co/farm) on ALEX Lab App, which you can access through the Earn -> Farm tab.
2. You will find the **My Farms** panel which your active farms. Click on the farm you want to harvest, either from the panel or from the farm list.
3. Expand the **My Farming** dashboard. If a cycle has ended, you will see rewards available to claim.
4. Click on the "Harvest All" button and confirm the transaction on your wallet (just as you did in the previous guides).
5. Wait for the transaction to be confirmed on the network. Remember, you can turn on [Telegram notifications](https://t.me/stacks_tx_notification_bot) or search for the transaction on the [ALEX Explorer](https://app.alexlab.co/explorer).
6. Once the transaction is completed, the reward amounts will be reflected in your wallet balance. You can always check your balance also on the ALEX Lab App, located beside the "Wallet Manager" at the top menu bar.
You can collect these rewards and use them for various purposes on the ALEX Lab Platform. For example, you can [stake](https://app.alexlab.co/stake) your $ALEX rewards manually to generate compounding interest. You can also use your APower rewards to increase your access to IDOs on the [ALEX Launchpad](https://app.alexlab.co/launchpad). You can even obtain more LP tokens!
### How often should I harvest my rewards?
To maximize your returns, it is best to harvest your rewards at the end of every cycle. This way, you have them available to generate more rewards! 🤩
For example, you can manually stake your $ALEX rewards to generate compounding interest. If your rewards are another token, you can still [swap](https://app.alexlab.co/swap) and convert them to $ALEX. Another option would be to use your rewards to buy more LP tokens and benefit from being a [liquidity provider](../liquidity-pools/).
Happy Farming! 🥕 🥬 🍅
## :bellhop: Withdrawing LP tokens (unstake)
Withdrawing you LP tokens takes just a few steps. The important thing is when to do it.
When farming, you are committed to locking up your tokens for a predefined period (reward cycles, each cycle contains 525 Stacks blocks, an estimation of \~3.5 days per cycle). Once these cycles conclude, you will be able to unstake them and regain control over your LP tokens.
If you staked multiple times at different moments, the lock periods apply to each amount separately.
Let's go through it step-by-step:
1. Go to the [Farms page](https://app.alexlab.co/farm) on ALEX Lab App, which you can access through the Earn -> Farm tab.
2. You will see the **My Farming** dashboard. Expand it to see all your farming details.
3. Find the farm from which you want to withdraw LP tokens and click on it.
4. Your LP tokens will automatically be available for withdrawal when your committed cycles end. You will find them under the **LP to claim** title on the dashboard.
5. Click on the "Harvest All" button and confirm the transaction in your wallet (just as you did in the previous guides). This will return your LP tokens back to your possession and automatically collect any unharvested rewards.
6. Wait for the transaction to be confirmed on the network. Remember, you can turn on [Telegram notifications](https://t.me/stacks_tx_notification_bot) or search for the transaction on the [ALEX Explorer](https://app.alexlab.co/explorer).
7. Once the transaction is completed, you will see the changes reflected in your wallet balance and on the platform panels. In particular, you will see your LP token balance on the [Pool page](https://app.alexlab.co/pool) in the **My Liquidity** panel or by selecting the pool from the list. You can also check your balance on the ALEX Lab App, located beside the Wallet Manager at the top menu bar.
If you want to farm your LP tokens again, remember: your staked amount will start generating yield from the next upcoming cycle. To maximize the APR you earn, it's best to stake for longer cycle periods to avoid missing out on any reward cycles due to the cooldown period.
Thanks for farming on ALEX Lab! 🧑‍🌾
Now that you have your tokens staked on a farm, you rewards are growing 🌱. Be patient 🧘 and when the time comes, check out the [How to Harvest Guide](how-to-harvest.md) to claim your rewards.

44
docs/product-features/farming/how-to-harvest.md Normal file
View File

@@ -0,0 +1,44 @@
# :tractor: Harvesting Your Farming Rewards
Farming will earn you rewards over time.
At the end of every staking cycle (525 blocks, approximately 3.5 days), rewards will be available to harvest. To claim your rewards, follow these steps:
1. Go to the [Farms page](https://app.alexlab.co/farm) on ALEX Lab App, which you can access through the Earn -> Farm tab.
2. You will find the **My Farms** panel which your active farms. Click on the farm you want to harvest, either from the panel or from the farm list.
3. Expand the **My Farming** dashboard. If a cycle has ended, you will see rewards available to claim.
4. Click on the "Harvest All" button and confirm the transaction on your wallet (just as you did in the previous guides).
5. Wait for the transaction to be confirmed on the network. Remember, you can turn on [Telegram notifications](https://t.me/stacks_tx_notification_bot) or search for the transaction on the [ALEX Explorer](https://app.alexlab.co/explorer).
6. Once the transaction is completed, the reward amounts will be reflected in your wallet balance. You can always check your balance also on the ALEX Lab App, located beside the "Wallet Manager" at the top menu bar.
You can collect these rewards and use them for various purposes on the ALEX Lab Platform. For example, you can [stake](https://app.alexlab.co/stake) your $ALEX rewards manually to generate compounding interest. You can also use your APower rewards to increase your access to IDOs on the [ALEX Launchpad](https://app.alexlab.co/launchpad). You can even obtain more LP tokens!
### How Often Should I Harvest My Rewards?
To maximize your returns, it is best to harvest your rewards at the end of every cycle. This way, you have them available to generate more rewards! 🤩
For example, you can manually stake your $ALEX rewards to generate compounding interest. If your rewards are another token, you can still [swap](https://app.alexlab.co/swap) and convert them to $ALEX. Another option would be to use your rewards to buy more LP tokens and benefit from being a [liquidity provider](../liquidity-pools/).
Happy Farming! 🥕 🥬 🍅
## :bellhop: Withdrawing LP Tokens (Unstake)
Withdrawing you LP tokens takes just a few steps. The important thing is when to do it.
When farming, you are committed to locking up your tokens for a predefined period (reward cycles, each cycle contains 525 Stacks blocks, an estimation of \~3.5 days per cycle). Once these cycles conclude, you will be able to unstake them and regain control over your LP tokens.
If you staked multiple times at different moments, the lock periods apply to each amount separately.
Let's go through it step-by-step:
1. Go to the [Farms page](https://app.alexlab.co/farm) on ALEX Lab App, which you can access through the Earn -> Farm tab.
2. You will see the **My Farming** dashboard. Expand it to see all your farming details.
3. Find the farm from which you want to withdraw LP tokens and click on it.
4. Your LP tokens will automatically be available for withdrawal when your committed cycles end. You will find them under the **LP to claim** title on the dashboard.
5. Click on the "Harvest All" button and confirm the transaction in your wallet (just as you did in the previous guides). This will return your LP tokens back to your possession and automatically collect any unharvested rewards.
6. Wait for the transaction to be confirmed on the network. Remember, you can turn on [Telegram notifications](https://t.me/stacks_tx_notification_bot) or search for the transaction on the [ALEX Explorer](https://app.alexlab.co/explorer).
7. Once the transaction is completed, you will see the changes reflected in your wallet balance and on the platform panels. In particular, you will see your LP token balance on the [Pool page](https://app.alexlab.co/pool) in the **My Liquidity** panel or by selecting the pool from the list. You can also check your balance on the ALEX Lab App, located beside the Wallet Manager at the top menu bar.
If you want to farm your LP tokens again, remember: your staked amount will start generating yield from the next upcoming cycle. To maximize the APR you earn, it's best to stake for longer cycle periods to avoid missing out on any reward cycles due to the cooldown period.
Thanks for farming on ALEX Lab! 🧑‍🌾

18
docs/product-features/farming/key-concepts.md
View File

@@ -4,13 +4,13 @@ description: >-
dashboard metrics!
---
# 💡 Key concepts
# 💡 Key Concepts
## Farm basics
## Farm Basics
Yield farming works in a very similar way to standard staking, with the key difference being that the tokens you stake are LP tokens. As in traditional staking, you lock up your tokens for a certain period (measured in cycles) and earn rewards over time. After each cycle, you will have rewards available to harvest[^1].
### What are LP tokens?
### What Are LP Tokens?
LP tokens are the tokens you receive when you provide funds to a liquidity pool. These tokens represent your share of the pool's assets. As a liquidity provider, you earn a portion of the fees charged to users who perform swaps within the pool. For a deeper understanding of these concepts, check out the [Liquidity Pools](../liquidity-pools/) section of the docs.
@@ -18,7 +18,7 @@ LP tokens are the tokens you receive when you provide funds to a liquidity pool.
You may notice that farming often yields higher rewards than regular staking. Well, farming involves liquidity provision and comes with the risk of Impermanent Loss. It's not as scary as it sounds, but it is worth learning about the concept before you get started. Learn more in the [Impermanent Loss subsection](../liquidity-pools/key-concepts.md#impermanent-loss) from the Liquidity Pools page.
{% endhint %}
### What exactly is a farm?
### What Exactly is a Farm?
A farm is a staking pool for a specific LP token. Each liquidity pool has their specific native LP tokens. There are different LP tokens corresponding to each liquidity pool on the ALEX Lab Platform.
@@ -33,7 +33,7 @@ Farms only accept LP tokens of one kind. For example, the STX-ALEX farm only acc
**Smart Contacts.** During farming, LP tokens are locked in the ALEX smart contract. Although they belong to you and only you have the authority to withdraw them, they are not held by your address during the lock-up period. As a result, you won't be able to view your LP tokens in the My Liquidity panel on the [ALEX Lab Pools page](https://app.alexlab.co/pool) during staking.
{% endhint %}
### Cycles and cooldown period
### Cycles and Cooldown Period
Farming is measured in cycles. **One cycle** is 525 Stacks blocks (after Stacks Nakamoto release, the farming cycle will be counted based on tenure height), which is approximately **3.5 days** or **525 Bitcoin blocks**. This means that when you stake tokens in a farm, you need to specify the number of cycles you want to lock up your tokens in the farm. Rewards are distributed after a cycle ends.
@@ -41,7 +41,7 @@ Your staked tokens will start generating yield in the next upcoming cycle, which
Let's use an example. Assume you stake for one cycle at a time. When that cycle ends, you can claim the rewards associated with that cycle. To continue generating rewards, you will have to withdraw your LP tokens and restake them. However, when you restake them, the current cycle will not be eligible for you to earn rewards. Therefore, you will have to wait until the next cycle to acquire rewards. Over 100 cycles, this method would cause you to miss rewards for about 50 cycles. In contrast, if you stake for 32 cycles, you will only miss rewards for 3 cycles.
### Reward distribution
### Reward Distribution
Farms may offer different types of reward tokens, and each farm has a predetermined amount of rewards. For simplicity, we can assume that the total rewards distributed to stakers during each cycle remains constant. At the end of each cycle, the rewards are available to be harvested by the farmers (stakers) in proportion to their share of LP tokens within that cycle.
@@ -78,7 +78,7 @@ Once you have staked LP tokens into a farm, it's important to familiarize yourse
<figure><img src="../../.gitbook/assets/farming/my-farming-dashboard-example.png" alt=""><figcaption><p>My Farming dashboard example for ALEX - LiALEX farm. This user has accumulated rewards from previous cycles that are available to claim. Also, there are no LP tokens that have completed their staking period and are ready for withdrawal (LP to claim).</p></figcaption></figure>
### Active farming LP
### Active Farming LP
The tokens you have staked in the farm. When your staking period ends for a certain amount, those tokens will move from here to the [LP to claim](key-concepts.md#lp-to-claim) section of the dashborad. If you staked multiple times at different cycles, the lock periods apply to each amount separately.
@@ -86,11 +86,11 @@ The tokens you have staked in the farm. When your staking period ends for a cert
This metric represents the average of all your farming cycle APRs (both current and upcoming).
### Rewards to claim
### Rewards to Claim
The rewards available for you to harvest. If you don't harvest, these rewards will accumulate over time. However, to maximize your returns, we recommend harvesting your rewards after every cycle ends. This way, you can stake them or buy more LP tokens to generate compound interest.
### LP to claim
### LP to Claim
The tokens that have completed their staking period. These tokens are no longer in a farming state. To make them generate farming rewards again, you will have to withdraw and restake them.

2
docs/product-features/liquidity-pools/README.md
View File

@@ -32,7 +32,7 @@ Old cards layout, in case we want to revert it
-->
### Looking to create your own pool?
### Looking to Create Your Own Pool?
The Self-Service Listing allows you to create your own trading pool within the ALEX decentralized exhange. Visit the dedicated page for more details.

2
docs/product-features/liquidity-pools/faqs.md
View File

@@ -4,7 +4,7 @@ description: Common questions you might have as a liquidity provider or pool cre
# ❓ FAQs
## Liquidity Pools & Providers
## Liquidity Pools and Providers
<details>

16
docs/product-features/liquidity-pools/how-to-add.md
View File

@@ -9,13 +9,13 @@ When **adding liquidity**, you will deposit an equivalent value of both tokens i
Ready to start? Let's get hands-on!
### Step 1
### Step 1: Go to the Pool Page
Go to [https://app.alexlab.co/](https://app.alexlab.co/) and click on navbar's Swap -> Pool tab.
<figure><img src="../../.gitbook/assets/liquidity-pools/adding-liquidity-1-pool-tab.png" alt="" width="375"><figcaption></figcaption></figure>
### Step 2
### Step 2: Select Pool
All available pools will be displayed including information such as:
@@ -32,7 +32,7 @@ Select the token pair to which you want to add liquidity from the displayed list
When hovering over a pool, you might notice a "+LP" button. This serves as a visual indicator for the selected pool. Clicking it will take you to the same screen as clicking anywhere on the pool's row.
{% endhint %}
### Step 3
### Step 3: Add Liquidity to Your Pool
After selecting a pool, you will be taken to a control panel for that specific liquidity pool, where you can add liquidity to the token pair and view more detailed metrics[^1].
@@ -46,7 +46,7 @@ When you set the amount for one token, the corresponding amount for the other to
Clicking the "Max" button will automatically set the amount to your total available balance.
{% endhint %}
### Step 4
### Step 4: Adjust Transaction Settings
If you want to adjust slippage, select the "Settings" icon to open the Transaction Settings panel and set your desired tolerance. The default slippage tolerance for non-stable swap token pairs is set to 4%, meaning your transaction will revert if the exchange rate changes unfavourably by more than this percentage. The displayed number of LP tokens you will receive is approximate due to this potential variation.
@@ -54,13 +54,13 @@ If you want to adjust slippage, select the "Settings" icon to open the Transacti
<figure><img src="../../.gitbook/assets/liquidity-pools/adding-liquidity-4-adjust-slippage.png" alt="" width="375"><figcaption><p>Transaction Settings panel example, with slippage tolerance set to 3%.</p></figcaption></figure>
### Step 5
### Step 5: Confirm Added Liquidity
One you decide the amount, click the "Add" button. Confirmation panel will appear. Here you can double check balances, slippage and LP tokens. If everything it's okay, click "Confirm" :sunglasses:
<figure><img src="../../.gitbook/assets/liquidity-pools/adding-liquidity-5-confirm-add-liquidity.png" alt="" width="375"><figcaption></figcaption></figure>
### Step 6
### Step 6: Confirm the Transaction in Your Wallet
After clicking "Confirm", you will need to confirm the transaction in your wallet. Here, your Stacks wallet is interacting with ALEX smart contract and is asking you for approval. Scroll through the wallet transaction window, review it and confirm the transaction. By doing this, you are allowing the wallet to sign and broadcast the transaction.
@@ -73,7 +73,7 @@ To be completely sure, you can check:
<div><figure><img src="../../.gitbook/assets/liquidity-pools/adding-liquidity-6-add-to-position-post-con.png" alt="" width="375"><figcaption><p>Amounts to transfer and post conditions.</p></figcaption></figure> <figure><img src="../../.gitbook/assets/liquidity-pools/adding-liquidity-6-add-to-position-function-args.png" alt="" width="375"><figcaption><p>Function arguments and confirmation button.</p></figcaption></figure></div>
### Step 7
### Step 7: Wait for Transaction Confirmation
Wait for the transaction to be confirmed on the network.
@@ -91,7 +91,7 @@ Recommended to track transaction status:
<div><figure><img src="../../.gitbook/assets/liquidity-pools/adding-liquidity-7-leather-tx-pending.png" alt="" width="375"><figcaption><p>Transaction pending displayed on Leather wallet.</p></figcaption></figure> <figure><img src="../../.gitbook/assets/liquidity-pools/adding-liquidity-7-leather-tx-success.png" alt="" width="375"><figcaption><p>Transaction completed, token transfers are visible.</p></figcaption></figure></div>
### Step 8
### Step 8: Check the Updated Liquidity
After successfully adding liquidity, you will be able to see your LP tokens and related details in "My Liquidity" panel.

18
docs/product-features/liquidity-pools/how-to-remove.md
View File

@@ -9,7 +9,7 @@ When **removing liquidity**, you will transfer your LP tokens back to the ALEX s
Ready to start? Let's get hands-on!
### Step 1
### Step 1: Go to the Pool Page
As when adding liquidity, go to [https://app.alexlab.co/](https://app.alexlab.co/) and click on navbar's Swap -> Pool tab.
@@ -19,21 +19,21 @@ Once you're on the Pool page, you'll find the "My Liquidity" panel at the top of
<figure><img src="../../.gitbook/assets/liquidity-pools/removing-liquidity-1-my-liquidity-main-panel.png" alt=""><figcaption><p>The pools where you are providing liquidity are displayed here. There is only one in this example.</p></figcaption></figure>
### Step 2
### Step 2: Select Pool
Select the pool you would like to remove liquidity from, either through the "My Liquidity" panel or directly from the pool list.
<figure><img src="../../.gitbook/assets/liquidity-pools/removing-liquidity-2-select-pool.png" alt=""><figcaption><p>STX-ALEX pool selection.</p></figcaption></figure>
### Step 3
### Step 3: Open the Remove Liquidity Tab
Once in the panel of the pool, select the "Remove Liquidity" tab.
<figure><img src="../../.gitbook/assets/liquidity-pools/removing-liquidity-3-remove-tab.png" alt="" width="375"><figcaption></figcaption></figure>
### Step 4
### Step 4: Enter Amount to Withdraw
For this step, it's important to have in mind that the LP tokens you hold represent your share of the pool's funds. By entering the LP token amount, you're specifying the portion of the pooled funds you want to withdraw. Clicking the "Max" button sets your entire LP token balance, indicating you want to remove all liquidity from the pool.
For this step, it's important to have in mind that the LP tokens you hold represent your share of the pool's funds. By entering the LP token amount, you're specifying the portion of the pooled funds you want to withdraw. Clicking the `Max` button sets your entire LP token balance, indicating you want to remove all liquidity from the pool.
When you enter the amount of LP tokens, you are specifiyng amount you will transfer to ALEX smart contract in order to receive your funds and any accrued fees in return. These fees are the ones accrued while holding those LP tokens.
@@ -41,19 +41,19 @@ Once you have decided the LP token amount, click the "Remove" button.
<figure><img src="../../.gitbook/assets/liquidity-pools/removing-liquidity-4-enter-amount.png" alt="" width="375"><figcaption><p>Example of removing all liquidity; the amount matches the LP token balance.</p></figcaption></figure>
### Step 5
### Step 5: Confirm Liquidity Removal
A confirmation panel will appear where you can double check the amount. If everything looks correct, click "Confirm" :sunglasses:
<figure><img src="../../.gitbook/assets/liquidity-pools/removing-liquidity-5-confirm-remove-liquidity.png" alt="" width="375"><figcaption></figcaption></figure>
### Step 6
### Step 6: Confirm the Transaction in Your Wallet
After clicking "Confirm", you will need to confirm the transaction in your wallet. Here, your Stacks wallet is interacting with ALEX smart contract and is asking you for approval. Scroll through the wallet transaction window, review it and confirm the transaction. By doing this, you are allowing the wallet to sign and broadcast the transaction.
<figure><img src="../../.gitbook/assets/liquidity-pools/removing-liquidity-6-reduce-position-function-args.png" alt="" width="375"><figcaption><p>Function arguments and confirmation button.</p></figcaption></figure>
### Step 7
### Step 7: Wait for Transaction Confirmation
Wait for the transaction to be confirmed on the network.
@@ -71,7 +71,7 @@ Recommended to track transaction status:
<div><figure><img src="../../.gitbook/assets/liquidity-pools/removing-liquidity-7-leather-tx-pending.png" alt="" width="375"><figcaption><p>Transaction pending displayed on Leather wallet.</p></figcaption></figure> <figure><img src="../../.gitbook/assets/liquidity-pools/removing-liquidity-7-leather-tx-success.png" alt="" width="375"><figcaption><p>Transaction completed, token transfers are visible.</p></figcaption></figure></div>
### Step 8
### Step 8: Check the Updated Liquidity
Once the transaction is completed, you will see the changes reflected in the "My Liquidity" panel, and the updated token balances should appear in your wallet.

4
docs/product-features/liquidity-pools/key-concepts.md
View File

@@ -6,13 +6,13 @@ description: >-
# 💡 Key concepts
## What are Liquidity Pools?
## What Are Liquidity Pools?
Liquidity pools are crowdfunded collections of crypto assets held in a smart contract, designed to provide liquidity for decentralized exchanges (DEXs) and support various decentralized finance (DeFi) protocols.
While their applications are diverse, ranging from lending and borrowing platforms to algorithmic protocols for stablecoins, their primary use is on DEXs. In this case, liquidity pools enable users to trade crypto assets without the need for a centralized intermediary, serving as reserves of assets that users can trade against.
## Their role in Automated Market Makers (AMMs)
## Their Role in Automated Market Makers (AMMs)
Automated Market Makers (AMMs) are the predominant type of decentralized exchange (DEX). While other DEX designs exist, AMM-based DEXs have become extremely popular. These exchanges operate using liquidity pools and algorithmic mechanisms to determine prices and facilitate the trading of crypto assets between peers.

28
docs/product-features/self-service-farming.md
View File

@@ -2,7 +2,7 @@
description: Add the farming feature to your pool and reward LPs with an additional yield!
---
# 🧑‍🌾 Self-Service Farming
# 🚜 Self-Service Farming
{% hint style="warning" %}
You can only add farming to liquidity pools that you have created via the ALEX Self-Service Listing. If you don't have your own pool yet and want to create one, check the [Self-Service Listing](broken-reference) page to find out how.
@@ -10,7 +10,7 @@ You can only add farming to liquidity pools that you have created via the ALEX S
## 🚀 Getting started
### How does it work?
### How Does It Work?
* The pool owner creates the farm by specifying the number of cycles and depositing the total reward amount. These two inputs determine the rewards distributed per cycle, which are equal for each cycle.
* The pool's liquidity providers stake their LP tokens in the newly created farm, earning rewards at the end of each cycle, just like any other farm within the ALEX Lab Platform.
@@ -28,29 +28,29 @@ Before you start, familiarize yourself with the basic rules of Self-Service Farm
## 📝 Procedure
### Step 1
### Step 1: Go to the Farm Page
Go to the [Farms page](https://app.alexlab.co/farm) and click on the "Create" button.
Go to the [Farm page](https://app.alexlab.co/farm) and click on the "Create" button.
<figure><img src="../.gitbook/assets/self-service-farming/create-farm-button.png" alt="" width="563"><figcaption></figcaption></figure>
In this guide we are assuming that you already have a pool, so select the "Creating a new farm" option and click "Continue".
In this guide we are assuming that you already have a pool, so select the `Creating a new farm` option and click `Continue`.
<figure><img src="../.gitbook/assets/self-service-farming/create-type-new-farm.png" alt="" width="375"><figcaption></figcaption></figure>
### Step 2
### Step 2: Select a Pool
Select a pool from the ones you've created.
<figure><img src="../.gitbook/assets/self-service-farming/step-1-select-a-pool.png" alt=""><figcaption></figcaption></figure>
### Step 3
### Step 3: Enter Rewards to Be Distributed
Enter the total amount of rewards that will be distributed in your farm. This amount is deposited at farm creation. Also, remember that in Self-Service Farming, the reward token has to be the same as the listing token.
<figure><img src="../.gitbook/assets/self-service-farming/enter-total-rewards-amount.png" alt=""><figcaption></figcaption></figure>
### Step 4
### Step 4: Enter Cycle Length and Amount
Select the **Reward Cycle Length**, which is the number of cycles in which your farm will be active and distributing rewards. This number, along with the total farming rewards, determines the **Est. Farming Rewards Per Cycle**.
@@ -72,15 +72,15 @@ If the user submits, the farm will be created at Cycle #80, leaving 33 blocks fo
If the user decides to proceed, the **Farm Opening Cycle** will run from Cycle #81 to Cycle #90, lasting approximately 35 days.
### Step 5
### Step 5: Confirm Rewards Submission
Once you're ready to move ahead, select the "Submit Rewards" button which will bring up the Confirmation panel. This panel provides a final overview of the farm creation, allowing you to double-check the total rewards and the farm opening period. If everything looks good, click "Confirm" 😎.
Once you're ready to move ahead, select the `Submit Rewards` button which will bring up the Confirmation panel. This panel provides a final overview of the farm creation, allowing you to double-check the total rewards and the farm opening period. If everything looks good, click `Confirm` 😎.
<figure><img src="../.gitbook/assets/self-service-farming/farm-create-confirmation-panel.png" alt="" width="371"><figcaption></figcaption></figure>
### Step 6
### Step 6: Confirm the Transaction in Your Wallet
After clicking "Confirm", you will need to confirm the transaction in your wallet. Here, your Stacks wallet is interacting with ALEX smart contract and is asking you for approval. Remember, in this farm creation transaction, you are transferring the total amount of rewards to the ALEX smart contract.
After clicking `Confirm`, you will need to confirm the transaction in your wallet. Here, your Stacks wallet is interacting with ALEX smart contract and is asking you for approval. Remember, in this farm creation transaction, you are transferring the total amount of rewards to the ALEX smart contract.
Scroll through the wallet transaction window, review it and confirm the transaction. By doing this, you are allowing the wallet to sign and broadcast the transaction.
@@ -91,7 +91,7 @@ To be completely sure, you can check:
* The transfer amount, covered by [Stacks post conditions](https://docs.stacks.co/stacks-101/post-conditions). Note that the amount you transfer to the smart contract is exactly determined (DOGGY in the example). If this condition is not met, the transaction will abort.
{% endhint %}
### Step 7
### Step 7: Wait for Transaction Confirmation
Wait for the transaction to be confirmed on the network.
@@ -103,7 +103,7 @@ Recommended to track transaction status:
* Check your address activity on the wallet.
{% endhint %}
### Step 8
### Step 8: Check Successful Farm Creation
Once the transaction is completed, your farm will have been successfully created. Your farm will appear on the [Farms](https://app.alexlab.co/farm) page and from that moment is open to the first farmers who want to join during the gathering period.

22
docs/product-features/self-service-listing.md
View File

@@ -12,7 +12,7 @@ description: >-
## 🚀 Getting Started
### How does it work?
### How Does It Work?
Self-Service Listing allows you to **create your own liquidity pool** on the ALEX DEX, enabling the **permissionless trade** of the **listed token** with an **anchor token** within the exchange. The anchor token is typically one with a stable value, providing a reliable reference point for defining the price of the newly listed token.
@@ -64,7 +64,7 @@ Head to the [Self-Service Listing page](https://app.alexlab.co/self-service-list
<figure><img src="../.gitbook/assets/self-service-listing/main-page.png" alt="Self-Service Listing page"><figcaption></figcaption></figure>
### Step 1: Submit token information & deposit the anchor token
### Step 1: Submit Token Information and Deposit the Anchor Token
In this step, you will set up the pool trading pair and configuration parameters. As part of this same transaction, you will transfer the anchor token's initial liquidity :moneybag: :anchor:.
@@ -72,7 +72,7 @@ In this step, you will set up the pool trading pair and configuration parameters
<details>
<summary>Step 1.1: Input the SIP-10 token contract address</summary>
<summary>Step 1.1: Input the SIP-10 Token Contract Address</summary>
Provide the listed token contract address. Ensure it complies with the [SIP-010 Fungible Token Standard](https://github.com/stacksgov/sips/blob/main/sips/sip-010/sip-010-fungible-token-standard.md) trait. In the example, the contract address is `SP108J6F4C7JD93BGJ91TEB5D3CFB5XW39QHDJ3MV.rabby-token`.
@@ -80,7 +80,7 @@ Provide the listed token contract address. Ensure it complies with the [SIP-010
<details>
<summary>Step 1.2: Confirm token information provided by the contract</summary>
<summary>Step 1.2: Confirm Token Information Provided by the Contract</summary>
Verify that the token information retrieved from the contract is correct. In the example:
@@ -94,7 +94,7 @@ Verify that the token information retrieved from the contract is correct. In the
<details>
<summary>Step 1.3: Set the initial liquidity and price</summary>
<summary>Step 1.3: Set the Initial Liquidity and Price</summary>
Enter the initial balances for both tokens. You can experiment with different amounts to observe how the exchange rate changes, though we recommend calculating these values beforehand.
@@ -110,7 +110,7 @@ Once the pool opens, the AMM algorithm will automatically rebalance the exchange
<details>
<summary>Step 1.4: Advanced pool settings (optional)</summary>
<summary>Step 1.4: Advanced Pool Settings (Optional)</summary>
This step is optional, as the default settings are usually sufficient.
@@ -120,7 +120,7 @@ However, we recommend consulting the [ALEXGo Technical documentation](https://do
<details>
<summary>Step 1.5: Submit transaction</summary>
<summary>Step 1.5: Submit Transaction</summary>
Keep in mind that as part of this same transaction, you will transfer the anchor token's initial liquidity. By confirming the transaction, you are accepting the transfer of specific amount of anchor tokens from your wallet to the ALEX smart contract.
@@ -148,15 +148,15 @@ After submitting the Self-Service Listing Pool, a pop-up will appear, allowing t
In case of locking or burning tokens, there will be a highlighted banner that displays the setting selected by the pool creator. This way, liquidity providers will know if the initial LP tokens have been locked or burnt, or if neither option has been applied.
### Step 3: Contract creation
### Step 3: Contract Creation
Once the transaction you executed in Step 1 is completed, you will see the checkbox labeled `Deposit Anchor Token ✅` marked as done. The ALEX team will review the submitted information and create a specific contract (a wrapped version) for your token to interact with the AMM DEX. This process may take between 24 and 48 hours.
### Step 4: Deposit listing token
### Step 4: Deposit Listing Token
Once the `Contract ready ✅` checkbox is marked as done, you're ready to deposit the listing token balance. This step involves interacting with a smart contract, so be sure to review the transaction details, paying particular attention to the amount to transfer. By accepting this transaction, you agree to transfer the initial liquidity of the listing token from your wallet to the ALEX smart contract.
### Step 5: Pool creation success
### Step 5: Pool Creation Success
Once the `Deposit Listing Token ✅` transaction is completed and the `Open pool ✅` checkbox is marked as done, your pool will be automatically ready for use. The new pool will appear as an ALEX Pool under the `Self Listed` tab on [app.alexlab.co/pool](https://app.alexlab.co/pool).
@@ -168,7 +168,7 @@ Once the `Deposit Listing Token ✅` transaction is completed and the `Open pool
If you have added a custom `start-block` configuration, the pool will be unavailabe until that block is reached.
{% endhint %}
### Step 6: Provide additional token information (optional)
### Step 6: Provide Additional Token Information (Optional)
To make your token visible on the ALEX Token List at [app.alexlab.co/token-list](https://app.alexlab.co/token-list), provide additional token information. Click on `Customer Support` on the [Self-Service Listing page](https://app.alexlab.co/self-service-listing) or contact us via Telegram at [t.me/ALEXselfservice ](https://t.me/ALEXselfservice)to submit the information (e.g. X accont, Discord, official website).

22
docs/product-features/stacks-swaps/how-to.md
View File

@@ -2,21 +2,21 @@
description: This guide will showcase how to swap two tokens on ALEX Lab App.
---
# 🧑‍🏫 How to swap
# 🧑‍🏫 How to Swap
When performing a token swap, you transfer an amount of the token you want to exchange (base token) to the ALEX smart contract. In return, you receive a pre-agreed amount of the desired token (target token) from the ALEX smart contract, all within a single swap transaction. The resulting balance changes will be reflected in your wallet.
That said, let's get hands-on!
## :currency\_exchange: :moneybag: Trade one token for another
## :currency\_exchange: :moneybag: Trade One Token for Another
### Step 1
### Step 1: Head to the Stacks Swap Page
Go to [https://app.alexlab.co/](https://app.alexlab.co/) to see the Swap panel. You can also navigate to it by clicking the "Swap" tab on the top menu bar.
<div><figure><img src="../../.gitbook/assets/stacks-swaps/1-swap-panel.png" alt="" width="375"><figcaption></figcaption></figure> <figure><img src="../../.gitbook/assets/stacks-swaps/1-swap-tab.png" alt="" width="375"><figcaption></figcaption></figure></div>
### Step 2
### Step 2: Select Token Pair
Select the tokens you want to exchange and the amount.
@@ -34,7 +34,7 @@ Clicking the "Max" button will automatically set the amount to your total availa
<figure><img src="../../.gitbook/assets/stacks-swaps/2-select-token.png" alt="" width="375"><figcaption><p>Token search and selection panel.</p></figcaption></figure>
### Step 3
### Step 3: Check Transaction Details
#### Transaction Details
@@ -56,15 +56,15 @@ If you want to adjust slippage tolerance, select the "Settings" icon to open the
<figure><img src="../../.gitbook/assets/stacks-swaps/3-tx-settings.png" alt="" width="375"><figcaption><p>Transaction Settings panel example, with slippage tolerance set to 2%.</p></figcaption></figure>
### Step 4
### Step 4: Confirm the Swap
Once you're ready to move ahead, select the "Swap" button which will bring up the Confirmation panel. This panel provides a final overview of your transaction details, allowing you to double-check price, route, fees and slippage. If everything looks good, click "Confirm" 😎.
Once you're ready to move ahead, select the `Swap` button which will bring up the Confirmation panel. This panel provides a final overview of your transaction details, allowing you to double-check price, route, fees and slippage. If everything looks good, click "Confirm" 😎.
<figure><img src="../../.gitbook/assets/stacks-swaps/4-confirmation-panel.png" alt="" width="375"><figcaption></figcaption></figure>
### Step 5
### Step 5: Confirm the Transaction in Your Wallet
After clicking "Confirm", you will need to confirm the transaction in your wallet. Here, your Stacks wallet is interacting with ALEX smart contract and is asking you for approval. Scroll through the wallet transaction window, review it and confirm the transaction. By doing this, you are allowing the wallet to sign and broadcast the transaction.
After clicking `Confirm`, you will need to confirm the transaction in your wallet. Here, your Stacks wallet is interacting with ALEX smart contract and is asking you for approval. Scroll through the wallet transaction window, review it and confirm the transaction. By doing this, you are allowing the wallet to sign and broadcast the transaction.
{% hint style="info" %}
To be completely sure, you can check:
@@ -77,7 +77,7 @@ To be completely sure, you can check:
<div><figure><img src="../../.gitbook/assets/stacks-swaps/5-swap-helper-post-con.png" alt="" width="375"><figcaption><p>Transfer amounts involved and post conditions.</p></figcaption></figure> <figure><img src="../../.gitbook/assets/stacks-swaps/5-swap-helper-function-args.png" alt="" width="375"><figcaption><p>Function arguments and confirmation button.</p></figcaption></figure></div>
### Step 6 <a href="#step-7" id="step-7"></a>
### Step 6: Wait for Transaction Confirmation <a href="#step-7" id="step-7"></a>
Wait for the transaction to be confirmed on the network.
@@ -93,7 +93,7 @@ Recommended to track transaction status:
<div><figure><img src="../../.gitbook/assets/stacks-swaps/6-leather-tx-pending.png" alt="" width="375"><figcaption><p>Transaction pending displayed on Leather wallet.</p></figcaption></figure> <figure><img src="../../.gitbook/assets/stacks-swaps/6-leather-tx-success.png" alt="" width="375"><figcaption><p>Transaction completed, token transfers are visible.</p></figcaption></figure></div>
### Step 7
### Step 7: Check the Updated Balance
Once the transaction is completed, you will see the balance updated in your wallet.

4
docs/product-features/staking/README.md
View File

@@ -31,7 +31,9 @@ ALEX provides two different forms of staking to suit every user's need.
## Explore
{% content-ref url="key-concepts.md" %} [key-concepts.md](key-concepts.md) {% endcontent-ref %}
{% content-ref url="how-to.md" %} [how-to.md](how-to.md) {% endcontent-ref %}
{% content-ref url="how-to-stake.md" %} [how-to-stake.md](how-to-stake.md) {% endcontent-ref %}
{% content-ref url="how-to-harvest.md" %} [how-to-harvest.md](how-to-harvest.md) {% endcontent-ref %}
{% content-ref url="how-to-auto-stake.md" %} [how-to-auto-stake.md](how-to-auto-stake.md) {% endcontent-ref %}
{% content-ref url="faqs.md" %} [faqs.md](faqs.md) {% endcontent-ref %}
## Support

74
docs/product-features/staking/how-to-auto-stake.md Normal file
View File

@@ -0,0 +1,74 @@
## :chart_with_upwards_trend: Auto Stake (Liquid Staking)
Once your first staking cycle has concluded, you will have the option to continue earning rewards via **Auto Staking**. Auto Staking allows you to earn rewards while maintaining liquidity as you receive LiALEX in exchange for your stake. You can start liquid staking directly from the [LISA Lab Homepage](https://app.lisalab.io/li/alex/staking), or from the [ALEX Lab Homepage](https://app.alexlab.co/stake) if you've manually staked before. This section explains how to start liquid staking your rewards from manual staking. For more information, you can refer to the [Key Concepts](key-concepts.md) section.
### Step 1: Check My Staking
Head to the [Stake page](https://app.alexlab.co/stake), or, alternatively, click on the navbar's `Earn` -> `Stake` tab from the [ALEX Labs homepage](https://app.alexlab.co).
Once you're on the Stake page, you'll find the **My Staking** panel, which displays your current stake.
### Step 2: Auto Stake Your Principal and Your Rewards
If a cycle has ended and you can claim rewards, you will see the amount of claimable $ALEX and APower on the `Harvest` button. If you have no rewards to claim yet, the `Harvest` button will be greyed out.
Below the button, you will see the `Auto Stake` slider. Click on it if you wish to proceed to Liquid Staking and receive LiALEX in exchange for staking your rewards.
Bear in mind that, if your staking period has ended, `Auto Stake` will also stake your **Principal** (your original $ALEX stake) rather than just your rewards. It is not possible to auto stake only a portion of your principal or your rewards.
With the `Auto Stake` slider in green, click on the `Harvest` button to stake your rewards.
<div>
<figure><img src="../../.gitbook/assets/staking/stake-harvest-lialex.png" alt=""><figcaption>Selected Auto Stake in "My Staking"</figcaption></figure>
</div>
### Step 3: Confirm Auto Stake
A confirmation panel will appear where you can double check the amount. If everything looks correct, click `Confirm`.
<figure><img src="../../.gitbook/assets/staking/stake-harvest-auto-confirm.png" alt=""><figcaption><p></p></figcaption></figure>
#### Confirm Harvest
* **Harvest:** The amount of staked $ALEX that will be auto staked and the amount of APower that you have earned by staking. &#x20;
* **Auto Stake (receive):** The amount of LiALEX tokens you will receive in exchange for continuing to stake your $ALEX. This allows you the benefit of maintaining liquidity while continuing to earn staking rewards.
* **Stake Price:** The price of LiALEX relative to $ALEX.
* **Total Claim:** The amount of LiALEX and APower that will be transferred to your wallet. Your ALEX tokens will continue being staked.
### Step 4: Confirm Transaction
After clicking `Confirm`, you will need to confirm the transaction in your wallet.
Here, your Stacks wallet is interacting with the ALEX smart contract and is asking you for approval. Scroll through the wallet transaction window, review it and confirm the transaction. By doing this, you are allowing the wallet to sign and broadcast the transaction.
<figure><img src="../../.gitbook/assets/staking/stake-harvest-auto-wallet.png" alt="" width="375"><figcaption><p>Transaction preview displayed on Leather wallet</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/staking/stake-harvest-auto-wallet-2.png" alt="" width="375"><figcaption><p>Function arguments and confirmation button</p></figcaption></figure>
### Step 5: Confirm Transaction on Your Wallet
Wait for the transaction to be confirmed on the network.
Your LiALEX could take between 20-40 minutes to appear on the [Stake page](https://app.alexlab.co/stake), but once the transaction is confirmed on the ALEX network, you will be able to see your staked tokens in the **My Staking** section.
<figure><img src="../../.gitbook/assets/staking/stake-harvest-auto-done.png" alt=""><figcaption>Your LiALEX in "My Staking"</figcaption></figure>
Note that Liquid Staking does not have a cooldown period, meaning your tokens start earning rewards from the current cycle onward. For more information, please refer to the [Staking FAQs](./faqs.md).
{% hint style="info" %}
Recommended to track transaction status:
* Turn on [Telegram notifications](https://t.me/stacks\_tx\_notification\_bot), you will get notified when the transaction is confirmed.
* Search for the transaction on the [ALEX Explorer](https://app.alexlab.co/explorer).
* Check your address activity on the wallet.
{% endhint %}
<div>
<figure><img src="../../.gitbook/assets/liquidity-providers/removing-liquidity-7-tg-tx-pending.png" alt="" width="344"><figcaption><p>Telegram message with transaction pending status.</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/liquidity-providers/removing-liquidity-7-tg-tx-success.png" alt="" width="361"><figcaption><p>Telegram message with transaction success status.</p></figcaption></figure>
</div>

64
docs/product-features/staking/how-to-harvest.md Normal file
View File

@@ -0,0 +1,64 @@
# :moneybag: Harvesting Rewards (Manual Staking)
Once your first staking cycle ends, you will be able to start harvesting your rewards. This section explains how to transfer your rewards to your wallet. To proceed to Liquid Staking with LiALEX, refer to the [Auto-Stake section](how-to.md#auto-stake-liquid-staking).
### Step 1: Check My Staking
As when staking, go to the [Stake page](https://app.alexlab.co/stake), or, alternatively, click on the navbar's `Earn` -> `Stake` tab from the [ALEX Lab homepage](https://app.alexlab.co).
Once you're on the Stake page, you'll find the **My Staking** panel, which displays your current stake.
### Step 2: Harvest Your Principal and Your Rewards
If a cycle has ended and you can claim rewards, you will see your \$ALEX and APower on the `Harvest` button. If you have no rewards to claim yet, `Harvest` will be greyed out. The button will also display the amount of $ALEX and APower that are available for harvesting.
Bear in mind that, if your staking period has ended, harvesting will also transfer your **Principal** (your staked $ALEX), to your wallet. It is not possible to collect only a portion of your principal or your rewards.
Click on the `Harvest` button to claim your rewards.
<figure><img src="../../.gitbook/assets/staking/stake-harvest.png" alt=""><figcaption><p></p></figcaption></figure>
### Step 3: Confirm Harvest
A confirmation panel will appear where you can double check the amount. If everything looks correct, click `Confirm`.
<figure><img src="../../.gitbook/assets/staking/stake-harvest-confirm.png" alt=""><figcaption><p></p></figcaption></figure>
#### Confirm Harvest
* **Principal:** This is the amount of staked \$ALEX that is no longer locked-up and can be transferred to your wallet. If you've staked 100 ALEX tokens for 4 cycles, and only the first cycle has ended, you will be able to harvest your rewards for that cycle while staked $ALEX remain locked-up for 3 more cycles. Hence, the principal would be 0 for this case. However, after the 4th cycle, the principal would be 100. &#x20;
* **Reward:** The amount of ALEX tokens and APower you can claim as a reward for staking your $ALEX tokens. If you don't harvest your rewards, they will continue to accumulate.
* **Total Claim:** The sum of your principal and rewards, in $ALEX and APower. This is the amount that will be transferred to your wallet.
### Step 4: Confirm Transaction
After clicking `Confirm`, you will need to confirm the transaction in your wallet.
Here, your Stacks wallet is interacting with the ALEX smart contract and is asking you for approval. Scroll through the wallet transaction window, review it and confirm the transaction. By doing this, you are allowing the wallet to sign and broadcast the transaction.
<figure><img src="../../.gitbook/assets/staking/stake-harvest-confirm-wallet.png" alt="" width="344"><figcaption><p>Transaction preview displayed on Leather wallet</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/staking/stake-harvest-wallet-confirm-2.png" alt="" width="344"><figcaption><p>Function arguments and confirmation button</p></figcaption></figure>
### Step 5: Check Transaction Status
Wait for the transaction to be confirmed on the network.
Transferring your rewards and staked tokens could take between 20-40 minutes, but once the transaction is confirmed on the ALEX network, you will be able to see your rewards in your wallet.
{% hint style="info" %}
Recommended to track transaction status:
* Turn on [Telegram notifications](https://t.me/stacks\_tx\_notification\_bot), you will get notified when the transaction is confirmed.
* Search for the transaction on the [ALEX Explorer](https://app.alexlab.co/explorer).
* Check your address activity on the wallet.
{% endhint %}
<div>
<figure><img src="../../.gitbook/assets/liquidity-providers/removing-liquidity-7-tg-tx-pending.png" alt="" width="344"><figcaption><p>Telegram message with transaction pending status.</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/liquidity-providers/removing-liquidity-7-tg-tx-success.png" alt="" width="361"><figcaption><p>Telegram message with transaction success status.</p></figcaption></figure>
</div>

77
docs/product-features/staking/how-to-stake.md Normal file
View File

@@ -0,0 +1,77 @@
# 🧑‍🏫 How to Stake on ALEX
Staking on ALEX requires a few easy steps. In short, it consists of locking up your tokens temporarily to earn rewards. In staking, time is measured in cycles, and at the end of each cycle, you will be able to harvest your rewards. At that point, you may choose to transfer rewards to your wallet or to proceed to Liquid Staking with LiALEX.
### Step 1: Connect Stacks Wallet
If you haven't already, the first step is to connect your wallet to ALEX. Go to the [Stake page](https://app.alexlab.co/stake) and under the **My Staking** section, press the `Connect stacks wallet` button. After performing the corresponding validation, **My Staking** will display.
You can always change your wallet configuration from the `Wallet Manager` in the top right corner.
<figure><img src="../../.gitbook/assets/staking/stake-wallet.png" alt=""><figcaption>Stake homepage</figcaption></figure>
### Step 2: My Staking
In **My Staking**, **Manual Staking** will indicate how much ALEX you're currently staking, along with its estimated Annual Percentage Rate (APR). Bear in mind that, unlike Annual Percentage Yield (APY), APR doesn't take into account the compounding effect of rewards.
On the right-hand side of **My Staking**, you will see the **Cycles** section, which indicates how much time is left for the upcoming cycle, as well as the number of the current one. You can expand this section to display **All Cycles**. The timer indicates how much time is left of the current cycle. Bear in mind that your tokens will be staked on the upcoming cycle for the first time.
<figure><img src="../../.gitbook/assets/staking/stake-my-staking.png" alt=""><figcaption>"My Staking" panel</figcaption></figure>
#### Staking Metrics
* **Manual Staking:** The amount of $ALEX you are currently staking.&#x20;
* **APR:** The Annual Percentage Rate of your investment. It is the interest you would earn by staking for one year.
* **Liquid Staking:** The amount of $ALEX you are currently staking through LISA.
* **APY:** The Annual Percentage Yield of your investment. It is the interest you would earn by staking for one year, including compounding interest from re-staking your rewards.
* **APower to be Distributed:** The amount of APower you will earn as a result of your investment.
#### Cycles
* **Cycles:** The number of the current cycle, as well as the numbers of the two upcoming cycles.
* **Liquid Staking:** The amount of $ALEX you will be staking through LISA for each cycle as a result of your investments so far.
* **Manual Staking:** The amount of $ALEX you will be manually staking for each cycle as a result of your investments so far.
By pressing `Proceed to LISA to Stake` you will open the dashboard for liquid staking on LISA. For more information, you can consult the [LISA Staking Guide](https://docs.lisalab.io/features-how-tos/staking-stacking).
Once you've verified your current balances, APR, APY and cycle timing, you can proceed to the next step.
### Step 3: Add ALEX Staking
Select how much $ALEX you wish to stake and for how long. You can use the slider to personalize the amount of cycles, and you will see an estimate of how many days the selected amount of cycles will last. If you wish to stake ALEX tokens for different periods of time, you will need to execute two transactions. For example, if you wish to stake 100 ALEX for 8 cycles and 80 ALEX for 24 cycles, you will need to follow these steps twice.
<figure><img src="../../.gitbook/assets/staking/stake-settings-preview.png" alt=""><figcaption>"Add ALEX Staking" panel</figcaption></figure>
The `MAX` button will stake your entire balance.
In **Staking Details** you can see the numbers of the cycles you'll be staking for under your current settings, along with the corresponding "Start" and "End" blocks on the Stacks network. Afterwards, click `Stake` to begin staking.
### Step 4: Confirm Staking
You will be prompted to confirm that the selected settings are correct. Please verify the information on the pop-up window and press `Confirm` to continue.
<figure><img src="../../.gitbook/assets/staking/stake-confirm.png" alt=""><figcaption></figcaption></figure>
### Step 5: Confirm Transaction on Your Wallet
Your Stacks wallet will ask you to confirm the transaction. After that, wait for your transaction to be confirmed on the network.
<figure><img src="../../.gitbook/assets/farming/stake-tokens-function-args.png" alt="" width="375"><figcaption><p>Wallet pop-up with function arguments and confirmation button.</p></figcaption></figure>
A `Transaction Mining...` pop-up should appear on the top right corner of your screen, followed by `Transaction Successful` a few moments later.
### Step 6: Check Transaction Status
Wait for the transaction to be confirmed on the network.
Your staked tokens could take between 20-40 minutes to appear on the [Stake page](https://app.alexlab.co/stake), but once the transaction is confirmed on the ALEX network, you will be able to see your staked tokens in the **My Staking** section.
<figure><img src="../../.gitbook/assets/staking/stake-done.png" alt=""><figcaption>Recently staked $ALEX in "My Staking" panel</figcaption></figure>
{% hint style="info" %}
Recommended to track transaction status:
* Turn on [Telegram notifications](https://t.me/stacks\_tx\_notification\_bot), you will get notified when the transaction is confirmed.
* Search for the transaction on the [ALEX Explorer](https://app.alexlab.co/explorer).
* Check your address activity on the wallet.
{% endhint %}

217
docs/product-features/staking/how-to.md
View File

@@ -1,217 +0,0 @@
# 🧑‍🏫 How to Stake on ALEX
Staking on ALEX requires a few easy steps. In short, it consists of locking up your tokens temporarily to earn rewards. In staking, time is measured in cycles, and at the end of each cycle, you will be able to harvest your rewards. At that point, you may choose to transfer rewards to your wallet or to proceed to Liquid Staking with LiALEX.
## :anchor: Staking Your $ALEX
### Step 1: Connect Stacks Wallet
If you haven't already, the first step is to connect your wallet to ALEX. Go to the [Stake page](https://app.alexlab.co/stake) and under the **My Staking** section, press the `Connect stacks wallet` button. After performing the corresponding validation, **My Staking** will display.
You can always change your wallet configuration from the `Wallet Manager` in the top right corner.
<figure><img src="../../.gitbook/assets/staking/stake-wallet.png" alt=""><figcaption>Stake homepage</figcaption></figure>
### Step 2: My Staking
In **My Staking**, **Manual Staking** will indicate how much ALEX you're currently staking, along with its estimated Annual Percentage Rate (APR). Bear in mind that, unlike Annual Percentage Yield (APY), APR doesn't take into account the compounding effect of rewards.
On the right-hand side of **My Staking**, you will see the **Cycles** section, which indicates how much time is left for the upcoming cycle, as well as the number of the current one. You can expand this section to display **All Cycles**. The timer indicates how much time is left of the current cycle. Bear in mind that your tokens will be staked on the upcoming cycle for the first time.
<figure><img src="../../.gitbook/assets/staking/stake-my-staking.png" alt=""><figcaption>"My Staking" panel</figcaption></figure>
#### Staking Metrics
* **Manual Staking:** The amount of $ALEX you are currently staking.&#x20;
* **APR:** The Annual Percentage Rate of your investment. It is the interest you would earn by staking for one year.
* **Liquid Staking:** The amount of $ALEX you are currently staking through LISA.
* **APY:** The Annual Percentage Yield of your investment. It is the interest you would earn by staking for one year, including compounding interest from re-staking your rewards.
* **APower to be Distributed:** The amount of APower you will earn as a result of your investment.
#### Cycles
* **Cycles:** The number of the current cycle, as well as the numbers of the two upcoming cycles.
* **Liquid Staking:** The amount of $ALEX you will be staking through LISA for each cycle as a result of your investments so far.
* **Manual Staking:** The amount of $ALEX you will be manually staking for each cycle as a result of your investments so far.
By pressing `Proceed to LISA to Stake` you will open the dashboard for liquid staking on LISA. For more information, you can consult the [LISA Staking Guide](https://docs.lisalab.io/features-how-tos/staking-stacking).
Once you've verified your current balances, APR, APY and cycle timing, you can proceed to the next step.
### Step 3: Add ALEX Staking
Select how much $ALEX you wish to stake and for how long. You can use the slider to personalize the amount of cycles, and you will see an estimate of how many days the selected amount of cycles will last. If you wish to stake ALEX tokens for different periods of time, you will need to execute two transactions. For example, if you wish to stake 100 ALEX for 8 cycles and 80 ALEX for 24 cycles, you will need to follow these steps twice.
<figure><img src="../../.gitbook/assets/staking/stake-settings-preview.png" alt=""><figcaption>"Add ALEX Staking" panel</figcaption></figure>
The `MAX` button will stake your entire balance.
In **Staking Details** you can see the numbers of the cycles you'll be staking for under your current settings, along with the corresponding "Start" and "End" blocks on the Stacks network. Afterwards, click `Stake` to begin staking.
### Step 4: Confirm Staking
You will be prompted to confirm that the selected settings are correct. Please verify the information on the pop-up window and press `Confirm` to continue.
<figure><img src="../../.gitbook/assets/staking/stake-confirm.png" alt=""><figcaption></figcaption></figure>
### Step 5: Confirm Transaction on Your Wallet
Your Stacks wallet will ask you to confirm the transaction. After that, wait for your transaction to be confirmed on the network.
<figure><img src="../../.gitbook/assets/farming/stake-tokens-function-args.png" alt="" width="375"><figcaption><p>Wallet pop-up with function arguments and confirmation button.</p></figcaption></figure>
A `Transaction Mining...` pop-up should appear on the top right corner of your screen, followed by `Transaction Successful` a few moments later.
### Step 6: Check Transaction Status
Wait for the transaction to be confirmed on the network.
Your staked tokens could take between 20-40 minutes to appear on the [Stake page](https://app.alexlab.co/stake), but once the transaction is confirmed on the ALEX network, you will be able to see your staked tokens in the **My Staking** section.
<figure><img src="../../.gitbook/assets/staking/stake-done.png" alt=""><figcaption>Recently staked $ALEX in "My Staking" panel</figcaption></figure>
{% hint style="info" %}
Recommended to track transaction status:
* Turn on [Telegram notifications](https://t.me/stacks\_tx\_notification\_bot), you will get notified when the transaction is confirmed.
* Search for the transaction on the [ALEX Explorer](https://app.alexlab.co/explorer).
* Check your address activity on the wallet.
{% endhint %}
## :moneybag: Harvesting Rewards (Manual Staking)
Once your first staking cycle ends, you will be able to start harvesting your rewards. This section explains how to transfer your rewards to your wallet. To proceed to Liquid Staking with LiALEX, refer to the [Auto-Stake section](how-to.md#auto-stake-liquid-staking).
### Step 1: Check My Staking
As when staking, go to the [Stake page](https://app.alexlab.co/stake), or, alternatively, click on the navbar's `Earn` -> `Stake` tab from the [ALEX Lab homepage](https://app.alexlab.co).
Once you're on the Stake page, you'll find the **My Staking** panel, which displays your current stake.
### Step 2: Harvest Your Principal & Your Rewards
If a cycle has ended and you can claim rewards, you will see your \$ALEX and APower on the `Harvest` button. If you have no rewards to claim yet, `Harvest` will be greyed out. The button will also display the amount of $ALEX and APower that are available for harvesting.
Bear in mind that, if your staking period has ended, harvesting will also transfer your **Principal** (your staked $ALEX), to your wallet. It is not possible to collect only a portion of your principal or your rewards.
Click on the `Harvest` button to claim your rewards.
<figure><img src="../../.gitbook/assets/staking/stake-harvest.png" alt=""><figcaption><p></p></figcaption></figure>
### Step 3: Confirm Harvest
A confirmation panel will appear where you can double check the amount. If everything looks correct, click `Confirm`.
<figure><img src="../../.gitbook/assets/staking/stake-harvest-confirm.png" alt=""><figcaption><p></p></figcaption></figure>
#### Confirm Harvest
* **Principal:** This is the amount of staked \$ALEX that is no longer locked-up and can be transferred to your wallet. If you've staked 100 ALEX tokens for 4 cycles, and only the first cycle has ended, you will be able to harvest your rewards for that cycle while staked $ALEX remain locked-up for 3 more cycles. Hence, the principal would be 0 for this case. However, after the 4th cycle, the principal would be 100. &#x20;
* **Reward:** The amount of ALEX tokens and APower you can claim as a reward for staking your $ALEX tokens. If you don't harvest your rewards, they will continue to accumulate.
* **Total Claim:** The sum of your principal and rewards, in $ALEX and APower. This is the amount that will be transferred to your wallet.
### Step 4: Confirm Transaction
After clicking `Confirm`, you will need to confirm the transaction in your wallet.
Here, your Stacks wallet is interacting with the ALEX smart contract and is asking you for approval. Scroll through the wallet transaction window, review it and confirm the transaction. By doing this, you are allowing the wallet to sign and broadcast the transaction.
<figure><img src="../../.gitbook/assets/staking/stake-harvest-confirm-wallet.png" alt="" width="344"><figcaption><p>Transaction preview displayed on Leather wallet</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/staking/stake-harvest-wallet-confirm-2.png" alt="" width="344"><figcaption><p>Function arguments and confirmation button</p></figcaption></figure>
### Step 5: Check Transaction Status
Wait for the transaction to be confirmed on the network.
Transferring your rewards and staked tokens could take between 20-40 minutes, but once the transaction is confirmed on the ALEX network, you will be able to see your rewards in your wallet.
{% hint style="info" %}
Recommended to track transaction status:
* Turn on [Telegram notifications](https://t.me/stacks\_tx\_notification\_bot), you will get notified when the transaction is confirmed.
* Search for the transaction on the [ALEX Explorer](https://app.alexlab.co/explorer).
* Check your address activity on the wallet.
{% endhint %}
<div>
<figure><img src="../../.gitbook/assets/liquidity-providers/removing-liquidity-7-tg-tx-pending.png" alt="" width="344"><figcaption><p>Telegram message with transaction pending status.</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/liquidity-providers/removing-liquidity-7-tg-tx-success.png" alt="" width="361"><figcaption><p>Telegram message with transaction success status.</p></figcaption></figure>
</div>
## :chart_with_upwards_trend: Auto Stake (Liquid Staking)
### Step 1: Check My Staking
Head to the [Stake page](https://app.alexlab.co/stake), or, alternatively, click on the navbar's `Earn` -> `Stake` tab from the [ALEX Labs homepage](https://app.alexlab.co).
Once you're on the Stake page, you'll find the **My Staking** panel, which displays your current stake.
### Step 2: Auto Stake Your Principal & Your Rewards
If a cycle has ended and you can claim rewards, you will see the amount of claimable $ALEX and APower on the `Harvest` button. If you have no rewards to claim yet, the `Harvest` button will be greyed out.
Below the button, you will see the `Auto Stake` slider. Click on it if you wish to proceed to Liquid Staking and receive LiALEX in exchange for staking your rewards.
Bear in mind that, if your staking period has ended, `Auto Stake` will also stake your **Principal** (your original $ALEX stake) rather than just your rewards. It is not possible to auto stake only a portion of your principal or your rewards.
With the `Auto Stake` slider in green, click on the `Harvest` button to stake your rewards.
<div>
<figure><img src="../../.gitbook/assets/staking/stake-harvest-lialex.png" alt=""><figcaption>Selected Auto Stake in "My Staking"</figcaption></figure>
</div>
### Step 3: Confirm Auto Stake
A confirmation panel will appear where you can double check the amount. If everything looks correct, click `Confirm`.
<figure><img src="../../.gitbook/assets/staking/stake-harvest-auto-confirm.png" alt=""><figcaption><p></p></figcaption></figure>
#### Confirm Harvest
* **Harvest:** The amount of staked $ALEX that will be auto staked and the amount of APower that you have earned by staking. &#x20;
* **Auto Stake (receive):** The amount of LiALEX tokens you will receive in exchange for continuing to stake your $ALEX. This allows you the benefit of maintaining liquidity while continuing to earn staking rewards.
* **Stake Price:** The price of LiALEX relative to $ALEX.
* **Total Claim:** The amount of LiALEX and APower that will be transferred to your wallet. Your ALEX tokens will continue being staked.
### Step 4: Confirm Transaction
After clicking `Confirm`, you will need to confirm the transaction in your wallet.
Here, your Stacks wallet is interacting with the ALEX smart contract and is asking you for approval. Scroll through the wallet transaction window, review it and confirm the transaction. By doing this, you are allowing the wallet to sign and broadcast the transaction.
<figure><img src="../../.gitbook/assets/staking/stake-harvest-auto-wallet.png" alt="" width="375"><figcaption><p>Transaction preview displayed on Leather wallet</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/staking/stake-harvest-auto-wallet-2.png" alt="" width="375"><figcaption><p>Function arguments and confirmation button</p></figcaption></figure>
### Step 5: Confirm Transaction on Your Wallet
Wait for the transaction to be confirmed on the network.
Your LiALEX could take between 20-40 minutes to appear on the [Stake page](https://app.alexlab.co/stake), but once the transaction is confirmed on the ALEX network, you will be able to see your staked tokens in the **My Staking** section.
<figure><img src="../../.gitbook/assets/staking/stake-harvest-auto-done.png" alt=""><figcaption>Your LiALEX in "My Staking"</figcaption></figure>
Note that Liquid Staking does not have a cooldown period, meaning your tokens start earning rewards from the current cycle onward. For more information, please refer to the [Staking FAQs](./faqs.md).
{% hint style="info" %}
Recommended to track transaction status:
* Turn on [Telegram notifications](https://t.me/stacks\_tx\_notification\_bot), you will get notified when the transaction is confirmed.
* Search for the transaction on the [ALEX Explorer](https://app.alexlab.co/explorer).
* Check your address activity on the wallet.
{% endhint %}
<div>
<figure><img src="../../.gitbook/assets/liquidity-providers/removing-liquidity-7-tg-tx-pending.png" alt="" width="344"><figcaption><p>Telegram message with transaction pending status.</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/liquidity-providers/removing-liquidity-7-tg-tx-success.png" alt="" width="361"><figcaption><p>Telegram message with transaction success status.</p></figcaption></figure>
</div>

2
docs/product-features/staking/key-concepts.md
View File

@@ -25,7 +25,7 @@ The APY (Annual Percentage Yield) reflects your potential earnings from staking
-->
### Cycles & Cooldown Period
### Cycles and Cooldown Period
Staking is measured in cycles. Cycles are **525 Stacks blocks** or about **3.5 days long**, and both manual and auto-staking receive rewards when each cycle concludes. When you decide to stake your ALEX tokens, you need to select the amount of cycles you wish to stake for. In the case of **Manual Staking**, your $ALEX won't be accessible during that period.

2
docs/resources/official-links.md
View File

@@ -43,7 +43,7 @@ description: >-
Chiente Hsu: [https://x.com/RuleBasedInvest](https://x.com/RuleBasedInvest)
<!-- Rachel: [https://twitter.com/rachel\_alexgo](https://twitter.com/rachel_alexgo) -->
Rachel: [https://twitter.com/rachel_alexgo](https://twitter.com/rachel_alexgo)
### Verified Tag on Discord for Team Authenticity&#x20;