Skip to content

Commit

Permalink
GITBOOK-207: Update signer version
Browse files Browse the repository at this point in the history
  • Loading branch information
@kenrogers @gitbook-bot
kenrogers authored and gitbook-bot committed Oct 28, 2024
1 parent fadb5d5 commit 4e77a2c
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 20 deletions.
8 changes: 3 additions & 5 deletions guides-and-tutorials/running-a-signer/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Run a Signer

{% include "../../.gitbook/includes/note-for-existing-signersth....md" %}

### How to Use This Guide

If you are not familiar with the concept of signing and stacking, and how they work together, be sure to check out the [Stackers and Signing concept guide](../../concepts/block-production/stackers-and-signing.md).
Expand Down Expand Up @@ -133,7 +131,7 @@ Note that at the moment the signer should only be run on testnet using these ins

#### Running the Signer with Docker

You can run the signer as a Docker container using the [`blockstack/stacks-signer:3.0.0.0.0.0`](https://hub.docker.com/layers/blockstack/stacks-signer/3.0.0.0.0.0/images/sha256-5406912473befe62ce21f1630908b01960bae29b7bef306fd5669037ac8e112b?context=explore) image.
You can run the signer as a Docker container using the [`blockstack/stacks-signer:3.0.0.0.0.1`](https://hub.docker.com/r/blockstack/stacks-signer/tags?page=1\&name=3.0.0.0.0.1) image.

When running the Docker container, you’ll need to ensure a few things:

Expand All @@ -147,7 +145,7 @@ Be sure to replace the `STX_SIGNER_PATH` with the correct path to your config fi

```bash
IMG="blockstack/stacks-signer"
VER="3.0.0.0.0.0"
VER="3.0.0.0.0.1"
STX_SIGNER_PATH="./"
STX_SIGNER_DATA="$STX_SIGNER_PATH/data"
STX_SIGNER_CONFIG="$STX_SIGNER_PATH/signer-config.toml"
Expand All @@ -173,7 +171,7 @@ For example, if you are running on M1 Mac, you would add `--platform=linux/amd64
Or, with a custom Dockerfile:

```docker
FROM blockstack/stacks-signer:3.0.0.0.0.0
FROM blockstack/stacks-signer:3.0.0.0.0.1
COPY signer-config.toml /config.toml
EXPOSE 30000
CMD ["stacks-signer", "run", "--config", "/config.toml"]
Expand Down
4 changes: 2 additions & 2 deletions nakamoto-upgrade/nakamoto-activation-guide-for-signers/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Nakamoto Activation Guide for Signers

{% hint style="info" %}
The block for Nakamoto activation has been chosen as Bitcoin block 867,867, which is currently expected on October 29th. This block is subject to change should core developers need additional time for testing or unexpected issues.
The block for Nakamoto activation has been chosen as Bitcoin block 867,867, which is currently expected on October 28th. This block is subject to change should core developers need additional time for testing or unexpected issues.

Binaries will be provided roughly a week in advance and your normal upgrade procedure should apply here, you’ll want to be running the latest node and Signer software. Note that if you do not upgrade ahead of the hard fork, your nodes will be dropped from the network.
{% endhint %}
Expand All @@ -13,7 +13,7 @@ This initial phase focuses on testing Signer 3.0 readiness in a testnet environm
**Action Required:**

1. Update stacks-node to version 3.0.0.0.0 ([here](https://github.com/stacks-network/stacks-core/releases/tag/3.0.0.0.0))
2. Update signer to version 3.0.0.0.0.0 ([here](https://github.com/stacks-network/stacks-core/releases/tag/signer-3.0.0.0.0.0))
2. Update signer to version 3.0.0.0.0.1 ([here](https://github.com/stacks-network/stacks-core/releases/tag/signer-3.0.0.0.0.1))
3. [Run a Primary Testnet node](setting-up-a-primary-post-nakamoto-testnet-node.md) alongside your Signer
4. Create a testnet wallet address
5. Complete the provided form ([here](https://blocksurvey.io/signer-nakamoto-activation-upgrade-GrOV5aivQ2.z2fh3bqEyLQ?v=o))
Expand Down
2 changes: 1 addition & 1 deletion ...activation-guide-for-signers/setting-up-a-primary-post-nakamoto-testnet-node.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### **Setup A Stacks Primary Testnet Node**

Once your signer is upgraded to version 3.0.0.0.0.0 ([here](https://github.com/stacks-network/stacks-core/releases/tag/signer-3.0.0.0.0.0)) you’ll need to run a primary testnet node alongside it.
Once your signer is upgraded to version 3.0.0.0.0.1 ([here](https://github.com/stacks-network/stacks-core/releases/tag/signer-3.0.0.0.0.1)) you’ll need to run a primary testnet node alongside it.

You have two options here. The first is to run the Bash script below and it will handle everything for you, including creating the configuration file, downloading and extracting a chain state archive, and getting the node up and running.

Expand Down
23 changes: 11 additions & 12 deletions reference/sample-configuration-files.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Signer Configuration

{% include "../.gitbook/includes/note-for-existing-signersth....md" %}

{% hint style="info" %}
Note that in this version, the Stacks node will not boot if it sees config values that are unused. If your node is not booting, be sure to check your logs for any messages indicating 
{% endhint %}
Expand All @@ -10,16 +8,17 @@ Note that in this version, the Stacks node will not boot if it sees config value

The signer configuration file is a TOML file that contains the configuration options for your signer. Below are the options you can set in the signer configuration file.

| Name | Required | Description |
| -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| node\_host | ✓ | IP:PORT where your Stacks node can be accessed. The port 20443 is the default RPC endpoint for Stacks nodes. Note that you must use an IP address - DNS hosts are not supported at this time. |
| endpoint | ✓ | IP:PORT where the signer will expose an RPC endpoint for receiving events from your Stacks node. |
| stacks\_private\_key | ✓ | Hex representation of the signer's Stacks private key used for communicating with the Stacks Node, including writing to the Stacker DB instance. |
| network | ✓ | Network to use. One of "mainnet", "testnet" or "mocknet". |
| auth\_password | ✓ | Authorization token for HTTP requests made from the signer to your Stacks node. |
| db\_path | ✓ | Path to the signer's database file |
| metrics\_endpoint | | IP:PORT for Prometheus metrics collection. |
| chain\_id | | An optional ChainID, only used for custom networks (like Nakamoto Testnet) |
| Name | Required | Description |
| ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| node\_host | ✓ | IP:PORT where your Stacks node can be accessed. The port 20443 is the default RPC endpoint for Stacks nodes. Note that you must use an IP address - DNS hosts are not supported at this time. |
| endpoint | ✓ | IP:PORT where the signer will expose an RPC endpoint for receiving events from your Stacks node. |
| stacks\_private\_key | ✓ | Hex representation of the signer's Stacks private key used for communicating with the Stacks Node, including writing to the Stacker DB instance. |
| network | ✓ | Network to use. One of "mainnet", "testnet" or "mocknet". |
| auth\_password | ✓ | Authorization token for HTTP requests made from the signer to your Stacks node. |
| db\_path | ✓ | Path to the signer's database file |
| block\_proposal\_timeout\_ms | | Specifies the maximum time (in milliseconds) a signer waits after a Bitcoin block for a miner to produce their first Nakamoto block. If the miner exceeds this time, the signer marks their tenure as invalid and rejects subsequent block proposals. Default value of 600\_000 (10 minutes). |
| metrics\_endpoint | | IP:PORT for Prometheus metrics collection. |
| chain\_id | | An optional ChainID, only used for custom networks (like Nakamoto Testnet) |

### Example Configs

Expand Down

0 comments on commit 4e77a2c

Please sign in to comment.