Skip to content
This repository has been archived by the owner on Oct 29, 2024. It is now read-only.

Commit

Permalink
update links to images; get to generation of exhaustive list
Browse files Browse the repository at this point in the history
  • Loading branch information
meganskye committed Jun 7, 2024
1 parent 43c2900 commit 992ba7e
Show file tree
Hide file tree
Showing 79 changed files with 786 additions and 246 deletions.
2 changes: 1 addition & 1 deletion docs/about/architecture/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import Figure from '/src/components/figure'
# Overview
Before you get started on your journey towards becoming an Astar network hacker, it will be beneficial to know about what Polkadot and Ethereum are, because Astar Network connects to both, and each have their own set of benefits benefits and limitations.

<Figure src={require('/docs/learn/architecture/img/fig4.jpg').default} />
<Figure src={require('/docs/about/architecture/img/fig4.jpg').default} />

Some highlights on the Polkadot parachain side are dApp Staking, ink! smart contracts, cross-chain messaging (XCM), and forkless upgradability, and on the Ethereum layer 2 side are the highest levels of EVM equivalence, shared liquidity across layer 2 networks, and access to the largest pool of developers in the blockchain industry that we can tailor our products for, on-demand.

Expand Down
2 changes: 1 addition & 1 deletion docs/about/economics/astar-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ Shibuya's token is SBY.
There are ways to get SBY for testing purposes via Faucet on the Astar Portal.

## Learn more
Get [SBY tokens](/docs/build/environment/faucet.md)
Obtain [SBY tokens](/docs/build/build-on-layer-1/environment/faucet.md)
Binary file added docs/about/economics/img/inflation_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/about/economics/img/tokenomics_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/about/economics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 12

Astar Network's tokenomics has been revised to best serve the needs of network participants, from users and builders to enterprise partners.

Tokenomics 2.0 introduce a sustainable token allocation structure and network fees as well as a lower inflation rate.
Tokenomics 2.0 introduces a sustainable token allocation structure and network fees as well as a lower inflation rate.

:::info
The outline of the phased approach to Tokenomics 2.0 as it progressed:
Expand Down
4 changes: 2 additions & 2 deletions docs/about/economics/legacy_inflation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ For the latest, please refer to the _Tokenomics 2.0_ model.

# Tokenomics 1.0

import tokenomics from '/docs/learn/img/tokenomics_1.png'
import inflation from '/docs/learn/img/inflation_1.png'
import tokenomics from '/docs/about/economics/img/tokenomics_1.png'
import inflation from '/docs/about/economics/img/inflation_1.png'

[Astar Network]: https://astar.network/

Expand Down
4 changes: 2 additions & 2 deletions docs/about/economics/tokenomics2-network-fees.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ The other limiting factor is the **Proof of Validity** (PoV) size. Since Polkado

In summary, there are two main factors limiting block production: `ref time` and `PoV size`, which taken all together, are collectively referred to as `weight`, an important concept when calculating transaction fees.

<Figure caption="Block Consumption" src={require('/docs/learn/tokenomics2/img/Astar-Block-Consumption.jpeg').default } width="100%" />
<Figure caption="Block Consumption" src={require('/docs/about/economics/img/Astar-Block-Consumption.jpeg').default } width="100%" />

Transaction Fees on Astar comprise of Native (Substrate) and EVM fees. Native and EVM transaction fees are calculated in different ways. Tokenomics 2.0 aligns the fees calculation between the two systems so that transactions consuming the same amount of block resources are priced roughly the same regardless of transaction type (Native or EVM).
Transaction Fees on Astar are comprised of Native (Substrate) and EVM fees. Native and EVM transaction fees are calculated in different ways. Tokenomics 2.0 aligns the fees calculation between the two systems so that transactions consuming the same amount of block resources are priced roughly the same regardless of transaction type (Native or EVM).

This section describes Tokenomics 2.0 fee model calculation details.

Expand Down
6 changes: 3 additions & 3 deletions docs/about/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,10 @@ A concept of layer 2 scaling. Modular blockchain systems move two or more of the
Partition of a blockchain network that allows for parallel processing of transactions to increase scalability and network capacity.

