Docker Compose setup of non-sBTC Components #141

SundarGowtham · 2024-05-09T15:49:28Z

This PR includes the Docker Compose Setup of:

Docker Builds of Non-sBTC components:
- Bitcoin Regtest Node
- Bitcoin Miner
- Stacks Node
- Nakamoto Signer
- Electrs
- Stacks API
- Stacks Explorer
- Mempool Frontend
- Mempool Backend
- MariaDB
- Postgres
docker-compose.yml file
helper .sh files:
- build.sh for docker builds
- up.sh for docker spin up
- down.sh for docker spin down
devnet-liveness.sh file for testing
devenv/local/docker-compose/README.md for setup

This PR does NOT include:

Any Kubernetes setup for local testing
Any Cloud related Kubernetes setup

To setup and test, follow the instructions in ./devenv/local/docker-compose/README.md

AshtonStephens · 2024-05-10T13:17:35Z

What should we look for / be able to do with this PR? Can you provide some tests or some commands that we can use to verify that this is doing or able to handle some expected behavior?

hstove · 2024-05-13T19:33:37Z

I mentioned this in the other PR, but two things that would be helpful with this PR are:

Rebase your commits on top of the main branch - you can do this with git rebase origin/main, and then git push origin testnet -f
Instead of using all-caps with [N]- folders, just do things like devenv/local/docker-compose, devenv/local/custom-k8s, etc

…s node docker config

Ref: https://github.com/Trust-Machines/nakademo/blob/main/settings/Devnet.toml

- Refactored the Dockerfile of the stacks node to just run the entrypoint.sh

- Bitcoin Miner correctly mines blocks

…ddress on the fly

- Added INSTRUCTIONS.md to devenv/local/docker-compose - Added stacks-old container - Added tests/ folder with runs automated devnet tests

SundarGowtham · 2024-05-15T07:42:34Z

@AshtonStephens

I've used the old Stacks version (2.4.0.0.0) in this Docker Compose build temporarily
I've written INSTRUCTIONS.md in ./devenv/local/docker-compose/ on how to replicate and test
To run some automated tests, you can run sh devenv/local/docker-compose/tests/devnet-liveness.sh (also mentioned in INSTRUCTIONS.md)

Some problems:

[CRITICAL] Even after changing the Stacks container to a pre-Nakamoto version, the Stacks Node still autogenerates a miner address instead of using the private key hard-coded in devenv/local/docker-compose/stacks-old/docker/Config.toml. The Bitcoin Node and Miner works perfectly fine
[DEBUG] Mempool Backend complains that it is not able to connect to the Electrum Backend; so for right now I've set MEMPOOL_BACKEND: "none" instead of MEMPOOL_BACKEND: "electrum" in the docker compose. This is not a critical problem but it would be ideal to get it working

Remaining Notes:

Every other component works just fine. The only quip is that the Nakamoto Signer won't exactly be able to connect to our v24.0.0.0 Stacks Node since it is pre-Nakamoto. However, if you uncomment the stacks section of the Docker Compose, change the depends-on, and change STACKS_CORE_RPC_HOST env var for stacks-api, then the Signer also connects to the Stacks Node correctly

- Stacks Node successfully finds BTC UTXOs

SundarGowtham · 2024-05-17T02:49:54Z

The Stacks Node successfully finds the UTXOs now. The whole Testnet should work except for 2 caveats.

[1] The Stacks Explorer devnet shows up as offline in Stacks Explorer.
[2] The mempool backend refuses to connect with electrs (or that electrs drops all inbound connections. So I configured mempool backend to not use electrs for now)

hstove

Looking good! Mainly would like to see a few "process" changes:

Rename SETUP-README and INSTRUCTION files to just README.
Update this PR's description to note exactly what is (and isn't) included

hstove · 2024-05-20T17:28:01Z

devenv/local/.gitignore

+K8S
+CUSTOM-K8S-DOCKER-BUILDS


Can you move this (and the .gitignore inside docker-compose) into the top-level .gitignore? That way it's much easier to debug where/why folders are ignored

I've removed the extra .gitignore files and changed md file names

hstove

Nice job! Everything is working well. I'd like to see a few small changes, but mainly unrelated to the actual docker compose setup.

Also, nice job on writing a test for this!

hstove · 2024-05-21T18:10:49Z

devenv/local/docker-compose/README.md

+######  Mempool Frontend: `http://localhost:3020`
+######  Stacks Explorer: `http://localhost:8083`


These links are backwards

hstove · 2024-05-21T18:12:42Z

devenv/local/docker-compose/README.md

+#### (i) _Postgres Tools_
+
+```
+brew install libpq
+echo 'export PATH="/opt/homebrew/opt/libpq/bin:$PATH"' >> ~/.zshrc
+source ~/.zshrc
+```


