Skip to content

Commit

Permalink
Merge pull request #54 from w3f/fix-banners
Browse files Browse the repository at this point in the history
Format Banners
  • Loading branch information
CrackTheCode016 authored Jan 31, 2025
2 parents b070af8 + b7ea0b6 commit 6d561da
Show file tree
Hide file tree
Showing 87 changed files with 715 additions and 2,420 deletions.
7 changes: 2 additions & 5 deletions docs/general/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,11 +256,8 @@ The collection of Substrate-provided pallets (Substrate Runtime Modules).
The origin of a blockchain, also known as block 0. It can also be used to reference the initial
state of the blockchain at origination.

:::note Example

In the _genesis_ state Alice, Bob, and Charlie had 30 tokens each.

:::
!!!note "Example"
In the _genesis_ state Alice, Bob, and Charlie had 30 tokens each.

## Governance

Expand Down
4 changes: 1 addition & 3 deletions docs/kusama/kusama-bug-bounty.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,11 @@ keywords: [bug, bounty, error, report]
slug: ../../kusama-bug-bounty
---

!!!note Program Scope
!!!note "Program Scope"
The bug bounty program does _not_ cover bugs on code bases that are external to or, written on top
of Kusama, or that use Kusama. To be eligible for the bug bounty program the bug has to be a part of
the Kusama codebase, this includes protocols that Polkadot uses such as AnV, XCM, GRANDPA, etc.



We call on our community and all bug bounty hunters to help identify bugs in Kusama.

If you discover a bug, we appreciate your cooperation in responsibly investigating and reporting it
Expand Down
8 changes: 2 additions & 6 deletions docs/kusama/kusama-coc.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,28 +26,24 @@ background. Community participants have read through the requisite resources and
knowledge about Kusama and all related content. This knowledge equips the community with the
requisite information needed to dispense of their duties as a participant.

!!!note Examples of Unacceptable Behavior
!!!note "Examples of Unacceptable Behavior"
These are just a few examples, and you can always consult a team member if you have any questions.

- Obnoxious, aggressive comments towards individuals or other projects on any medium of
communication.
- Knowingly distributing false information about Kusama or other projects.
- Harassing other individuals or projects.



That said, please note that Kusama is an edgy and meme-friendly network, and community member
actions shouldn't be taken too seriously - try to assume jest before malice.

!!!tip What To Do If You Witness or Are Subject To Unacceptable Behavior
!!!tip "What To Do If You Witness or Are Subject To Unacceptable Behavior"
If you are being harassed, notice that someone else is being harassed, or have any other concerns
relating to harassment, please contact the administrator of the channel you’re in.

This Code of Conduct may be revised at any time. We are always willing to revise this document based
on feedback from the Kusama participants and/or the Polkadot community.



## Bugs

Please understand that this network is, despite its success, an experiment with potential flaws, so
Expand Down
20 changes: 5 additions & 15 deletions docs/kusama/kusama-inflation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,7 @@ KSM is an inflationary token. Inflation is set to be 10% annually. Depending on
and the ideal staking rate (more about this below), part of the inflation is distributed to the
stakers and part to the [treasury](../learn/learn-polkadot-opengov-treasury.md).

