Feature: Simln integration in Polar

[Abdulkbk]

Closes #829

Replaces #1038

Description

This PR integrates SimLn into Polar.

As mentioned in the previous PR implementing such:

SimLN is a simulation tool that can be used to generate realistic payment activity on any lightning network topology. It is intentionally environment-agnostic so that it can be used across many environments - from integration tests to public signets.

Polar provides a set of node configurations and payment activities (such as amount and frequency) to SimLN, which facilitates ongoing payments between the nodes.

Steps to Test

1. Create a new network with 2 Lightning nodes. (LND, CLN, Eclair, or a mixture of 2)
2. Start the network.
3. Open a channel between the 2 nodes.
4. Click on the "Simulation Designer" tab.
5. Click the "Add a new Simulation" button.
6. Select the source and destination nodes in the modal that appears.
7. Click the "Create" button to add the simulation, and then Start.
8. View the Docker logs for payment activities between the nodes.

Screenshots

Build the simln Image

cd docker/simln

docker build -t polarlightning/simln:0.2.5 --build-arg SIMLN_VERSION=0.2.5 .

Some parts of the code were taken from PR.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (7a65b37) to head (ec07027).

Additional details and impacted files

@@            Coverage Diff             @@
##            master     #1159    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files          156       160     +4     
  Lines         5713      5980   +267     
  Branches      1144      1212    +68     
==========================================
+ Hits          5713      5980   +267     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Abdulkbk]

Tagging @kelvinator07 and @jamaljsr for reviews :)

[kelvinator07]

Well Done @Abdulkbk I'll test the feature within the next couple of days and give feedback.

[Abdulkbk]

cc: @kelvinator07 👀

[Abdulkbk]

The project is now complete, and all LN implementations are now supported 💯

[jamaljsr]

Thanks for updating the Dockerfile. Apologies for the delay in approving this. Everything looks good when testing on my arm64 Mac but I also want to test on Linux, Windows, and x64 before merging this. I tried to do this today but ran into some OS issues on my other machine which I hope to resolve over the weekend. Just wanted to give you that update.

I also pushed the multi-platform docker image to Docker Hub as polarlightning/simln. Doing this made me realize we need to update the docker/README.md to include instructions for building the image. Can you please add a new section underneath Lightning Terminal for simln?

[jamaljsr]

I tested this branch on Windows and ran into a problem. I still need to test on Linux.

[jamaljsr]

I've tested this on Windows and am running into an issue with the simln container. I'm getting this error.

The problem is the difference in the file path strings on Windows. Here's the generated sim.json file:

{
  "nodes": [
    {
      "id": "alice",
      "macaroon": "/home/simln/.C:\\Users\\jamal\\.polar\\networks\\1\\volumes\\lnd\\alice\\data\\chain\\bitcoin\\regtest\\admin.macaroon",
      "address": "https://host.docker.internal:10001",
      "cert": "/home/simln/.C:\\Users\\jamal\\.polar\\networks\\1\\volumes\\lnd\\alice\\tls.cert"
    },
    {
      "id": "bob",
      "base_url": "http://host.docker.internal:8282",
      "api_username": "",
      "api_password": "eclairpw"
    },
    {
      "id": "carol",
      "macaroon": "/home/simln/.C:\\Users\\jamal\\.polar\\networks\\1\\volumes\\lnd\\carol\\data\\chain\\bitcoin\\regtest\\admin.macaroon",
      "address": "https://host.docker.internal:10003",
      "cert": "/home/simln/.C:\\Users\\jamal\\.polar\\networks\\1\\volumes\\lnd\\carol\\tls.cert"
    }
  ],
  "activity": [
    {
      "source": "alice",
      "destination": "bob",
      "interval_secs": 10,
      "amount_msat": 100000000
    },
    {
      "source": "alice",
      "destination": "carol",
      "interval_secs": 10,
      "amount_msat": 100000000
    }
  ]
}

And here's the contents of the LightningNode object in the network:

          {
            "id": 0,
            "networkId": 1,
            "name": "alice",
            "type": "lightning",
            "implementation": "LND",
            "version": "0.19.2-beta",
            "status": 1,
            "backendName": "backend1",
            "paths": {
              "tlsCert": "C:\\Users\\jamal\\.polar\\networks\\1\\volumes\\lnd\\alice\\tls.cert",
              "adminMacaroon": "C:\\Users\\jamal\\.polar\\networks\\1\\volumes\\lnd\\alice\\data\\chain\\bitcoin\\regtest\\admin.macaroon",
              "invoiceMacaroon": "C:\\Users\\jamal\\.polar\\networks\\1\\volumes\\lnd\\alice\\data\\chain\\bitcoin\\regtest\\invoice.macaroon",
              "readonlyMacaroon": "C:\\Users\\jamal\\.polar\\networks\\1\\volumes\\lnd\\alice\\data\\chain\\bitcoin\\regtest\\readonly.macaroon"
            },
            "ports": {
              "rest": 8081,
              "grpc": 10001,
              "p2p": 9735
            },
            "docker": {
              "image": "",
              "command": ""
            }
          },

Are you able to resolve this? If you don't have access to a Windows machine, you should be able to use mock data in a unit test.

[Abdulkbk]

I will use the mock data in unit test. Thanks.

[Abdulkbk]

@jamaljsr, are you able to conclude the testing?

[jamaljsr]

Yes, I will test it again on Windows and Linux this week. Thanks for the updates.