This is very specific install instructions for MacOs with zsh, so if it's necessary it's probably better to just link to a "how to install postgres" page.

Added a section where any OS user can download from the Postgres website. I also added specific instructions for each type of OS

hstove · 2024-05-21T18:33:50Z

devenv/local/docker-compose/tests/devnet-liveness.sh

+
+STX_SYNC_WITH_BTC_UTXO_SUCCESS=false
+STX_SYNC_WITH_BTC_UTXO_SUCCESS_FRMT=$(echo "\033[1;31m$STX_SYNC_WITH_BTC_UTXO_SUCCESS\033[0m❌")
+if [[ $STACKS_DOCKER_LOGS == *"UTXOs found"* ]]; then


This test doesn't pass for me, even though I can see the "UTXOs found" log

Just wrote the RPC approach instead of using Docker logs. The problem with the using the logs from the Stacks node is that not all of the logs are being captured. The RPC approach is more reliable

hstove · 2024-05-21T18:34:31Z

devenv/local/docker-compose/tests/devnet-liveness.sh

+echo " ---------------------------------------------------------------"
+
+
+GET_STACKS_API_PING=$(curl -s "http://localhost:3700")


This is the port for the API's event observer, which is good, but we should also have a liveness check for the "public" API (port 3999)

Just added the STACKS_PUBLIC_API_LIVENESS_SUCCESS test. Everything passes now

hstove · 2024-05-21T18:36:34Z

devenv/local/docker-compose/tests/devnet-liveness.sh

+echo "----------------------------------------------------------"
+echo "|                        SUMMARY                         |"
+echo "----------------------------------------------------------"


Because this is a test file, it should exit with code 1 unless every test passes

Tests return a 0 or 1 now

hstove

LGTM! Nice work

netrome

Looks great! There's a lot of commented out stuff that I think can be cleaned up, but feel free to do it as a follow-up or keep anything that you still find helpful.

So excited to have this working!

netrome · 2024-05-24T08:02:38Z

devenv/.gitignore

@@ -0,0 +1,3 @@
+cloud
+K8S
+local-commands.sh


Does this file contain things that would be useful for us? It could be checked in to a scripts folder then.

It does but it will be push in the next PR

netrome · 2024-05-24T08:05:11Z

devenv/local/docker-compose/README.md

+## [1] Build all containers:
+
+##### `sh build.sh`
+
+## [2] Spin up all containers:
+
+##### `sh up.sh`


Should we consider adding top-level make targets for spinning up the local dev env? It would be nice to be able to run make local-dev-env from the project root. It can definitely be done as a follow-up.

netrome · 2024-05-24T08:09:00Z

devenv/local/docker-compose/bitcoin-miner-sidecar/docker-compose.yml

+    # hostname: bitcoin
+    # networks:
+    #   devnet:
+    #     # ipv4_address: 172.16.238.200
+    #     aliases:
+    #       - bitcoin


I assume this is stale config that should be cleaned up.

Along with the other blocks of commented-out-configuration in this file.

devenv/local/docker-compose/bitcoin/docker-compose-bitcoin.yml

devenv/local/docker-compose/bitcoin-miner-sidecar/docker-compose.yml

devenv/local/docker-compose/bitcoin-miner-sidecar/docker/entrypoint.sh

devenv/local/docker-compose/stacks/docker/entrypoint.sh

SundarGowtham added the test environment The testing envionment used to develop the sBTC-v1 features. label May 9, 2024

SundarGowtham self-assigned this May 9, 2024

SundarGowtham and others added 24 commits May 14, 2024 02:50

commiting the local docker builds for non-sbtc components

5ccaeef

non-sBTC services

2d0209b

added names to multi-ports

07d5ab2

fixed btc port names

5e3f5b4

mariadb & postgres db deployment

4fa477d

fixed electrs docker container

883be35

electrs k8s deployment works

764bd1d

added stacks api deployment and also added miner key section to stack…

abc519f

…s node docker config

fixed nakamoto signer, stacks, stacks-explorer Docker build files

b0c1f6a

Adding more deployments

3e18417

Added docker compose folder

faf13e4

added back docker folder for the stacks container

4f67ae3

Added the Docker Compose setup for local development

b7510ee

Added a well known Clarity testing private key

f455e39

Ref: https://github.com/Trust-Machines/nakademo/blob/main/settings/Devnet.toml

Kuberentes Configuration for Local Development

7bb5f03

deleted [1]-CUSTOM-DOCKER-BUILDS folder

63616d0

fix: include ENV vars in entrypoint script for nakamoto-signer

26b2796

