Skip to content

Commit dbb3889

Browse files
werner-stacksgitbook-bot
authored andcommitted
GITBOOK: Staking STX: restore navigation links, move Start here above Definitions, Audit B fixes
1 parent 6c5195b commit dbb3889

1 file changed

Lines changed: 36 additions & 30 deletions

File tree

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,11 @@
11
# Staking STX
22

3-
Staking is the process of locking STX, or STX paired with BTC or sBTC, to support the network's consensus and earn Bitcoin-denominated rewards. If you aren't familiar with how it works, read the [Stacking](https://github.com/stacks-network/docs/blob/master/docs/learn/block-production/stacking.md) and [Stackers and Signing](https://github.com/stacks-network/docs/blob/master/docs/learn/block-production/signing.md) concept guides first.
3+
Staking is locking STX, or STX paired with BTC or sBTC, to support the network's consensus and earn Bitcoin-denominated rewards. If you aren't familiar with how it works, read the [Stacking](https://docs.stacks.co/learn/block-production/stacking) and [Stackers and Signing](https://docs.stacks.co/learn/block-production/signing) concept guides first.
44

55
Staking uses the `pox-5` contract, deployed at `SP000000000000000000002Q6VF78.pox-5`. You can [read its source on the Explorer](https://explorer.hiro.so/txid/SP000000000000000000002Q6VF78.pox-5?chain=mainnet\&tab=sourceCode). PoX-5 activated with the Epoch 4.0 hard fork and replaces `pox-4`.
66

77
{% hint style="warning" %}
8-
**Every PoX-4 position unlocked at activation.** If you were stacking under PoX-4, your STX is already unlocked and you must re-enrol under PoX-5 to keep earning. See What's Changed in PoX-5.
9-
{% endhint %}
10-
11-
### Definitions and roles
12-
13-
* **Staker**: anyone locking STX. Either **STX-only** staking, or a **protocol bond** pairing a BTC L1 timelock (or sBTC) with an STX lock. PoX-5 allows exactly one position per Stacks principal, and the two kinds are mutually exclusive.
14-
* **Signer-manager**: the contract a staker stakes to. It is identified on-chain by its contract principal, not by a raw signer key, and it holds the reward-distribution logic.
15-
* **Signer**: the holder of the signer key that a signer-manager has been granted via `grant-signer-key`. Running a signer means running the `stacks-signer` software alongside your own Stacks node and Bitcoin node.
16-
* **Pool**: a signer-manager that other people stake to.
17-
18-
{% hint style="info" %}
19-
**"Solo" and "pooled" are no longer separate mechanisms.** Under PoX-4 they were. Under PoX-5 everyone stakes non-custodially to a signer-manager contract; the only question is who deployed it.
20-
21-
A solo staker in the old sense is someone running their own signer-manager, which is operationally the same thing as offering a pool service, because anyone can stake to that contract. There is no `delegator` or `pool operator` role at the protocol layer.
8+
**Every PoX-4 position unlocked at activation.** If you were stacking under PoX-4, your STX is already unlocked and you must re-enroll under PoX-5 to keep earning. See [What's Changed in PoX-5](whats-changed-in-pox-5.md).
229
{% endhint %}
2310

2411
### Start here
@@ -27,42 +14,61 @@ A solo staker in the old sense is someone running their own signer-manager, whic
2714
{% step %}
2815
#### What's Changed in PoX-5
2916

30-
If you were stacking under PoX-4: what unlocked, how to re-enrol, what changed about rewards, and the deadlines for the next cycle.
17+
If you were stacking under PoX-4: what unlocked, how to re-enroll, what changed about rewards, and the deadlines for the next cycle.
18+
19+
* [What's Changed in PoX-5](whats-changed-in-pox-5.md)
3120
{% endstep %}
3221

3322
{% step %}
3423
#### Stake to an existing signer-manager
3524

36-
The common path, and what most people should do. You keep custody of your STX; the signer-manager you choose handles registration and reward distribution. Pick one whose fee and admin set you are comfortable with, both are readable on-chain.
25+
The common path, and what most people should do. You keep custody of your STX; the signer-manager you choose handles registration and reward distribution. Pick one whose fee and admin set you are comfortable with. Both are readable on-chain.
26+
27+
* [Stake to an Existing Signer-Manager](stack-with-a-pool.md)
3728
{% endstep %}
3829

3930
{% step %}
4031
#### Run your own signer-manager
4132

4233
For operators. This means deploying a contract and running infrastructure: a Bitcoin node, a Stacks node, and the signer software.
4334

44-
* [Deploy a Signer Manager Contract](https://docs.stacks.co/operate/deploy-a-signer-manager-contract)
45-
* [Generate a Signer Signature](https://docs.stacks.co/operate/stacking-stx/generate-signer-signature)
46-
* [Take a Signer Fee](https://docs.stacks.co/operate/take-a-signer-fee)
47-
* [Run a Signer](https://docs.stacks.co/operate/run-a-signer)
48-
* [PoX-5 Upgrade Guide](https://docs.stacks.co/operate/run-a-signer/pox-5-upgrade-guide)
49-
* [Run a Node](https://docs.stacks.co/operate/run-a-node) and [Run a Bitcoin Node](https://docs.stacks.co/operate/run-a-node/run-a-bitcoin-node)
35+
* [Deploy a Signer Manager Contract](../deploy-a-signer-manager-contract.md)
36+
* [Generate a Signer Signature](generate-signer-signature.md)
37+
* [Take a Signer Fee](../take-a-signer-fee.md)
38+
* [Run a Signer](../run-a-signer/)
39+
* [PoX-5 Upgrade Guide](../run-a-signer/pox-5-upgrade-guide.md)
40+
* [Run a Node](../run-a-node/) and [Run a Bitcoin Node](../run-a-node/run-a-bitcoin-node.md)
5041
{% endstep %}
5142
{% endstepper %}
5243

5344
{% hint style="info" %}
54-
The minimum for a signer-manager to enter the signer set is a **fixed 50,000 STX** (`SIGNER_SET_MIN_USTX`) in aggregate across everyone staking to it. An individual stake may be smaller. This replaces PoX-4's cycle-varying `min_threshold_ustx`, so there is no longer a dynamic minimum to check.
45+
The minimum for a signer-manager to enter the signer set is a **fixed 50,000 STX** (`SIGNER_SET_MIN_USTX`) in aggregate across everyone staking to it. An individual stake may be smaller. This replaces PoX-4's cycle-varying `min_threshold_ustx`.
46+
{% endhint %}
47+
48+
### Definitions and roles
49+
50+
* **Staker**: anyone locking STX. Either **STX-only** staking, or a **protocol bond** pairing a BTC L1 timelock (or sBTC) with an STX lock. PoX-5 allows exactly one position per Stacks principal, and the two kinds are mutually exclusive.
51+
* **Signer-manager**: the contract a staker stakes to. It is identified on-chain by its contract principal, not by a raw signer key, and it holds the reward-distribution logic.
52+
* **Signer**: the holder of the signer key that a signer-manager has been granted via `grant-signer-key`. Running a signer means running the `stacks-signer` software alongside your own Stacks node and Bitcoin node.
53+
* **Pool**: a signer-manager that other people stake to.
54+
55+
{% hint style="info" %}
56+
**"Solo" and "pooled" are no longer separate mechanisms.** Under PoX-4 they were. Under PoX-5 everyone stakes non-custodially to a signer-manager contract; the only question is who deployed it.
57+
58+
A solo staker in the old sense is someone running their own signer-manager, which is operationally the same thing as offering a pool service, because anyone can stake to that contract. There is no `delegator` or `pool operator` role at the protocol layer.
5559
{% endhint %}
5660

5761
### Reference guides
5862

59-
* Generate a Signer Signature. Updated for PoX-5.
63+
Updated for PoX-5:
64+
65+
* [Stake to an Existing Signer-Manager](stack-with-a-pool.md)
66+
* [Generate a Signer Signature](generate-signer-signature.md)
6067

6168
{% hint style="warning" %}
62-
The guides below were written for PoX-4 and are being updated for PoX-5. Treat their contract calls and arguments as out of date until then. In particular, per-transaction signer signatures and the `delegate-stx` / `stack-aggregation-commit` flow no longer exist.
69+
The guides below were written for PoX-4 and are being updated for PoX-5. Treat their contract calls and arguments as out of date until then. Per-transaction signer signatures and the `delegate-stx` / `stack-aggregation-commit` flow no longer exist.
6370
{% endhint %}
6471

65-
* Solo Stacking
66-
* Stack with a Pool
67-
* Operate a Pool
68-
* Key and Address Rotation
72+
* [Solo Stacking](solo-stacking.md)
73+
* [Operate a Pool](operate-a-pool.md)
74+
* [Key and Address Rotation](key-and-address-rotation.md)

0 commit comments

Comments
 (0)