Skip to content

Commit c60d5c9

Browse files
werner-stacksgitbook-bot
authored andcommitted
GITBOOK: No subject
1 parent dbb3889 commit c60d5c9

8 files changed

Lines changed: 13 additions & 15 deletions

File tree

107 KB
Loading
125 KB
Loading
108 KB
Loading

‎docs/operate/run-a-sbtc-signer/README.md‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,18 @@ It is of the utmost importance to follow the recommendations below.
1616

1717
{% stepper %}
1818
{% step %}
19-
2019
#### Prevent unauthorized access to signer infrastructure
2120

2221
Prevent unauthorized access to the sBTC Signer infrastructure (the signer itself, its private key, and the associated PostgreSQL database).
2322
{% endstep %}
2423

2524
{% step %}
26-
2725
#### Keep an offline, secure backup of the Signer private key
2826

2927
Keep an offline, secure backup of the sBTC Signer private key.
3028
{% endstep %}
3129

3230
{% step %}
33-
3431
#### Regularly backup PostgreSQL database
3532

3633
Regularly backup the PostgreSQL database and store it in a secure location.
@@ -51,8 +48,6 @@ Note that these are in _addition_ to the hardware requirements for running a Sta
5148

5249
## Connection diagram
5350

54-
<figure><img src="../.gitbook/assets/image%20(8).png" alt=""><figcaption></figcaption></figure>
55-
5651
## Configure your Bitcoin node
5752

5853
### Minimum version
@@ -74,21 +69,18 @@ The signer connects to Bitcoin Core via RPC and polls for new bitcoin blocks. Th
7469

7570
{% stepper %}
7671
{% step %}
77-
7872
#### Bitcoin Core validates a new block
7973

8074
Bitcoin Core validates a new block.
8175
{% endstep %}
8276

8377
{% step %}
84-
8578
#### Signer detects the block via RPC polling
8679

8780
Signer detects the block via RPC polling.
8881
{% endstep %}
8982

9083
{% step %}
91-
9284
#### Signer processes relevant sBTC transactions
9385

9486
Signer processes relevant sBTC transactions.

‎docs/operate/run-a-signer/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
This guide is a step-by-step walkthrough for setting up and running a signer. It covers only the signer infrastructure: the signer software and the Stacks node it connects to.
88

