Skip to content

Commit

Permalink
docs: clarify explanation of start-burn-ht (#1625)
Browse files Browse the repository at this point in the history
  • Loading branch information
obycode committed May 2, 2024
1 parent dd5ee1b commit 7335f63
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion nakamoto-upgrade/signing-and-stacking/stacking-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ The arguments are:
* Stacker: the STX address of the delegator
* Amount: denoted in ustx (1 stx = 1,000,000 ustx)
* Pox Address: The BTC address of the pool operator where they will receive the BTC rewards
* Start burn height: The BTC block height in which delegation can begin. This must not be in the past, so the best option here is to add 1 or 2 to the current block height when you initiate this transaction. Note that the delegation will not actively begin at this block height, but whatever reward cycle is passed in the aggregation commit function (below). That function will run a check to make sure that this start burn height falls before the chosen cycle.
* Start burn height: The BTC block height in which delegation can begin. This field is used to ensure that an old transaction intended for an earlier cycle will fail, and also prevents callers from "post-dating" the call to a future cycle. The best option here is to add 1 or 2 to the current block height when you initiate this transaction. Note that the delegation will not actively begin at this block height, but whatever reward cycle is passed in the aggregation commit function (below).
* Lock period: number of cycles to lock for. If the delegator provided the until burn height argument, then the end of these cycles cannot be past the expiration provided. Max lock period is 12

This step also allows the pool operator to proactively choose which Stackers they’ll accept delegation from. For “closed” pools, the pool operator will only call this function for approved Stackers. It is up to each pool operator who runs a closed pool to implement this process.
Expand Down

0 comments on commit 7335f63

Please sign in to comment.