Skip to content

Commit 690c4b1

Browse files
committed
sim-ln/docs: Update README for activity alias usage
1 parent 9f3a4f2 commit 690c4b1

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -248,10 +248,11 @@ The example simulation file below sets up the following simulation:
248248
```
249249

250250

251-
Nodes can be identified by their public key or an id string (as
252-
described above). Activity sources and destinations may reference the
253-
`id` defined in `nodes`, but destinations that are not listed in `nodes`
254-
*must* provide a valid public key.
251+
Activity sources must reference an `id` defined in `nodes`, because the simulator can
252+
only send payments from nodes that it controls. Destinations may reference either an
253+
`id` defined in `nodes` or provide a pubkey or alias of a node in the public network.
254+
If the alias provided is not unique in the public network, a pubkey must be used
255+
to identify the node.
255256

256257
### Simulation Output
257258

0 commit comments

Comments
 (0)