Skip to content

Commit b6f9010

Browse files
authored
Minor staking changes (#1641)
* init&finish * minor fixes * minor fix * various changes
1 parent 01639c8 commit b6f9010

File tree

6 files changed

+50
-18
lines changed

6 files changed

+50
-18
lines changed

components/Starknet/modules/architecture-and-concepts/pages/staking.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -255,11 +255,11 @@ To invoke onchain contracts, use xref:tools:core-tools.adoc#starknet_foundry[Sta
255255

256256
| Staking
257257
| Invoke the staking contract's https://github.com/starkware-libs/starknet-staking/blob/main/docs/spec.md#stake[`stake`^] function
258-
a| * You should make sure you are xref:responsibilities[running a full node (on Mainnet) and attesting to blocks (on Sepolia)] before staking
258+
a| * You should make sure you are xref:responsibilities[running a full node and attesting to blocks] before staking
259259
* You must first approve the transfer of the amount of STRK tokens to be staked to the staking contract by invoking the STRK contract's `approve` function
260260
* `operational_address` should have sufficient funds to pay for attestation transactions
261261
* `amount` should be equal or greater than the xref:protocol[minimum stake for validators] and denominated in FRI (i.e., 1*10^18^ = 1 STRK)
262-
* `commission` should be entered as a percentage with precision, where 10000 represents 100% (e.g., to set a 5% commission, you enter 500)
262+
* `commission` should be entered as a percentage with precision, where 10,000 represents 100% (e.g., to set a 5% commission, you enter 500)
263263

264264
| Claiming rewards
265265
| Invoke the staking contract's https://github.com/starkware-libs/starknet-staking/blob/main/docs/spec.md#claim_rewards[`claim_rewards`^] function
@@ -272,7 +272,7 @@ a| * `amount` should be denominated in FRI (i.e., 1*10^18^ = 1 STRK)
272272

273273
| Updating commission
274274
| Invoke the staking contract's https://github.com/starkware-libs/starknet-staking/blob/main/docs/spec.md#update_commission[`update_commission`^] function
275-
a| * `commission` should be entered as a percentage with precision, where 10000 represents 100% (e.g., to set a 5% commission, you enter 500)
275+
a| * `commission` should be entered as a percentage with precision, where 10,000 represents 100% (e.g., to set a 5% commission, you enter 500)
276276
* Commissions can be increased only after xref:commissions[committing to a maximum commission] using https://github.com/starkware-libs/starknet-staking/blob/main/docs/spec.md#set_commission_commitment[`set_commission_commitment`^]
277277

278278
| Changing reward address
@@ -281,7 +281,7 @@ a| * `commission` should be entered as a percentage with precision, where 10000
281281

282282
| Changing operational address
283283
| Invoke the staking contract's https://github.com/starkware-libs/starknet-staking/blob/main/docs/spec.md#declare_operational_address[`declare_operational_address`^] and https://github.com/starkware-libs/starknet-staking/blob/main/docs/spec.md#change_operational_address[`change_operational_address`^] functions
284-
|
284+
| `declare_operational_address` should be invoked by your new operational address and `change_operational_address` should be invoked by your staking address
285285

286286
| Opening delegation
287287
| Invoke the staking contract's https://github.com/starkware-libs/starknet-staking/blob/main/docs/spec.md#set_open_for_delegation[`set_open_for_delegation`^] function

components/Starknet/modules/guides/pages/staking-on-starknet/next-steps.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,6 @@ By now you're successfully running your own Pathfinder full node on Sepolia test
1414
1515
* Learn more about https://eqlabs.github.io/pathfinder/[the Pathfinder full node^]
1616
17+
* Join the https://t.me/+CLZl_F_Nj2RlNjU0[Starknet-Staking Telegram group] (if you haven't already)
18+
1719
Good luck and welcome aboard! Your participation helps strengthen and safeguard Starknet's future 🛡️

components/Starknet/modules/guides/pages/staking-on-starknet/overview.adoc

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,18 @@ Welcome to the official guide for becoming Starknet validator! ✅
44

55
While Starknet is currently still centralized, it is gradually moving towards employing a staking protocol, handing over the responsibilities of producing, attesting, and proving blocks to validators.
66

7-
[TIP]
8-
====
9-
To learn more about Starknet's staking protocol, see xref:architecture-and-concepts:staking.adoc[_Protocol_].
10-
====
11-
127
This guide will walk you though all the steps necessary to for becoming a Starknet validator, including:
138

149
* xref:staking-on-starknet/prerequisite.adoc[]
1510
* xref:staking-on-starknet/stake.adoc[]
1611
* xref:staking-on-starknet/pathfinder.adoc[]
1712
* xref:staking-on-starknet/next-steps.adoc[]
1813
19-
Ready? Let's go! 🏁
14+
Ready? Let's go! 🏁
15+
16+
[IMPORTANT]
17+
====
18+
Although this guide assumes no prior knowledge, it is highly recommended to go over xref:architecture-and-concepts:staking.adoc[the specifications of Starknet's staking protocol] before following it.
19+
20+
For any questions or inquiries, reach out to us on https://t.me/+CLZl_F_Nj2RlNjU0[Telegram^].
21+
====

components/Starknet/modules/guides/pages/staking-on-starknet/pathfinder.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Running your Starknet full node
22

3+
[IMPORTANT]
4+
====
5+
For any questions or inquiries, reach out to us on https://t.me/+CLZl_F_Nj2RlNjU0[Telegram^].
6+
====
7+
38
== Overview
49

510
Welcome to the third installment of the _Becoming a Starknet validator_ guide! ✅

components/Starknet/modules/guides/pages/staking-on-starknet/prerequisite.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Setting up your environment
22

3+
[IMPORTANT]
4+
====
5+
For any questions or inquiries, reach out to us on https://t.me/+CLZl_F_Nj2RlNjU0[Telegram^].
6+
====
7+
38
== Overview
49

510
Welcome to the first installment of the _Becoming a Starknet validator_ guide! ✅
@@ -23,6 +28,11 @@ export ETHEREUM_URL=<YOUR_URL>
2328

2429
Becoming a Starknet validator requires three accounts deployed on either Sepolia or Mainnet. To follow this guide, these account should be configured as follows:
2530

31+
[NOTE]
32+
====
33+
To understand the role of the each account, read more about xref:architecture-and-concepts:staking.adoc#addresses[validator addresses in the staking protocol].
34+
====
35+
2636
* An account with its address exported using:
2737
+
2838
[source,terminal]

components/Starknet/modules/guides/pages/staking-on-starknet/stake.adoc

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Staking your STRK tokens
22

3+
[IMPORTANT]
4+
====
5+
For any questions or inquiries, reach out to us on https://t.me/+CLZl_F_Nj2RlNjU0[Telegram^].
6+
====
7+
38
== Overview
49

510
Welcome to the second installment of the _Becoming a Starknet validator_ guide! ✅
@@ -9,14 +14,21 @@ To become a validator, you must stake least the minimum required amount of STRK
914

1015
== Approving STRK transfer
1116

12-
To lock STRK token into the Staking contract, you first need to approve the transfer of STRK tokens from your staking address to the Staking contract. To do so, use your staking address to invoke the STRK token contract's `approve` function with the following parameters:
17+
To lock STRK token into the Staking contract, you first need to approve the transfer of STRK tokens from your staking address to the Staking contract.
18+
19+
[NOTE]
20+
====
21+
To understand the role of the staking address, read more about xref:architecture-and-concepts:staking.adoc#addresses[validator addresses in the staking protocol].
22+
====
23+
24+
To do so, use your staking address to invoke the STRK token contract's `approve` function with the following parameters:
1325

1426
. The Staking contract's address
1527
. The number of STRK tokens to stake
16-
+
28+
1729
[NOTE]
1830
====
19-
This number needs to be greater than or equal to the minimum stake for validators.
31+
The number of STRK tokens to stake must be greater than or equal to xref:architecture-and-concepts:staking.adoc#protocol[the minimum stake for validators].
2032
====
2133

2234
For example, the following can be used to approve the transfer of 1 STRK to the Staking contract on Sepolia:
@@ -39,14 +51,15 @@ Once the transfer is approved, you can lock your STRK tokens into the Staking co
3951
. The address to set as your rewards address
4052
. The address to set as your operational address
4153
. The number of STRK tokens to stake
42-
+
54+
. `true` to enable delegation pooling and `false` otherwise
55+
. The commission rate to set for your delegation pool (if enabled), as a percentage with precision where 10,000 represents 100%
56+
4357
[NOTE]
4458
====
45-
This number must match the number specified in the `approve` function.
46-
====
59+
To understand the role of the rewards and operational addresses, read more about xref:architecture-and-concepts:staking.adoc#addresses[validator addresses in the staking protocol].
4760
48-
. `true` to enable delegation pooling and `false` otherwise
49-
. The commission rate to set for your delegation pool (if enabled), as a percentage with precision where 10,000 represents 100%
61+
The number of STRK tokens to stake must match the number specified in the `approve` function.
62+
====
5063

5164
For example, the following can be used to stake 1 STRK with delegation pooling enabled and 1% commission on Sepolia:
5265

0 commit comments

Comments
 (0)