Skip to content

Commit

Permalink
dApp Staking V3 User Guides (#576)
Browse files Browse the repository at this point in the history
* dApp Staking V3 User Guides

- Moved dApp Staking from Build to Use Category
- Moved old dApp Staking v2 guide & images under dApp Staking section;
- Added dApp Staking v3 User guide & images;
- Updated all links to dApp Staking section;
- Organized Use Category Sidebar;
- Ran `Yarn build` without errors;

* Added V2 users warning message

- Addition of a warning message to inform that V3 is only available on Shibuya and invite V2 users to visit the dApp Staking V2 category.
- Fixed a few typo;

* Update after Dino's suggestions

* Update index.md

* Added suggestions

* Updated User Guide - v2

- Resolved conflicts with PR 573;
- Re-added a dApp Staking page under Build section;
- Moved integrate dApp Staking page to Build/dApp-staking page;
- Fixed typo;
- Added suggestions;
- Changed and enlarged images;
- Changed every unbond & unbonding to unlock & unlocking;
- Removed all mentions of Build2Earn;

* Update index.md

---------

Co-authored-by: Ivan <95318860+andabak@users.noreply.github.com>
  • Loading branch information
Gunit2481 and andabak committed Jan 19, 2024
1 parent d95bfbe commit a38d806
Show file tree
Hide file tree
Showing 134 changed files with 412 additions and 63 deletions.
18 changes: 18 additions & 0 deletions docs/build/dapp-staking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
sidebar_position: 4
---

# dApp Staking

All content relating to dApp Staking has been moved to other sections of the documentation:
- For general and technical documentation on dApp Staking, refer to [dApp Staking](/docs/learn/dapp-staking/) in the Learn section ;
- For Stakers, refer to [dApp Staking for stakers](/docs/use/dapp-staking/for-stakers/) in the Use section;
- For projects looking to join the dApp Staking program, refer to [dApp Staking for devs](/docs/use/dapp-staking/for-devs/) in the Use section;

If you are interested in developing on top of dApp Staking and integrating dApp Staking into your project, please refer to the section below:

# Integrate dApp Staking

Learn how to integrate dApp staking into your EVM dApp in the precompiles chapter:

[EVM Precompiled Contracts](/docs/build/evm/precompiles/staking/)
9 changes: 0 additions & 9 deletions docs/build/dapp-staking/for-devs/integrate-dapp-staking.md

This file was deleted.

Binary file removed docs/build/dapp-staking/for-stakers/img/10.png
Binary file not shown.
Binary file removed docs/build/dapp-staking/for-stakers/img/11.png
Binary file not shown.
Binary file removed docs/build/dapp-staking/for-stakers/img/12.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/build/dapp-staking/for-stakers/img/2.png
Binary file not shown.
Binary file removed docs/build/dapp-staking/for-stakers/img/3.png
Binary file not shown.
Binary file removed docs/build/dapp-staking/for-stakers/img/4.png
Binary file not shown.
Binary file removed docs/build/dapp-staking/for-stakers/img/5.png
Binary file not shown.
Binary file removed docs/build/dapp-staking/for-stakers/img/6.png
Binary file not shown.
Binary file removed docs/build/dapp-staking/for-stakers/img/7.png
Binary file not shown.
Binary file removed docs/build/dapp-staking/for-stakers/img/8.png
Binary file not shown.
Binary file removed docs/build/dapp-staking/for-stakers/img/9.png
Binary file not shown.
24 changes: 0 additions & 24 deletions docs/build/dapp-staking/for-stakers/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/build/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Astar is a interoperable smart contract platform providing native access to both
✅ Global Standard NFT Marketplace & DEX (Dew, Rarible, Quickswap) <br/>

## Build2Earn
Astar network's innovative Build2Earn program allows developers to earn a basic income while they build out their products and communities. Users are able to support projects by staking on them, which adds to the passive income developers earn and forms the basis of an *unstoppable grant*. Build2Earn encourages projects to stand out and provide value directly to end-users. See the [dApp staking section](/docs/build/dapp-staking/) for more information.
Astar network's innovative Build2Earn program allows developers to earn a basic income while they build out their products and communities. Users are able to support projects by staking on them, which adds to the passive income developers earn and forms the basis of an *unstoppable grant*. Build2Earn encourages projects to stand out and provide value directly to end-users. See the [dApp staking section](/docs/use/dapp-staking/) for more information.

## Wasm smart contracts
See the [Wasm chapter](/docs/build/wasm) for more information.
Expand Down
2 changes: 1 addition & 1 deletion docs/build/integrations/wallets/ledger/ledger-native.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Ledger NanoS users should install the Astar XL version of the app, shown in the

<Figure src={require('/docs/build/integrations/wallets/ledger/img/native/ledger8.png').default} width='600px' />

For detailed information about dApp staking or how to stake on the EVM side of Astar Portal using a Ledger device, please refer to the [Astar official documentation](/docs/build/dapp-staking/for-stakers/) or [Ledger EVM staking guide](./ledger-evm.md)
For detailed information about dApp staking or how to stake on the EVM side of Astar Portal using a Ledger device, please refer to the [Astar official documentation](/docs/use/dapp-staking/for-stakers/) or [Ledger EVM staking guide](./ledger-evm.md)

:::tip
If you receive a **Ledger error: Failed to execute 'claimInterface' on 'USBDevice': Unable to claim interface** message during the dApp staking claim process, ensure you are performing the operation using a Chromium-based browser such as Chrome or Brave, and the Ledger device connection method is WebHID, as outlined in the previous step.
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/dapp-staking/dapp-staking-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ These are major remarks about the migration:
If any of the terms above are unclear to you (e.g. _staking_ vs _locking_) you can find detailed exaplanation the following sections:

- [Tokenomics 2.0](/docs/learn/tokenomics2/)
- [dApp Staking v3 Technical Overview](/docs/learn/dapp-staking/dapp-staking-protocol.md)
- [dApp Staking v3 Technical Overview](/docs/learn/dapp-staking/dapp-staking-protocol/)

### Practical explanation with an example:

Expand Down
11 changes: 6 additions & 5 deletions docs/learn/dapp-staking/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ Another way for the value of tokens to increase is if the total circulation of t

This market dynamic enables dApp stakers to get more long-term value from their tokens while earning high APRs from staking their tokens to dApps.

Please refer to [this section](/docs/build/dapp-staking/for-stakers/) to learn more about participating as a staker.

Please refer to [this section](/docs/use/dapp-staking/for-stakers/) to learn more about participating as a staker.

### Benefits for Builders: Earn Rewards

Expand All @@ -42,7 +43,7 @@ Ultimately, the most precious human resource in the Web3 ecosystem are developer

With dApp staking, developers can earn a basic income while building dApps on Astar/Shiden. Having financial incentives entices more developers to build and improve their dApps. The more developers build on our ecosystem, the better off everyone is.

Please refer to [this section](/docs/build/dapp-staking/for-devs/) to learn more about participating as a dApp builder.
Please refer to [this section](/docs/use/dapp-staking/for-devs/) to learn more about participating as a dApp builder.

### Benefits for dApp Users: Increase in dApp & Network Utility

Expand All @@ -53,11 +54,11 @@ Having more (and better) dApps attracts and retains more users, creating a netwo

## What next?

If you are ASTR token holder interested in staking please refer to [this section](/docs/build/dapp-staking/for-stakers/) to learn more about participating as a staker.
If you are ASTR token holder interested in staking please refer to [this section](/docs/use/dapp-staking/for-stakers/) to learn more about participating as a staker.

If you are a dApp developer building on Astar, please refer to [this section](/docs/build/dapp-staking/for-stakers/) to learn more about participating as a staker.
If you are a dApp developer building on Astar, please refer to [this section](/docs/use/dapp-staking/for-devs/) to learn more about participating as a dApp.

For detailed technical overview of dAppStaking protocol please go [here](/docs/learn/dapp-staking/dapp-staking-protocol.md)
For detailed technical overview of dAppStaking protocol please go [here](/docs/learn/dapp-staking/dapp-staking-protocol/).

:::info

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "dApp Staking",
"position": 5
"position": 4
}
4 changes: 4 additions & 0 deletions docs/use/dapp-staking/dapp-staking-v2/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "dApp Staking V2",
"position": 3
}
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# dApp Staking & Web3

