Skip to content

Commit 8ad307b

Browse files
committed
Updates readme to include node connection information
1 parent 14087f5 commit 8ad307b

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,33 @@ sim-cli sim.json
5050
The simulator requires access details for a set of `nodes` that you
5151
have permission to execute commands on. Note that the current version
5252
of the simulator uses keysend to execute payments, which must be
53-
enabled in LND using `--accept-keysend`.
53+
enabled in LND using `--accept-keysend` (for CLN node it is enabled by default).
54+
55+
The required access details will depend on the node implementation. For LND, the following
56+
information is required:
57+
58+
```
59+
{
60+
"id": <node_id>,
61+
"address": https://<ip:port or domain:port>,
62+
"macaroon": <path_to_selected_macaroon>,
63+
"cert": <path_to_tls_cert>
64+
}
65+
```
66+
67+
Whereas for CLN nodes, the following information is required:
68+
69+
```
70+
{
71+
"id": <node_id>,
72+
"address": https://<ip:port or domain:port>,
73+
"ca_cert": <path_to_ca_cert>,
74+
"client_cert": <path_to_client_cert>,
75+
"client_key": <path_to_client_key>
76+
}
77+
```
78+
79+
**Note that node addresses must be declare with HTTPS transport, i.e. <https://ip-or-domain:port>**
5480

5581
Payment activity can be simulated in two different ways:
5682
* Random activity: generate random activity on the `nodes` provided,
@@ -86,8 +112,6 @@ not "drain" from the simulation.
86112
}
87113
```
88114

89-
**Note that node addresses must be declare with HTTPS transport, i.e. <https://ip-or-domain>**
90-
91115
Nodes can be identified by an arbitrary string ("Alice", "CLN1", etc) or
92116
by their node public key. If a valid public key is provided it *must*
93117
match the public key reported by the node.

0 commit comments

Comments
 (0)