### Shiden
The "canary network" for Astar connected to Kusama, a canary network for Polkadot. It consists of an early-release, unaudited version of the Astar codebase. It is not a testnet. For more info refer to the [Networks](/docs/learn/networks.md) section.
The "canary network" for Astar connected to Kusama, a canary network for Polkadot. It consists of an early-release, unaudited version of the Astar codebase. It is not a testnet. For more info refer to the [Networks](/docs/about/networks.md) section.

### Shibuya
A testnet for Shiden and Astar. For more info refer to the [Networks](/docs/learn/networks.md) section.
A testnet for Shiden and Astar. For more info refer to the [Networks](/docs/about/networks.md) section.

### Smart Contract
A self-executing computer program that automatically enforces and executes the terms of an agreement between parties on a blockchain network.
Expand Down Expand Up @@ -139,7 +139,7 @@ A concept of layer 2 scaling. Modular blockchain systems move two or more of the
A cryptographic protocol that allows one party to prove knowledge of a secret without revealing the secret itself.

### zKatana
A testnet for Astar zkEVM. For more info refer to the [Networks](/docs/learn/networks.md) section.
A testnet for Astar zkEVM. For more info refer to the [Networks](/docs/about/networks.md) section.

### Zombienet
A CLI tool to easily spawn ephemeral Substrate-based networks and perform tests against them.
Expand Down
10 changes: 3 additions & 7 deletions docs/about/networks.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 6

Prior to commencing development it's important to understand the Astar Network family, and choose an appropriate network based on what you would like to do. Currently, there are a number of networks available, including the Local network which runs exclusively within your development environment. All networks support EVM RPCs, and Astar Parachain supports Substrate RPC as well.

![Astar networks](img/fig4.jpg)
![Astar networks](../about/products/img/fig4.jpg)

## Local Networks

Expand All @@ -17,11 +17,11 @@ You can clone the Astar repository and run the local node provided, or download
### Swanky Node

