Skip to content

Commit 4d1eef0

Browse files
authored
init (#1570)
1 parent e25ebe6 commit 4d1eef0

10 files changed

+17
-15
lines changed

components/Starknet/modules/staking/pages/claiming-rewards.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
:description: How to claim your staking rewards on Starknet by directly interacting with the staking or delegation pooling contracts.
55

6-
include::partial$snippet-important-staking-v2.adoc[]
6+
include::partial$snippet-important-staking-architecture.adoc[]
77

88
Staking rewards on Starknet accumulate over time as your staked STRK tokens contribute to network security. To claim these rewards, you need to interact with the staking contract (if you are a validator) or the specific delegation pooling contract associated with the validator you have staked with (if you are a delegator) and execute the appropriate functions.
99

components/Starknet/modules/staking/pages/delegating-stake.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
:description: How to delegate your stake to a validator on Starknet by interacting directly with the staking and delegation pooling contracts.
55

6-
include::partial$snippet-important-staking-v2.adoc[]
6+
include::partial$snippet-important-staking-architecture.adoc[]
77

88
Delegating your stake on Starknet involves adding your stake to a validator's delegation pool managed by the staking contract. This approach offers the advantage of lower capital requirements and relieves you of the need to manage the operational aspects of staking, as the validator handles these responsibilities.
99

components/Starknet/modules/staking/pages/entering-staking.adoc

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[id="entering-staking"]
22
= Becoming a Validator
33

4-
include::partial$snippet-important-staking-v2.adoc[]
4+
include::partial$snippet-important-staking-architecture.adoc[]
55

66
:description: How to enter the staking protocol on Starknet by interacting directly with the staking contract.
77

@@ -11,16 +11,14 @@ Using the Starknet staking contract to stake STRK tokens requires interacting wi
1111
. Records the validator's details, including reward and operational addresses, in the staking contract.
1212
. If pooling is enabled, deploys a new delegation pool contract associated with the validator.
1313

14-
Subsequently, the validators tokens will be locked in the staking contract, and the validator will begin earning rewards based on their stake.
14+
Subsequently, the validator's tokens will be locked in the staking contract, and the validator will begin earning rewards based on their stake.
1515

16-
For more information on what happens during the staking process, see xref:architecture.adoc#staking-contract[Staking Architecture].
16+
For more information on what happens during the staking process, see xref:architecture-and-concepts:staking.adoc[Architecture].
1717

1818
.Prerequisites
1919

20-
* Validators are required to run full nodes in preparation for the following stages of the protocol. You can use any full node implementation you choose:
21-
** https://github.com/NethermindEth/juno[Juno] by Nethermind: https://juno.nethermind.io/hardware-requirements[juno.nethermind.io/hardware-requirements]
22-
** https://github.com/eqlabs/pathfinder[Pathfinder] by Equilibrium: https://github.com/eqlabs/pathfinder?tab=readme-ov-file#hardware-requirements[github.com/eqlabs/pathfinder?tab=readme-ov-file#hardware-requirements]
23-
** https://github.com/madara-alliance/madara[Madara] by Madara Alliance: https://docs.madara.build/Installation/requirements[docs.madara.build/Installation/requirements]
20+
* In first phase of the staking protocol (currently on Mainnet): A running xref:ecosystem:fullnodes-rpc-providers.adoc[full node]
21+
* In the second phase of the staking protocol (currently on Sepolia): A running full node with the with the added https://github.com/eqlabs/starknet-validator-attestation/tree/main[validator attestation package^]
2422
* A Starknet-compatible xref:ecosystem:block-explorers-monitoring-tools.adoc[block explorer] or xref:tools:interacting-with-starknet.adoc[CLI tool].
2523
* Sufficient STRK token balance in your wallet.
2624
+

components/Starknet/modules/staking/pages/exiting-staking.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
:description: How to exit the staking protocol on Starknet by unstaking as a validator or undelegating as a delegator through direct interaction with the staking or delegation pooling contracts.
55

6-
include::partial$snippet-important-staking-v2.adoc[]
6+
include::partial$snippet-important-staking-architecture.adoc[]
77

88
Exiting the staking protocol involves either unstaking your STRK tokens as a validator or undelegating your stake as a delegator. Both processes require you to first signal your intent to exit, followed by an action to finalize the process after a waiting period.
99

components/Starknet/modules/staking/pages/increasing-staking.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
:description: How to increase your stake on Starknet by interacting directly with the staking or delegation pooling contracts.
55

6-
include::partial$snippet-important-staking-v2.adoc[]
6+
include::partial$snippet-important-staking-architecture.adoc[]
77

88
The staking and pooling contracts allow validators and delegators to increase their existing stake. Validators use the `increase_stake` function, which is called from the Staking contract, while delegators use the `add_to_delegation_pool` function, which is called from the delegation pooling contract. These functions add the specified amount of STRK tokens to the current stake, recalculate rewards before the staked amount is updated, and update the total staked amount.
99

components/Starknet/modules/staking/pages/managing-staking-and-delegation-operations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
:description: How validators and delegators can manage staking and delegation settings on Starknet by interacting directly with the staking and delegation pooling contracts.
55

6-
include::partial$snippet-important-staking-v2.adoc[]
6+
include::partial$snippet-important-staking-architecture.adoc[]
77

88
This guide outlines how both validators and delegators can manage various aspects of their staking and delegation activities on Starknet. Validators can perform operations such as opening delegation pools and updating commission rates. Delegators can manage their participation by changing their reward addresses associated with delegation pools.
99

components/Starknet/modules/staking/pages/overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[id="staking_overview"]
22
= Staking Overview
33

4-
include::partial$snippet-important-staking-v2.adoc[]
4+
include::partial$snippet-important-staking-architecture.adoc[]
55

66
== Introduction
77
Staking on Starknet involves locking STRK tokens in the staking protocol, contributing to network security and performance. Anyone holding STRK in their wallets can stake their tokens on Starknet either directly or by delegating their tokens to others, with rewards based on their level of participation and contribution.

components/Starknet/modules/staking/pages/staking-events-and-read-functions.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
:description: How to manage and respond to events emitted by the Starknet staking protocol.
55

6-
include::partial$snippet-important-staking-v2.adoc[]
6+
include::partial$snippet-important-staking-architecture.adoc[]
77

88
Staking events provide critical information about changes in the staking process, such as balance updates, delegation pool creation, and exit intents. Read functions allow you to query important staking details. For a complete list of events and read functions, including keys and data, please refer to the official Starknet staking repository (link:https://github.com/starkware-libs/starknet-staking[Starknet Staking Repo]) and the spec file (link:https://github.com/starkware-libs/starknet-staking/blob/main/docs/spec.md[spec.md]).
99

components/Starknet/modules/staking/pages/switching-delegation-pools.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
:description: How to switch your delegated stake from one validator's pool to another on Starknet by interacting directly with the delegation pooling contract.
55

6-
include::partial$snippet-important-staking-v2.adoc[]
6+
include::partial$snippet-important-staking-architecture.adoc[]
77

88
Switching your delegated stake from one validator's delegation pool to another allows you to optimize your staking strategy by moving your funds to a different validator. This process involves interacting with the `switch_delegation_pool` function in the delegation pooling contract, which coordinates with the staking contract to move your stake.
99

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[IMPORTANT]
2+
====
3+
This guide is a hands-on tutorial for staking on Starknet. To learn about the staking protocol, go to xref:architecture-and-concepts:staking.adoc[Architecture].
4+
====

0 commit comments

Comments
 (0)