Skip to content

Commit

Permalink
Clean up README
Browse files Browse the repository at this point in the history
  • Loading branch information
cndolo committed Jun 28, 2023
1 parent 0cd56a8 commit 65f30ee
Show file tree
Hide file tree
Showing 12 changed files with 13 additions and 36 deletions.
49 changes: 13 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# lightning-simulator

![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
[![CI](https://github.com/open-anonymous-science/lightning-simulator/actions/workflows/test.yml/badge.svg)](https://github.com/open-anonymous-science/lightning-simulator/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/open-anonymous-science/lightning-simulator/branch/main/graph/badge.svg?token=QZH345MHCJ)](https://codecov.io/gh/open-anonymous-science/lightning-simulator)
[![dependency status](https://deps.rs/repo/github/open-anonymous-science/lightning-simulator/status.svg)](https://deps.rs/repo/github/open-anonymous-science/lightning-simulator)
[![CI](https://github.com/cndolo/lightning-simulator/actions/workflows/test.yml/badge.svg)](https://github.com/cndolo/lightning-simulator/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/cndolo/lightning-simulator/branch/main/graph/badge.svg?token=QZH345MHCJ)](https://codecov.io/gh/cndolo/lightning-simulator)
[![dependency status](https://deps.rs/repo/github/cndolo/lightning-simulator/status.svg)](https://deps.rs/repo/github/cndolo/lightning-simulator)

This is a collection of projects related to simulating payments in the Lightning
network.
Expand All @@ -23,8 +23,15 @@ or [lnresearch](https://github.com/lnresearch/topology).

## simulator

A binary that uses the `network-parser` to read the JSON files and simulate
A library and binary that use the `network-parser` to read the JSON files and simulate
payments in the LN.
The library implements routing and payment splitting logic and can be used as
follows.

```
lightning-simulator = {git = "https://github.com/cndolo/lightning-simulator"}
use simlib::*;
```

## Build

Expand All @@ -34,35 +41,5 @@ Build all members of the project:

## Simulation results

Here are the results of a series of simulations conducted on a snapshot of the
network on 2023-05-16.

<details open>
<summary><b>Performance</b></summary>

![](plots/success_rate.png)

![](plots/transaction_fees.png)

![](plots/path_length.png)

![](plots/htlc_attempts.png)

![](plots/failed_path_length.png)

![](plots/splits.png)

</details>

<details open>
<summary><b>Privacy</b></summary>

![](plots/observation_rate.png)

![](plots/predecessor_guesses.png)

![](plots/vulnerable_successful_payments.png)

![](plots/path_diversity.png)

</details>
We maintain interactive charts with simulation results at
[https://anonymous.4open.science/w/lightning-simulator-13A7/](https://anonymous.4open.science/w/lightning-simulator-13A7/).
Binary file removed plots/failed_path_length.png
Binary file not shown.
Binary file removed plots/htlc_attempts.png
Binary file not shown.
Binary file removed plots/observation_rate.png
Binary file not shown.
Binary file removed plots/path_diversity.png
Binary file not shown.
Binary file removed plots/path_length.png
Binary file not shown.
Binary file removed plots/predecessor_guesses.png
Binary file not shown.
Binary file removed plots/splits.png
Binary file not shown.
Binary file removed plots/success_rate.png
Binary file not shown.
Binary file removed plots/transaction_fees.png
Binary file not shown.
Binary file removed plots/vulnerable_payments.png
Binary file not shown.
Binary file removed plots/vulnerable_successful_payments.png
Binary file not shown.

0 comments on commit 65f30ee

Please sign in to comment.