test: add coverage for bitcoind-knots support

Author: kwsantiago

src/components/network/NetworkSetting.tsx

@@ -94,6 +94,7 @@ const NetworkSetting: React.FC = () => {
             'c-lightning': settings.basePorts['c-lightning'].rest,
             eclair: settings.basePorts.eclair.rest,
             bitcoind: settings.basePorts.bitcoind.rest,
+            'bitcoind-knots': settings.basePorts['bitcoind-knots'].rest,
             tapd: settings.basePorts.tapd.rest,
             grpcLND: settings.basePorts.LND.grpc,
             'grpcC-lightning': settings.basePorts['c-lightning'].grpc,
@@ -124,6 +125,11 @@ const NetworkSetting: React.FC = () => {
                 <InputNumber />
               </Form.Item>
             </Col>
+            <Col span={6}>
+              <Form.Item name="bitcoind-knots" label={dockerConfigs['bitcoind-knots'].name}>
+                <InputNumber />
+              </Form.Item>
+            </Col>
             <Col span={6}>
               <Form.Item name="tapd" label={dockerConfigs.tapd.name}>
                 <InputNumber />

src/components/network/NewNetwork.tsx

@@ -55,6 +55,13 @@ const NewNetwork: React.FC = () => {
         throw new Error(l('tapdCountError'));
       }
 
+      const hasLightningNodes =
+        values.lndNodes + values.clightningNodes + values.eclairNodes + values.litdNodes > 0;
+      const hasBitcoinBackend = values.bitcoindNodes + values.bitcoindKnotsNodes > 0;
+      if (hasLightningNodes && !hasBitcoinBackend) {
+        throw new Error(l('bitcoinBackendError'));
+      }
+
       await addNetwork(values);
     } catch (error: any) {
       notify({ message: l('createError'), error });

src/i18n/locales/en-US.json

@@ -549,6 +549,7 @@
   "cmps.network.NetworkSetting.saveSuccess": "Saved settings",
   "cmps.network.NetworkSetting.description": "Base Ports determine the starting port numbers that will be used for each node. When a network is started, Polar will use these values to detect the next open port on your machine to assign to the nodes. You usually do not need to change these unless you are running into port conflicts with other apps installed on your computer. If you change these values, try to maintain at decent size gap (roughly 100) between them to prevent them from overlapping as more nodes of each implementation are added to your networks.",
   "cmps.network.NewNetwork.tapdCountError": "The number of Taproot Assets nodes must be less than or equal to the number of LND nodes",
+  "cmps.network.NewNetwork.bitcoinBackendError": "Lightning nodes require at least one Bitcoin backend (Bitcoin Core or Bitcoin Knots)",
   "cmps.nodeImages.CommandVariables.header": "Command Variable Substitutions",
   "cmps.nodeImages.CommandVariables.tableTitle": "Wrap the variables below in double braces to use them in the command",
   "cmps.nodeImages.CommandVariables.variable": "Variable",

src/store/models/network.spec.ts

@@ -211,6 +211,19 @@ describe('Network model', () => {
       expect(node.docker.image).toBe(custom[0].dockerImage);
       expect(node.docker.command).toBe(custom[0].command);
     });
+
+    it('should add a network with bitcoind-knots nodes', async () => {
+      await store.getActions().network.addNetwork({
+        ...addNetworkArgs,
+        bitcoindNodes: 0,
+        bitcoindKnotsNodes: 2,
+      });
+      const { bitcoin } = firstNetwork().nodes;
+      expect(bitcoin).toHaveLength(2);
+      bitcoin.forEach(node => {
+        expect(node.implementation).toBe('bitcoind-knots');
+      });
+    });
   });
 
   describe('Adding a Node', () => {
@@ -376,6 +389,21 @@ describe('Network model', () => {
       const { lightning } = firstNetwork().nodes;
       expect(lightning[5].docker.command).toBe('test-command');
     });
+
+    it('should add a bitcoind-knots node to an existing network', async () => {
+      const knotsLatest = defaultRepoState.images['bitcoind-knots'].latest;
+      const payload = {
+        id: firstNetwork().id,
+        type: 'bitcoind-knots',
+        version: knotsLatest,
+      };
+      await store.getActions().network.addNode(payload);
+      const { bitcoin } = firstNetwork().nodes;
+      expect(bitcoin).toHaveLength(2);
+      expect(bitcoin[1].name).toBe('backend2');
+      expect(bitcoin[1].implementation).toBe('bitcoind-knots');
+      expect(bitcoin[1].version).toBe(knotsLatest);
+    });
   });
 
   describe('Removing a Node', () => {

src/utils/network.spec.ts

@@ -13,6 +13,7 @@ import {
 import { Network } from 'types';
 import { defaultRepoState } from './constants';
 import {
+  createBitcoindKnotsNetworkNode,
   createBitcoindNetworkNode,
   createCLightningNetworkNode,
   createLitdNetworkNode,
@@ -379,6 +380,141 @@ describe('Network Utils', () => {
     });
   });
 
+  describe('createBitcoindKnotsNetworkNode', () => {
+    let network: Network;
+
+    beforeEach(() => {
+      network = createNetwork({
+        id: 1,
+        name: 'my-test',
+        description: 'my-test-description',
+        lndNodes: 0,
+        clightningNodes: 0,
+        eclairNodes: 0,
+        bitcoindNodes: 1,
+        bitcoindKnotsNodes: 0,
+        tapdNodes: 0,
+        litdNodes: 0,
+        status: Status.Stopped,
+        repoState: defaultRepoState,
+        managedImages: testManagedImages,
+        customImages: [],
+        manualMineCount: 6,
+      });
+    });
+
+    it('should create a bitcoind-knots node with correct properties', () => {
+      const node = createBitcoindKnotsNetworkNode(
+        network,
+        defaultRepoState.images['bitcoind-knots'].latest,
+        testNodeDocker,
+      );
+      expect(node.name).toBe('backend2');
+      expect(node.type).toBe('bitcoin');
+      expect(node.implementation).toBe('bitcoind-knots');
+      expect(node.version).toBe(defaultRepoState.images['bitcoind-knots'].latest);
+      expect(node.status).toBe(Status.Stopped);
+      expect(node.ports.rpc).toBeDefined();
+      expect(node.ports.p2p).toBeDefined();
+      expect(node.ports.zmqBlock).toBeDefined();
+      expect(node.ports.zmqTx).toBeDefined();
+    });
+
+    it('should peer with existing bitcoin nodes', () => {
+      const node = createBitcoindKnotsNetworkNode(
+        network,
+        defaultRepoState.images['bitcoind-knots'].latest,
+        testNodeDocker,
+      );
+      network.nodes.bitcoin.push(node);
+      expect(node.peers).toContain('backend1');
+      expect(network.nodes.bitcoin[0].peers).toContain('backend2');
+    });
+
+    it('should have no peers when it is the first bitcoin node', () => {
+      network.nodes.bitcoin = [];
+      const node = createBitcoindKnotsNetworkNode(
+        network,
+        defaultRepoState.images['bitcoind-knots'].latest,
+        testNodeDocker,
+      );
+      expect(node.peers).toHaveLength(0);
+    });
+  });
+
+  describe('createNetwork with bitcoind-knots', () => {
+    it('should create a network with bitcoind-knots nodes', () => {
+      const network = createNetwork({
+        id: 1,
+        name: 'knots-test',
+        description: 'test with knots',
+        lndNodes: 0,
+        clightningNodes: 0,
+        eclairNodes: 0,
+        bitcoindNodes: 0,
+        bitcoindKnotsNodes: 2,
+        tapdNodes: 0,
+        litdNodes: 0,
+        status: Status.Stopped,
+        repoState: defaultRepoState,
+        managedImages: testManagedImages,
+        customImages: [],
+        manualMineCount: 6,
+      });
+      expect(network.nodes.bitcoin).toHaveLength(2);
+      expect(network.nodes.bitcoin[0].implementation).toBe('bitcoind-knots');
+      expect(network.nodes.bitcoin[1].implementation).toBe('bitcoind-knots');
+    });
+
+    it('should create a network with mixed bitcoind and bitcoind-knots nodes', () => {
+      const network = createNetwork({
+        id: 1,
+        name: 'mixed-test',
+        description: 'test with mixed backends',
+        lndNodes: 0,
+        clightningNodes: 0,
+        eclairNodes: 0,
+        bitcoindNodes: 1,
+        bitcoindKnotsNodes: 1,
+        tapdNodes: 0,
+        litdNodes: 0,
+        status: Status.Stopped,
+        repoState: defaultRepoState,
+        managedImages: testManagedImages,
+        customImages: [],
+        manualMineCount: 6,
+      });
+      expect(network.nodes.bitcoin).toHaveLength(2);
+      expect(network.nodes.bitcoin[0].implementation).toBe('bitcoind');
+      expect(network.nodes.bitcoin[1].implementation).toBe('bitcoind-knots');
+      expect(network.nodes.bitcoin[1].peers).toContain('backend1');
+      expect(network.nodes.bitcoin[0].peers).toContain('backend2');
+    });
+
+    it('should adjust bitcoind-knots version for LND compatibility when target version is available', () => {
+      const network = createNetwork({
+        id: 1,
+        name: 'knots-lnd-test',
+        description: 'test knots with lnd',
+        lndNodes: 1,
+        clightningNodes: 0,
+        eclairNodes: 0,
+        bitcoindNodes: 0,
+        bitcoindKnotsNodes: 1,
+        tapdNodes: 0,
+        litdNodes: 0,
+        status: Status.Stopped,
+        repoState: defaultRepoState,
+        managedImages: testManagedImages,
+        customImages: [],
+        manualMineCount: 6,
+      });
+      expect(network.nodes.bitcoin).toHaveLength(1);
+      expect(network.nodes.bitcoin[0].implementation).toBe('bitcoind-knots');
+      expect(network.nodes.bitcoin[0].version).toBeDefined();
+    });
+  });
+
   describe('createNetworkNodes', () => {
     let network: Network;
 

src/utils/tests/helpers.ts

@@ -31,6 +31,11 @@ export const testManagedImages: ManagedImage[] = [
     version: defaultRepoState.images.bitcoind.latest,
     command: '',
   },
+  {
+    implementation: 'bitcoind-knots',
+    version: defaultRepoState.images['bitcoind-knots'].latest,
+    command: '',
+  },
   {
     implementation: 'tapd',
     version: defaultRepoState.images.tapd.latest,
@@ -191,8 +196,8 @@ export const testRepoState: DockerRepoState = {
       ],
     },
     'bitcoind-knots': {
-      latest: '29.0',
-      versions: ['29.0', '28.0', '27.0', '26.0'],
+      latest: '29.2',
+      versions: ['29.2', '28.0', '27.0', '26.0'],
     },
     btcd: {
       latest: '',