Skip to content

Commit a750b3d

Browse files
committed
docs: polish content
1 parent 9f8dad3 commit a750b3d

File tree

9 files changed

+29
-34
lines changed

9 files changed

+29
-34
lines changed

archive/index.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,40 @@ links:
66
title: Pre-registration
77
description: How to be prepared to join the first epoch as a validator and earn rewards from the very beginning
88
href: validator-registration
9-
span: 6
9+
span: half
1010
- title: Be part of the migration
1111
label: Node Operators
1212
href: node-operators
13+
span: half
1314
- label: Learn more
1415
title: Deep dive into the technical details
1516
href: migration-technical-details
1617
- label: FAQ
1718
title: Check our FAQs for more information
1819
href: faqs
20+
- label: PoS
21+
title: Curious about the new PoS? Check the protocol
22+
href: ../protocol/index
1923
---
2024

21-
# Nimiq Migration to Proof-of-Stake
25+
# Legacy PoW → PoS Migration
2226

23-
We are transitioning from a Proof-of-Work blockchain to a Proof-of-Stake blockchain. Learn more about the migration process and how you can get involved.
27+
> [!NOTE]
28+
> This archive preserves the resources created for the Proof-of-Work to Proof-of-Stake transition.
2429
2530
<NqGrid f-my-xl :cards="$frontmatter.links" />
2631

2732
## Understanding the Migration
2833

29-
Nimiq is transitioning from a Proof-of-Work to a Proof-of-Stake blockchain through a special hard fork. The transition process includes several key phases:
34+
Nimiq completed the transition from a Proof-of-Work to a Proof-of-Stake blockchain through a special hard fork. The transition process included several key phases:
3035

3136
- **Pre-registration Phase**: Establishes the first list of validators for the PoS blockchain within the PoW chain
3237
- **Pre-Staking Phase**: Users pre-stake their NIM
3338
- **Activation Phase**: Selects candidate transition blocks from the PoW chain and executes the transition to the PoS chain if at least 80% of the stake is ready
3439

35-
During the migration, we will capture the entire blockchain state, including all accounts, balances, and transaction history. This means that users' balances will remain intact and will be transferred to the new PoS chain.
40+
During the migration, the entire blockchain stateincluding accounts, balances, and transaction history—was captured so that users' balances moved intact to the PoS chain.
3641

