-
Notifications
You must be signed in to change notification settings - Fork 2
/
workbench.sh
executable file
·381 lines (324 loc) · 15.3 KB
/
workbench.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
#!/usr/bin/env sh
## Startup script for docker container.
###############################################################################
# Environment
###############################################################################
DEFAULT_DOMAIN="regtest"
DENVPATH=".env" ## Path to your local .env file.
WORKPATH="$(pwd)" ## Absolute path to use for this directory.
LINE_OUT="/dev/null" ## Default output for noisy commands.
ESC_KEYS="ctrl-z" ## Escape sequence for detaching from terminals.
HEADMODE="-i" ## Container connects to terminal by default.
SPAWN_DELAY=2 ## Delay (in seconds) to wait between spawning nodes.
DATAPATH="data" ## Default path for a node's interal storage.
SHAREPATH="share" ## Default path to publish connection info.
###############################################################################
# Usage
###############################################################################
usage() {
printf "
Usage: $(basename $0) [ OPTIONS ] TAG
Launch a docker container for bitcoin / lightning development.
Example: $(basename $0) build
$(basename $0) start master --miner
$(basename $0) start alice --faucet master
$(basename $0) start bob --faucet master --channels alice
Arguments:
TAG Tag name used to identify the container.
Build Options | Parameters | Description
-h, --help Display this help text and exit.
-b, --build Build a new dockerfile image, using existing cache.
-r, --rebuild Delete the existing cache, and build a new image from source.
-i, --devmode Start container in devmode (mounts ./run, does not start entrypoint).
-H, --headless Start container in headless mode (does not connect to terminal at start).
-w, --wipe Delete the existing data volume, and create a new volume.
-m, --miner Configure this as a mining node (generates blocks and clears mempool).
-m, --miner= POLL,INT,FUZZ Provide an optional configuration to the mining node.
-p, --peers TAG1,TAG2 List the peer nodes to connect to (for Bitcoin / Lightning nodes).
-c, --channels TAG1,TAG2 List the peer nodes to open channels with (for Lightning nodes).
-f, --faucet TAG Specify a node to use as a faucet (usually a mining node).
-d, --domain STRING Set the top-level domain name for the container (Default is $DEFAULT_NAME).
-r, --rest Enable the CL-REST interface for this node.
-t, --tor Enable the use of Tor and onion services for this node.
-l, --local When combined with --tor, forces local peering but allows hidden services.
-M, --mount INT:EXT Declare a path to mount within the container. Can be declared multiple times.
-P, --ports PORT1,PORT2 List a comma-separated string of ports to open within the container.
-T, --passthru STRING Pass through an argument string to the docker run script.
-v, --verbose Outputs more information into the terminal (useful for debugging).
Spawn Options:
NOTE: Spawn is only compatible with the flags below. All flags must precede 'spawn' keyword.
spawn STRING Spawn multiple nodes at once, using optional STRING to specify the name of
a .conf file in the ./spawn folder. Default file used is 'spawn.conf'.
--no-kill If a node in the spawn config is already running, don't kill it.
Other Options:
Utility commands for managing images and nodes.
build Compiles any missing binary files and builds the image.
rebuild Removes the existing image cache and builds from scratch.
login TAG Login to an existing node that is currently running.
Example Commands:
$(basename $0) compile Example command for pre-compiling all binaries in build/dockerfiles.
$(basename $0) login alice Example command for logging into the terminal for alice.
$(basename $0) spawn regswarm Example command for spawning nodes with 'regswarm' domain and default spawn.conf file.
Example Flags:
--mine=poll,int,fuzz Configure your mining node to poll every x seconds for transactions,
(e.x --mine=2,60,20) or mine blocks continuously at an interval (or both!). If you are running
multiple mining nodes, set the fuzz value to add random variation to each
block, or you may get chain splits! All params are denominated in seconds,
setting to zero disables that feature.
--mount app:/root/app Declares a path to be mounted within the container. Paths can be relative
or absolute.
--ports 9737,80:8080 Declare a list of ports to be forwarded from within the container. You can
also specify a different internal:external destination for each port.
For more information, or if you want to report any bugs / issues,
please visit the github page: https://github.com:cmdruid/regtest-workbench
\n"
}
###############################################################################
# Methods
###############################################################################
chk_arg() {
## Check if argument is passed a value, or another argument.
( [ -z "$1" ] || [ -n "$(echo $1 | grep -E '^-')" ] ) \
&& echo "Bad value! Received an argument instead: $1" && exit 1 \
|| return 0
}
add_arg() {
## Construct a string of arguments.
chk_arg $1 && ARGS_STR="$ARGS_STR -e $1"
}
add_mount() {
## Build a parameter string for mounting a volume.
if chk_arg $1; then
src=`printf $1 | awk -F ':' '{ print $1 }'`
dest=`printf $1 | awk -F ':' '{ print $2 }'`
if [ -z "$(echo $1 | grep -E '^/')" ]; then prefix="$WORKPATH/"; fi
MOUNTS="$MOUNTS --mount type=bind,source=$prefix$src,target=$dest"
fi
}
add_ports() {
## Build a parameter string for forwarding ports.
if chk_arg $1; then for port in `echo $1 | tr ',' ' '`; do
src=`printf $port | awk -F ':' '{ print $1 }'`
dest=`printf $port | awk -F ':' '{ print $2 }'`
if [ -z "$dest" ]; then dest="$src"; fi
PORTS="$PORTS -p $src:$dest"
done; fi
}
add_list() {
## Build a paramater string for specifying peers.
[ -z "$1" ] || [ -z "$2" ] && return
## Create a list of peers from entries in the existing sharepath.
[ "$2" = "all" ] \
&& add_arg "$1=$(find $SHAREPATH -mindepth 1 -maxdepth 1 -type d -printf '%f,')" \
&& return
add_arg "$1=$2" && return
}
read_env() {
## Read a key=value store and convert into a string.
[ -n "$1" ] && \
while read line || [ -n "$line" ]; do
if ! printf %s "$line" | egrep -q '^ *#'; then printf %s "-e ${line} "; fi
done < "$1"
}
image_exists() {
[ -n "$1" ] && docker image ls | grep $1 > $LINE_OUT 2>&1
}
container_exists() {
docker container ls -a | grep $SRV_NAME > $LINE_OUT 2>&1
}
volume_exists() {
docker volume ls | grep $DAT_NAME > $LINE_OUT 2>&1
}
network_exists() {
docker network ls | grep $NET_NAME > $LINE_OUT 2>&1
}
check_binaries() {
## Check if a binary already exists for each available build dockerfile.
if [ ! -d "build/out" ]; then mkdir -p build/out; fi
for file in build/dockerfiles/*; do
name="$(basename -s .dockerfile $file)"
if [ -z "$(ls build/out | grep $name)" ]; then
printf "Binary for $name is missing! Building from source ..."
BUILDPATH=$WORKPATH/build build/build.sh $file
fi
done
[ -n "$EXT" ] && echo "All binary files are compiled and ready!"
}
remove_image() {
## Remove an existing docker image.
[ -n "$IMG_NAME" ] \
|| ( [ -n "$1" ] && IMG_NAME="$1" ) \
|| IMG_NAME="$DEFAULT_DOMAIN-img"
printf "Removing existing image ... "
if [ -n "$VERBOSE" ]; then printf "\n"; fi
docker image rm $IMG_NAME > $LINE_OUT 2>&1
if image_exists $IMG_NAME; then printf "failed!\n" && exit 1; fi
printf "done.\n"
}
build_image() {
## Build a new docker image.
check_binaries
[ -n "$1" ] && IMG_NAME="$1"
[ -z "$IMG_NAME" ] && IMG_NAME="$DEFAULT_DOMAIN-img"
printf "Building image for $IMG_NAME from dockerfile ... "
if [ -n "$VERBOSE" ]; then printf "\n"; fi
DOCKER_BUILDKIT=1 docker build --tag $IMG_NAME . > $LINE_OUT 2>&1
if ! image_exists $IMG_NAME; then printf "failed!\n" && exit 1; fi
printf "done.\n"
}
create_network() {
## Create a new network interface.
printf "Creating network $NET_NAME ... "
if [ -n "$VERBOSE" ]; then printf "\n"; fi
docker network create $NET_NAME > $LINE_OUT 2>&1;
if ! network_exists; then printf "failed!\n" && exit 1; fi
printf "done.\n"
}
get_container_id() {
## Get the identifier of a tagged container.
[ -z "$1" ] && echo "You provided an empty search tag!" && exit 1
docker container ls | grep $1 | awk '{ print $1 }' | head -n 2 | tail -n 1
}
login_container() {
## Login to existing running container.
cid=`get_container_id $1`
[ -z "$cid" ] && echo "That node does not exist!" && exit 3
docker exec -it --detach-keys $ESC_KEYS $cid terminal
}
stop_container() {
## Stop, kill and remove a currently running container.
if container_exists; then
printf "Purging existing container ... "
if [ -n "$VERBOSE" ]; then printf "\n"; fi
docker container stop $SRV_NAME > $LINE_OUT 2>&1
docker container rm $SRV_NAME > $LINE_OUT 2>&1
# if container_exists; then printf "failed!\n" && exit 1; fi
printf "done.\n"
fi
}
spawn_nodes() {
## Set defaults.
[ -z "$DOMAIN" ] && DOMAIN="$DEFAULT_DOMAIN"
[ -n "$1" ] && conf="$WORKPATH/spawn/$1.conf" || conf="$WORKPATH/spawn/spawn.conf"
## Check spawn config file exists.
[ ! -e "$conf" ] && echo "Spawn config file not found!" && exit
## Run the spawn loop.
build_image "$DOMAIN-img"
printf "Spawning $DOMAIN network:\n"
cat $conf | while read line; do
[ -n "$(echo $line | grep -E '^ *#')" ] && continue ## Ignore commented lines.
printf "Starting node: $line\n"
NOKILL=$NOKILL ./workbench.sh $line --domain $DOMAIN --headless
done
}
wipe_data() {
## Remove existing persistent data volume for container.
printf "Purging existing data volume ... "
if [ -n "$VERBOSE" ]; then printf "\n"; fi
docker volume rm $DAT_NAME > $LINE_OUT 2>&1
if volume_exists; then printf "failed!\n" && exit 1; fi
printf "done.\n"
}
cleanup() {
## Exit codes are complicated.
status="$?"
[ -n "$HEADLESS" ] || [ "$status" -eq 10 ] && exit
( [ $status -eq 11 ] || [ $status -eq 1 ] ) && echo "You are now logged out. Node running in the background." && exit
stop_container && echo "Exiting workbench with status: $status" && exit
}
###############################################################################
# Main
###############################################################################
main() {
[ -n "$VERBOSE" ] && echo \
"Configuration string: $HEADMODE $RUN_FLAGS $MOUNTS $PORTS $ENV_STR $ARGS_STR $PASSTHRU\n"
## Start container script.
docker run -t \
--name $SRV_NAME \
--hostname $SRV_NAME \
--network $NET_NAME \
--mount type=bind,source=$WORKPATH/$SHAREPATH,target=/$SHAREPATH \
--mount type=volume,source=$DAT_NAME,target=/$DATAPATH \
-e DATAPATH="/$DATAPATH" -e SHAREPATH="/$SHAREPATH" -e ESC_KEYS="$ESC_KEYS" \
$HEADMODE $RUN_FLAGS $MOUNTS $PORTS $ENV_STR $ARGS_STR $PASSTHRU $IMG_NAME:latest
}
###############################################################################
# Script
###############################################################################
set -E && trap cleanup EXIT
## Parse arguments.
for arg in "$@"; do
case $arg in
build) build_image $2; exit 10;;
rebuild) remove_image $2; build_image $2; exit 10;;
login) login_container $2; exit 11;;
start) TAG=$2 shift 2;;
spawn) spawn_nodes $2; exit ;;
-h|--help) usage; exit ;;
-b|--build) BUILD=1; shift ;;
-r|--rebuild) REBUILD=1; shift ;;
-w|--wipe) WIPE=1; shift ;;
-d|--devmode) DEVMODE=1; shift ;;
-v|--verbose) VERBOSE=1; LINE_OUT="/dev/tty"; shift ;;
-H|--headless) HEADLESS=1; HEADMODE=""; shift ;;
-T|--passthru) PASSTHRU=$2; shift 2;;
-D|--domain) DOMAIN=$2; shift 2;;
-i|--image) IMG_NAME=$2; shift 2;;
-M|--mount) add_mount $2; shift 2;;
-P|--ports) add_ports $2; shift 2;;
-p|--peers) add_list "PEER_LIST" $2; shift 2;;
-c|--channels) add_list "CHAN_LIST" $2; shift 2;;
-f|--faucet) add_arg "USE_FAUCET=$2"; shift 2;;
-m|--miner) add_arg "MINE_NODE=DEFAULT"; shift ;;
-m=*|--miner=*) add_arg "MINE_NODE=${arg#*=}"; shift ;;
-r|--rest) add_arg "REST_NODE=1"; shift ;;
-t|--tor) add_arg "TOR_NODE=1"; shift ;;
-l|--local) add_arg "LOCAL_ONLY=1"; shift ;;
--spawn-conf) SPAWN_CONF=$2; shift 2;;
--no-kill) NOKILL=1; shift ;;
esac
done
## If no name argument provied, display help and exit.
[ -z "$TAG" ] && [ -z "$1" ] && usage && exit
[ -z "$TAG" ] && [ -n "$1" ] && TAG=$1
## Set default variables and flags.
[ -z "$DOMAIN" ] && DOMAIN="$DEFAULT_DOMAIN"
[ -z "$IMG_NAME" ] && IMG_NAME="$DOMAIN-img"
[ -e "$ENV_PATH" ] && ENV_STR=`read_env $ENV_PATH`
## Define naming scheme.
NET_NAME="$DOMAIN-net"
SRV_NAME="$TAG.$DOMAIN.node"
DAT_NAME="$TAG.$DOMAIN.data"
## Make sure sharepath is created.
echo $WORKPATH > /dev/null ## Silly work-around for a silly bug.
if [ ! -d "$WORKPATH/$SHAREPATH" ]; then mkdir -p "$WORKPATH/$SHAREPATH"; fi
## If there's an existing container, remove it.
if container_exists && [ -n "$NOKILL" ]; then
echo "Container already running for $SRV_NAME, aborting!" && exit 0
else stop_container; fi
## If rebuild is declared, remove existing image.
if image_exists $IMG_NAME && [ -n "$REBUILD" ]; then remove_image; fi
## If no existing image is present, build it.
if ! image_exists $IMG_NAME || [ -n "$BUILD" ]; then build_image; fi
## If no existing network exists, create it.
if ! network_exists; then create_network; fi
## Purge data volume if flagged for removal.
[ -n "$WIPE" ] && volume_exists && wipe_data
## Set flags and run mode of container.
if [ -n "$DEVMODE" ] && [ -z "$HEADLESS" ]; then
DEV_MOUNT="type=bind,source=$WORKPATH/run,target=/root/run"
RUN_MODE="development"
RUN_FLAGS="--rm --entrypoint bash --mount $DEV_MOUNT -e DEVMODE=1"
else
RUN_MODE="safe"
RUN_FLAGS="--init --detach --restart on-failure:2"
fi
## Call main container script based on run mode.
echo "Starting container for $SRV_NAME in $RUN_MODE mode ..."
if [ -n "$HEADLESS" ]; then
main && sleep $SPAWN_DELAY
elif [ -n "$DEVMODE" ]; then
echo "Enter the command 'node-start' to begin the node startup script:" && main
else
cid=`main` && docker attach --detach-keys $ESC_KEYS $cid && exit 11
fi