- Added ARGS and ENVs to all containers with has entrypoint.sh

b34f466

- Refactored the Dockerfile of the stacks node to just run the entrypoint.sh

- Bitcoin Node correctly stores RPC Credentials

073fdcd

- Bitcoin Miner correctly mines blocks

BTC Miner is able to access BTC RPC API now

be1df18

- BTC and BTC Miner now works. The Stacks Node however generates an a…

585cfcd

…ddress on the fly

fix: add MINER_KEY to seed in node config

1cbf2ad

- Tweaked more stuff in Stacks config

fb17036

added some local docker files

398bab2

SundarGowtham force-pushed the testnet branch from b9f1dfb to 398bab2 Compare May 14, 2024 07:51

SundarGowtham marked this pull request as draft May 14, 2024 16:28

SundarGowtham changed the title ~~Docker Compose setup of non-sBTC Components~~ Docker Compose setup of non-sBTC Components-DRAFT May 14, 2024

- Changed folder names to not have numbers in front

e205841

- Added INSTRUCTIONS.md to devenv/local/docker-compose - Added stacks-old container - Added tests/ folder with runs automated devnet tests

SundarGowtham and others added 5 commits May 15, 2024 17:31

- Changed the miner address to moU2g2zzH3qLYCNPXGPAMqsgxr2Bw15V2j

c852c18

- Removed attribute in createwallet btc rpc call

a6e00f4

updated setup readme

a410a35

fix: use "" as btc wallet name, run regtest

3a4f692

- Reverted back to stacks v25

4f7a649

- Stacks Node successfully finds BTC UTXOs

SundarGowtham marked this pull request as ready for review May 17, 2024 02:50

SundarGowtham changed the title ~~Docker Compose setup of non-sBTC Components-DRAFT~~ Docker Compose setup of non-sBTC Components May 20, 2024

SundarGowtham requested a review from hstove May 20, 2024 14:45

hstove requested changes May 20, 2024

View reviewed changes

SundarGowtham added 4 commits May 21, 2024 10:29

Removed unnecessary gitignores and changed names of .md files to README

af82cc4

Formatted devenv/README.md to have less comments

845d063

removed stacks v24

f3c677f

removed stacks-old from docker compose networking

71950e9

hstove requested changes May 21, 2024

View reviewed changes

hstove reviewed May 21, 2024

View reviewed changes

hstove and others added 2 commits May 21, 2024 17:40

fix: correct burnchain options for mining

f898770

added tests for stacks public api

6f4f4bd

SundarGowtham requested a review from hstove May 22, 2024 14:51

SundarGowtham added 2 commits May 22, 2024 10:19

tests return 1 or 0

242f2fd

swapped 0 and 1

48413e8

hstove approved these changes May 22, 2024

View reviewed changes

SundarGowtham requested a review from netrome May 23, 2024 15:23

netrome approved these changes May 24, 2024

View reviewed changes

removed unecessary comments

f62c13f

SundarGowtham merged commit e9e2dd0 into main May 24, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docker Compose setup of non-sBTC Components #141

Docker Compose setup of non-sBTC Components #141

SundarGowtham commented May 9, 2024 •

edited

AshtonStephens commented May 10, 2024

hstove commented May 13, 2024

SundarGowtham commented May 15, 2024

SundarGowtham commented May 17, 2024

hstove left a comment

hstove May 20, 2024

SundarGowtham May 21, 2024

hstove left a comment

hstove May 21, 2024

SundarGowtham May 22, 2024

hstove May 21, 2024

SundarGowtham May 22, 2024

hstove May 21, 2024

SundarGowtham May 22, 2024

hstove May 21, 2024

SundarGowtham May 22, 2024

hstove May 21, 2024

SundarGowtham May 22, 2024

hstove left a comment

netrome left a comment

netrome May 24, 2024

SundarGowtham May 24, 2024

netrome May 24, 2024

netrome May 24, 2024

netrome May 24, 2024

		###### Mempool Frontend: `http://localhost:3020`
		###### Stacks Explorer: `http://localhost:8083`

		echo " ---------------------------------------------------------------"


		GET_STACKS_API_PING=$(curl -s "http://localhost:3700")

		K8S
		CUSTOM-K8S-DOCKER-BUILDS

Docker Compose setup of non-sBTC Components #141

Docker Compose setup of non-sBTC Components #141

Conversation

SundarGowtham commented May 9, 2024 • edited

AshtonStephens commented May 10, 2024

hstove commented May 13, 2024

SundarGowtham commented May 15, 2024

SundarGowtham commented May 17, 2024

hstove left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hstove 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

hstove left a comment

Choose a reason for hiding this comment

netrome 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

SundarGowtham commented May 9, 2024 •

edited