Swanky Node is a Substrate based blockchain configured to enable the smart contract module `pallet-contracts`, and other features that assist local development of Wasm smart contracts.
For more information about Swanky Node, check out the [Swanky Suite](https://docs.astar.network/docs/build/wasm/swanky-suite/) section.
For more information about Swanky Node, check out the [Swanky Suite](https://docs.astar.network/docs/build/wasm/swanky-suite/) section. [INSERT LINK]

### Zombienet

With Zombienet users can download arbitrary Relay Chain and parachain binaries (or use images) to setup a configurable local test network. Users will have access to all privileged actions on the Relay Chain and parachains, which simplifies testing. For more information about Zombienet, check out the [Build Environment](https://docs.astar.network/docs/build/environment/zombienet-testing) chapter.
With Zombienet users can download arbitrary Relay Chain and parachain binaries (or use images) to setup a configurable local test network. Users will have access to all privileged actions on the Relay Chain and parachains, which simplifies testing. For more information about Zombienet, check out the [Build Environment](https://docs.astar.network/docs/build/environment/zombienet-testing) chapter. [INSERT LINK]

## Testnets

Expand All @@ -34,10 +34,6 @@ The Shibuya native token symbol is SBY.

To obtain test tokens from the faucet, please visit the Astar Portal and connect to Shibuya. If for any reason the faucet is empty, please contact the Astar team on Discord.

### zKatana (Sepolia) - Deprecated

An early iteration of the zkEVM testnet that used zk rollup architecture. Now deprecated.

### zKyoto (Sepolia)

zKyoto is a Validium-based network connected to the Ethereum Sepolia testnet and Polygon AggLayer. It is the testing and proving ground for dApps deployed on the Astar zkEVM.
Expand Down
2 changes: 1 addition & 1 deletion docs/about/products/dapp-staking/dapp-staking-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ As a staker, you will need to pick which dApp(s) to stake on again. **It’s imp

### Q: I've staked 16 dApps and now I can't add or move tokens and I'm getting an error. What should I do?

<Figure src={require('/docs/learn/img/Maxium_contracts_error.png').default } width="50%" />
<Figure src={require('/docs/about/products/img/Maxium_contracts_error.png').default } width="50%" />

An address can stake on a maximum of 16 contracts (dApps).
- You must unstake all your tokens from one of these dApps, so that you'll be staking on 15 dApps instead of 16.
Expand Down
27 changes: 27 additions & 0 deletions docs/about/products/dapp-staking/dapp-staking/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
sidebar_position: 2
sidebar_label: dApp Staking
title: Astar dApp Staking
---

## What is dApp Staking

dApp staking on Astar and Shiden Network introduces a novel approach, empowering individuals to nominate their ASTR or SDN tokens to support dApps building on the network.

For every block produced on the network, a segment of inflation is specifically allocated to dApp staking. These rewards are then divided between the dApp developers and stakers involved, offering benefits to both developers and stakers.

As a dApp gains popularity and attracts more stakers, the developers stand to receive a greater share of block rewards. Importantly, the dApp staking program is inclusive, accommodating projects utilizing EVM and Wasm technologies, along with zkEVM dApps.

For a more detailed explanation of dApp Staking, refer to the comprehensive presentation in the [Learn section] (/docs/learn/dapp-staking/). **LINK TO UPDATE**

### User & Developers guides

In the following sections, you'll find all the help you need to interact with dApp Staking as a staker or dApp owner.

You will also find guides for dApp Staking V2 for reference until the full transition to dApp Staking V3.


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

<DocCardList items={useCurrentSidebarCategory().items}/>
4 changes: 4 additions & 0 deletions docs/about/products/dapp-staking/for-devs/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "For Devs",
"position": 2
}
33 changes: 33 additions & 0 deletions docs/about/products/dapp-staking/for-devs/create-promotion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
sidebar_position: 4
---

import Figure from '/src/components/figure'

# Create a promotion card on top page

If you have a campaign or new product you would like to share in the community, this will help you spread the news. It will create a card which will be shown on the top of the dApp Staking page as well as the Portal asset page.

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

<Figure src={require('/docs/use/how-to-guides/layer-1/dapp-staking/for-devs/img/Promotion_card_3.png').default} width="90%" />

# Steps for creating a PR for the promotion card

- Fork our [astar-apps](https://github.com/AstarNetwork/astar-apps) repository.

- Find a file [dapp_promotion.json](https://github.com/AstarNetwork/astar-apps/blob/main/src/data/dapp_promotions.json) and put a promotion details there.

- add a promotion image to [public/images/dapp_promotions](https://github.com/AstarNetwork/astar-apps/tree/main/public/images/dapp_promotions) folder.

- Create a PR to the <code>release-hotfix</code> branch in [astar-apps](https://github.com/AstarNetwork/astar-apps).


:::info
- **Image must be 16:9 and recommended size is less than 1MB**.
- **Description is limited to 65 characters maximum**.
- Your PR will be merged after being reviewed by the dApp Staking operation team.
- Card can be removed at any time, for any reason, at the discretion of the operation team.
- Multiple PRs or more than one PR within a month from the same team will not be approved.
:::

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
73 changes: 73 additions & 0 deletions docs/about/products/dapp-staking/for-devs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
import Figure from "/src/components/figure"

# For Developers

## Overview

Discover [dApp Staking] (/docs/learn/dapp-staking/), **LINK TO UPDATE** 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/). **LINK TO UPDATE**

**Are you a product owner and want to list your dApp in our staking mechanism to earn rewards?**

Please take the following parameters into consideration and make sure you meet the [requirements](/use/how-to-guides/layer-1/dapp-staking/for-devs/requirements.md):

:::tip

Before reading the dApp Staking section for dApp owner, make sure you understand the concept of periods, subperiods and eras, as well as the dApp Staking V3 parameters explained [here] (/docs/learn/dapp-staking/#period--subperiods). **LINK TO UPDATE**

:::

### Tier System and Rewards

dApp Staking introduces the concept of a tier system for dApps. It's important to fully understand the [tier mechanism] (/docs/learn/dapp-staking/dapp-staking-protocol#tier-system) before proceeding with dApp Staking application and registration as a dApp owner. **LINK TO UPDATE**

Currently, there are **4 tiers** with a limited number of slots per tier. Tier capacity for dApp staking is calculated at the start of each period based on the ASTR price as described [here] (/docs/learn/dapp-staking/dapp-staking-protocol#tier-system). **LINK TO UPDATE**

The slots allocated to each tier can be viewed on the [dApp Staking Page](https://portal.astar.network/astar/dapp-staking/discover) of the Astar Portal.

At the end of each **Build&Earn** subperiod, dApps are assigned to a tier based on the total value staked on them by users. Each tier has a **threshold** that a dApp must reach in order to access it.

The threshold for tier 4 is fixed, but for the other tiers, the threshold is **dynamic** and calculated at the start of each new period based on the total number of slots for the period. To find out more, [click here] (/docs/learn/dapp-staking/dapp-staking-protocol#tier-threshold-entry). **LINK TO UPDATE**

**Rewards** for dApps are also **dynamic**, fluctuating from tier to tier. The higher the tier, the greater the number of ASTR tokens allocated from inflation as rewards for that tier.

The rewards of a tier are divided between all available slots and distributed to the dApps occupying slots. This means that the rewards for dApps within a tier are the same for each dApp, even if not all slots within a tier are occupied.

*Refer to the [dApp staking parameters] (/docs/learn/dapp-staking/protocol-parameters#network-values) page to find out more about the tier system and reward allocation.* **LINK TO UPDATE**

:::tip
You have to claim your rewards to receive them. We recommend that you claim your rewards at least once a week or, optimistically, 2 or 3 times a week.

:::

:::info

**Example:**

- Tier 1 has 5 slots for dApps and 50,000 ASTR tokens are allocated as a reward;
- At the end of the voting subperiod, only 3 slots are occupied by dApps in Tier 1 ;
- These 3 dApps will each receive 10,000 ASTR as reward;
- The remaining 20,000 ASTR tokens will not be minted by the network and will be considered burnt;

:::

If there are more dApps eligible for a tier than there is capacity, the dApps with the higher score get the advantage. dApps which missed out on a higher tier get priority for entry into the next lower tier (if there still is any).

In the case a dApp doesn't satisfy the entry threshold for any tier, even though there is still capacity, the dApp will simply be left out of tiers and won't earn any reward.

:::warning

In the event that a dApp is **unregistered** from dApp Staking following a governance decision, all developer unclaimed rewards will become unavailable. We recommend that dApp owners claim their rewards regularly.

:::

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

### Other pages may be of interest:

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

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

38 changes: 38 additions & 0 deletions docs/about/products/dapp-staking/for-devs/manage-dApp-Staking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
sidebar_position: 3
---

import Figure from "/src/components/figure"

# Manage dApp & claim rewards

As a dApp owner, a new panel will appear in the Asset page of the Astar portal: **Your Project** ;

<Figure src={require('/docs/use/how-to-guides/layer-1/dapp-staking/for-devs/img/Project.png').default} width="90%" />

By clicking on your dApp in the **Your Project** panel, you will have access to everything related to your dApp, from claiming developer rewards to editing your project information;

### Your Dashboard:

- **Curent Tier:** The current tier to which your dApp has been assigned. See [Tier system] (/docs/use/dapp-staking/for-devs/#tier-system-and-rewards) for more information; **LINK TO UPDATE**
- **Number of stakers:** Total of current stakers on your dApp;
- **Total Earned:** Total tokens received in the dApp Staking program;

<Figure src={require('/docs/use/how-to-guides/layer-1/dapp-staking/for-devs/img/dApp_owner_page.png').default} width="90%" />

### Your Rewards:

Here you can see how many tokens you have earned for past periods and what you still have to `claim`;

<Figure src={require('/docs/use/how-to-guides/layer-1/dapp-staking/for-devs/img/dApp_rewards.png').default} width="100%" />

To claim your tokens, click on the **Claim your rewards** button and sign the transaction with your wallet;
Claiming will release all your pending rewards;

### Edit:

- **Edit Project Page:** Allows you to edit information about your dApp Staking projects;
- **Edit your owner info:** If you want to change the registered smart contract address and the address receiving developer rewards ;
- **Add a promotion card:** If you are running a campaign, you can create a promotion card that will be added to the dApp Staking section of the Portal after review;

<Figure src={require('/docs/use/how-to-guides/layer-1/dapp-staking/for-devs/img/dApp_owner_page_2.png').default} width="85%" />
Loading

0 comments on commit 992ba7e

Please sign in to comment.