:::info
This section of dApp Staking V2 is a legacy of the current dApp Staking model and serves as a reference until the complete transition to dApp Staking v3.

Full overview of dAppStaking v3 can be found in the [Learn/dAppStaking](/docs/learn/dapp-staking/) section of the docs.
:::

At Astar, we are on a mission to revolutionize the internet. We envision a future where the internet is truly decentralized, and not controlled by a handful of tech giants. We believe the internet should be free and owned by the people for the people. We believe that people should have ownership of their data and assets, and not be at the mercy of intermediaries. This is the essence of the Web3 vision and what drives Astar.

*What does this have to do with dApp staking*? Well, to put it simply, a lot.
Expand All @@ -12,11 +18,7 @@ DApp staking is one of the catalysts that will accelerate the Web3 vision from a

At Astar Network, we are tackling these three challenges head-on.

The third point, namely — the necessity for great dApps to be built — is the driving force behind **#Build2Earn (our dApp staking initiative)** and the focus of this article.

:::info
Full overview of dAppStaking v3 can be found in the [Learn/dAppStaking](/docs/learn/dapp-staking/) section of the docs.
:::
The third point, namely — the necessity for great dApps to be built — is the driving force behind **dApp staking** and the focus of this article.

## What is dApp Staking?

Expand Down Expand Up @@ -58,14 +60,8 @@ Ultimately, the most precious human resource in the Web3 ecosystem is developers

