Skip to content

Commit 6528aee

Browse files
committed
Adding documentation for start_secs and count activity fields.
1 parent fb4e47b commit 6528aee

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,12 +141,31 @@ to execute. Note that `source` nodes *must* be contained in `nodes`,
141141
but destination nodes can be any public node in the network (though
142142
this may result in liquidity draining over time).
143143

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+
144162
The example simulation file below sets up the following simulation:
145163
* Connect to `Alice` running LND to generate activity.
146164
* Connect to `Bob` running CLN to generate activity.
147165
* Dispatch 2000 msat payments from `Alice` to `Carol` every 1 seconds.
148166
* Dispatch 140000 msat payments from `Bob` to `Alice` every 50 seconds.
149167
* 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.
150169
```
151170
{
152171
"nodes": [
@@ -162,6 +181,18 @@ The example simulation file below sets up the following simulation:
162181
"ca_cert": "/path/ca.pem",
163182
"client_cert": "/path/client.pem",
164183
"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"
165196
}
166197
],
167198
"activity": [
@@ -182,6 +213,14 @@ The example simulation file below sets up the following simulation:
182213
"destination": "03232e245059a2e7f6e32d6c4bca97fc4cda935c553ea3693adb3265a19050c3bf",
183214
"interval_secs": 2,
184215
"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
185224
}
186225
]
187226
}

0 commit comments

Comments
 (0)