Add signer and update versions #128

bowtiedbot · 2024-10-25T17:23:25Z

Added signer docker compose file as extra service, which can be started with an optional flag on all available networks.

Also updated node and API versions to the latest ones:

stacks-node: 3.0.0.0.0
stacks-blockchain-api: 8.1.2
stacks-signer: 3.0.0.0.0.0

Added signer docker compose file as extra service, which can be started with an optional flag on all available networks. Updated node and API versions to the latest ones.

CLAassistant · 2024-10-25T17:23:31Z

All committers have signed the CLA.

wileyj · 2024-10-25T18:15:49Z

unless i'm misreading this, you're proposing to start a signer as flag i.e. -f signer similar to how nginx proxy is started.
however, i don't see a compose yaml that actually starts the signer, is that commit missing?
ex:
https://github.com/degen-lab/stacks-blockchain-docker/blob/feat/add-signer-and-update-versions/compose-files/extra-services/proxy.yaml

i think you'll want another file like this for the signer unless the signer should run by default, in which case it can be added here: https://github.com/degen-lab/stacks-blockchain-docker/blob/feat/add-signer-and-update-versions/compose-files/common.yaml

bowtiedbot · 2024-10-25T18:53:19Z

You're right, for some reason Github decided to ignore the signer files. I've added them now in the latest commit, thank you!

wileyj · 2024-10-25T20:10:36Z

thanks! seems good to me, but i won't be able to check this soon. i'll ping adriano, if he can get it running we'll merge it

aldur

Thank you! I'll try running it on a clean environment and report back.

Meanwhile, I also asked @friedger if he can help testing it, since this closes #126.

aldur · 2024-10-25T17:43:14Z

docs/config.md

+| `SIGNER_PRIVATE_KEY`         | The private key of the signer, on mainnet.                                                       |               |
+| `TESTNET_SIGNER_PRIVATE_KEY` | The private key of the signer, on testnet.                                                       |               |


Just curious why two separate variables?

So we can run a testnet instance and a mainnet instance in the same environment?

That's because most users have different signer private keys on mainnet vs testnet. Users shouldn't worry about modifying the key every time they switch between a mainnet and a testnet instance, but have both set in env.

aldur · 2024-10-26T06:31:31Z

manage.sh