9-
If you are not familiar with the concept of signing, be sure to check out the [Stackers and Signing concept guide](../../learn/block-production/signing.md).
9+
If you are not familiar with the concept of signing, be sure to check out the [Stackers and Signing concept guide](https://github.com/stacks-network/docs/blob/master/docs/learn/block-production/signing.md).
1010

1111
### Background and High-Level Process
1212

@@ -17,7 +17,7 @@ This doc provides instructions to set up both using either Docker or the release
1717
### Knowledge Prerequisites
1818

1919
* Docker and basic knowledge of pulling and running images
20-
* Basic knowledge of [Stacks accounts](../../learn/network-fundamentals/wallets-and-accounts.md)
20+
* Basic knowledge of [Stacks accounts](https://github.com/stacks-network/docs/blob/master/docs/learn/network-fundamentals/wallets-and-accounts.md)
2121

2222
{% stepper %}
2323
{% step %}
@@ -114,7 +114,7 @@ Signers are intended to work with a local node. The node<->signer connection is
114114

115115
## Create a Configuration File
116116

117-
Create a file named `signer-config.toml`. Populate it with the example signer config file contents from the [Sample Configuration Files](../../reference/node-operations/signer-configuration.md) page. Each field is described on that page.
117+
Create a file named `signer-config.toml`. Populate it with the example signer config file contents from the [Sample Configuration Files](https://github.com/stacks-network/docs/blob/master/docs/reference/node-operations/signer-configuration.md) page. Each field is described on that page.
118118

119119
***
120120

@@ -229,7 +229,7 @@ Start the Stacks node after the signer is running. The node will not run unless
229229

230230
### Stacks Node Configuration
231231

232-
Create `node-config.toml`. See the [Sample Configuration Files](../../reference/node-operations/signer-configuration.md) page for the full contents.
232+
Create `node-config.toml`. See the [Sample Configuration Files](https://github.com/stacks-network/docs/blob/master/docs/reference/node-operations/signer-configuration.md) page for the full contents.
233233

234234
Important fields to change:
235235

‎docs/operate/run-a-signer/signer-quickstart.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
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.
1818

19-
If you are not familiar with how signing works yet, be sure to check out the [Signing concept guide](../../learn/block-production/signing.md).
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).
2020

2121
{% hint style="danger" %}
2222
The CLI examples below may show outdated release versions. For the latest releases, always refer to the links above in the top info block.

‎docs/operate/stacking-stx/solo-stacking.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This guide covers everything you need to stack independently as a solo stacker: starting, extending, increasing, and stopping your stacking position.
44

55
{% hint style="info" %}
6-
This guide assumes you are familiar with stacking at a conceptual level. If not, read the [Stacking](../../learn/block-production/stacking.md) concept guide first.
6+
This guide assumes you are familiar with stacking at a conceptual level. If not, read the [Stacking](https://github.com/stacks-network/docs/blob/master/docs/learn/block-production/stacking.md) concept guide first.
77
{% endhint %}
88

99
Solo stacking requires meeting the minimum STX threshold and either running a signer or collaborating with one. The minimum amount is dynamic and can be found at the [pox endpoint](https://api.mainnet.hiro.so/v2/pox) under `min_threshold_ustx` (1 STX = 1,000,000 uSTX).

‎docs/operate/stacking-stx/stack-with-a-pool.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ For STX-only staking, use [app.leather.io/staking](https://app.leather.io/stakin
1616

1717
Whichever you use, the transaction goes to `pox-5` and locks your STX in your own account.
1818

19+
<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>
20+
21+
<figure><img src="../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
22+
1923
[Watch the flow end to end](https://x.com/Stacks/status/2083267023916662923)
2024

2125
{% hint style="warning" %}
@@ -24,6 +28,8 @@ Staking and staking updates are blocked during the prepare phase, the last 100 B
2428

2529
A transaction ID confirms submission, not success. Confirm the position on-chain or in your wallet before treating yourself as staked.
2630

31+
<figure><img src="../.gitbook/assets/image (2).png" alt=""><figcaption></figcaption></figure>
32+
2733
{% hint style="warning" %}
2834
**One position per Stacks principal.** STX-only staking and a protocol bond are mutually exclusive. Registering a bond while staked fails with `ERR_ALREADY_STAKED (u19)`.
2935
{% endhint %}
@@ -37,7 +43,7 @@ If you took whichever manager your app offered, you can skip this. Everything be
3743
* **Admin set.** Who can change the fee and withdraw accrued fees. Some managers block an admin from removing themselves, so the contract can never be left with no admin. Others have no such guard.
3844
* **An active signer-key grant.** A manager without one cannot accept new stake, and your transaction fails with `ERR_SIGNER_KEY_GRANT_NOT_FOUND (u17)`.
3945

40-
A manager needs 50,000 STX (`SIGNER_SET_MIN_USTX`) in aggregate across everyone staking to it before it enters the signer set. That threshold is fixed and applies to the manager rather than to you, so your own stake can be any size.
46+
A manager needs 50,000 STX (`SIGNER_SET_MIN_USTX`) in aggregate across everyone staking to it before it enters the signer set. That threshold is fixed and applies to the manager rather than to you, so your own stake can be any size as long as the signer-manager doesn't restrict it.
4147

4248
{% hint style="info" %}
4349
**Immutable code, mutable terms.** A deployed contract's Clarity source can never change, but its parameters can. An admin can change the fee at any time, up to whatever ceiling that contract fixed at deployment. Read the current fee and the admin set rather than assuming the economics are settled.

0 commit comments

Comments
 (0)