@@ -104,7 +104,8 @@ To run the simulator with random activity generation, you just need to
104104provide a set of nodes and the simulator will generate activity based
105105on the topology of the underlying graph. Note that payments will only
106106be sent between the ` nodes ` that are provided so that liquidity does
107- not "drain" from the simulation.
107+ not "drain" from the simulation. Every node specified will be eligible
108+ to send and receive payments when running with random activity.
108109
109110```
110111{
@@ -348,6 +349,27 @@ Note that you need to provide forwarding policies in each direction,
348349because each participant in the channel sets their own forwarding
349350policy and restrictions on their counterparty.
350351
352+
353+ ### Random Activity Exclusions
354+
355+ When running with random activity (implied by the absence of ` activity ` ),
356+ every node listed in ` sim_network ` will be eligible to send and receive
357+ payments. If you'd like to specify nodes in ` sim_network ` that do not
358+ send/receive payments, you can include them in an ` exclude ` list:
359+
360+ ```
361+ {
362+ "sim_network": [ ... ],
363+ "exclude": [
364+ "020a30431ce58843eedf8051214dbfadb65b107cc598b8277f14bb9b33c9cd026f"
365+ ]
366+ }
367+ ```
368+
369+ This is required for the case where you want to specify a channel that
370+ will be used in the simulated network that is just responsible for
371+ forwarding payments, but does not send or receive any payments itself.
372+
351373### Inclusions and Limitations
352374
353375The simulator will execute payments on the mocked out network as it
0 commit comments