feat: add simln support to CLN

Author: Abdulkbk

src/components/designer/default/AddSimulationModal.tsx

@@ -113,7 +113,7 @@ const AddSimulationModal: React.FC<Props> = ({ network }) => {
               name="source"
               label={l('source')}
               nodeStatus={Status.Started}
-              implementation={['LND', 'eclair']}
+              implementation={['LND', 'eclair', 'c-lightning']}
               nodes={nodes}
             />
           </Col>
@@ -123,7 +123,7 @@ const AddSimulationModal: React.FC<Props> = ({ network }) => {
               name="destination"
               label={l('destination')}
               nodeStatus={Status.Started}
-              implementation={['LND', 'eclair']}
+              implementation={['LND', 'eclair', 'c-lightning']}
               nodes={nodes}
             />
           </Col>

src/lib/docker/dockerService.spec.ts

@@ -885,7 +885,7 @@ describe('DockerService', () => {
       name: 'my network',
       description: 'network description',
       lndNodes: 1,
-      clightningNodes: 0,
+      clightningNodes: 1,
       eclairNodes: 1,
       bitcoindNodes: 1,
       tapdNodes: 0,
@@ -899,6 +899,9 @@ describe('DockerService', () => {
     const eclairNodes = network.nodes.lightning.filter(
       n => n.implementation === 'eclair',
     );
+    const clightningNodes = network.nodes.lightning.filter(
+      n => n.implementation === 'c-lightning',
+    );
     beforeEach(() => {
       // Add simulation config to the test network
       network.simulation = {
@@ -964,9 +967,9 @@ describe('DockerService', () => {
     });
 
     it('should handle errors when using unsupported node types', async () => {
-      network.nodes.lightning[0].implementation = 'c-lightning';
+      network.nodes.lightning[0].implementation = 'litd';
       await expect(dockerService.startSimulation(network)).rejects.toThrow(
-        'unsupported node implementation: c-lightning',
+        'unsupported node implementation: litd',
       );
     });
 
@@ -995,5 +998,44 @@ describe('DockerService', () => {
         expect.stringContaining(`container_name: polar-n1-simln`),
       );
     });
+
+    // Now we should be able to use c-lightning in the simulation
+    it('should add c-lightning to the docker-compose.yml file', async () => {
+      network.simulation = {
+        activity: [
+          {
+            id: 0,
+            source: clightningNodes[0].name,
+            destination: eclairNodes[0].name,
+            intervalSecs: 60,
+            amountMsat: 1000,
+          },
+        ],
+        status: Status.Stopped,
+      };
+      dockerService.saveComposeFile(network);
+      expect(filesMock.write).toHaveBeenCalledWith(
+        expect.stringContaining('docker-compose.yml'),
+        expect.stringContaining(`container_name: polar-n1-simln`),
+      );
+
+      composeMock.upOne.mockResolvedValue(mockResult);
+      await dockerService.startSimulation(network);
+
+      // Verify directories were created
+      expect(fsMock.ensureDir).toHaveBeenCalled();
+
+      // Verify sim.json was written with correct config
+      expect(filesMock.write).toHaveBeenCalledWith(
+        expect.stringContaining('sim.json'),
+        expect.stringContaining(clightningNodes[0].name),
+      );
+
+      // Verify docker compose command was called
+      expect(composeMock.upOne).toHaveBeenCalledWith(
+        'simln',
+        expect.objectContaining({ cwd: network.path }),
+      );
+    });
   });
 });

src/lib/docker/dockerService.ts

@@ -455,6 +455,21 @@ class DockerService implements DockerLibrary {
             };
             break;
 
+          case 'c-lightning':
+            const cln = node as CLightningNode;
+            simNode = {
+              id: cln.name,
+              address: `host.docker.internal:${cln.ports.grpc}`,
+              ca_cert: `/home/simln/.${cln.paths.tlsCert?.split('volumes/').pop()}`,
+              client_cert: `/home/simln/.${cln.paths.tlsClientCert
+                ?.split('volumes/')
+                .pop()}`,
+              client_key: `/home/simln/.${cln.paths.tlsClientKey
+                ?.split('volumes/')
+                .pop()}`,
+            };
+            break;
+
           default:
             throw new Error(`unsupported node implementation: ${node.implementation}`);
         }

src/lib/docker/nodeTemplates.ts

@@ -198,6 +198,7 @@ export const simln = (
   volumes: [
     `./volumes/${name}:/home/simln/.simln`,
     `./volumes/${dockerConfigs.LND.volumeDirName}:/home/simln/.lnd`,
+    `./volumes/${dockerConfigs['c-lightning'].volumeDirName}:/home/simln/.c-lightning`,
   ],
   expose: [],
   ports: [],

src/utils/constants.ts

@@ -193,6 +193,8 @@ export const dockerConfigs: Record<NodeImplementationWithSimln, DockerConfig> =
       '--channel.max-htlc-value-in-flight-percent=100',
       '--channel.max-htlc-value-in-flight-msat=5000000000000', // 50 BTC in msats
       '--features.keysend=optional',
+      '--channel.min-final-expiry-delta-blocks=22', // Default is 30 for eclair, however it is 22 for CLN (the lowest).
+      '--channel.fulfill-safety-before-timeout-blocks=20', // When `channel.min-final-expiry-delta-blocks` is set, this is required and most be less than it. Default is 24.
     ].join('\n  '),
     // if vars are modified, also update composeFile.ts & the i18n strings for cmps.nodes.CommandVariables
     variables: ['name', 'eclairPass', 'backendName', 'rpcUser', 'rpcPass'],