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

@@ -1,11 +1,9 @@
-**/.dockerignore
-**/.env
-**/.git
-**/.gitignore
+.git
+.gitignore
 **/docker-compose*
 **/Dockerfile*
-**/*.Dockerfile
+.dockerignore
 LICENSE
 README.md
-scripts/
+scripts
 .gitlab-ci.yml

.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

.gitignore

@@ -1 +0,0 @@
-.env

.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

README.md

@@ -71,10 +71,11 @@ There is a `docker-compose.yml` in the `vlsd` folder which can be used to run a
 
 ```bash
 cd vlsd
+export VLS_GIT_HASH=$VLS_GIT_HASH
 docker compose up
 ```
 
-**_Note_**: Make sure to set `BITCOIND_RPC_URL` and `CLN_RMEOTE_HSMD_URL` as either environment variables or in the `docker-compose.yml` file before running the above command.
+**_Note_**: Make sure to set `BITCOIND_RPC_URL`, `VLS_GIT_HASH` and `CLN_RMEOTE_HSMD_URL` as either environment variables or in the `docker-compose.yml` file before running the above command. You can take `VLS_GIT_HASH` from [.env](./.env) or from the main [repo](https://gitlab.com/lightning-signer/validating-lightning-signer)
 
 If you wish to run it as a standalone container without using `docker-compose` you can use the following command:
 
@@ -84,6 +85,7 @@ docker run \
   --rm \
   --name vlsd \
   --network host \
+  --build_arg VLS_GIT_HASH=$VLS_GIT_HASH
   -e VLS_NETWORK=testnet \
   -e BITCOIND_RPC_URL=$BITCOIND_RPC_URL \
   --mount 'type=volume,src=vls_data,dst=/home/vls/.lightning-signer' \
@@ -181,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
 

bitcoind/Dockerfile

@@ -49,15 +49,15 @@ RUN mkdir $GNUPGHOME && set -ex \
 
 RUN gpg -kv
 
-ARG BITCOIN_VERSION=23.0
+ARG BITCOIN_VERSION
 ARG BITCOIN_PREFIX=/opt/bitcoin-${BITCOIN_VERSION}
-ARG SHA256SUMS_HASH=aaff81ea001f499e8f6f3221387d7db960d71a3b7a4a2b1aaf2c8060bc94a391
-
+ARG BITCOIN_SHA256SUMS_HASH
+RUN echo "Building bitcoin core version $BITCOIN_VERSION"
 RUN wget https://bitcoincore.org/bin/bitcoin-core-${BITCOIN_VERSION}/SHA256SUMS && \
     wget https://bitcoincore.org/bin/bitcoin-core-${BITCOIN_VERSION}/SHA256SUMS.asc && \
     wget https://bitcoincore.org/bin/bitcoin-core-${BITCOIN_VERSION}/bitcoin-${BITCOIN_VERSION}.tar.gz && \
     gpg --batch --verify SHA256SUMS.asc SHA256SUMS && \
-    echo "${SHA256SUMS_HASH} SHA256SUMS" | sha256sum -c - && \
+    echo "${BITCOIN_SHA256SUMS_HASH} SHA256SUMS" | sha256sum -c - && \
     grep " bitcoin-${BITCOIN_VERSION}.tar.gz\$" SHA256SUMS | sha256sum -c - && \
     tar -xzf *.tar.gz
 
@@ -108,10 +108,11 @@ RUN apk --no-cache add \
   libevent \
   libzmq
 
-ENV BITCOIN_DATA=/home/bitcoin/.bitcoin
-ARG BITCOIN_VERSION=23.0
+ARG BITCOIN_VERSION
 ARG BITCOIN_PREFIX=/opt/bitcoin-${BITCOIN_VERSION}
 
+ENV BITCOIN_DATA=/home/bitcoin/.bitcoin
+
 COPY --from=bitcoin-core ${BITCOIN_PREFIX}/bin/bitcoin-cli /usr/bin/bitcoin-cli
 COPY --from=bitcoin-core ${BITCOIN_PREFIX}/bin/bitcoin-tx /usr/bin/bitcoin-tx
 COPY --from=bitcoin-core ${BITCOIN_PREFIX}/bin/bitcoind /usr/bin/bitcoind

docker-compose.yml

@@ -3,6 +3,9 @@ services:
   bitcoin-core:
     build:
       context: ./bitcoind
+      args:
+        - BITCOIN_VERSION
+        - BITCOIN_SHA256SUMS_HASH
     image: bitcoind:${IMAGE_TAG:-latest}
     container_name: bitcoind-test
     volumes:
@@ -19,6 +22,15 @@ services:
   core-lightning:
     build:
       context: ./lightningd
+      args:
+        - CORE_LIGHTNING_REPO
+        - CORE_LIGHTNING_GIT_HASH
+        - CLBOSS_REPO
+        - CLBOSS_GIT_HASH
+        - CLN_PLUGINS_REPO
+        - CLN_PLUGINS_GIT_HASH
+        - VLS_REPO
+        - VLS_GIT_HASH
     image: lightningd:${IMAGE_TAG:-latest}
     container_name: lightningd-test
     command:
@@ -46,6 +58,9 @@ services:
   txoo:
     build:
       context: ./txood
+      args:
+        - TXOO_REPO
+        - TXOO_GIT_HASH
     image: txood:${IMAGE_TAG:-latest}
     container_name: txood-test
     restart: unless-stopped
@@ -64,6 +79,9 @@ services:
   vls:
     build:
       context: ./vlsd
+      args:
+        - VLS_REPO
+        - VLS_GIT_HASH
     image: vlsd:${IMAGE_TAG:-latest}
     container_name: vlsd-test
     profiles:

lightningd/Dockerfile

@@ -27,8 +27,8 @@ RUN apk update && \
       zlib-dev \
       zlib-static
 
-ARG CORE_LIGHTNING_GIT_HASH=76cd32387a400a2aee607edaf1e0a06e92e1402f \
-    CORE_LIGHTNING_REPO=https://github.com/ElementsProject/lightning.git
+ARG CORE_LIGHTNING_GIT_HASH \
+    CORE_LIGHTNING_REPO
 RUN git clone --recursive $CORE_LIGHTNING_REPO core-lightning
 RUN cd core-lightning && \
     git checkout $CORE_LIGHTNING_GIT_HASH && \
@@ -37,11 +37,11 @@ RUN cd core-lightning && \
     make -j $(nproc) install && \
     make clean
 
-ARG PLUGINS_GIT_HASH=cf96eb63c1687644042ea85acfd3785527fd98d4 \
-    PLUGINS_REPO=https://github.com/lightningd/plugins.git
-RUN git clone $PLUGINS_REPO
+ARG CLN_PLUGINS_GIT_HASH \
+    CLN_PLUGINS_REPO
+RUN git clone $CLN_PLUGINS_REPO
 RUN cd plugins && \
-    git checkout $PLUGINS_GIT_HASH
+    git checkout $CLN_PLUGINS_GIT_HASH
 
 FROM --platform=${TARGETPLATFORM:-${BUILDPLATFORM:-linux/amd64}} alpine:3.18 as clboss_builder
 
@@ -60,8 +60,8 @@ RUN apk update && \
     pkgconf \
     sqlite-dev
 
-ARG CLBOSS_GIT_HASH=0673c50e7374ea8f5cb7e302f72b7978c6bd1794 \
-    CLBOSS_REPO=https://github.com/ZmnSCPxj/clboss.git
+ARG CLBOSS_GIT_HASH \
+    CLBOSS_REPO
 RUN git clone --recurse-submodules $CLBOSS_REPO clboss
 RUN cd clboss && \
     git checkout $CLBOSS_GIT_HASH && \
@@ -85,9 +85,9 @@ RUN apk update && \
     protobuf-dev \
     rust
 
-ARG VLS_GIT_HASH=5712eb74b672ffd8b691b9e772e05a827d03e7df \
-    VLS_REPO=https://gitlab.com/lightning-signer/validating-lightning-signer.git
-RUN echo building remote_hsmd_socket from hash: $VLS_GIT_HASH
+ARG VLS_GIT_HASH \
+    VLS_REPO
+RUN echo "building remote_hsmd_socket from hash: $VLS_GIT_HASH"
 RUN git clone $VLS_REPO vls
 RUN cd vls && \
     git checkout $VLS_GIT_HASH && \

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' ' ') .

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' ' ') .

txood/Dockerfile

@@ -9,8 +9,8 @@ RUN apk update && \
     rust \
     cargo
 
-ARG TXOO_GIT_HASH=1cfeecf5f806a04a12c97ca17c39566a1a24e732
-ARG TXOO_REPO=https://gitlab.com/lightning-signer/txoo.git
+ARG TXOO_GIT_HASH \
+    TXOO_REPO
 RUN git clone --recurse-submodules $TXOO_REPO
 RUN cd txoo && \
     git checkout $TXOO_GIT_HASH && \

vlsd/Dockerfile

@@ -12,9 +12,10 @@ RUN apk update && \
     protobuf-dev \
     rust
 
-ARG VLS_GIT_HASH=5712eb74b672ffd8b691b9e772e05a827d03e7df
-RUN echo building vlsd from hash: $VLS_GIT_HASH
-RUN git clone https://gitlab.com/lightning-signer/validating-lightning-signer.git vls
+ARG VLS_GIT_HASH \
+    VLS_REPO
+RUN echo "building vlsd from hash: $VLS_GIT_HASH"
+RUN git clone $VLS_REPO vls
 RUN cd vls && \
     git checkout $VLS_GIT_HASH && \
     cargo install --locked --path ./vls-proxy --bin vlsd2 --profile release --root /usr/local/ && \

vlsd/docker-compose.yml

@@ -4,6 +4,8 @@ services:
     build:
       context: .
       dockerfile: Dockerfile
+      args:
+        - VLS_GIT_HASH
     image: vlsd
     container_name: vlsd-standalone
     command: