Skip to content

Commit 00b7e47

Browse files
kenrogersgitbook-bot
authored andcommitted
GITBOOK-58: Add FAQ page
1 parent 78a10b5 commit 00b7e47

11 files changed

+143
-7
lines changed

.gitbook/assets/error-1.jpg

20.8 KB
Loading
Loading
Loading
Loading
Loading
Loading

SUMMARY.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@
1919
* [Testnets](nakamoto-upgrade/testnets/README.md)
2020
* [Pre-Launch Testnet](nakamoto-upgrade/testnets/pre-launch.md)
2121
* [Nakamoto Testnet](nakamoto-upgrade/testnets/nakamoto.md)
22-
* [How to Run a Signer](nakamoto-upgrade/running-a-signer.md)
23-
* [How to Stack](nakamoto-upgrade/stacking-flow.md)
22+
* [Signing and Stacking](nakamoto-upgrade/signing-and-stacking/README.md)
23+
* [How to Run a Signer](nakamoto-upgrade/signing-and-stacking/running-a-signer.md)
24+
* [How to Stack](nakamoto-upgrade/signing-and-stacking/stacking-flow.md)
25+
* [FAQ](nakamoto-upgrade/signing-and-stacking/faq.md)
2426

2527
## 🎓 Stacks 101 (Pre-Nakamoto) <a href="#stacks-101" id="stacks-101"></a>
2628

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Signing and Stacking
2+
3+
Signing and stacking are critical roles in Nakamoto.
4+
5+
The pages in this section will guide you in setting up a signer and the different ways you can go about stacking in Nakamoto.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# FAQ
2+
3+
### Signer Setup
4+
5+
<details>
6+
7+
<summary>My signer says it is uninitialized</summary>
8+
9+
If you get a message like the following saying your signer is uninitialized, that means that it has not registered for the current or upcoming reward cycle (or the burnchain block height is not yet at the second block in the prepare phase) for the signer to know if it is registered.
10+
11+
`Signer spawned successfully. Waiting for messages to process... INFO [1711088054.872542] [stacks-signer/src/runloop.rs:278] [signer_runloop] Running one pass for signer ID# 0. Current state: Uninitialized`
12+
13+
At this point if you want your signer to do something you need someone to either delegate to you or you need to stack on your own for an upcoming reward cycle.
14+
15+
For more on this, be sure to check out the [How to Stack ](stacking-flow.md)doc.
16+
17+
</details>
18+
19+
<details>
20+
21+
<summary>I am trying to run my signer using Docker and it is not working correctly</summary>
22+
23+
Currently, for PRs, we only build for glibc x64 images. If you want to test on another architecture, you'll need to build the Docker image locally or build the binary from source as described in the [How to Run a Signer](running-a-signer.md) doc.
24+
25+
</details>
26+
27+
<details>
28+
29+
<summary>I'm getting an error about a missing variable</summary>
30+
31+
There aren't yet properly tagged releases for Nakamoto, so you'll need to make sure that you are building from the `next` branch of building from source or using the `next` tag if using the Docker image.
32+
33+
</details>
34+
35+
### Stacks Nodes
36+
37+
<details>
38+
39+
<summary>Do I need to run a Stacks node alongside a signer?</summary>
40+
41+
Yes, you'll need to run both a Stacks node and a signer. Set up the signer first and then set up your Stacks node following the instructions in the [How to Run a SIgner](running-a-signer.md) doc. Specifically, you'll want to run a testnet follower node.
42+
43+
If the instructions in the above linked guide for setting up a Stacks node are not suitable, you can follow one of the guides found in the [Nodes and Miners](../../stacks-in-depth/nodes-and-miners/) section.
44+
45+
</details>
46+
47+
<details>
48+
49+
<summary>When trying to run the node I am getting a connection error</summary>
50+
51+
First, be sure that you have the proper entry point specified in your `node-config.toml` file as specified in the [How to Run a Signer](running-a-signer.md) doc.
52+
53+
If you are getting an error like the following:
54+
55+
![](../../.gitbook/assets/telegram-cloud-photo-size-4-6046167312920330449-y.jpg)
56+
57+
And you are inside a Docker container with default bridging mode, then localhost is not available, and you'll need to point to the Docker host.
58+
59+
</details>
60+
61+
### Stacking
62+
63+
<details>
64+
65+
<summary>What is stacking?</summary>
66+
67+
Stacking is the act of locking your STX tokens in order to help secure the network. In Nakamoto, stackers take on the additional responsibility of validating new Stacks blocks as miners propose them.
68+
69+
If you aren't familiar with stacking as a concept you can take a look at the [Stacking](../../stacks-101/stacking.md) doc.
70+
71+
</details>
72+
73+
<details>
74+
75+
<summary>As a signer, what exactly do I need to do in regards to stacking?</summary>
76+
77+
Because stackers also function as signers in Nakamoto, signers must either solo stack or delegate their STX tokens to a delegate.
78+
79+
These options and the processes for doing so are outlined in the [How to Stack](stacking-flow.md) doc, but you must do one of the two in order to operate as a signer.
80+
81+
</details>
82+
83+
<details>
84+
85+
<summary>How can I delegate my STX as a signer?</summary>
86+
87+
In order to delegate your STX tokens, you'll need to call the `delegate-stack-stx` function in the `pox-4` contract. The process for doing this can be found in the [How to Stack](stacking-flow.md) doc.
88+
89+
</details>
90+
91+
<details>
92+
93+
<summary>Signer public keys need to be provided when calling delegate and solo stacking functions, does this correspond to the same public key used when generating the signer signature?</summary>
94+
95+
Yes, the signer pubkey field always corresponds with the signer signature.
96+
97+
</details>
98+
99+
<details>
100+
101+
<summary>What is the .stackers boot contract?</summary>
102+
103+
This tracks the signers that are registered in a given reward-cycle.
104+
105+
</details>
106+
107+
<details>
108+
109+
<summary>Are there any changes to the overall stacking flow minus the inclusion of the signer pubkey?</summary>
110+
111+
No, the latest changes revolved around the signature, then about including a max-amount & auth-id with the signature.
112+
113+
</details>
114+
115+
<details>
116+
117+
<summary>Is there a list of 3rd party signers available?</summary>
118+
119+
&#x20;We have publicly announced many signers joining the network including: Blockdaemon, Figment, Kiln, Chorus One, Luganodes and[ more](https://stacks.org/new-signers-join-stacks).
120+
121+
</details>
122+
123+
<details>
124+
125+
<summary>Signers change every reward cycle, so do we need a way to get the new signers at each reward cycle?</summary>
126+
127+
That's correct, the PoX contract does a DKG event every cycle (every \~2 weeks). This is detailed in the [Nakamoto SIP](https://github.com/stacksgov/sips/blob/feat/sip-021-nakamoto/sips/sip-021/sip-021-nakamoto.md#stacker-turnover) where signers must register their keys.
128+
129+
</details>