With dApp staking, developers can earn a basic income while building dApps on Astar/Shiden. Having financial incentives entices more developers to build and improve their dApps. The more developers build on our ecosystem, the better off everyone is.

## Build2Earn Program

Our dApp staking initiative on Astar is foundational to our #Build2Earn program and is the natural continuation of our [#Stake2Earn](https://medium.com/astar-network/stake2earn-festival-411cb712a380) campaign. #Build2Earn is our financial incentive program whose aim is to provide a basic income to developers for building useful dApps on Astar/Shiden.

In the coming days, we will be announcing more details about important projects being built on Astar/Shiden Network. We will also be sharing step-by-step details on how to stake your Astar/Shiden tokens so that you too can partake in dApp staking, and help build the Web3 internet of tomorrow.


import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
<DocCardList items={useCurrentSidebarCategory().items}/>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 13
sidebar_position: 7
---

# Manually Claim dApp Staking Rewards On Polkadot.Js
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,3 @@ The unbonding panel is where you can see the progress of unbonding and withdraw.
My dApps Panel is where you can see all dApps you have staked with and manage the assets.
- **Add**: you can add more $ASTR in dApp staking.
- **Unbond**: here you can select how many tokens you want to unbond from your staked amount.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 11
sidebar_position: 5
---

# Unbond Vested Tokens
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 12
sidebar_position: 6
---

# Withdraw Stake From Unregistered Contract
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you have a campaign or new product you would like to share in the community,

You can create a PR once a month, at most.

<Figure src={require('/docs/build/dapp-staking/for-devs/img/promotion-card.png').default} width="100%" />
<Figure src={require('/docs/use/dapp-staking/for-devs/img/promotion-card.png').default} width="100%" />

# Steps for creating a PR for the promotion card

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Astar is aiming to become a DAO in a couple of years. While moving towards becom
## Astar Network

