Skip to content

Commit

Permalink
Updates readme to include node connection information
Browse files Browse the repository at this point in the history
  • Loading branch information
sr-gi committed Oct 26, 2023
1 parent 5c41224 commit 76c8ced
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,31 @@ sim-cli sim.json
The simulator requires access details for a set of `nodes` that you
have permission to execute commands on. Note that the current version
of the simulator uses keysend to execute payments, which must be
enabled in LND using `--accept-keysend`.
enabled in LND using `--accept-keysend` (for CLN node it is enabled by default).

The required access details will depend on the node implementation. For LND, the following
information is required:

```
{
"id": <node_id>,
"address": <ip_and_port_or_domain_and_port>,
"macaroon": <path_to_selected_macaroon>,
"cert": <path_to_tls_cert>
}
```

Whereas for CLN nodes, the following information is required:

```
{
"id": <node_id>,
"address": <ip_and_port_or_domain_and_port>,
"ca_cert": <path_to_ca_cert>,
"client_cert": <path_to_client_cert>,
"client_key": <path_to_client_key>
}
```

Payment activity can be simulated in two different ways:
* Random activity: generate random activity on the `nodes` provided,
Expand Down

0 comments on commit 76c8ced

Please sign in to comment.