!!!info
The current KSM token supply can be seen [here](../general/chain-state-values.md#total-issuance).


!!!info The current KSM token supply can be seen [here](../general/chain-state-values.md#total-issuance).

It is essential to understand that the primary objective of inflation is to incentivize network
participants through
Expand All @@ -44,23 +41,16 @@ stake when the _current staking rate_ < _ideal staking rate_ and disincentivize
_current staking rate_ > _ideal staking rate_. The goal is to have the staking rate meet the ideal
staking rate. The current staking rate would be the total amount staked in the current era over the
total token supply, where the total amount staked is the stake of all validators and nominators on
the network. The ideal staking rate accounts for having sufficient backing of tokens to prevent the
possible compromise of security while keeping the native token liquid.
the network. The ideal staking rate accounts for having sufficient backing of tokens to prevent the possible compromise of security while keeping the native token liquid.

![staking](../assets/rewards-inflation.png)

<p style={{textAlign:"center"}}>Source: <a href="https://research.web3.foundation/Polkadot/overview/token-economics">Research - Web3 Foundation</a></p>
More information [here](https://research.web3.foundation/Polkadot/overview/token-economics).

- **x-axis**: Proportion of staked tokens
- **y-axis**: Annualized percentage (inflation and staking rewards, see below)
- **Blue line**: Annual inflation rate diverted to NPoS, i.e., the total amount of tokens minted to
pay validators and nominators. For instance, 0.1 corresponds to 10% of token inflation diverted to
stakers. Since annual token inflation is 10%, all inflation is used to pay validators and
nominators, and 0% of token inflation is diverted to the treasury.
- **Green line**: Annual rewards rate for stakers. For instance, 0.2 corresponds to 20% of annual
returns on the staked tokens. You can determine the current annual staking rewards rate by looking
at the top bar of the staking overview on
[the Polkadot Staking Dashboard](https://staking.polkadot.cloud/#/overview).
- **Blue line**: Annual inflation rate diverted to NPoS, i.e., the total amount of tokens minted to pay validators and nominators. For instance, 0.1 corresponds to 10% of token inflation diverted to stakers. Since annual token inflation is 10%, all inflation is used to pay validators and nominators, and 0% of token inflation is diverted to the treasury.
- **Green line**: Annual rewards rate for stakers. For instance, 0.2 corresponds to 20% of annual returns on the staked tokens. You can determine the current annual staking rewards rate by looking at the top bar of the staking overview on [the Polkadot Staking Dashboard](https://staking.polkadot.cloud/#/overview).

Assuming that the ideal staking rate is 60%, all of the inflation would go to the validators and
nominators if 60% of all tokens are staked. Any deviation from the 60% - positive or negative -
Expand Down
27 changes: 6 additions & 21 deletions docs/kusama/kusama-social-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ caution There is no way to get back your private key by using this method

This is just a way of performing transactions on behalf of the lost account, so you can think of it
as a proxy instead.



s
In this guide, you will learn how to create a recoverable account, how to recover it, and what you
need to be aware of when using it.

Expand All @@ -31,11 +29,8 @@ recovery process to recover your account.

![social-recovery-diag-1](../assets/recovery/social-recovery-diag-1.png)

!!!note Account Recovery
If you are recovering an account, ensure that your network is set to Kusama. You can do this by
selecting the network from the top right corner in the Polkadot-JS UI.


!!!note "Account Recovery"
If you are recovering an account, ensure that your network is set to Kusama. You can do this by selecting the network from the top right corner in the Polkadot-JS UI.

First, see the [Accounts](https://polkadot.js.org/apps/#/accounts) page on Polkadot-JS Apps that
shows all available accounts on your browser's local storage and Polkadot-JS extension. To create a
Expand Down Expand Up @@ -70,11 +65,7 @@ owner to have enough time to check and react in case someone pretends to be you
recovery process.

!!!info
Setting the block delay to be a little longer would be better since even if an attacker acquired
enough signatures to recover your account, they would still have to wait until the block delay is
passed to control your account.


Setting the block delay to be a little longer would be better since even if an attacker acquired enough signatures to recover your account, they would still have to wait until the block delay is passed to control your account.

![kusama accounts page2](../assets/kusama/kusama_make_account_recoverable.png)

Expand All @@ -91,8 +82,6 @@ The above diagram shows the whole process of recovering an account.
Ensure that your new account has enough KSM to pay for the transaction fees and the amount that is
used for reserve when making a recovery.



Navigate to the menu beside the send button in the row of your new account and click the "Initiate
recover for another" option.

Expand Down Expand Up @@ -154,12 +143,8 @@ The recovery process is now complete and successful.

![social-recovery-15](../assets/recovery/social-recovery-15.png)

!!!tip Using `Root` origin
There is still one possible way to recover the account without going through the recovery process.
That is by using the `Root` origin. However, in order to use root permissions, you will need to
either go through [governance](../learn/learn-polkadot-opengov.md).


!!!tip "Using `Root` origin"
There is still one possible way to recover the account without going through the recovery process. That is by using the `Root` origin. However, in order to use root permissions, you will need to either go through [governance](../learn/learn-polkadot-opengov.md).

## Further Reading

Expand Down
27 changes: 7 additions & 20 deletions docs/kusama/kusama-society.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,16 +81,13 @@ You can find an existing member to place a bid on your behalf if you do not have
willing to give them a tip. An existing member can submit a `vouch` transaction through the
Extrinsics page.

:::info vouch(who,value,tip)

- who: The user you are vouching for
!!!info "vouch(who,value,tip)"
- who: The user you are vouching for
- value: The value that the user would like to get when joining the society
- tip: Fees you get

The final value that the candidate will get = (value - tip)

:::

![vouch](../assets/society/vouch.jpg)

### 2. Candidate Phase
Expand All @@ -99,12 +96,8 @@ Bids selected in this phase will be voted on by the existing members to decide w
will be approved to join the society. Members will vote for all the candidates and the final outcome
will be randomly selected by one of the votes. Let's take a look the example shown below:

:::note

If the randomly selected member does not vote, it will be treated as a rejection. For each rotation
period, the maximum number of members that can be accepted is set as 10.

:::
!!!info
If the randomly selected member does not vote, it will be treated as a rejection. For each rotation period, the maximum number of members that can be accepted is set as 10.

A - Accept, R - Reject, S - Skeptic

Expand All @@ -124,9 +117,7 @@ and their unclaimed payouts will be slashed. Moreover, each member who voted opp
randomly selected vote will have their unclaimed payouts slashed and strikes increased. In this
case, member 4 will be punished.

:::info The maximum number of strikes you can have is on Kusama is 10

:::
!!!info The maximum number of strikes you can have is on Kusama is 10.

The slashed funds (2 KSM currently) will be given to a random member who voted the same as the
selected vote as a reward for participating in the vote. The reward is escrowed for some period of
Expand Down Expand Up @@ -180,12 +171,8 @@ and search for "Existing Members (Challenges)". Besides that, you can earn extra
user apply for the membership and requesting a tip. This is useful when a user does not have enough
balance to reserve a deposit. The tip will be given when a user successfully joins the society.

:::info

Each member can only vouch for one user at a time. A member is not required to reserve the deposit
when vouching for a user.

:::
!!!info
Each member can only vouch for one user at a time. A member is not required to reserve the deposit when vouching for a user.

If a member accumulates too many strikes or fails their membership challenge, they will become
suspended. While a member is suspended, they are unable to claim matured payouts. It is up to the
Expand Down
62 changes: 16 additions & 46 deletions docs/learn/archive/learn-auction.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,21 +71,16 @@ propagating through the entire ending period, where a snapshot is taken at each
ending period to capture the winners for that given block. At the end of the period, one of the
snapshots is randomly selected to determine the winner of the auction.

:::info The parachain candidate with the highest bid at the ending time chosen by the Verifiable
Random Function wins the slot auction.

:::
!!!info
The parachain candidate with the highest bid at the ending time chosen by the Verifiable
Random Function wins the slot auction.

A parachain auction lasts exactly one week from the starting period (1 day and 18 hours) to
[ending period](../../general/chain-state-values.md#auction-ending-period) (candle auction phase)
and finally 6 hours for determining the auction winner.

:::info

[Crowdloan contributions](./learn-crowdloans.md##supporting-a-crowdloan-campaign) cannot be made
during these six hours when the winning block for the auction is being determined on-chain.

:::
!!!info
[Crowdloan contributions](./learn-crowdloans.md##supporting-a-crowdloan-campaign) cannot be made during these six hours when the winning block for the auction is being determined on-chain.

More details on this are available in the [Network Implementation](#network-implementation) section.

Expand All @@ -98,32 +93,19 @@ or during the auction.

- The ending period of auction 9 starts at [`block 9362014`](https://kusama.subscan.io/auction/9).

:::note The auction has a full duration equal to `block 9362014` + `72000`

Here, `block 72000` is the "ending period", which is divided into **3600 samples of 20 blocks**.
Figuratively, the candle is lit, and the candle phase lasts for 72,000 blocks.

:::
!!!note "The auction has a full duration equal to `block 9362014` + `72000`"
Here, `block 72000` is the "ending period", which is divided into **3600 samples of 20 blocks**. Figuratively, the candle is lit, and the candle phase lasts for 72,000 blocks.

- The winning sample during the ending period had the `index 1078`.

:::note Sample 1078 is the winner

Sample 1078 refers to the winner as of `block 9362014 + 21560`, which equals
[`block 9383574`](https://kusama.subscan.io/block/9383574).

:::
!!!note "Sample 1078 is the winner"
Sample 1078 refers to the winner as of `block 9362014 + 21560`, which equals [`block 9383574`](https://kusama.subscan.io/block/9383574).

- The parent block was a new BABE session in the `Logs`, which updated the randomness that was used
to select that [sample index](https://kusama.subscan.io/block/9434277).

:::note Inspecting the block state

You can inspect the state at the end of `block 9434277` to see the sample indices with an
[archive node](../../maintain/maintain-sync.md####types-of-nodes). The digest in the `Logs` of
`9434277` is decodable and contains the random value as well as the BABE authorities.

:::
!!!note "Inspecting the block state"
You can inspect the state at the end of `block 9434277` to see the sample indices with an [archive node](../../maintain/maintain-sync.md####types-of-nodes). The digest in the `Logs` of `9434277` is decodable and contains the random value as well as the BABE authorities.

- As a result, the winner of this auction was not the highest bid during the full duration.

Expand Down Expand Up @@ -172,12 +154,8 @@ into 6-week periods for Kusama). Parachains may lease a slot for any combination
slot duration. Parachains may lease more than one slot over time, meaning that they could extend
their lease to the network past the maximum duration by leasing a contiguous slot.

:::note Individual parachain slots are fungible

This means that parachains do not need to always inhabit the same slot, however they always must
maintain a slot to remain a parachain.

:::
!!!note "Individual parachain slots are fungible"
This means that parachains do not need to always inhabit the same slot, however they always must maintain a slot to remain a parachain.

## Bidding

Expand Down Expand Up @@ -210,11 +188,9 @@ Bidders will submit a configuration of bids specifying the token amount they are
for which periods. The slot ranges may be any of the periods 1 - `n`, where `n` is the number of
[periods available for a slot](../../general/chain-state-values.md#period-per-slot-auction).

:::note If you bond tokens with a parachain slot, you cannot stake with those tokens. In this way,
!!!note If you bond tokens with a parachain slot, you cannot stake with those tokens. In this way,
you pay for the parachain slot by forfeiting the opportunity to earn staking rewards.

:::

A bidder configuration for a single bidder may look like the following pseudocode example:

```js
Expand Down Expand Up @@ -302,14 +278,8 @@ the `registrar` pallet.

![Parachain Slot Swap](../../assets/para-swap.png)

:::note Any two parachains can swap their slots via XCM

The [slot swap via XCM](https://github.com/paritytech/polkadot/pull/4772) requires two live
parachains to send an XCM message to the relay chain to approve the swap. A parachain team with
access to two overlapping slots can start a shell parachain on the new slot and swap it with their
actual parachain on the old slot, thus ensuring continuity of the lease.

:::
!!!note "Any two parachains can swap their slots via XCM"
The [slot swap via XCM](https://github.com/paritytech/polkadot/pull/4772) requires two live parachains to send an XCM message to the relay chain to approve the swap. A parachain team with access to two overlapping slots can start a shell parachain on the new slot and swap it with their actual parachain on the old slot, thus ensuring continuity of the lease.

### Lease Extension with Non-Overlapping Slots

Expand Down
Loading

0 comments on commit 6d561da

Please sign in to comment.