nakamoto-upgrade/running-a-signer.md nakamoto-upgrade/signing-and-stacking/running-a-signer.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ It will also walk through how to set up the config files to get the signer and S
2121
### Knowledge Prerequisites
2222

2323
* Docker and basic knowledge of pulling and running images
24-
* Basic knowledge of [Stacks accounts](../stacks-101/accounts.md)
25-
* Basic knowledge of [stacking](../stacks-101/stacking.md) and the [Nakamoto stacking flow](stacking-flow.md)
24+
* Basic knowledge of [Stacks accounts](../../stacks-101/accounts.md)
25+
* Basic knowledge of [stacking](../../stacks-101/stacking.md) and the [Nakamoto stacking flow](stacking-flow.md)
2626

2727
<details>
2828

nakamoto-upgrade/stacking-flow.md nakamoto-upgrade/signing-and-stacking/stacking-flow.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ This document intends to lay out all the steps required to stack STX tokens on t
55
{% endhint %}
66

77
{% hint style="info" %}
8-
This doc assumes you are familiar with stacking at a conceptual level. If not, you may want to read the [Stacking](../stacks-101/stacking.md) section of Stacks 101.
8+
This doc assumes you are familiar with stacking at a conceptual level. If not, you may want to read the [Stacking](../../stacks-101/stacking.md) section of Stacks 101.
99
{% endhint %}
1010

1111
In Nakamoto, stacking flows have significant changes in comparison to previous versions of Stacks. Because Nakamoto requires stackers to run a signer, which validates blocks produced by Stacks miners, stackers need to provide new information when making Stacking transactions.
1212

1313
These changes affect both solo Stacking and delegated Stacking. This document outlines the new flows for both cases.
1414

15-
If you aren't familiar with the general block production process under Nakamoto and what role signers and stackers play, you may want to read [Nakamoto in 10 Minutes](nakamoto-in-10-minutes.md) to get up to speed.
15+
If you aren't familiar with the general block production process under Nakamoto and what role signers and stackers play, you may want to read [Nakamoto in 10 Minutes](../nakamoto-in-10-minutes.md) to get up to speed.
1616

1717
### Definitions
1818

@@ -243,7 +243,7 @@ The exact tooling that will be available for both solo and delegated stacking is
243243

244244
This section describes the various transactions that signers need to make in order to be registered as a signer for a certain reward cycle. The order of operations between the automated signer and the stacking transactions that need to be done “manually” is important for ensuring that a signer is fully set up for a certain reward cycle.
245245

246-
<figure><img src="../.gitbook/assets/Untitled design (1).png" alt=""><figcaption></figcaption></figure>
246+
<figure><img src="../../.gitbook/assets/Untitled design (1).png" alt=""><figcaption></figcaption></figure>
247247

248248
#### Prerequisite: ensure the signer is hosted and running
249249

0 commit comments

Comments
 (0)