Skip to content

Commit 19f7162

Browse files
author
Ifeanyichukwu
committed
chore: cleanup and document activity_name optional field properly
1 parent 1f29207 commit 19f7162

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ but destination nodes can be any public node in the network (though
153153
this may result in liquidity draining over time).
154154

155155
Required fields:
156+
156157
```
157158
"source": the payer
158159
"destination": the payee
@@ -161,22 +162,27 @@ Required fields:
161162
```
162163

163164
Optional fields:
165+
164166
```
165167
"start_secs": the time to start sending payments
166168
"count": the total number of payments to send
169+
"activity_name": an optional name for each activity description, used as the logging prefix to relate logs to their corresponding activity
167170
```
168171

169172
> If `start_secs` is not provided the payments will begin as soon as the simulation starts (default=0)
170173
171174
> If `count` is not provided the payments will continue for as long as the simulation runs (default=None)
172175
176+
> If `activity_name` is not provided the index of each activity description will be used as the logging prefix
177+
173178
The example simulation file below sets up the following simulation:
174-
* Connect to `Alice` running LND to generate activity.
175-
* Connect to `Bob` running CLN to generate activity.
176-
* Dispatch 2000 msat payments from `Alice` to `Carol` every 1 seconds.
177-
* Dispatch 140000 msat payments from `Bob` to `Alice` every 50 seconds.
178-
* Dispatch 1000 msat payments from `Bob` to `Dave` every 2 seconds.
179-
* Dispatch 10 payments (5000 msat each) from `Erin` to `Frank` at 2 second intervals, starting 20 seconds into the sim.
179+
180+
- Connect to `Alice` running LND to generate activity.
181+
- Connect to `Bob` running CLN to generate activity.
182+
- Dispatch 2000 msat payments from `Alice` to `Carol` every 1 seconds.
183+
- Dispatch 140000 msat payments from `Bob` to `Alice` every 50 seconds.
184+
- Dispatch 1000 msat payments from `Bob` to `Dave` every 2 seconds.
185+
- Dispatch 10 payments (5000 msat each) from `Erin` to `Frank` at 2 second intervals, starting 20 seconds into the sim.
180186

181187
```
182188
{
@@ -198,13 +204,13 @@ The example simulation file below sets up the following simulation:
198204
"id": "Erin",
199205
"address": "https://localhost:10012",
200206
"macaroon": "/path/admin.macaroon",
201-
"cert": "/path/tls.cert"
207+
"cert": "/path/tls.cert"
202208
},
203209
{
204210
"id": "Frank",
205211
"address": "https://localhost:10014",
206212
"macaroon": "/path/admin.macaroon",
207-
"cert": "/path/tls.cert"
213+
"cert": "/path/tls.cert"
208214
}
209215
],
210216
"activity": [

0 commit comments

Comments
 (0)