From 038f4c6d8271fe57f2a67d838cd69464df74cfbe Mon Sep 17 00:00:00 2001 From: sofinico Date: Thu, 19 Dec 2024 09:36:26 +0100 Subject: [PATCH 1/9] fix: correct liquidity pools image rendering --- .../adding-liquidity-1-pool-tab.png | Bin .../adding-liquidity-2-select-pool.png | Bin .../adding-liquidity-3-pool-control-panel.png | Bin .../adding-liquidity-4-adjust-slippage.png | Bin .../adding-liquidity-4-settings-icon.png | Bin ...ding-liquidity-5-confirm-add-liquidity.png | Bin ...uidity-6-add-to-position-function-args.png | Bin ...g-liquidity-6-add-to-position-post-con.png | Bin .../adding-liquidity-7-leather-tx-pending.png | Bin .../adding-liquidity-7-leather-tx-success.png | Bin .../adding-liquidity-7-tg-tx-pending.png | Bin .../adding-liquidity-7-tg-tx-success.png | Bin .../adding-liquidity-7-tx-broadcasted.png | Bin .../adding-liquidity-8-my-liquidity.png | Bin .../faqs-pool-info-panel-fees.png | Bin ...ng-liquidity-1-my-liquidity-main-panel.png | Bin .../removing-liquidity-2-select-pool.png | Bin .../removing-liquidity-3-remove-tab.png | Bin .../removing-liquidity-4-enter-amount.png | Bin ...g-liquidity-5-confirm-remove-liquidity.png | Bin ...uidity-6-reduce-position-function-args.png | Bin ...g-liquidity-6-reduce-position-post-con.png | Bin ...emoving-liquidity-7-leather-tx-pending.png | Bin ...emoving-liquidity-7-leather-tx-success.png | Bin .../removing-liquidity-7-tg-tx-pending.png | Bin .../removing-liquidity-7-tg-tx-success.png | Bin .../removing-liquidity-8-my-liquidity.png | Bin docs/product-features/farming/how-to.md | 2 +- docs/product-features/liquidity-pools/faqs.md | 2 +- .../liquidity-pools/how-to.md | 44 +++++++++--------- 30 files changed, 24 insertions(+), 24 deletions(-) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-1-pool-tab.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-2-select-pool.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-3-pool-control-panel.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-4-adjust-slippage.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-4-settings-icon.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-5-confirm-add-liquidity.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-6-add-to-position-function-args.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-6-add-to-position-post-con.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-7-leather-tx-pending.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-7-leather-tx-success.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-7-tg-tx-pending.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-7-tg-tx-success.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-7-tx-broadcasted.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/adding-liquidity-8-my-liquidity.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/faqs-pool-info-panel-fees.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/removing-liquidity-1-my-liquidity-main-panel.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/removing-liquidity-2-select-pool.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/removing-liquidity-3-remove-tab.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/removing-liquidity-4-enter-amount.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/removing-liquidity-5-confirm-remove-liquidity.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/removing-liquidity-6-reduce-position-function-args.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/removing-liquidity-6-reduce-position-post-con.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/removing-liquidity-7-leather-tx-pending.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/removing-liquidity-7-leather-tx-success.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/removing-liquidity-7-tg-tx-pending.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/removing-liquidity-7-tg-tx-success.png (100%) rename docs/.gitbook/assets/{liquidity-providers => liquidity-pools}/removing-liquidity-8-my-liquidity.png (100%) diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-1-pool-tab.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-1-pool-tab.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-1-pool-tab.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-1-pool-tab.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-2-select-pool.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-2-select-pool.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-2-select-pool.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-2-select-pool.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-3-pool-control-panel.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-3-pool-control-panel.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-3-pool-control-panel.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-3-pool-control-panel.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-4-adjust-slippage.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-4-adjust-slippage.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-4-adjust-slippage.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-4-adjust-slippage.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-4-settings-icon.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-4-settings-icon.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-4-settings-icon.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-4-settings-icon.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-5-confirm-add-liquidity.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-5-confirm-add-liquidity.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-5-confirm-add-liquidity.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-5-confirm-add-liquidity.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-6-add-to-position-function-args.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-6-add-to-position-function-args.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-6-add-to-position-function-args.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-6-add-to-position-function-args.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-6-add-to-position-post-con.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-6-add-to-position-post-con.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-6-add-to-position-post-con.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-6-add-to-position-post-con.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-7-leather-tx-pending.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-7-leather-tx-pending.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-7-leather-tx-pending.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-7-leather-tx-pending.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-7-leather-tx-success.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-7-leather-tx-success.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-7-leather-tx-success.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-7-leather-tx-success.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-7-tg-tx-pending.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-7-tg-tx-pending.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-7-tg-tx-pending.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-7-tg-tx-pending.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-7-tg-tx-success.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-7-tg-tx-success.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-7-tg-tx-success.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-7-tg-tx-success.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-7-tx-broadcasted.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-7-tx-broadcasted.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-7-tx-broadcasted.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-7-tx-broadcasted.png diff --git a/docs/.gitbook/assets/liquidity-providers/adding-liquidity-8-my-liquidity.png b/docs/.gitbook/assets/liquidity-pools/adding-liquidity-8-my-liquidity.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/adding-liquidity-8-my-liquidity.png rename to docs/.gitbook/assets/liquidity-pools/adding-liquidity-8-my-liquidity.png diff --git a/docs/.gitbook/assets/liquidity-providers/faqs-pool-info-panel-fees.png b/docs/.gitbook/assets/liquidity-pools/faqs-pool-info-panel-fees.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/faqs-pool-info-panel-fees.png rename to docs/.gitbook/assets/liquidity-pools/faqs-pool-info-panel-fees.png diff --git a/docs/.gitbook/assets/liquidity-providers/removing-liquidity-1-my-liquidity-main-panel.png b/docs/.gitbook/assets/liquidity-pools/removing-liquidity-1-my-liquidity-main-panel.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/removing-liquidity-1-my-liquidity-main-panel.png rename to docs/.gitbook/assets/liquidity-pools/removing-liquidity-1-my-liquidity-main-panel.png diff --git a/docs/.gitbook/assets/liquidity-providers/removing-liquidity-2-select-pool.png b/docs/.gitbook/assets/liquidity-pools/removing-liquidity-2-select-pool.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/removing-liquidity-2-select-pool.png rename to docs/.gitbook/assets/liquidity-pools/removing-liquidity-2-select-pool.png diff --git a/docs/.gitbook/assets/liquidity-providers/removing-liquidity-3-remove-tab.png b/docs/.gitbook/assets/liquidity-pools/removing-liquidity-3-remove-tab.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/removing-liquidity-3-remove-tab.png rename to docs/.gitbook/assets/liquidity-pools/removing-liquidity-3-remove-tab.png diff --git a/docs/.gitbook/assets/liquidity-providers/removing-liquidity-4-enter-amount.png b/docs/.gitbook/assets/liquidity-pools/removing-liquidity-4-enter-amount.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/removing-liquidity-4-enter-amount.png rename to docs/.gitbook/assets/liquidity-pools/removing-liquidity-4-enter-amount.png diff --git a/docs/.gitbook/assets/liquidity-providers/removing-liquidity-5-confirm-remove-liquidity.png b/docs/.gitbook/assets/liquidity-pools/removing-liquidity-5-confirm-remove-liquidity.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/removing-liquidity-5-confirm-remove-liquidity.png rename to docs/.gitbook/assets/liquidity-pools/removing-liquidity-5-confirm-remove-liquidity.png diff --git a/docs/.gitbook/assets/liquidity-providers/removing-liquidity-6-reduce-position-function-args.png b/docs/.gitbook/assets/liquidity-pools/removing-liquidity-6-reduce-position-function-args.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/removing-liquidity-6-reduce-position-function-args.png rename to docs/.gitbook/assets/liquidity-pools/removing-liquidity-6-reduce-position-function-args.png diff --git a/docs/.gitbook/assets/liquidity-providers/removing-liquidity-6-reduce-position-post-con.png b/docs/.gitbook/assets/liquidity-pools/removing-liquidity-6-reduce-position-post-con.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/removing-liquidity-6-reduce-position-post-con.png rename to docs/.gitbook/assets/liquidity-pools/removing-liquidity-6-reduce-position-post-con.png diff --git a/docs/.gitbook/assets/liquidity-providers/removing-liquidity-7-leather-tx-pending.png b/docs/.gitbook/assets/liquidity-pools/removing-liquidity-7-leather-tx-pending.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/removing-liquidity-7-leather-tx-pending.png rename to docs/.gitbook/assets/liquidity-pools/removing-liquidity-7-leather-tx-pending.png diff --git a/docs/.gitbook/assets/liquidity-providers/removing-liquidity-7-leather-tx-success.png b/docs/.gitbook/assets/liquidity-pools/removing-liquidity-7-leather-tx-success.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/removing-liquidity-7-leather-tx-success.png rename to docs/.gitbook/assets/liquidity-pools/removing-liquidity-7-leather-tx-success.png diff --git a/docs/.gitbook/assets/liquidity-providers/removing-liquidity-7-tg-tx-pending.png b/docs/.gitbook/assets/liquidity-pools/removing-liquidity-7-tg-tx-pending.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/removing-liquidity-7-tg-tx-pending.png rename to docs/.gitbook/assets/liquidity-pools/removing-liquidity-7-tg-tx-pending.png diff --git a/docs/.gitbook/assets/liquidity-providers/removing-liquidity-7-tg-tx-success.png b/docs/.gitbook/assets/liquidity-pools/removing-liquidity-7-tg-tx-success.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/removing-liquidity-7-tg-tx-success.png rename to docs/.gitbook/assets/liquidity-pools/removing-liquidity-7-tg-tx-success.png diff --git a/docs/.gitbook/assets/liquidity-providers/removing-liquidity-8-my-liquidity.png b/docs/.gitbook/assets/liquidity-pools/removing-liquidity-8-my-liquidity.png similarity index 100% rename from docs/.gitbook/assets/liquidity-providers/removing-liquidity-8-my-liquidity.png rename to docs/.gitbook/assets/liquidity-pools/removing-liquidity-8-my-liquidity.png diff --git a/docs/product-features/farming/how-to.md b/docs/product-features/farming/how-to.md index 0de03b2..e0e22d7 100644 --- a/docs/product-features/farming/how-to.md +++ b/docs/product-features/farming/how-to.md @@ -50,7 +50,7 @@ Now that you've chosen a farm to stake in, you'll need LP tokens, which are obta 1. Click on the Pool tab in the top navigation bar. -
+
2. Find the pool that matches the **Trading Pair** you noted before. This is the liquidity pool linked to the farm you've selected. 3. Click on the pool. This will open the pool control panel, where you can add liquidity. diff --git a/docs/product-features/liquidity-pools/faqs.md b/docs/product-features/liquidity-pools/faqs.md index 04ec13e..70b3605 100644 --- a/docs/product-features/liquidity-pools/faqs.md +++ b/docs/product-features/liquidity-pools/faqs.md @@ -14,7 +14,7 @@ The **swap fee** is the total fee charged to users for executing a token swap. I On the other hand, the **fee rebate** is the portion of the swap fee that is distributed to liquidity providers as a reward for supplying liquidity to the pool. The remaining portion of the swap fee goes to the ALEX Lab Foundation. You can also find the fee rebate percentage in the Pool Info panel. -Pool Info panel, with highligthed "Fees" box +Pool Info panel, with highligthed "Fees" box diff --git a/docs/product-features/liquidity-pools/how-to.md b/docs/product-features/liquidity-pools/how-to.md index 5be03ac..48ee3c6 100644 --- a/docs/product-features/liquidity-pools/how-to.md +++ b/docs/product-features/liquidity-pools/how-to.md @@ -18,7 +18,7 @@ Ready to start? Let's get hands-on! Go to [https://app.alexlab.co/](https://app.alexlab.co/) and click on navbar's Swap -> Pool tab. -
+
### Step 2 @@ -31,7 +31,7 @@ All available pools will be displayed including information such as: Select the token pair to which you want to add liquidity from the displayed list. Note you can sort by pool metrics. -

Selected STX-ALEX liquidity pool as example.

+

Selected STX-ALEX liquidity pool as example.

{% hint style="warning" %} 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. @@ -45,7 +45,7 @@ When you set the amount for one token, the corresponding amount for the other to **Need tokens?** Visit the [Token Swaps](../token-swaps/) docs section and to learn how to exchange tokens on ALEX Lab platform. -

Control panel example for STX-ALEX liquidity pool. Amount is set to 4 STX and ALEX token amount is automatically determined.

+

Control panel example for STX-ALEX liquidity pool. Amount is set to 4 STX and ALEX token amount is automatically determined.

{% hint style="warning" %} Clicking the "Max" button will automatically set the amount to your total available balance. @@ -55,15 +55,15 @@ Clicking the "Max" button will automatically set the amount to your total availa 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. -

Transaction Settings icon.

+

Transaction Settings icon.

-

Transaction Settings panel example, with slippage tolerance set to 3%.

+

Transaction Settings panel example, with slippage tolerance set to 3%.

### Step 5 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: -
+
### Step 6 @@ -76,13 +76,13 @@ To be completely sure, you can check: * The amounts you will transfer to the smart contract, covered by [Stacks post conditions](https://docs.stacks.co/stacks-101/post-conditions). Note that one transfer amount is exactly determined (STX in the example) while the other is subject to a "less than or equal to" condition. This accounts the potential slippage variation, and here you can see the exact upper bound. If these conditions are not met, the transaction will abort. {% endhint %} -

Amounts to transfer and post conditions.

Function arguments and confirmation button.

+

Amounts to transfer and post conditions.

Function arguments and confirmation button.

### Step 7 Wait for the transaction to be confirmed on the network. -
+
{% hint style="info" %} Recommended to track transaction status: @@ -92,9 +92,9 @@ Recommended to track transaction status: * Check your address activity on the wallet. {% endhint %} -

Telegram message with transaction pending status.

Telegram message with transaction success status.

+

Telegram message with transaction pending status.

Telegram message with transaction success status.

-

Transaction pending displayed on Leather wallet.

Transaction completed, token transfers are visible.

+

Transaction pending displayed on Leather wallet.

Transaction completed, token transfers are visible.

### Step 8 @@ -105,7 +105,7 @@ After successfully adding liquidity, you will be able to see your LP tokens and * The **My Pool Share** shows how much of the overall pool you own, as a percentage. * The **Indicative Value** reflects the value of your holdings in USD, which can change based on the price action of the underlying assets. -

"My Liquidity" panel.

+

"My Liquidity" panel.

{% hint style="info" %} You can find the "My Liquidity" panel above the Liquidity Pool control panel (shown in Step 3). A summarized version is also available under the Swap -> Pool tab or at https://app.alexlab.co/pool. @@ -117,23 +117,23 @@ You can find the "My Liquidity" panel above the Liquidity Pool control panel (sh As when adding liquidity, go to [https://app.alexlab.co/](https://app.alexlab.co/) and click on navbar's Swap -> Pool tab. -
+
Once you're on the Pool page, you'll find the "My Liquidity" panel at the top of the pool list. This panel provides a summary of all your pool contributions. -

The pools where you are providing liquidity are displayed here. There is only one in this example.

+

The pools where you are providing liquidity are displayed here. There is only one in this example.

### Step 2 Select the pool you would like to remove liquidity from, either through the "My Liquidity" panel or directly from the pool list. -

STX-ALEX pool selection.

+

STX-ALEX pool selection.

### Step 3 Once in the panel of the pool, select the "Remove Liquidity" tab. -
+
### Step 4 @@ -143,25 +143,25 @@ When you enter the amount of LP tokens, you are specifiyng amount you will trans Once you have decided the LP token amount, click the "Remove" button. -

Example of removing all liquidity; the amount matches the LP token balance.

+

Example of removing all liquidity; the amount matches the LP token balance.

### Step 5 A confirmation panel will appear where you can double check the amount. If everything looks correct, click "Confirm" :sunglasses: -
+
### Step 6 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. -

Function arguments and confirmation button.

+

Function arguments and confirmation button.

### Step 7 Wait for the transaction to be confirmed on the network. -
+
{% hint style="info" %} Recommended to track transaction status: @@ -171,14 +171,14 @@ Recommended to track transaction status: * Check your address activity on the wallet. {% endhint %} -

Telegram message with transaction pending status.

Telegram message with transaction success status.

+

Telegram message with transaction pending status.

Telegram message with transaction success status.

-

Transaction pending displayed on Leather wallet.

Transaction completed, token transfers are visible.

+

Transaction pending displayed on Leather wallet.

Transaction completed, token transfers are visible.

### Step 8 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. -
+
[^1]: The APR metric is the same as the displayed in the Fee Rebate column on the previous step. From 1e37f02351cc06bd03ced7e1f4883590cbb7ccee Mon Sep 17 00:00:00 2001 From: Josh Date: Sat, 28 Dec 2024 08:59:45 +0000 Subject: [PATCH 2/9] GITBOOK-47: Josh's PR#10 Stake Change --- docs/product-features/staking/README.md | 35 ++- docs/product-features/staking/faqs.md | 59 ++++- docs/product-features/staking/how-to.md | 201 +++++++++++++++++- docs/product-features/staking/key-concepts.md | 38 +++- 4 files changed, 324 insertions(+), 9 deletions(-) diff --git a/docs/product-features/staking/README.md b/docs/product-features/staking/README.md index 006c731..5e0edf8 100644 --- a/docs/product-features/staking/README.md +++ b/docs/product-features/staking/README.md @@ -1,13 +1,36 @@ # ⚓ Stake -ALEX staking involves “locking up” your $ALEX token on the platform for an amount of time (”rewards cycles”) in exchange for earning protocol rewards. +Stake your ALEX tokens and start earning rewards! -You can think of $ALEX staking as depositing money into an interest-earning account. The longer you keep the money in the account the more interest you earn. Similarly, the longer you stake $ALEX the more rewards you earn. +ALEX staking involves "locking up" your ALEX tokens on the platform for an amount of time, measured in cycles, in exchange for protocol rewards. -ALEX provides manual(Customized) ALEX Staking. +You can think of $ALEX staking as depositing money into an interest-earning account: the longer you keep the money in the account, the more interest you earn. -Lisa Protocol([https://www.lisalab.io/](https://www.lisalab.io/)) is now providing liquid staking for ALEX Staking ($LiALEX) +Similarly, the longer you stake $ALEX, the more rewards you earn. The protocol rewards are provided in the form of more $ALEX and APower tokens. -The protocol rewards are provided in the form of more $ALEX as well as [$APower](https://medium.com/alexgobtc/what-is-alex-staking-power-and-how-do-i-use-it-1b3de3797fa2) which is only available to stakers to be used in the ALEX launchpad. +{% hint style="info" %} +**What is APower?** APower is the lottery ticket that allows you to take part in any future IDO rounds on our Launchpad. It is a non-transferrable and non-tradable token that is earned by staking. Learn more on the [FAQs](https://coinfabrik.gitbook.io/alexlab-doc/stake/features/staking/faqs#what-is-apower) page. +{% endhint %} -

ALEX Staking

+ALEX provides two different forms of staking to suit every user's need. + +* [**Manual Staking**](https://coinfabrik.gitbook.io/alexlab-doc/stake/features/staking/key-concepts#manual-staking): Stake $ALEX directly on the [ALEX Lab Platform](https://app.alexlab.co/stake). +* [**Liquid Staking**](https://coinfabrik.gitbook.io/alexlab-doc/stake/features/staking/key-concepts#liquid-staking): Stake $ALEX via LiALEX, powered by [LISA Protocol](https://www.lisalab.io/). + +### 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="faqs.md" %} +[faqs.md](faqs.md) +{% endcontent-ref %} + +### Support + +For assistance, please reach out to our Community Managers on [Discord](https://discord.com/invite/alexlab) and [Telegram Channel](https://t.me/AlexCommunity). You can also email us at [contact@alexgo.io](mailto:contact@alexgo.io). diff --git a/docs/product-features/staking/faqs.md b/docs/product-features/staking/faqs.md index ad852f9..d179fb4 100644 --- a/docs/product-features/staking/faqs.md +++ b/docs/product-features/staking/faqs.md @@ -1,3 +1,60 @@ # ❓ FAQs -Comming soon. +### How is Staking different from Farming? + +Staking involves locking cryptocurrency in a smart contract for a set amount of time in exchange for rewards. During that period, the tokens won't be accessible to the user. It is generally safer and the returns tend to be lower. + +Farming involves lending or staking crypto holdings in DeFi protocols to supply liquidity. The tokens must be deposited into a liquidity pool, and depositors receive LP tokens, representing their share of the pool. They can earn additional tokens by participating in DeFi activities such as lending, borrowing, or trading. + +You can also consult the [farming documentation](../farming/). + +### What is Harvesting? + +Harvesting refers to the act of **claiming your staking rewards**. When you claim your rewards, they are automatically transferred to your wallet. + +### **Can I only collect a portion of my rewards?** + +No. If your staking period has ended, all the rewards and APower you have accrued, as well as the $ALEX you've staked, will be transferred to your wallet. You will be able to re-stake them on the next cycle, after the current one ends. + +If a cycle has ended but you've staked your $ALEX for longer, you will be able to claim your rewards but not your staked ALEX tokens, which will remain locked-up until the staking period you selected expires. If you wish to avoid cooldown periods and manual staking, you can use the **Auto Staking** function with [LiALEX](faqs.md#what-is-lialex). + +### Do Staking reward accumulates? + +Yes, staking rewards accumulate over time. It is not mandatory to harvest your rewards at the end of each cycle, you can claim them whenever you choose. Also, when you withdraw (unstake) your $ALEX or LiALEX, any unharvested rewards will automatically be withdrawn as well. + +### Can I claim my Rewards after every Cycle? + +Yes, rewards can be claimed after every cycle concludes, even if you've staked your $ALEX for several cycles. Bear in mind that, although you can claim rewards, your staked tokens can only be withdrawn after the selected cycles expire. + +### What is the Cooldown Period? + +The cooldown period refers to the time between when your ALEX tokens are staked and when a new cycle begins. Essentially, it is the remaining time (measured in Stacks blocks) of the current staking cycle. This implies that your staked tokens won't start generating rewards immediately, but in the next upcoming cycle. + +For example, if you staked your $ALEX for 32 cycles, you won't receive any rewards for the 33rd cycle. Afterwards, you will be able to earn rewards again if you choose to re-stake your tokens. For more details, check the [Cycles and Cooldown Period](https://coinfabrik.gitbook.io/alexlab-doc/stake/features/staking/key-concepts#cycles-and-cooldown-period) section of the Key concepts page. + +### Why is it more convenient to stake for longer period? + +Because of the cooldown period. If you plan to stake for multiple cycles, it is more efficient to stake for the entire period upfront rather than withdrawing and restaking repeatedly. + +Lets suppose you want to stake for 12 cycles and choose to stake thrice for 4-cycle periods, you will miss out on rewards for 3 cycles. This happens because each time you withdraw and restake, you enter a cooldown period. In contrast, if you stake directly for the full 12 cycles, you will only miss rewards for 1 cycle, the very first one. + +The more cycles you choose to stake for, the less cool-down cycles you will have in the middle. To avoid cool-down cycles altogether, you may use [Liquid Staking with LiALEX](https://coinfabrik.gitbook.io/alexlab-doc/stake/features/staking/key-concepts#liquid-staking). + +### I just staked $ALEX, when will I see my staked ALEX? + +The transaction may take up to 40 minutes to become visible in the "My Staking" menu. + +You can consult the [Staking Guide](how-to.md) for more information on verifying your staking status. + +### What is APower? + +ALEX Staking Power, or APower, is a special incentive awarded only to $ALEX stakers and yield farmers. APower is a non-transferrable and non-tradable token, that provides special access to future IDOs on the ALEX Launchpad. There are two ways to earn APower through staking on the ALEX platform, either by: + +1. **Stake $ALEX (1x Multiplier)** +2. **Stake LP tokens through Yield Farming (0.3x Multiplier)** + +There is no maximum amount of APower an address can earn over a period of time. If you are interested in frequently participating in IDOs, staking $ALEX would generate APower the fastest. + +### What is LiALEX? + +LiALEX is the transferable utility token that allows you to maintain liquidity while staking your $ALEX. When you stake $ALEX through LISA, you mint LiALEX that allow you to participate in other DeFi activities, such as requesting stablecoin loans or investing them in farming pools. For more information, refer to the [LISA Documentation](https://docs.lisalab.io/) diff --git a/docs/product-features/staking/how-to.md b/docs/product-features/staking/how-to.md index 4f45ff0..8ac0fe4 100644 --- a/docs/product-features/staking/how-to.md +++ b/docs/product-features/staking/how-to.md @@ -1,3 +1,202 @@ # 🧑‍🏫 How to stake -Comming soon. +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. + +### ⚓ 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. + +

Stake homepage

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

"My Staking" panel

+ +**Staking Metrics** + +* **Manual Staking:** The amount of $ALEX you are currently staking. +* **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. + +

"Add ALEX Staking" panel

+ +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. + +
+ +#### 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. + +Wallet pop-up with function arguments and confirmation button. + +
+ +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. + +

Recently staked $ALEX in "My Staking" panel

+ +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. + +### 💰 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 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: 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. + +
+ +#### Step 3: Confirm Harvest + +A confirmation panel will appear where you can double check the amount. If everything looks correct, click `Confirm`. + +
+ +**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. +* **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. + +

Transaction preview displayed on Leather wallet

+ +

Function arguments and confirmation button

+ +#### 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 %} + +

Telegram message with transaction pending status.

+ +

Telegram message with transaction success status.

+ +## 📈 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. + +

Selected Auto Stake in "My Staking"

+ +#### Step 3: Confirm Auto Stake + +A confirmation panel will appear where you can double check the amount. If everything looks correct, click `Confirm`. + +
+ +**Confirm Harvest** + +* **Harvest:** The amount of staked $ALEX that will be auto staked and the amount of APower that you have earned by staking. +* **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. + +

Transaction preview displayed on Leather wallet

+ +

Function arguments and confirmation button

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

Your LiALEX in "My Staking"

+ +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](https://coinfabrik.gitbook.io/alexlab-doc/stake/features/staking/faqs). + +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. + +

Telegram message with transaction pending status.

+ +

Telegram message with transaction success status.

diff --git a/docs/product-features/staking/key-concepts.md b/docs/product-features/staking/key-concepts.md index 0006e18..8cc4541 100644 --- a/docs/product-features/staking/key-concepts.md +++ b/docs/product-features/staking/key-concepts.md @@ -1,3 +1,39 @@ # 💡 Key concepts -Comming soon. +### Staking Basics + +Staking consists of locking your ALEX tokens temporarily to earn ALEX and APower tokens as rewards. Users can stake their tokens to earn passive income in the form of newly minted tokens and transaction fees. + +The ALEX staking pool offers two main options, each one rewarding stakers with a different token: manual staking with $ALEX or liquid staking with LiALEX. + +#### Rewards + +Staking rewards are the compensation that you can receive in return for locking up your $ALEX tokens for a certain amount of staking cycles. The longer you stake your $ALEX, the greater the rewards. They are obtained from transaction fees and newly minted tokens. + +The network calculates each participant's reward share based on their staked amount. Rewards are either automatically reinvested in the case of **Liquid Staking** or can be claimed after **every cycle** in the case of **Manual Staking.** This means that, even if you decided to stake your tokens for 8 cycles, you will be able to claim rewards after each cycle concludes. + +To maximize your returns, you should claim and re-stake your rewards as soon as they are available to generate compounded returns. Unclaimed rewards do not expire, so you can claim them whenever you wish, but they do not generate returns either. + +#### APR + +The average APR (Annual Percentage Rate) reflects the yearly interest of your investment minus fees. It does not include compounding interest. The longer the staking cycle, the higher the APR, since you will be skipping less cycles due to cool-down. + +#### Cycles & 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. + +After the chosen cycles expire, you can claim your rewards and withdraw your staked tokens, or re-stake them for however many cycles you choose. Bear in mind that, once your custom-selected number of cycles ends, there will be a **cooldown cycle** with no rewards received, after which you may re-stake and resume earning rewards. For that reason, the longer you stake, the fewer cool-down cycles you will have, resulting in greater returns overall. + +### Manual Staking + +Manual Staking is the conventional way of staking your tokens on the ALEX network. After each cycle, you will have the option to harvest your rewards, which you may re-stake manually to generate compound interest. When you harvest your rewards, those tokens are automatically transferred to your wallet. + +### Liquid Staking + +[Liquid Staking](https://app.lisalab.io/li/alex/staking) with LiALEX allows users to earn rewards just as in manual staking, but with the added benefits of maintaining liquidity and automatic re-staking. Liquid staking is made possible through LISA, a set of tools deployed by ALEX Labs on the Stacks blockchain. + +Liquid staking earns you passive compound interest on your investment, as you won't need to manually harvest and re-stake your rewards. Since your rewards are automatically reinvested, there is no cooldown period, which allows you to maximize your returns. + +Staking $ALEX through LISA provides users with LiALEX, a transferable utility token that can be used for other on-chain activities. Liquid staking not only allows you to earn rewards from your investment, but also frees you from the constraints of locking up your assets. + +For more information, you can consult the [LISA Documentation](https://docs.lisalab.io/). From 1d8c3265728fd760791510788c0593a5f4822170 Mon Sep 17 00:00:00 2001 From: Josh Date: Sat, 28 Dec 2024 09:02:40 +0000 Subject: [PATCH 3/9] GITBOOK-48: PR#10 - v1.1 --- docs/product-features/staking/faqs.md | 2 +- docs/product-features/staking/key-concepts.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/product-features/staking/faqs.md b/docs/product-features/staking/faqs.md index d179fb4..829373f 100644 --- a/docs/product-features/staking/faqs.md +++ b/docs/product-features/staking/faqs.md @@ -38,7 +38,7 @@ Because of the cooldown period. If you plan to stake for multiple cycles, it is Lets suppose you want to stake for 12 cycles and choose to stake thrice for 4-cycle periods, you will miss out on rewards for 3 cycles. This happens because each time you withdraw and restake, you enter a cooldown period. In contrast, if you stake directly for the full 12 cycles, you will only miss rewards for 1 cycle, the very first one. -The more cycles you choose to stake for, the less cool-down cycles you will have in the middle. To avoid cool-down cycles altogether, you may use [Liquid Staking with LiALEX](https://coinfabrik.gitbook.io/alexlab-doc/stake/features/staking/key-concepts#liquid-staking). +The more cycles you choose to stake for, the less cool-down cycles you will have in the middle. To avoid cool-down cycles altogether, you may use [Liquid Staking with LiALEX](https://docs.alexlab.co/features/staking/how-to#auto-stake-liquid-staking). ### I just staked $ALEX, when will I see my staked ALEX? diff --git a/docs/product-features/staking/key-concepts.md b/docs/product-features/staking/key-concepts.md index 8cc4541..6cbdd03 100644 --- a/docs/product-features/staking/key-concepts.md +++ b/docs/product-features/staking/key-concepts.md @@ -6,7 +6,7 @@ Staking consists of locking your ALEX tokens temporarily to earn ALEX and APower The ALEX staking pool offers two main options, each one rewarding stakers with a different token: manual staking with $ALEX or liquid staking with LiALEX. -#### Rewards +### Rewards Staking rewards are the compensation that you can receive in return for locking up your $ALEX tokens for a certain amount of staking cycles. The longer you stake your $ALEX, the greater the rewards. They are obtained from transaction fees and newly minted tokens. @@ -14,11 +14,11 @@ The network calculates each participant's reward share based on their staked amo To maximize your returns, you should claim and re-stake your rewards as soon as they are available to generate compounded returns. Unclaimed rewards do not expire, so you can claim them whenever you wish, but they do not generate returns either. -#### APR +### APR The average APR (Annual Percentage Rate) reflects the yearly interest of your investment minus fees. It does not include compounding interest. The longer the staking cycle, the higher the APR, since you will be skipping less cycles due to cool-down. -#### Cycles & Cooldown Period +### Cycles & 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. From 5ba0d4ba57647ed3b6d88f207796c02bf33031b3 Mon Sep 17 00:00:00 2001 From: Josh Date: Sat, 28 Dec 2024 09:03:55 +0000 Subject: [PATCH 4/9] GITBOOK-49: No subject --- docs/product-features/staking/faqs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/product-features/staking/faqs.md b/docs/product-features/staking/faqs.md index 829373f..cb5acc0 100644 --- a/docs/product-features/staking/faqs.md +++ b/docs/product-features/staking/faqs.md @@ -30,7 +30,7 @@ Yes, rewards can be claimed after every cycle concludes, even if you've staked y The cooldown period refers to the time between when your ALEX tokens are staked and when a new cycle begins. Essentially, it is the remaining time (measured in Stacks blocks) of the current staking cycle. This implies that your staked tokens won't start generating rewards immediately, but in the next upcoming cycle. -For example, if you staked your $ALEX for 32 cycles, you won't receive any rewards for the 33rd cycle. Afterwards, you will be able to earn rewards again if you choose to re-stake your tokens. For more details, check the [Cycles and Cooldown Period](https://coinfabrik.gitbook.io/alexlab-doc/stake/features/staking/key-concepts#cycles-and-cooldown-period) section of the Key concepts page. +For example, if you staked your $ALEX for 32 cycles, you won't receive any rewards for the 33rd cycle. Afterwards, you will be able to earn rewards again if you choose to re-stake your tokens. For more details, check the [Cycles and Cooldown Period](https://docs.alexlab.co/features/staking/key-concepts#cycles-and-cooldown-period) section of the Key concepts page. ### Why is it more convenient to stake for longer period? From 91ba02f627597d6366119b8e62707ea33ab9e031 Mon Sep 17 00:00:00 2001 From: Josh Date: Fri, 3 Jan 2025 03:37:29 +0000 Subject: [PATCH 5/9] GITBOOK-50: No subject --- docs/product-features/self-service-listing.md | 60 ++++++++++++------- 1 file changed, 39 insertions(+), 21 deletions(-) diff --git a/docs/product-features/self-service-listing.md b/docs/product-features/self-service-listing.md index d391220..6383c0f 100644 --- a/docs/product-features/self-service-listing.md +++ b/docs/product-features/self-service-listing.md @@ -10,9 +10,9 @@ description: >- **Supported Tokens:** ALEX Self-Service Listing currently supports Stacks Chain Tokens (SIP-010 Standard Token). {% endhint %} -## 🚀 Getting Started +### 🚀 Getting Started -### How it works? +#### 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. @@ -20,17 +20,19 @@ Pool creation usually takes between 24 to 48 hours. Once the pool is created and The pool owner is the initial liquidity provider and will receive the corresponding LP tokens upon successful pool creation. Once the pool is live and operational, the owner can withdraw funds just like any other liquidity provider. +**Available Anchor Tokens:** Native _STX_ token, _ALEX_ token and _aBTC_ token. + {% hint style="info" %} -Avaiblable Anchor Tokens: Native STX token, ALEX token and aBTC token. +Interested in having your own unique pairs out of the available anchor tokens? Please reach out to us. {% endhint %} The trading pool operates under the [ALEX Automated Market Maker (AMM)](../detailed-information/alexs-automated-market-maker-amm.md) algorithm, which dynamically determines the exchange rate (price) based on the trades. -### Minimum requirements +#### Minimum requirements 👉 **Token Deployment.** Ensure your token is deployed on the Stacks blockchain, as you will need to provide the token contract. -👉 **Select an Anchor Token.** Choose an anchor token from the available options: Stacks native token STX, ALEX token, or aBTC token. Ensure you have at least 1,800 STX or an equivalent value in ALEX or aBTC token to create the pool—this is the minimum anchor token liquidity. +👉 **Select an Anchor Token.** Choose an anchor token from the available options: Stacks native token _STX_, _ALEX_ token, or _aBTC_ token. Ensure you have at least 1,800 _STX_ or an equivalent value in _ALEX_ or _aBTC_ token to create the pool—this is the minimum anchor token liquidity. 👉 **Determine Initial Price.** Decide the initial price for your listing token in terms of anchor token units. This should answer the question: how many anchor tokens do users need to buy one listed token? @@ -46,7 +48,7 @@ To determine the price, you will need to decide how many STX equals 1 of your li To calculate the initial liquidity for the listed token, you need to divide the anchor token amount by the price. This is `4,000 STX / 0.5 STX = 8,000`, resulting in the initial amount for the listed token. -The liquidity pool for the pair **Listed Token** :rocket: **- Anchor Token** :anchor: will have an initial ratio of 2:1. This ratio is calculated as the minimal expression of the fraction `8,000 / 4,000` (initial listed token amount slash initial anchor token amount). +The liquidity pool for the pair **Listed Token** 🚀 **- Anchor Token** ⚓ will have an initial ratio of 2:1. This ratio is calculated as the minimal expression of the fraction `8,000 / 4,000` (initial listed token amount slash initial anchor token amount). @@ -54,25 +56,27 @@ The liquidity pool for the pair **Listed Token** :rocket: **- Anchor Token** :an With that said, let's get hands-on! -## 🛠️ Procedure +### 🛠️ Procedure -### Step 0: Go to Self-Service Listing page +#### Step 0: Go to the Self-Service Listing page -Head to the [Self-Service Listing page](https://app.alexlab.co/self-service-listing) at the ALEX Lab App. Alternatively, you can access it via the [app.alexlab.co](https://app.alexlab.co) homepage by navigating to the `Swap` -> `Pool` tab. Once on the Pool main page, hit the `+ Create` button and select the `Creating a new pool` option. +Head to the [Self-Service Listing page](https://app.alexlab.co/self-service-listing) at the ALEX Lab App. Alternatively, you can access it via the [app.alexlab.co](https://app.alexlab.co/) homepage by navigating to the `Swap` -> `Pool` tab. Once on the Pool main page, hit the `+ Create` button and select the `Creating a new pool` option. -
Self-Service Listing page
+
-### Step 1: Submit token information & deposit the anchor token +#### Step 1: Submit token information & 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:. +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 💰 ⚓. -
Self-Service Listing page
+
Step 1.1: Input the SIP-10 token contract address -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`. +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`.
@@ -110,7 +114,9 @@ Once the pool opens, the AMM algorithm will automatically rebalance the exchange Step 1.4: Advanced pool settings (optional) -This step is optional, as the default settings are usually sufficient. If you have questions to ask before customization, reach out via [Discord](https://discord.com/invite/alexlab) or [Telegram](https://t.me/AlexCommunity). +This step is optional, as the default settings are usually sufficient. + +However, we recommend consulting the [ALEXGo Technical documentation](https://docs.alexgo.io/automated-market-making/trading-pool) before making customizations. If you have questions to ask before customization, reach out via [Discord](https://discord.com/invite/alexlab) or [Telegram](https://t.me/AlexCommunity). @@ -130,31 +136,43 @@ Recommended to track transaction status: -### Step 2: Contract creation +#### Step 2: Choose LP Lock & Burn Settings + +After submitting the Self-Service Listing Pool, a pop-up will appear, allowing the creator to choose whether to lock or burn the initial LP tokens, or to leave the liquidity pool unlocked. By default, the Self-Service Listing Pool is set to be locked for 6 months, as it is the recommended option. Users are prompted to select one of three settings: + +* **Do not lock LP 🔓**: There will be no lock-up period and the initial liquidity provider (the pool creator) will receive the corresponding LP tokens once the pool is live and operational. Since the pool is unlocked, the owner will be able to withdraw liquidity at any time. +* **LP is locked for 6 months 🔒** : This is the default option. It locks liquidity within decentralized smart contracts for a 6 month period, requiring a manual LP claim after maturity. When the period concludes, the pool owner can withdraw liquidity as any other provider. This prevents unexpected withdrawals and protects liquidity providers from rug pulls. +* **Burn LP 🔥** : Permanently burns a portion of tokens, ensuring that they can never be recovered or withdrawn. Since the initial liquidity vanishes, this option protects future liquidity providers from rug pulls and enhances trust and transparency. + +
+ +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 Once the transaction from 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 3: 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 4: 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). 🤝 After completing this step, you (and everyone) can start trading the token pair on ALEX DEX 🤝 -
Pool creation successful

Pool creation successful.

+

Pool creation successful

{% hint style="warning" %} If you have added a custom `start-block` configuration, the pool will be unavailabe until that block is reached. {% endhint %} -### Step 5: 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). -
Token List example

Token List example.

+

Token List examples

ALEX requires a [Coingecko](https://www.coingecko.com/) or [CoinMarketCap](https://coinmarketcap.com/) token listing to verify the provided social media information before uploading it to the official list at [app.alexlab.co/token-list](https://app.alexlab.co/token-list). From c347562fbc71bcc850f2816aac38799d44e78b46 Mon Sep 17 00:00:00 2001 From: Josh Date: Fri, 3 Jan 2025 03:42:57 +0000 Subject: [PATCH 6/9] GITBOOK-51: PR#10 Merge --- docs/product-features/self-service-listing.md | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/product-features/self-service-listing.md b/docs/product-features/self-service-listing.md index 6383c0f..b2bc3cb 100644 --- a/docs/product-features/self-service-listing.md +++ b/docs/product-features/self-service-listing.md @@ -14,29 +14,33 @@ description: >- #### 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. +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. Pool creation usually takes between 24 to 48 hours. Once the pool is created and live, the price discovery phase begins: users can start trading the listed token against the anchor token and viceversa. Users interested in providing liquidity can contribute to the pool like any other ALEX pool. -The pool owner is the initial liquidity provider and will receive the corresponding LP tokens upon successful pool creation. Once the pool is live and operational, the owner can withdraw funds just like any other liquidity provider. +The pool owner is the initial liquidity provider and will receive the corresponding LP tokens upon successful pool creation. + +Once the pool is live and operational, the owner can withdraw funds just like any other liquidity provider. **Available Anchor Tokens:** Native _STX_ token, _ALEX_ token and _aBTC_ token. {% hint style="info" %} -Interested in having your own unique pairs out of the available anchor tokens? Please reach out to us. +Interested in having your own unique pairs out of the available anchor tokens? Please reach out to us. Important to note that unique pairs are **subject to approval** by the ALEX Lab Foundation team. {% endhint %} The trading pool operates under the [ALEX Automated Market Maker (AMM)](../detailed-information/alexs-automated-market-maker-amm.md) algorithm, which dynamically determines the exchange rate (price) based on the trades. #### Minimum requirements -👉 **Token Deployment.** Ensure your token is deployed on the Stacks blockchain, as you will need to provide the token contract. +👉 **Token Deployment:** Ensure your token is deployed on the Stacks blockchain, as you will need to provide the token contract. -👉 **Select an Anchor Token.** Choose an anchor token from the available options: Stacks native token _STX_, _ALEX_ token, or _aBTC_ token. Ensure you have at least 1,800 _STX_ or an equivalent value in _ALEX_ or _aBTC_ token to create the pool—this is the minimum anchor token liquidity. +👉 **Select an Anchor Token:** Choose an anchor token from the available options: Stacks native token _STX_, _ALEX_ token, or _aBTC_ token. Ensure you have at least 1,800 _STX_ or an equivalent value in _ALEX_ or _aBTC_ token to create the pool—this is the minimum anchor token liquidity. -👉 **Determine Initial Price.** Decide the initial price for your listing token in terms of anchor token units. This should answer the question: how many anchor tokens do users need to buy one listed token? +👉 **Determine Initial Price:** Decide the initial price for your listing token in terms of anchor token units. This should answer the question: how many anchor tokens do users need to buy one listed token? -👉 **Calculate Initial Liquidity.** Once the initial price is determined, you can set the initial liquidity amounts for both tokens in the pool. You may calculate this manually or use the ALEX Lab UI for assistance. If you're planning to [add farming to the pool](self-service-farming.md), make sure to reserve enough tokens for farm rewards. +👉 **Calculate Initial Liquidity:** Once the initial price is determined, you can set the initial liquidity amounts for both tokens in the pool. You may calculate this manually or use the ALEX Lab UI for assistance. If you're planning to [add farming to the pool](self-service-farming.md), make sure to reserve enough tokens for farm rewards.
@@ -54,8 +58,6 @@ The liquidity pool for the pair **Listed Token** 🚀 **- Anchor Token** ⚓ wil 🔎 For more details, check the [FAQs](liquidity-pools/faqs.md#self-service-listing) section. -With that said, let's get hands-on! - ### 🛠️ Procedure #### Step 0: Go to the Self-Service Listing page From e43e320a6c6485cc0785dbb986fd70dfe697910c Mon Sep 17 00:00:00 2001 From: david weil Date: Wed, 8 Jan 2025 10:58:22 -0300 Subject: [PATCH 7/9] revert gitbook merge --- docs/product-features/self-service-listing.md | 76 +++---- docs/product-features/staking/README.md | 35 +-- docs/product-features/staking/faqs.md | 59 +---- docs/product-features/staking/how-to.md | 201 +----------------- docs/product-features/staking/key-concepts.md | 38 +--- 5 files changed, 37 insertions(+), 372 deletions(-) diff --git a/docs/product-features/self-service-listing.md b/docs/product-features/self-service-listing.md index b2bc3cb..d391220 100644 --- a/docs/product-features/self-service-listing.md +++ b/docs/product-features/self-service-listing.md @@ -10,37 +10,31 @@ description: >- **Supported Tokens:** ALEX Self-Service Listing currently supports Stacks Chain Tokens (SIP-010 Standard Token). {% endhint %} -### 🚀 Getting Started +## 🚀 Getting Started -#### How does it work? +### How it works? -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. +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. Pool creation usually takes between 24 to 48 hours. Once the pool is created and live, the price discovery phase begins: users can start trading the listed token against the anchor token and viceversa. Users interested in providing liquidity can contribute to the pool like any other ALEX pool. -The pool owner is the initial liquidity provider and will receive the corresponding LP tokens upon successful pool creation. - -Once the pool is live and operational, the owner can withdraw funds just like any other liquidity provider. - -**Available Anchor Tokens:** Native _STX_ token, _ALEX_ token and _aBTC_ token. +The pool owner is the initial liquidity provider and will receive the corresponding LP tokens upon successful pool creation. Once the pool is live and operational, the owner can withdraw funds just like any other liquidity provider. {% hint style="info" %} -Interested in having your own unique pairs out of the available anchor tokens? Please reach out to us. Important to note that unique pairs are **subject to approval** by the ALEX Lab Foundation team. +Avaiblable Anchor Tokens: Native STX token, ALEX token and aBTC token. {% endhint %} The trading pool operates under the [ALEX Automated Market Maker (AMM)](../detailed-information/alexs-automated-market-maker-amm.md) algorithm, which dynamically determines the exchange rate (price) based on the trades. -#### Minimum requirements +### Minimum requirements -👉 **Token Deployment:** Ensure your token is deployed on the Stacks blockchain, as you will need to provide the token contract. +👉 **Token Deployment.** Ensure your token is deployed on the Stacks blockchain, as you will need to provide the token contract. -👉 **Select an Anchor Token:** Choose an anchor token from the available options: Stacks native token _STX_, _ALEX_ token, or _aBTC_ token. Ensure you have at least 1,800 _STX_ or an equivalent value in _ALEX_ or _aBTC_ token to create the pool—this is the minimum anchor token liquidity. +👉 **Select an Anchor Token.** Choose an anchor token from the available options: Stacks native token STX, ALEX token, or aBTC token. Ensure you have at least 1,800 STX or an equivalent value in ALEX or aBTC token to create the pool—this is the minimum anchor token liquidity. -👉 **Determine Initial Price:** Decide the initial price for your listing token in terms of anchor token units. This should answer the question: how many anchor tokens do users need to buy one listed token? +👉 **Determine Initial Price.** Decide the initial price for your listing token in terms of anchor token units. This should answer the question: how many anchor tokens do users need to buy one listed token? -👉 **Calculate Initial Liquidity:** Once the initial price is determined, you can set the initial liquidity amounts for both tokens in the pool. You may calculate this manually or use the ALEX Lab UI for assistance. If you're planning to [add farming to the pool](self-service-farming.md), make sure to reserve enough tokens for farm rewards. +👉 **Calculate Initial Liquidity.** Once the initial price is determined, you can set the initial liquidity amounts for both tokens in the pool. You may calculate this manually or use the ALEX Lab UI for assistance. If you're planning to [add farming to the pool](self-service-farming.md), make sure to reserve enough tokens for farm rewards.
@@ -52,33 +46,33 @@ To determine the price, you will need to decide how many STX equals 1 of your li To calculate the initial liquidity for the listed token, you need to divide the anchor token amount by the price. This is `4,000 STX / 0.5 STX = 8,000`, resulting in the initial amount for the listed token. -The liquidity pool for the pair **Listed Token** 🚀 **- Anchor Token** ⚓ will have an initial ratio of 2:1. This ratio is calculated as the minimal expression of the fraction `8,000 / 4,000` (initial listed token amount slash initial anchor token amount). +The liquidity pool for the pair **Listed Token** :rocket: **- Anchor Token** :anchor: will have an initial ratio of 2:1. This ratio is calculated as the minimal expression of the fraction `8,000 / 4,000` (initial listed token amount slash initial anchor token amount).
🔎 For more details, check the [FAQs](liquidity-pools/faqs.md#self-service-listing) section. -### 🛠️ Procedure +With that said, let's get hands-on! -#### Step 0: Go to the Self-Service Listing page +## 🛠️ Procedure -Head to the [Self-Service Listing page](https://app.alexlab.co/self-service-listing) at the ALEX Lab App. Alternatively, you can access it via the [app.alexlab.co](https://app.alexlab.co/) homepage by navigating to the `Swap` -> `Pool` tab. Once on the Pool main page, hit the `+ Create` button and select the `Creating a new pool` option. +### Step 0: Go to Self-Service Listing page -
+Head to the [Self-Service Listing page](https://app.alexlab.co/self-service-listing) at the ALEX Lab App. Alternatively, you can access it via the [app.alexlab.co](https://app.alexlab.co) homepage by navigating to the `Swap` -> `Pool` tab. Once on the Pool main page, hit the `+ Create` button and select the `Creating a new pool` option. -#### Step 1: Submit token information & deposit the anchor token +
Self-Service Listing page
-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 💰 ⚓. +### Step 1: Submit token information & 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:. + +
Self-Service Listing page
Step 1.1: Input the SIP-10 token contract address -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`. +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`.
@@ -116,9 +110,7 @@ Once the pool opens, the AMM algorithm will automatically rebalance the exchange Step 1.4: Advanced pool settings (optional) -This step is optional, as the default settings are usually sufficient. - -However, we recommend consulting the [ALEXGo Technical documentation](https://docs.alexgo.io/automated-market-making/trading-pool) before making customizations. If you have questions to ask before customization, reach out via [Discord](https://discord.com/invite/alexlab) or [Telegram](https://t.me/AlexCommunity). +This step is optional, as the default settings are usually sufficient. If you have questions to ask before customization, reach out via [Discord](https://discord.com/invite/alexlab) or [Telegram](https://t.me/AlexCommunity).
@@ -138,43 +130,31 @@ Recommended to track transaction status: -#### Step 2: Choose LP Lock & Burn Settings - -After submitting the Self-Service Listing Pool, a pop-up will appear, allowing the creator to choose whether to lock or burn the initial LP tokens, or to leave the liquidity pool unlocked. By default, the Self-Service Listing Pool is set to be locked for 6 months, as it is the recommended option. Users are prompted to select one of three settings: - -* **Do not lock LP 🔓**: There will be no lock-up period and the initial liquidity provider (the pool creator) will receive the corresponding LP tokens once the pool is live and operational. Since the pool is unlocked, the owner will be able to withdraw liquidity at any time. -* **LP is locked for 6 months 🔒** : This is the default option. It locks liquidity within decentralized smart contracts for a 6 month period, requiring a manual LP claim after maturity. When the period concludes, the pool owner can withdraw liquidity as any other provider. This prevents unexpected withdrawals and protects liquidity providers from rug pulls. -* **Burn LP 🔥** : Permanently burns a portion of tokens, ensuring that they can never be recovered or withdrawn. Since the initial liquidity vanishes, this option protects future liquidity providers from rug pulls and enhances trust and transparency. - -
- -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 2: Contract creation Once the transaction from 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 3: 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 4: 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). 🤝 After completing this step, you (and everyone) can start trading the token pair on ALEX DEX 🤝 -

Pool creation successful

+
Pool creation successful

Pool creation successful.

{% hint style="warning" %} 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 5: 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). -

Token List examples

+
Token List example

Token List example.

ALEX requires a [Coingecko](https://www.coingecko.com/) or [CoinMarketCap](https://coinmarketcap.com/) token listing to verify the provided social media information before uploading it to the official list at [app.alexlab.co/token-list](https://app.alexlab.co/token-list). diff --git a/docs/product-features/staking/README.md b/docs/product-features/staking/README.md index 5e0edf8..006c731 100644 --- a/docs/product-features/staking/README.md +++ b/docs/product-features/staking/README.md @@ -1,36 +1,13 @@ # ⚓ Stake -Stake your ALEX tokens and start earning rewards! +ALEX staking involves “locking up” your $ALEX token on the platform for an amount of time (”rewards cycles”) in exchange for earning protocol rewards. -ALEX staking involves "locking up" your ALEX tokens on the platform for an amount of time, measured in cycles, in exchange for protocol rewards. +You can think of $ALEX staking as depositing money into an interest-earning account. The longer you keep the money in the account the more interest you earn. Similarly, the longer you stake $ALEX the more rewards you earn. -You can think of $ALEX staking as depositing money into an interest-earning account: the longer you keep the money in the account, the more interest you earn. +ALEX provides manual(Customized) ALEX Staking. -Similarly, the longer you stake $ALEX, the more rewards you earn. The protocol rewards are provided in the form of more $ALEX and APower tokens. +Lisa Protocol([https://www.lisalab.io/](https://www.lisalab.io/)) is now providing liquid staking for ALEX Staking ($LiALEX) -{% hint style="info" %} -**What is APower?** APower is the lottery ticket that allows you to take part in any future IDO rounds on our Launchpad. It is a non-transferrable and non-tradable token that is earned by staking. Learn more on the [FAQs](https://coinfabrik.gitbook.io/alexlab-doc/stake/features/staking/faqs#what-is-apower) page. -{% endhint %} +The protocol rewards are provided in the form of more $ALEX as well as [$APower](https://medium.com/alexgobtc/what-is-alex-staking-power-and-how-do-i-use-it-1b3de3797fa2) which is only available to stakers to be used in the ALEX launchpad. -ALEX provides two different forms of staking to suit every user's need. - -* [**Manual Staking**](https://coinfabrik.gitbook.io/alexlab-doc/stake/features/staking/key-concepts#manual-staking): Stake $ALEX directly on the [ALEX Lab Platform](https://app.alexlab.co/stake). -* [**Liquid Staking**](https://coinfabrik.gitbook.io/alexlab-doc/stake/features/staking/key-concepts#liquid-staking): Stake $ALEX via LiALEX, powered by [LISA Protocol](https://www.lisalab.io/). - -### 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="faqs.md" %} -[faqs.md](faqs.md) -{% endcontent-ref %} - -### Support - -For assistance, please reach out to our Community Managers on [Discord](https://discord.com/invite/alexlab) and [Telegram Channel](https://t.me/AlexCommunity). You can also email us at [contact@alexgo.io](mailto:contact@alexgo.io). +

ALEX Staking

diff --git a/docs/product-features/staking/faqs.md b/docs/product-features/staking/faqs.md index cb5acc0..ad852f9 100644 --- a/docs/product-features/staking/faqs.md +++ b/docs/product-features/staking/faqs.md @@ -1,60 +1,3 @@ # ❓ FAQs -### How is Staking different from Farming? - -Staking involves locking cryptocurrency in a smart contract for a set amount of time in exchange for rewards. During that period, the tokens won't be accessible to the user. It is generally safer and the returns tend to be lower. - -Farming involves lending or staking crypto holdings in DeFi protocols to supply liquidity. The tokens must be deposited into a liquidity pool, and depositors receive LP tokens, representing their share of the pool. They can earn additional tokens by participating in DeFi activities such as lending, borrowing, or trading. - -You can also consult the [farming documentation](../farming/). - -### What is Harvesting? - -Harvesting refers to the act of **claiming your staking rewards**. When you claim your rewards, they are automatically transferred to your wallet. - -### **Can I only collect a portion of my rewards?** - -No. If your staking period has ended, all the rewards and APower you have accrued, as well as the $ALEX you've staked, will be transferred to your wallet. You will be able to re-stake them on the next cycle, after the current one ends. - -If a cycle has ended but you've staked your $ALEX for longer, you will be able to claim your rewards but not your staked ALEX tokens, which will remain locked-up until the staking period you selected expires. If you wish to avoid cooldown periods and manual staking, you can use the **Auto Staking** function with [LiALEX](faqs.md#what-is-lialex). - -### Do Staking reward accumulates? - -Yes, staking rewards accumulate over time. It is not mandatory to harvest your rewards at the end of each cycle, you can claim them whenever you choose. Also, when you withdraw (unstake) your $ALEX or LiALEX, any unharvested rewards will automatically be withdrawn as well. - -### Can I claim my Rewards after every Cycle? - -Yes, rewards can be claimed after every cycle concludes, even if you've staked your $ALEX for several cycles. Bear in mind that, although you can claim rewards, your staked tokens can only be withdrawn after the selected cycles expire. - -### What is the Cooldown Period? - -The cooldown period refers to the time between when your ALEX tokens are staked and when a new cycle begins. Essentially, it is the remaining time (measured in Stacks blocks) of the current staking cycle. This implies that your staked tokens won't start generating rewards immediately, but in the next upcoming cycle. - -For example, if you staked your $ALEX for 32 cycles, you won't receive any rewards for the 33rd cycle. Afterwards, you will be able to earn rewards again if you choose to re-stake your tokens. For more details, check the [Cycles and Cooldown Period](https://docs.alexlab.co/features/staking/key-concepts#cycles-and-cooldown-period) section of the Key concepts page. - -### Why is it more convenient to stake for longer period? - -Because of the cooldown period. If you plan to stake for multiple cycles, it is more efficient to stake for the entire period upfront rather than withdrawing and restaking repeatedly. - -Lets suppose you want to stake for 12 cycles and choose to stake thrice for 4-cycle periods, you will miss out on rewards for 3 cycles. This happens because each time you withdraw and restake, you enter a cooldown period. In contrast, if you stake directly for the full 12 cycles, you will only miss rewards for 1 cycle, the very first one. - -The more cycles you choose to stake for, the less cool-down cycles you will have in the middle. To avoid cool-down cycles altogether, you may use [Liquid Staking with LiALEX](https://docs.alexlab.co/features/staking/how-to#auto-stake-liquid-staking). - -### I just staked $ALEX, when will I see my staked ALEX? - -The transaction may take up to 40 minutes to become visible in the "My Staking" menu. - -You can consult the [Staking Guide](how-to.md) for more information on verifying your staking status. - -### What is APower? - -ALEX Staking Power, or APower, is a special incentive awarded only to $ALEX stakers and yield farmers. APower is a non-transferrable and non-tradable token, that provides special access to future IDOs on the ALEX Launchpad. There are two ways to earn APower through staking on the ALEX platform, either by: - -1. **Stake $ALEX (1x Multiplier)** -2. **Stake LP tokens through Yield Farming (0.3x Multiplier)** - -There is no maximum amount of APower an address can earn over a period of time. If you are interested in frequently participating in IDOs, staking $ALEX would generate APower the fastest. - -### What is LiALEX? - -LiALEX is the transferable utility token that allows you to maintain liquidity while staking your $ALEX. When you stake $ALEX through LISA, you mint LiALEX that allow you to participate in other DeFi activities, such as requesting stablecoin loans or investing them in farming pools. For more information, refer to the [LISA Documentation](https://docs.lisalab.io/) +Comming soon. diff --git a/docs/product-features/staking/how-to.md b/docs/product-features/staking/how-to.md index 8ac0fe4..4f45ff0 100644 --- a/docs/product-features/staking/how-to.md +++ b/docs/product-features/staking/how-to.md @@ -1,202 +1,3 @@ # 🧑‍🏫 How to stake -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. - -### ⚓ 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. - -

Stake homepage

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

"My Staking" panel

- -**Staking Metrics** - -* **Manual Staking:** The amount of $ALEX you are currently staking. -* **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. - -

"Add ALEX Staking" panel

- -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. - -
- -#### 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. - -Wallet pop-up with function arguments and confirmation button. - -
- -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. - -

Recently staked $ALEX in "My Staking" panel

- -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. - -### 💰 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 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: 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. - -
- -#### Step 3: Confirm Harvest - -A confirmation panel will appear where you can double check the amount. If everything looks correct, click `Confirm`. - -
- -**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. -* **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. - -

Transaction preview displayed on Leather wallet

- -

Function arguments and confirmation button

- -#### 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 %} - -

Telegram message with transaction pending status.

- -

Telegram message with transaction success status.

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

Selected Auto Stake in "My Staking"

- -#### Step 3: Confirm Auto Stake - -A confirmation panel will appear where you can double check the amount. If everything looks correct, click `Confirm`. - -
- -**Confirm Harvest** - -* **Harvest:** The amount of staked $ALEX that will be auto staked and the amount of APower that you have earned by staking. -* **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. - -

Transaction preview displayed on Leather wallet

- -

Function arguments and confirmation button

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

Your LiALEX in "My Staking"

- -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](https://coinfabrik.gitbook.io/alexlab-doc/stake/features/staking/faqs). - -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. - -

Telegram message with transaction pending status.

- -

Telegram message with transaction success status.

+Comming soon. diff --git a/docs/product-features/staking/key-concepts.md b/docs/product-features/staking/key-concepts.md index 6cbdd03..0006e18 100644 --- a/docs/product-features/staking/key-concepts.md +++ b/docs/product-features/staking/key-concepts.md @@ -1,39 +1,3 @@ # 💡 Key concepts -### Staking Basics - -Staking consists of locking your ALEX tokens temporarily to earn ALEX and APower tokens as rewards. Users can stake their tokens to earn passive income in the form of newly minted tokens and transaction fees. - -The ALEX staking pool offers two main options, each one rewarding stakers with a different token: manual staking with $ALEX or liquid staking with LiALEX. - -### Rewards - -Staking rewards are the compensation that you can receive in return for locking up your $ALEX tokens for a certain amount of staking cycles. The longer you stake your $ALEX, the greater the rewards. They are obtained from transaction fees and newly minted tokens. - -The network calculates each participant's reward share based on their staked amount. Rewards are either automatically reinvested in the case of **Liquid Staking** or can be claimed after **every cycle** in the case of **Manual Staking.** This means that, even if you decided to stake your tokens for 8 cycles, you will be able to claim rewards after each cycle concludes. - -To maximize your returns, you should claim and re-stake your rewards as soon as they are available to generate compounded returns. Unclaimed rewards do not expire, so you can claim them whenever you wish, but they do not generate returns either. - -### APR - -The average APR (Annual Percentage Rate) reflects the yearly interest of your investment minus fees. It does not include compounding interest. The longer the staking cycle, the higher the APR, since you will be skipping less cycles due to cool-down. - -### Cycles & 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. - -After the chosen cycles expire, you can claim your rewards and withdraw your staked tokens, or re-stake them for however many cycles you choose. Bear in mind that, once your custom-selected number of cycles ends, there will be a **cooldown cycle** with no rewards received, after which you may re-stake and resume earning rewards. For that reason, the longer you stake, the fewer cool-down cycles you will have, resulting in greater returns overall. - -### Manual Staking - -Manual Staking is the conventional way of staking your tokens on the ALEX network. After each cycle, you will have the option to harvest your rewards, which you may re-stake manually to generate compound interest. When you harvest your rewards, those tokens are automatically transferred to your wallet. - -### Liquid Staking - -[Liquid Staking](https://app.lisalab.io/li/alex/staking) with LiALEX allows users to earn rewards just as in manual staking, but with the added benefits of maintaining liquidity and automatic re-staking. Liquid staking is made possible through LISA, a set of tools deployed by ALEX Labs on the Stacks blockchain. - -Liquid staking earns you passive compound interest on your investment, as you won't need to manually harvest and re-stake your rewards. Since your rewards are automatically reinvested, there is no cooldown period, which allows you to maximize your returns. - -Staking $ALEX through LISA provides users with LiALEX, a transferable utility token that can be used for other on-chain activities. Liquid staking not only allows you to earn rewards from your investment, but also frees you from the constraints of locking up your assets. - -For more information, you can consult the [LISA Documentation](https://docs.lisalab.io/). +Comming soon. From a14d47d430094f182baf462b89b5f424a6a250d1 Mon Sep 17 00:00:00 2001 From: sofinico Date: Fri, 10 Jan 2025 11:34:05 -0300 Subject: [PATCH 8/9] chore: address alex team review --- docs/product-features/self-service-listing.md | 40 ++++++++++--------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/docs/product-features/self-service-listing.md b/docs/product-features/self-service-listing.md index a6fa0f9..0f6ed3c 100644 --- a/docs/product-features/self-service-listing.md +++ b/docs/product-features/self-service-listing.md @@ -18,14 +18,16 @@ Self-Service Listing allows you to **create your own liquidity pool** on the ALE Pool creation usually takes between 24 to 48 hours. Once the pool is created and live, the price discovery phase begins: users can start trading the listed token against the anchor token and viceversa. Users interested in providing liquidity can contribute to the pool like any other ALEX pool. -The pool owner is the initial liquidity provider and will receive the corresponding LP tokens upon successful pool creation. Once the pool is live and operational, the owner can withdraw funds just like any other liquidity provider. +The pool owner is the initial liquidity provider and is responsible for selecting the settings for the initial LP tokens (see [Step 2: Choose LP Lock & Burn Settings](#step-2-choose-lp-lock--burn-settings)). + +The trading pool operates using the [ALEX Automated Market Maker (AMM)](../detailed-information/alexs-automated-market-maker-amm.md) algorithm, which dynamically determines the exchange rate (price) based on the trades. + +**Avaiblable Anchor Tokens:** Native STX token, ALEX token and aBTC token. {% hint style="info" %} -Avaiblable Anchor Tokens: Native _STX_ token, _ALEX_ token and _aBTC_ token. +Interested in having your own unique pairs out of the available anchor tokens? Please [reach out to us](https://t.me/ALEXselfservice). It is important to note that unique pairs are subject to approval by the ALEX Lab Foundation team. {% endhint %} -The trading pool operates under the [ALEX Automated Market Maker (AMM)](../detailed-information/alexs-automated-market-maker-amm.md) algorithm, which dynamically determines the exchange rate (price) based on the trades. - ### Minimum requirements 👉 **Token Deployment.** Ensure your token is deployed on the Stacks blockchain, as you will need to provide the token contract. @@ -82,11 +84,11 @@ Provide the listed token contract address. Ensure it complies with the [SIP-010 Verify that the token information retrieved from the contract is correct. In the example: -* **Token name** -> `RABBY Token` -* **Token symbol** -> `RABBY` -* **Description** -> Unlock the potential of programmable adventures within Bitcoin's rabbit holes. -* **Token deployment address** -> `SP108J6F4C7JD93BGJ91TEB5D3CFB5XW39QHDJ3MV` -* **Token logo** +- **Token name** -> `RABBY Token` +- **Token symbol** -> `RABBY` +- **Description** -> Unlock the potential of programmable adventures within Bitcoin's rabbit holes. +- **Token deployment address** -> `SP108J6F4C7JD93BGJ91TEB5D3CFB5XW39QHDJ3MV` +- **Token logo** @@ -98,9 +100,9 @@ Enter the initial balances for both tokens. You can experiment with different am In the screenshot example, this is: -* **Anchor Token ⚓** (a.k.a `token-x`) -> `4,000 STX ($7,200)` -* **Listing Token 🚀** (a.k.a `token-y`) -> `200,000 RABBY` -* **Exchange Rate ⚖️** -> `1 RABBY = 0.02 STX ($0.03)` +- **Anchor Token ⚓** (a.k.a `token-x`) -> `4,000 STX ($7,200)` +- **Listing Token 🚀** (a.k.a `token-y`) -> `200,000 RABBY` +- **Exchange Rate ⚖️** -> `1 RABBY = 0.02 STX ($0.03)` Once the pool opens, the AMM algorithm will automatically rebalance the exchange rate as users trade the tokens. @@ -126,9 +128,9 @@ Click `Submit` and scroll through the wallet transaction window, ensuring the pa 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. +- 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. @@ -136,7 +138,7 @@ Recommended to track transaction status: After submitting the Self-Service Listing Pool, a pop-up will appear, allowing the creator to choose whether to lock or burn the initial LP tokens, or to leave the liquidity pool unlocked. By default, the Self-Service Listing Pool is set to be locked for 6 months, as it is the recommended option. Users are prompted to select one of three settings: -- **Do not lock LP 🔓**: There will be no lock-up period and the initial liquidity provider (the pool creator) will receive the corresponding LP tokens once the pool is live and operational. Since the pool is unlocked, the owner will be able to withdraw liquidity at any time. +- **Do not lock LP 🔓**: There will be no lock-up period and the initial liquidity provider (the pool creator) will receive the corresponding LP tokens once the pool is live and operational. Since the pool is unlocked, the owner will be able to withdraw liquidity at any time. - **LP is locked for 6 months 🔒** : This is the default option. It locks liquidity within decentralized smart contracts for a 6 month period, requiring a manual LP claim after maturity. When the period concludes, the pool owner can withdraw liquidity as any other provider. This prevents unexpected withdrawals and protects liquidity providers from rug pulls. @@ -174,9 +176,9 @@ To make your token visible on the ALEX Token List at [app.alexlab.co/token-list] ALEX requires a [Coingecko](https://www.coingecko.com/) or [CoinMarketCap](https://coinmarketcap.com/) token listing to verify the provided social media information before uploading it to the official list at [app.alexlab.co/token-list](https://app.alexlab.co/token-list). -Thanks for creating your pool on the ALEX DEX 🎉 📈 +Thanks for creating your pool on the ALEX DEX 🎉 📈 - \ No newline at end of file +--> From 5f2a035ad477433455bbb933edf3a2adafcad56d Mon Sep 17 00:00:00 2001 From: sofinico Date: Fri, 10 Jan 2025 11:48:17 -0300 Subject: [PATCH 9/9] chore: fix typo --- docs/product-features/self-service-listing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/product-features/self-service-listing.md b/docs/product-features/self-service-listing.md index 0f6ed3c..64aa563 100644 --- a/docs/product-features/self-service-listing.md +++ b/docs/product-features/self-service-listing.md @@ -22,7 +22,7 @@ The pool owner is the initial liquidity provider and is responsible for selectin The trading pool operates using the [ALEX Automated Market Maker (AMM)](../detailed-information/alexs-automated-market-maker-amm.md) algorithm, which dynamically determines the exchange rate (price) based on the trades. -**Avaiblable Anchor Tokens:** Native STX token, ALEX token and aBTC token. +**Available Anchor Tokens:** Native STX token, ALEX token and aBTC token. {% hint style="info" %} Interested in having your own unique pairs out of the available anchor tokens? Please [reach out to us](https://t.me/ALEXselfservice). It is important to note that unique pairs are subject to approval by the ALEX Lab Foundation team.