@@ -154,9 +155,10 @@ usage() {
 	log "        -n|--network: [ mainnet | testnet | mocknet ]"
 	log "        -a|--action: [ start | stop | logs | reset | upgrade | import | export | bns ]"
 	log "    optional args:"
-	log "        -f|--flags: [ proxy ]"
+	log "        -f|--flags: [ signer,proxy ]"


Can you also add how to run this on the readme?

friedger

I think my signer is running.

The beginning was a bit scary. signer couldn't start, stacks node was waiting on the signer.... eventually, it runs.

friedger · 2024-10-26T07:13:38Z

README.md

@@ -25,7 +25,7 @@ cp sample.env .env
 ### Seed chainstate from Hiro Archiver

 Using data from the [Hiro Archiver](https://docs.hiro.so/hiro-archive) service, this script will download the latest files, extract them and restore the postgres data. \
-_**Note**: it can take a long time to process the data, and you'll need at a minimum roughly 150GB of free space_
+_**Note**: it can take a long time to process the data, and you'll need at a minimum roughly 350GB of free space_


This is not related to signer, correct?

No, that's strictly from the node and API data. The node has about 250GB unarchived, while the API has 80.

friedger · 2024-10-26T07:17:12Z

conf/mainnet/Config.toml.sample

-[[events_observer]]
-endpoint = "stacks-blockchain-api:3700"
-events_keys = ["*"]
+stacker = true


This is optional for instances that choose to not run the signing service. What is the impact?

When starting without the signer, that line gets commented, along with the signer's events_observer line: https://github.com/degen-lab/stacks-blockchain-docker/blob/feat/add-signer-and-update-versions/manage.sh#L453-L463

friedger · 2024-10-26T07:22:12Z

conf/testnet/Config.toml.sample

@@ -33,3 +43,39 @@ amount = 10000000000000000
 [[ustx_balance]]
 address = "ST2TFVBMRPS5SSNP98DQKQ5JNB2B6NZM91C4K3P7B"
 amount = 10000000000000000
+
+[[burnchain.epochs]]


Are these important?

Yes, the node has to know the epochs set by Hiro on their bootstrap node. These are taken from the Stacks Docs page with Sample Configuration Files. The testnet node would panic otherwise: https://docs.stacks.co/reference/sample-configuration-files#stacks-node-testnet-config

friedger · 2024-10-26T07:25:04Z

docs/config.md

+| `SIGNER_PRIVATE_KEY`         | The private key of the signer, on mainnet.                                                       |               |
+| `TESTNET_SIGNER_PRIVATE_KEY` | The private key of the signer, on testnet.                                                       |               |


So we can run a testnet instance and a mainnet instance in the same environment?

friedger · 2024-10-26T07:30:53Z

conf/mainnet/Config.toml.sample

+
+[connection_options]
+auth_token = "1234"
+private_neighbors = false


why not using default value?

That is so the node doesn't announce/accept neighbors that are behind private networks - leaving it as a default (true) might load the logs with messages that the connection between your node and the private node couldn't be established

friedger · 2024-10-26T11:06:27Z

conf/mainnet/Signer.toml.sample

+db_path = "/root/stacks-signer/data/signer.sqlite"
+auth_password = ""
+stacks_private_key = ""
+block_proposal_timeout_ms = 180000


We also want prometheus as a default, I think.

add command to run the environment with signer on README.md

bowtiedbot · 2024-10-26T13:20:46Z

I've added metrics endpoints for node and signer, as well as how to run the environment with a signer directly on README.md in the latest commit.

friedger · 2024-10-26T16:49:06Z

Could you add an option to remove stacks-blockchain-api ?
Maybe it is too much of an effort and we should create a fork?

aldur · 2024-10-26T19:09:39Z

I think it's a reasonable thing to do, but I'm worried about scope creep on this PR. I'd suggest closing this and then iterating to disable the API in case.

wileyj · 2024-10-28T15:10:27Z

I think my signer is running.
The beginning was a bit scary. signer couldn't start, stacks node was waiting on the signer.... eventually, it runs.

good enough for me - i'll merge this, and we can figure out improvements/changes post 3.0 activation.
thanks for the PR!

friedger · 2024-10-30T20:46:42Z

@wileyj this is not a solution that follows the recommendations for running a signer. They say that signers should run a stacks node without any other services like mock mining or stacks-api.

wileyj · 2024-10-30T21:10:59Z

fair point - in this case i think it's better to keep since it is optional as a flag (for the signer) and we'll tighten this repo up later on to disable the api if the signer is set to start.

add signer and update versions

2b632b3

Added signer docker compose file as extra service, which can be started with an optional flag on all available networks. Updated node and API versions to the latest ones.

Merge branch 'master' into feat/add-signer-and-update-versions

01e2381

fix: add signer compose and configuration files

5394a10

aldur reviewed Oct 26, 2024

View reviewed changes

friedger reviewed Oct 26, 2024

View reviewed changes

add: prometheus metrics endpoint for node and signer

420794a

add command to run the environment with signer on README.md

wileyj merged commit 9098ef2 into stacks-network:master Oct 28, 2024
1 check passed

friedger mentioned this pull request Oct 30, 2024

Add the option to run a signer #126

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add signer and update versions #128

Add signer and update versions #128

bowtiedbot commented Oct 25, 2024 •

edited

Loading

CLAassistant commented Oct 25, 2024 •

edited

Loading

wileyj commented Oct 25, 2024

bowtiedbot commented Oct 25, 2024

wileyj commented Oct 25, 2024 •

edited

Loading

aldur left a comment

aldur Oct 25, 2024

friedger Oct 26, 2024

bowtiedbot Oct 26, 2024

aldur Oct 26, 2024

friedger left a comment

friedger Oct 26, 2024

bowtiedbot Oct 26, 2024

friedger Oct 26, 2024

bowtiedbot Oct 26, 2024

friedger Oct 26, 2024

friedger Oct 26, 2024

bowtiedbot Oct 26, 2024

friedger Oct 26, 2024

friedger Oct 26, 2024

friedger Oct 26, 2024

bowtiedbot Oct 26, 2024

friedger Oct 26, 2024

bowtiedbot commented Oct 26, 2024

friedger commented Oct 26, 2024

aldur commented Oct 26, 2024

wileyj commented Oct 28, 2024

friedger commented Oct 30, 2024

wileyj commented Oct 30, 2024

		\| `SIGNER_PRIVATE_KEY` \| The private key of the signer, on mainnet. \| \|
		\| `TESTNET_SIGNER_PRIVATE_KEY` \| The private key of the signer, on testnet. \| \|

Add signer and update versions #128

Add signer and update versions #128

Conversation

bowtiedbot commented Oct 25, 2024 • edited Loading

CLAassistant commented Oct 25, 2024 • edited Loading

wileyj commented Oct 25, 2024

bowtiedbot commented Oct 25, 2024

wileyj commented Oct 25, 2024 • edited Loading

aldur left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

friedger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bowtiedbot commented Oct 26, 2024

friedger commented Oct 26, 2024

aldur commented Oct 26, 2024

wileyj commented Oct 28, 2024

friedger commented Oct 30, 2024

wileyj commented Oct 30, 2024

bowtiedbot commented Oct 25, 2024 •

edited

Loading

CLAassistant commented Oct 25, 2024 •

edited

Loading

wileyj commented Oct 25, 2024 •

edited

Loading