Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/sim ln integration #1038

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

kelvinator07
Copy link
Contributor

@kelvinator07 kelvinator07 commented Oct 29, 2024

Closes #829

Replaces #868

Description

This PR implements SimLN into Polar.

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.

To ensure successful payments, there must be an existing channel established between the nodes.

Steps to Test

  1. Create a new network with 2 LND nodes (Currently supports only LND while CLN is WIP)
  2. Start the network
  3. Open a channel between the 2 LND nodes
  4. Click on the Activity Designer menu
  5. Click on the Arrow beside Add Activities
  6. Select Source and Destination nodes
  7. Click on the START button
  8. View docker logs for payment activities between nodes

Screenshots

Screenshot 2024-10-30 at 22 19 54 Screenshot 2024-10-30 at 22 47 23 Screenshot 2024-10-30 at 22 25 27

@kelvinator07 kelvinator07 force-pushed the feat/sim-ln-integration branch from 265dd92 to 26c7a93 Compare October 29, 2024 21:28
@kelvinator07
Copy link
Contributor Author

@Abdulkbk FYI

@jamaljsr
Copy link
Owner

jamaljsr commented Nov 4, 2024

@kelvinator07 Thanks for working on this. I've played with it a bit and just have a little feedback so far on the UX considering the full functionality is not completed yet.

  1. The flow of having to hit the arrow to show the "Add Activity" form isn't intuitive in my opinion. That should stand out a bit more, maybe by using a plus icon. Instead of having the form displayed in the sidebar, I would suggest opening a modal to add/edit an activity. The existing litd LNC Sessions UX comes to mind.
    image
  2. The Start button design isn't consistent with all of the other buttons throughout that app. This should use the primary button look and feel. Also, remember to check the UI in light mode.
    image
  3. I was able to add an activity while simln was already running. It didn't update the currently running activities. Should we prevent users from doing this?
  4. When stopping the whole network, the simln container doesn't stop gracefully. Docker has to kill it after the 30sec timeout. Is there a way to fix this so users don't have to wait 30secs every time they stop the network?
  5. This is minor but I don't think the tab label "Activity Designer" matches what this section actually does. I'd call it "Simulations".

I'm sure I'll have more feedback as this PR progresses but that's what stood out to me on my first pass.

@kelvinator07
Copy link
Contributor Author

@jamaljsr Thanks for your feedback. I'll update and revert.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: proposed integration of sim-ln in polar
2 participants