feat: add bitcoind-knots support

Author: kwsantiago

docker/README.md

@@ -47,6 +47,24 @@ $ docker buildx build --platform linux/amd64,linux/arm64 --build-arg BITCOIN_VER
 
 Replace `<version>` with the desired bitcoind version (ex: `0.18.1`)
 
+## Bitcoin Knots
+
+### Tags
+
+- `29.2` ([bitcoind-knots/Dockerfile](https://github.com/jamaljsr/polar/blob/master/docker/bitcoind-knots/Dockerfile))
+- `28.0` ([bitcoind-knots/Dockerfile](https://github.com/jamaljsr/polar/blob/master/docker/bitcoind-knots/Dockerfile))
+- `27.0` ([bitcoind-knots/Dockerfile](https://github.com/jamaljsr/polar/blob/master/docker/bitcoind-knots/Dockerfile))
+- `26.0` ([bitcoind-knots/Dockerfile](https://github.com/jamaljsr/polar/blob/master/docker/bitcoind-knots/Dockerfile))
+
+**Building the image**
+
+```sh
+$ cd bitcoind-knots
+$ docker buildx build --platform linux/amd64,linux/arm64 --build-arg BITCOIN_VERSION=<version> --build-arg KNOTS_DATE=<date> -t polarlightning/bitcoind-knots:<version> --push .
+```
+
+Replace `<version>` with the desired Bitcoin Knots version (ex: `29.2`) and `<date>` with the Knots release date suffix (ex: `20251110`)
+
 ## LND
 
 ### Tags

docker/bitcoind-knots/Dockerfile

@@ -0,0 +1,36 @@
+FROM debian:stable-slim
+
+ARG BITCOIN_VERSION
+ARG KNOTS_DATE
+ENV FULL_VERSION=${BITCOIN_VERSION}.knots${KNOTS_DATE}
+ENV PATH=/opt/bitcoin-${FULL_VERSION}/bin:$PATH
+
+RUN apt-get update -y \
+  && apt-get install -y curl gosu \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+RUN SYS_ARCH="$(uname -m)" \
+  && MAJOR_VERSION="$(echo ${BITCOIN_VERSION} | cut -d. -f1)" \
+  && curl -SLO https://bitcoinknots.org/files/${MAJOR_VERSION}.x/${FULL_VERSION}/bitcoin-${FULL_VERSION}-${SYS_ARCH}-linux-gnu.tar.gz \
+  && tar -xzf *.tar.gz -C /opt \
+  && rm *.tar.gz
+
+RUN curl -SLO https://raw.githubusercontent.com/bitcoin/bitcoin/master/contrib/completions/bash/bitcoin-cli.bash \
+  && mkdir -p /etc/bash_completion.d \
+  && mv bitcoin-cli.bash /etc/bash_completion.d/bitcoin-cli.bash-completion \
+  && curl -SLO https://raw.githubusercontent.com/scop/bash-completion/master/bash_completion \
+  && mv bash_completion /usr/share/bash-completion/
+
+COPY docker-entrypoint.sh /entrypoint.sh
+COPY bashrc /home/bitcoin/.bashrc
+
+RUN chmod a+x /entrypoint.sh
+
+VOLUME ["/home/bitcoin/.bitcoin"]
+
+EXPOSE 18443 18444 28334 28335
+
+ENTRYPOINT ["/entrypoint.sh"]
+
+CMD ["bitcoind"]

docker/bitcoind-knots/bashrc

@@ -0,0 +1,8 @@
+# enable bash completion in interactive shells
+if ! shopt -oq posix; then
+  if [ -f /usr/share/bash-completion/bash_completion ]; then
+    . /usr/share/bash-completion/bash_completion
+  elif [ -f /etc/bash_completion ]; then
+    . /etc/bash_completion
+  fi
+fi

docker/bitcoind-knots/docker-entrypoint.sh

@@ -0,0 +1,29 @@
+#!/bin/sh
+set -e
+
+# containers on linux share file permissions with hosts.
+# assigning the same uid/gid from the host user
+# ensures that the files can be read/write from both sides
+if ! id bitcoin > /dev/null 2>&1; then
+  USERID=${USERID:-1000}
+  GROUPID=${GROUPID:-1000}
+
+  echo "adding user bitcoin ($USERID:$GROUPID)"
+  groupadd -f -g $GROUPID bitcoin
+  useradd -r -u $USERID -g $GROUPID bitcoin
+  chown -R $USERID:$GROUPID /home/bitcoin
+fi
+
+if [ $(echo "$1" | cut -c1) = "-" ]; then
+  echo "$0: assuming arguments for bitcoind"
+
+  set -- bitcoind "$@"
+fi
+
+if [ "$1" = "bitcoind" ] || [ "$1" = "bitcoin-cli" ] || [ "$1" = "bitcoin-tx" ]; then
+  echo "Running as bitcoin user: $@"
+  exec gosu bitcoin "$@"
+fi
+
+echo "$@"
+exec "$@"

docker/nodes.json

@@ -46,6 +46,10 @@
       "latest": "30.0",
       "versions": ["30.0", "29.0", "28.0", "27.0", "26.0"]
     },
+    "bitcoind-knots": {
+      "latest": "29.3",
+      "versions": ["29.3", "29.2", "28.0", "27.0", "26.0"]
+    },
     "btcd": {
       "latest": "",
       "versions": []

src/components/common/ImageUpdatesModal.spec.tsx

@@ -77,6 +77,7 @@ describe('ImageUpdatesModal', () => {
           eclair: [],
           litd: [],
           bitcoind: ['4.5.6'],
+          'bitcoind-knots': [],
           btcd: [],
           tapd: [],
         },

src/components/common/RenameNodeModal.spec.tsx

@@ -36,6 +36,7 @@ describe('RenameNodeModal', () => {
       eclairNodes: 1,
       litdNodes: 1,
       bitcoindNodes: 3,
+      bitcoindKnotsNodes: 0,
       tapdNodes: 1,
       status,
       repoState: defaultRepoState,

src/components/designer/Sidebar.tsx

@@ -20,7 +20,10 @@ const Sidebar: React.FC<Props> = ({ network, chart }) => {
     if (type === 'node') {
       const { bitcoin, lightning, tap } = network.nodes;
       const node = [...bitcoin, ...lightning, ...tap].find(n => n.name === id);
-      if (node && node.implementation === 'bitcoind') {
+      if (
+        node &&
+        (node.implementation === 'bitcoind' || node.implementation === 'bitcoind-knots')
+      ) {
         return <BitcoindDetails node={node as BitcoindNode} />;
       } else if (node && node.type === 'lightning') {
         return <LightningDetails node={node as LightningNode} />;

src/components/designer/bitcoin/actions/SendOnChainModal.spec.tsx

@@ -25,6 +25,7 @@ describe('SendOnChainModal', () => {
       clightningNodes: 1,
       eclairNodes: 1,
       bitcoindNodes: 3,
+      bitcoindKnotsNodes: 0,
       tapdNodes: 0,
       litdNodes: 0,
       status: Status.Started,

src/components/designer/lightning/actions/CreateInvoiceModal.spec.tsx

@@ -144,6 +144,7 @@ describe('CreateInvoiceModal', () => {
         clightningNodes: 0,
         eclairNodes: 0,
         bitcoindNodes: 1,
+        bitcoindKnotsNodes: 0,
         tapdNodes: 0,
         litdNodes: 3,
         status: Status.Started,