Skip to content

plebnet-dev/signet-playground

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Signet Playground

A dockerized, self-contained Bitcoin Signet network to study how it works.

Requirements

Recent Docker version with the Compose v2 plugin.

$ docker compose version
Docker Compose version v2.25.0

Setup

Start Knots, Electrs, MariaDB and MongoDB. Since Knots is booting in custom signet mode Knots and Electrs will finish their setup almost immediately, as there is no blockchain to download.

$ docker compose up -d knots electrs mariadb mongo

Now run a one-time process that will store in Knots' wallet the private key that is used for the signet challenge:

$ docker compose run --rm wallet-setup
{
  "name": "BBO"
}

With the private key stored in Knots you can now start the faucet, miner and mempool processes:

$ docker compose up -d faucet miner mempool-api mempool-web

Testing

Mempool Explorer

Browse the Signet chain at http://localhost:8080

Sparrow

Connect your Sparrow Wallet to Electrs:

  1. Tools > Restart in Network > Signet
  2. File > Preferences > Server > Private Electrum > localhost:60601, no SSL, no Tor proxy.
  3. Wait until the blockchain has at least 100 blocks, then get some sats from the faucet at http://localhost:8123

bitcoin-cli

Interact directly with the node via the command line by entering into the knots container and running bitcoin-cli with appropriate credentials:

$ docker compose exec -it knots sh -l
$ bitcoin-cli -signet -rpcuser=knots -rpcpassword=knots -getinfo
Chain: signet
Blocks: 101
Headers: 101
Verification progress: 100.0000%
Difficulty: 0.001126515290698186

Network: in 1, out 0, total 1
Version: 260100
Time offset (s): 0
Proxies: n/a
Min tx relay fee rate (BTC/kvB): 0.00001000

Wallet: BBO
Keypool size: 1000
Transaction fee rate (-paytxfee) (BTC/kvB): 0.00000000

Balance: 50.00000000

Warnings: (none)

Clean Up

Stop and remove all containers and data volumes with the usual Docker Compose command:

$ docker compose down -v

References

Guides

Docker images

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published