- Your dApp is **launched and live on Astar Network**
- Does your project contribute to Astar TVL, make sure you are listed on [DefilLama](../../integrations/dapp-listing/defillama).
- List your project on [DappRadar](../../integrations/dapp-listing/dappradar).
- Does your project contribute to Astar TVL? Make sure you are listed on [DefilLama](/docs/build/integrations/dapp-listing/defillama).
- List your project on [DappRadar](/docs/build/integrations/dapp-listing/dappradar).
- Your dApp has #astar-network, #dAppStaking tags at the GitHub repo.
- You need to create a PR to the Ecosystem Page. As our website is open-source, you can contribute directly to it - just create a PR on your own! [Here](https://github.com/AstarNetwork/astarwebsite_v2/blob/349db39d724b57f58fbee84b3fa500bf0d29bee6/components/Header.vue)
- If you wish to have your project listed on Astar website [ecosystem page](https://astar.network/community/ecosystem), fill in this [FORM](https://forms.gle/xsGUnCt3fm4isWWF7).
Expand Down
107 changes: 107 additions & 0 deletions docs/use/dapp-staking/for-stakers/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
import Figure from "/src/components/figure"

# For Stakers

## Overview

Do you love to stake? Or do you want to support your favorite project on Astar Network or Shiden Network?

Discover [dApp Staking](/docs/learn/dapp-staking/), a unique mechanism that allows communities to support their favorite teams by staking ASTR or SDN with them. When staking ASTR or SDN on a dApp, users not only support the development of innovative apps but also receive staking rewards from inflation.

You can educate yourself more by reading the technical documentation about [dApp Staking](/docs/learn/dapp-staking/).

:::warning

dApp Staking V3 is launched and accessible only on the Shibuya testnet. For dApp Staking users on Astar and Shiden Network, please refer to the [dApp Staking V2 section](/docs/use/dapp-staking/dapp-staking-v2/).

:::

### Periods, Subperiods & Eras:

`Eras`: Time units measured in blocks. Fairly short, a basic time division in dApp staking;

**dApp Staking** is divided into **Periods** which consists of two **Subperiods**: **Voting** and **Build&Earn**.

**Voting** is the subperiod when stakers can decide to vote for dApp(s) to stake their tokens and when dApps owners and team can market their products, conduct campaign and attract stakers.
No staking rewards are generated during the Voting subperiod but if users vote and stake on dApps during this subperiod, they will become eligible for the **Bonus Reward**;

**Build&Earn** is the subperiod when stakers and dApps start earning rewards;
Users can still stake tokens during the Build&Earn subperiod to increase the rewards they get from staking. However, the amount staked during Build&Earn does not contribute to the Bonus Reward.

At the end of a **Build&Earn** subperiod, the current period ends. A new period begins, and all tokens are `unstaked` from dApp(s) but remain `locked`. A new **Voting Subperiod** starts.

As an user, you need to take the following parameters into consideration before using dApp Staking:

### Parameters:

| | Shibuya | Shiden Network | Astar Network |
| --- | --- | --- | --- |
| Eras Per Period | 28 (~7days) | TBD | TBD |
| Eras Per Voting Subperiod | 8 (~48hours) | TBD | TBD |
| Eras Per Build&Earn Subperiod | 20 (~120hours) | TBD |TBD |
| Blocks Per Era | 1800 (~6hours) | TBD | TBD |
| Unlocking Period | 4 Eras (~1 day) | 5 Eras (~5 days) | 10 Eras (~10 days) |
| Minimum Amount to Stake | 5 SBY | 50 SDN | 500 ASTR |


### Basic Staking Rewards:

dApp Staking rewards are generated only if tokens have been staked on a dApp for at least 1 full `Era` and distributed on the following `Era` (Era+1);

:::tip

For stakers, if you stake today, you will start earning tomorrow (next era), and the rewards will be distributed the day after tomorrow.
For dApps If you get into a tier today, you will start earning rewards tomorrow (next era) and the rewards will be distributed the day after tomorrow.

:::

For stakers, the APR is the same for all stakers, regardless of which dApp they stake on;
For dApps, staking rewards depends on the Tier system, dApps go into rewards tier based on the amount of tokens staked by users.

Rewards must be claimed before trying to `stake` or `unstake`.
*(If using the Astar Portal, the interface will automatically claim the rewards when voting)*

If a project is **unregistered** from dApp Staking, staked tokens on that project will still receive **basic rewards** as long as the tokens remain staked.

:::warning

There is no rewards during the Unlocking period when unstaking from dApp Staking;

:::

### Bonus Staking Rewards:

If an user stake on dApp(s) during the **Voting Subperiod** and keep the same staked amount or higher on a dApp through the whole **Build&Earn Subperiod**, they will be eligible for the **Bonus Reward** for this dApp.

:::info

**Example**

- User stake 1500 ASTR on **dApp A** and 1000 ASTR on **dApp B** during the `Voting`subperiod.
- During the `Build&Earn` subperiod, user move 500 ASTR from **dApp B** to **dApp A**;
- He now has 2000 ASTR on **dApp A** and 500 ASTR on **dApp B**, so he's still eligible for the `Bonus reward` for **dApp A** but no longer for **dApp B** because the tokens staked on **dApp** B are less than those staked at the end of the `Voting` subperiod (500 < 1000 ASTR).
- To be eligible for the `Bonus reward` for **dApp B**, the user must stake an additional 500 ASTR on **dApp B** to reach 1000 ASTR.

:::

Bonus rewards for a period can only be claimed after the period finishes.


### Other:

- You need to keep a minimum of 10 ASTR or 5 SDN tokens as transferable after staking.
- **You need to claim to receive your rewards, we recommend claiming your staking rewards once a week.**
- When unlocking tokens, there is a unlocking period on Astar and on Shiden. The unlocking period lenghts can be consulted [here](/docs/use/dapp-staking/for-stakers/#parameters).
Please note that this is based on a perfect block production of 12s. In case of any delay, your unlocking period can be a little longer.

In case you have any questions, please check the [FAQ page](/docs/learn/dapp-staking/dapp-staking-faq/) in the Learn section or join our [Discord channel](https://discord.com/invite/astarnetwork).

Other pages that can be of interest:

<br/>

import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>

Loading

0 comments on commit a38d806

Please sign in to comment.