From 8702d3cc1ace9204d5a968ac9f217504f09f6067 Mon Sep 17 00:00:00 2001
From: Lakshya Singh <lakshay.singh1108@gmail.com>
Date: Wed, 13 Mar 2024 22:03:40 +0530
Subject: [PATCH] env: add versions for all services

- btc 26.0
- cln 24.0
- vls 0.11.0
- txoo 0.6.4
Signed-off-by: Lakshya Singh <lakshay.singh1108@gmail.com>
---
 .dockerignore                | 10 ++++------
 .env                         | 18 ++++++++++++++++++
 .gitignore                   |  1 -
 .gitlab-ci.yml               |  2 +-
 README.md                    | 18 ++++++++++++++++++
 scripts/build_from_cache.sh  |  3 ++-
 scripts/build_image_cache.sh |  2 +-
 7 files changed, 44 insertions(+), 10 deletions(-)
 create mode 100644 .env

diff --git a/.dockerignore b/.dockerignore
index 84ee65c..3b7aae8 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -1,11 +1,9 @@
-**/.dockerignore
-**/.env
-**/.git
-**/.gitignore
+.git
+.gitignore
 **/docker-compose*
 **/Dockerfile*
-**/*.Dockerfile
+.dockerignore
 LICENSE
 README.md
-scripts/
+scripts
 .gitlab-ci.yml
diff --git a/.env b/.env
new file mode 100644
index 0000000..ffaba2b
--- /dev/null
+++ b/.env
@@ -0,0 +1,18 @@
+# bitcoin version 26.0
+BITCOIN_VERSION=26.0
+BITCOIN_SHA256SUMS_HASH=63487c308a6655f939efd700bfca8e0285fa2f869283aaa7192bdd4b8799a747
+# core lightning version v24.02
+CORE_LIGHTNING_REPO=https://github.com/ElementsProject/lightning.git
+CORE_LIGHTNING_GIT_HASH=8418989f9bf3563a67ac91602500672b51628579
+# clboss
+CLBOSS_REPO=https://github.com/ZmnSCPxj/clboss.git
+CLBOSS_GIT_HASH=0673c50e7374ea8f5cb7e302f72b7978c6bd1794
+# cln plugins
+CLN_PLUGINS_REPO=https://github.com/lightningd/plugins.git
+CLN_PLUGINS_GIT_HASH=a525e6c42033a6270c81065a559301ceb2a761fa
+# txoo version 0.6.4
+TXOO_REPO=https://gitlab.com/lightning-signer/txoo.git
+TXOO_GIT_HASH=6f0718e3f2b9406df5e3cd73306f473199141da0
+# vls version v0.11.0
+VLS_REPO=https://gitlab.com/lightning-signer/validating-lightning-signer.git
+VLS_GIT_HASH=395b604964d5a0b4e9ee32c1b6e440dfbf4874f0
diff --git a/.gitignore b/.gitignore
index 4c49bd7..e69de29 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +0,0 @@
-.env
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index b845123..4ff38e1 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -49,7 +49,7 @@ compose:
     - docker volume create vls_data
     - docker buildx create --name=$BUILDER --use
   script:
-    - echo "IMAGE_TAG=${IMAGE_TAG}" > .env
+    - export IMAGE_TAG=${IMAGE_TAG}
     - ./scripts/build_from_cache.sh bitcoind
     - ./scripts/build_from_cache.sh lightningd
     - ./scripts/build_from_cache.sh txood
diff --git a/README.md b/README.md
index f5b5cdf..23fc485 100644
--- a/README.md
+++ b/README.md
@@ -183,6 +183,24 @@ docker container exec lightningd-test lightning-cli --testnet clboss-status | le
 # Show node summary status
 docker container exec lightningd-test lightning-cli --testnet summary
 ```
+## Choosing Versions
+
+The currently set default versions for services is as follows in the [.env](.env) file:
+- **Bitcoin Core**: v26.0
+- **Core Lightning**: v24.02
+- **TXOO**: v0.6.4
+- **VLS**: v0.11.0
+
+You just can switch to a particular version/commit for a service by updating the git hash and then rebuilding the service:
+```bash
+cd vls-container
+# update bitcoin core version
+sed -i 's/23.0/23.2/g' .env
+# build images again
+docker compose --profile vls build
+```
+
+Note: For `bitcoind` its also important to update the `BITCOIN_SHA256SUMS_HASH`. It is the *SHA256 HASH* of `SHA256SUMS` file.
 
 ## Future Work
 
diff --git a/scripts/build_from_cache.sh b/scripts/build_from_cache.sh
index 2f50344..458b0d0 100755
--- a/scripts/build_from_cache.sh
+++ b/scripts/build_from_cache.sh
@@ -5,4 +5,5 @@ set -ex
 SERVICE=$1
 
 cd $SERVICE
-docker build --load --builder $BUILDER --cache-from $CACHE/$SERVICE:$CACHE_TAG -t $SERVICE:$IMAGE_TAG .
+
+docker build --load --builder $BUILDER --cache-from $CACHE/$SERVICE:$CACHE_TAG -t $SERVICE:$IMAGE_TAG $(grep -v '^#' ../.env | sed 's/^/--build-arg /' | tr '\n' ' ') .
diff --git a/scripts/build_image_cache.sh b/scripts/build_image_cache.sh
index bbab802..8934c5f 100755
--- a/scripts/build_image_cache.sh
+++ b/scripts/build_image_cache.sh
@@ -7,4 +7,4 @@ SERVICE=$1
 docker buildx create --name=$SERVICE --use
 cd $SERVICE
 
-docker build --load --builder=$SERVICE --cache-to type=registry,ref=$CACHE/$SERVICE:$CACHE_TAG --cache-from $CACHE/$SERVICE:$CACHE_TAG -t $SERVICE:$IMAGE_TAG .
+docker build --load --builder=$SERVICE --cache-to type=registry,ref=$CACHE/$SERVICE:$CACHE_TAG --cache-from $CACHE/$SERVICE:$CACHE_TAG -t $SERVICE:$IMAGE_TAG $(grep -v '^#' ../.env | sed 's/^/--build-arg /' | tr '\n' ' ') .