@@ -141,12 +141,31 @@ to execute. Note that `source` nodes *must* be contained in `nodes`,
141
141
but destination nodes can be any public node in the network (though
142
142
this may result in liquidity draining over time).
143
143
144
+ Required fields:
145
+ ```
146
+ "source": the payer
147
+ "destination": the payee
148
+ "interval_secs": how often the payments should be sent
149
+ "amount_msat": the amount of each payment
150
+ ```
151
+
152
+ Optional fields:
153
+ ```
154
+ "start_secs": the time to start sending payments
155
+ "count": the total number of payments to send
156
+ ```
157
+
158
+ > If ` start_secs ` is not provided the payments will begin as soon as the simulation starts (default=0)
159
+
160
+ > If ` count ` is not provided the payments will continue for as long as the simulation runs (default=None)
161
+
144
162
The example simulation file below sets up the following simulation:
145
163
* Connect to ` Alice ` running LND to generate activity.
146
164
* Connect to ` Bob ` running CLN to generate activity.
147
165
* Dispatch 2000 msat payments from ` Alice ` to ` Carol ` every 1 seconds.
148
166
* Dispatch 140000 msat payments from ` Bob ` to ` Alice ` every 50 seconds.
149
167
* Dispatch 1000 msat payments from ` Bob ` to ` Dave ` every 2 seconds.
168
+ * Dispatch 10 payments (5000 msat each) from ` Erin ` to ` Frank ` at 2 second intervals, starting 20 seconds into the sim.
150
169
```
151
170
{
152
171
"nodes": [
@@ -162,6 +181,18 @@ The example simulation file below sets up the following simulation:
162
181
"ca_cert": "/path/ca.pem",
163
182
"client_cert": "/path/client.pem",
164
183
"client_key": "/path/client-key.pem"
184
+ },
185
+ {
186
+ "id": "Erin",
187
+ "address": "https://localhost:10012",
188
+ "macaroon": "/path/admin.macaroon",
189
+ "cert": "/path/tls.cert"
190
+ },
191
+ {
192
+ "id": "Frank",
193
+ "address": "https://localhost:10014",
194
+ "macaroon": "/path/admin.macaroon",
195
+ "cert": "/path/tls.cert"
165
196
}
166
197
],
167
198
"activity": [
@@ -182,6 +213,14 @@ The example simulation file below sets up the following simulation:
182
213
"destination": "03232e245059a2e7f6e32d6c4bca97fc4cda935c553ea3693adb3265a19050c3bf",
183
214
"interval_secs": 2,
184
215
"amount_msat": 1000
216
+ },
217
+ {
218
+ "source": "Erin",
219
+ "destination": "Frank",
220
+ "start_secs": 20,
221
+ "count": 10,
222
+ "interval_secs": 2,
223
+ "amount_msat": 5000
185
224
}
186
225
]
187
226
}
0 commit comments