You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 8710354
Browse filesBrowse the repository at this point in the historyBrowse files
If you want to get up and running as an active signer as quickly as possible, here is a list of the commands you need to run and actions to take.
17
+
The commands below take a fresh Ubuntu machine to a running signer and Stacks node.
18
18
19
-
If you are not familiar with how signing works yet, be sure to check out the [Signing concept guide](https://github.com/stacks-network/docs/blob/master/docs/learn/block-production/signing.md).
20
-
21
-
{% hint style="danger" %}
22
-
The CLI examples below may show outdated release versions. For the latest releases, always refer to the links above in the top info block.
23
-
{% endhint %}
19
+
If you are not familiar with how signing works yet, be sure to check out the [Signing concept guide](https://docs.stacks.co/learn/block-production/signing).
The account file previously created looks like this:
63
+
The account file looks like this:
68
64
69
65
```json
70
66
{
@@ -88,12 +84,11 @@ From this file, you'll need the `privateKey` value.
88
84
89
85
**Download the stacks-signer binary**
90
86
91
-
Official binaries are available from the [Stacks Core releases page on Github](https://github.com/stacks-network/stacks-core/releases/latest). Each release includes pre-built binaries. Download the [latest signer release ZIP file](https://github.com/stacks-network/stacks-core/releases/latest) for your server’s architecture and decompress it. Inside of that folder is a `stacks-signer` binary.
87
+
Download the [latest signer release ZIP file](https://github.com/stacks-network/stacks-core/releases/latest) for your server's architecture and decompress it. Inside that folder is a `stacks-signer` binary.
92
88
93
89
Assuming a `Linux x64 glibc` machine, the commands to download and uncompress the signer binary look like this:
94
90
95
91
```bash
96
-
# The CLI examples below may show outdated release versions.
97
92
# Enter the signer directory
98
93
cd~/stacks-signer
99
94
@@ -106,12 +101,12 @@ unzip linux-glibc-x64.zip
106
101
107
102
**Create the configuration file**
108
103
109
-
Create the configuration file required to start the signer (be sure to replace `<your_token>` and `<your_private_key>` with your auth token and private key values):
104
+
Create the configuration file required to start the signer (be sure to replace `<your_token>` and `<your_private_key>` with your auth token and private key values). Every option is documented in [Signer Configuration](https://docs.stacks.co/reference/node-operations/signer-configuration).
110
105
111
106
{% tabs %}
112
107
{% tab title="Mainnet" %}
108
+
{% code title="signer-config.toml" %}
113
109
```bash
114
-
# The CLI examples below may show outdated release versions.
115
110
# Set environment variables
116
111
AUTH_TOKEN=<your_token># Used for signer-node authentication
117
112
PRIVATE_KEY=<your_private_key># privateKey from Step 1, this is the signer's private key
If the outputs of the previous commands are correct, you can proceed and start the signer:
184
+
If the output is correct, start the signer:
185
185
186
186
```bash
187
187
~/stacks-signer/stacks-signer run -c ~/stacks-signer/signer-config.toml
@@ -191,7 +191,7 @@ If the outputs of the previous commands are correct, you can proceed and start t
191
191
{% step %}
192
192
#### Optional: Set up a Bitcoin node (strongly recommended)
193
193
194
-
In order to optimize signer health and performance, we highly recommend setting up your own Bitcoin node rather than relying on a third-party node.
194
+
Run your own Bitcoin node rather than relying on a third-party one. A hosted node can leave your Stacks node behind tip and unsynced.
195
195
196
196
We have created guides for running both a [full Bitcoin node](../run-a-node/run-a-bitcoin-node.md) and a [pruned Bitcoin node](../run-a-node/run-a-pruned-bitcoin-node.md) you can follow.
197
197
{% endstep %}
@@ -201,12 +201,11 @@ We have created guides for running both a [full Bitcoin node](../run-a-node/run-
201
201
202
202
**Download the stacks-node binary**
203
203
204
-
Official binaries are available from the [Stacks Core releases page on Github](https://github.com/stacks-network/stacks-core/releases/latest). Each release includes pre-built binaries. Download the [latest node release ZIP file](https://github.com/stacks-network/stacks-core/releases/latest) for your server’s architecture and decompress it. Inside of that folder is a `stacks-node` binary.
204
+
Download the [latest node release ZIP file](https://github.com/stacks-network/stacks-core/releases/latest) for your server's architecture and decompress it. Inside that folder is a `stacks-node` binary.
205
205
206
206
Assuming a `Linux x64 glibc` machine, the commands to download and uncompress the node binary look like this:
207
207
208
208
```bash
209
-
# The CLI examples below may show outdated release versions.
210
209
# Enter the node directory
211
210
cd ~/stacks-node
212
211
@@ -219,18 +218,16 @@ unzip linux-glibc-x64.zip
219
218
220
219
**Create the configuration file**
221
220
222
-
Create the configuration file required to start the node (be sure to replace `<your_token>` with your auth token value):
221
+
Create the configuration file required to start the node (be sure to replace `<your_token>` with your auth token value). Every option is documented in [Stacks Node Configuration](https://docs.stacks.co/reference/node-operations/readme-1).
223
222
224
223
{% tabs %}
225
224
{% tab title="Mainnet" %}
226
225
{% hint style="warning" %}
227
-
For mainnet, we strongly recommended that you run your own bitcoin node (you can follow guides on how to run a [full Bitcoin node](https://docs.stacks.co/guides-and-tutorials/nodes-and-miners/run-a-bitcoin-node) or a [pruned Bitcoin node](https://docs.stacks.co/guides-and-tutorials/nodes-and-miners/run-a-pruned-bitcoin-node)) in order to ensure you have no connection issues when downloading bitcoin blocks. A hosted bitcoin node may cause your stacks node to fall behind tip and remain unsynced.
228
-
229
226
If you run your own bitcoin node, you'll have to update `peer_host` and optionally add `rpc_port`, `peer_port`, `username` and `password` fields under the `[burnchain]` section of the node's configuration file.
230
227
{% endhint %}
231
228
229
+
{% code title="node-config.toml" %}
232
230
```bash
233
-
# The CLI examples below may show outdated release versions.
234
231
# Set environment variables
235
232
AUTH_TOKEN=<your_token> # Used for signer-node authentication, same token as the one set up in the signer configuration
You can [download a chainstate archive](https://archive.hiro.so/) in order to quickly sync your node, otherwise it will take a long time to get up-to-date with the other nodes.
409
+
You can [download a chainstate archive](https://archive.hiro.so/) instead of syncing from genesis.
@@ -440,10 +479,13 @@ If you would like to learn more about monitoring your signer and its correspondi
440
479
{% endstep %}
441
480
442
481
{% step %}
443
-
#### Next Steps: Stacking
482
+
#### Next Steps: Register Your Signer
483
+
484
+
Once your signer and Stacks node are running and verified, this signer key has to be bound to a signer-manager contract before stakers can route to it. PoX-5 replaces the PoX-4 per-transaction signer signature with a standing on-chain grant:
444
485
445
-
Once your signer and Stacks node are running and verified, the next step is to stack STX to register your signer for a reward cycle. See the [Stacking STX](../staking-stx/) guide forcomplete instructions on solo stacking, delegated stacking, and managing your keys.
486
+
1. You produce a SIP-018 signature off-chain with this signer's private key, binding it to a specific signer-manager and an `auth-id`. See [Generate a Signer Signature](../staking-stx/generate-signer-signature.md).
487
+
2. That signer-manager submits `grant-signer-key` carrying your signature, then calls `register-signer` to bind itself to your key on chain.
446
488
447
-
You will need to [generate a signer signature](../staking-stx/generate-signer-signature.md) before making any stacking transaction.
489
+
See [Staking STX](../staking-stx/) for the full PoX-5 staking flow, and [Key and Address Rotation](../staking-stx/key-and-address-rotation.md) for changing this key later.
0 commit comments