Skip to content

Commit e9c8e6e

Browse files
committed
doc: add contrib/signet readme
1 parent 355d0c4 commit e9c8e6e

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

contrib/signet/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Contents
2+
========
3+
This directory contains tools related to Signet, both for running a Signet yourself and for using one.
4+
5+
getcoins.py
6+
===========
7+
8+
A script to call a faucet to get Signet coins.
9+
10+
Syntax: `getcoins.py [-h|--help] [-c|--cmd=<bitcoin-cli path>] [-f|--faucet=<faucet URL>] [-a|--addr=<signet bech32 address>] [-p|--password=<faucet password>] [--] [<bitcoin-cli args>]`
11+
12+
* `--cmd` lets you customize the bitcoin-cli path. By default it will look for it in the PATH
13+
* `--faucet` lets you specify which faucet to use; the faucet is assumed to be compatible with https://github.com/kallewoof/bitcoin-faucet
14+
* `--addr` lets you specify a Signet address; by default, the address must be a bech32 address. This and `--cmd` above complement each other (i.e. you do not need `bitcoin-cli` if you use `--addr`)
15+
* `--password` lets you specify a faucet password; this is handy if you are in a classroom and set up your own faucet for your students; (above faucet does not limit by IP when password is enabled)
16+
17+
If using the default network, invoking the script with no arguments should be sufficient under normal
18+
circumstances, but if multiple people are behind the same IP address, the faucet will by default only
19+
accept one claim per day. See `--password` above.

0 commit comments

Comments
 (0)