37-
**There is no requirement to participate in the migration.** However, if you want, you can [become one of the first validators](validator-registration) or [migrate as an observer](node-operators). Nimiq ensures that no NIM will be lost during the process. We have [guides](#nimiq-migration-to-proof-of-stake) available for those who want to actively engage in the transition.
42+
**Participation was optional.** Those who wanted to contribute could [become one of the first validators](validator-registration) or [migrate as observers](node-operators). The captured state ensured no NIM was lost during the process, and the guides below document the steps that were available at the time.
3843

3944
## Most Asked Questions
4045

index.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,9 @@ hoverableGrid:
7676
description: Interactive, in‑browser walkthrough
7777
href: https://nimiq.guide
7878
icon: i-local:nimiq-tutorial
79-
- title: RPC Playground
80-
description: Test JSON‑RPC calls live
81-
href: ./rpc-client/playground
82-
icon: i-local:nimiq-rpc
79+
- title: RPC Quick Start
80+
description: Explore docs and run JSON-RPC from your environment
81+
href: ./rpc-client/
8382
- title: Nimiq MCP
8483
description: Build with AI
8584
href: https://github.com/onmax/nimiq-mcp
@@ -156,7 +155,10 @@ popularResources:
156155
href: ./validators/staking-faq
157156
- text: Validators API
158157
href: https://github.com/nimiq/validators-api
159-
# TODO: TS library. ARPL
158+
- text: Validator RPC Docs
159+
href: ./validators/rpc-docs/
160+
- text: ARPL CLI Tool
161+
href: https://github.com/sisou/arpl
160162
- title: Core & Protocol
161163
links:
162164
- text: Protocol Docs

migration/index.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
1-
# Migration Guide
1+
# Legacy Migration Guide (PoW → PoS)
22

3-
This section contains migration guides and resources for upgrading from Nimiq 1.0 to 2.0 (Albatross).
3+
> [!IMPORTANT]
4+
> This content documents the completed transition from PoW to PoS and is retained for historical reference.
45
56
## Migration Resources
67

78
- [Migration for Integrators](migration-integrators) - Guide for integrators migrating to Nimiq 2.0
89
- [JSON-RPC Migration](migration-json-rpc) - JSON-RPC API changes and migration guide
910
- [Web Developers Migration](migration-web-developers) - Guide for web developers
1011
- [Technical Details](migration-technical-details) - Technical migration details and breaking changes
11-
12-
::: warning
13-
This section is primarily for reference during the migration period. Most developers should start with the current documentation in the Protocol, Web Client, and RPC Client sections.
14-
:::

protocol/storage/merkle-trees.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Merkle Radix Tree is a data structure used in our blockchain system to store
1111

1212
Merkle Radix Trees are significantly different from standard Merkle Trees. Leaf nodes with similar prefixes are paired up, while leaf nodes with unique prefixes are called “only child” nodes. Parent nodes in the tree can have multiple children or just one child. When a parent node has only one child, it merges with that child node, optimizing space within the tree. Likewise, as parent nodes can have an only child node, parent nodes can also have up to 16 children. Below is a simplified illustration of a Merkle Radix Tree.
1313

14-
![Alt Text](/assets/images/protocol/merkle.png)
14+
![Diagram of a Merkle Radix Tree showing merged branches](/assets/images/protocol/merkle.png)
1515

1616
When constructing the tree, nodes with similar prefixes are paired to form parent nodes, optimizing space by reducing the number of intermediate nodes. If a node does not have a sibling with a similar prefix, it becomes an "only child" node and is merged with its parent node, further optimizing space within the tree.
1717

@@ -24,7 +24,7 @@ Transactions are hashed and stored as leaf nodes. As transactions are appended t
2424

2525
MMRs are designed to efficiently append new transactions without restructuring the entire tree. When a new transaction occurs, its hash is appended to the MMR as a new leaf node, always added to the tree's rightmost part. As MMRs include a set of trees within, each tree hash root is called a “peak”. To calculate the final root of the tree, the peaks are hashed from the right, combining their hash values to construct the root hash. These peaks, representing the root hash values of individual trees within the MMR, also serve as reference points for subsets of transaction data. Note that due to the nature of the MMR, it is possible to have a sub-tree consisting of just one node. Below is a simplified illustration of an MMR with 3 sub-trees.
2626

27-
![Alt Text](/assets/images/protocol/mmr.png)
27+
![Diagram of a Merkle Mountain Range with three peaks](/assets/images/protocol/mmr.png)
2828

2929
Unlike Merkle Radix Trees where accounts and balances undergo constant updates, MMRs do not require direct data updates. In case a block is reverted, transactions are deleted from the transaction history, and new transactions are appended as new blocks come in.
3030

rpc-client/playground.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

validators/staking-faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Staking enhances the security and decentralization of the Nimiq network. Validat
2424

2525
You can choose not to stake and not earn any rewards. By not staking, you miss the opportunity to help maintain the network secure and decentralized.
2626

27-
How long does it take to have my funds available after I un-stake?
27+
### How long does it take to have my funds available after I un-stake?
2828

2929
Once you un-stake your funds, it usually takes between 12 hours to 4 days for them to become available. The exact time frame depends on your validator's status. In rare cases, validators can be "jailed" for up to 4 days, which may delay access to your funds.
3030

@@ -70,7 +70,7 @@ Yes, you can change the Staking Pool or Validator to which you've staked your NI
7070

7171
You can only stake with one validator per wallet address. To stake with multiple validators, you’ll need to create additional wallet addresses. Simply create a new wallet, transfer funds to it, and stake with your chosen validator under that new wallet address.
7272

73-
What happens if the validator I’m staking with goes offline?
73+
### What happens if the validator I’m staking with goes offline?
7474

7575
If the validator you're staking with goes offline, it will be deactivated and will not receive rewards during its inactivity. As a staker, this means you won't earn rewards from that validator while it's offline. However, you retain full control over your NIM and can choose to unstake and delegate to a different validator at any time. Keep in mind that unstaking involves a lock-up period before your funds become available for redelegation.
7676

@@ -100,7 +100,7 @@ Currently, exchanges that support NIM do not offer direct staking functionality.
100100

101101
### How does the Nimiq Proof of Stake protocol ensure that all validators follow the rules?
102102

103-
There is a system of rewards and punishments for validators. Validators are rewarded for validating transactions and producing blocks according to the consensus protocol, incentivizing good behavior. If a validator fails to follow the rules, they may face a punishment such as losing rewards or being temporarily “jailed” for up to 4 days, during which they cannot participate or earn rewards. This combination of rewards and punishments motivates validators to follow the rules. If you would like to learn more about validators, rewards, and punishments, you can refer to the [protocol documentation](https://www.nimiq.com/developers/learn/).
103+
There is a system of rewards and punishments for validators. Validators are rewarded for validating transactions and producing blocks according to the consensus protocol, incentivizing good behavior. If a validator fails to follow the rules, they may face a punishment such as losing rewards or being temporarily “jailed” for up to 4 days, during which they cannot participate or earn rewards. This combination of rewards and punishments motivates validators to follow the rules. If you would like to learn more about validators, rewards, and punishments, you can refer to the [protocol documentation](/protocol/).
104104

105105
### Can I lose my funds when staking?
106106

validators/validator-trustscore.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ $$
153153

154154
Where:
155155
- $c_j$: The number of blocks produced by the validator in batch $j$ of epoch $i$.
156-
- $N$: The total number of batches in the epoch (retrievable from the [policy](htts://github.com/nimiq/core-rs-albatross/blob/albatross/primitives/src/policy.rs)).
156+
- $N$: The total number of batches in the epoch (retrievable from the [policy](https://github.com/nimiq/core-rs-albatross/blob/albatross/primitives/src/policy.rs)).
157157
The number of blocks a validator produced can be retrieved from the blockchain via the rewarded inherent of each batch.
158158

159159
##### **Calculating $H_i$**

web-client/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ integrations:
1717
- title: Nuxt
1818
icon: i-logos:nuxt-icon
1919
href: ./integrations/nuxt
20-
- title: NextJS
20+
- title: Next.js
2121
icon: i-logos:nextjs-icon
2222
href: ./integrations/NextJS
2323
- title: CommonJS
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
## Contribute
22

3-
You can help us improve this guide by contributing to the Nimiq Web Client documentation on GitHub. Simply click the **Edit this page** button at the bottom of the page to suggest changes.
3+
You can help us improve this guide by contributing directly on GitHub. Simply click the **Edit this page** button at the bottom of the page to suggest changes.

0 commit comments

Comments
 (0)