https://github.com/thunderbiscuit/regtest-in-a-pod

A robust regtest environment with electrum, esplora, CBF, a block explorer and more using Podman containers.
https://github.com/thunderbiscuit/regtest-in-a-pod

Last synced: about 1 month ago
JSON representation

A robust regtest environment with electrum, esplora, CBF, a block explorer and more using Podman containers.

• Host: GitHub
• URL: https://github.com/thunderbiscuit/regtest-in-a-pod
• Owner: thunderbiscuit
• Created: 2024-05-24T13:52:59.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-08-06T13:10:34.000Z (3 months ago)
• Last Synced: 2024-08-06T15:15:40.900Z (3 months ago)
• Language: Shell
• Homepage: https://thunderbiscuit.com/posts/podman-bitcoin/
• Size: 11.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Readme

This repo is a companion to the [Using Podman Containers for Regtest Bitcoin Development](https://thunderbiscuit.com/posts/podman-bitcoin/) blog article.

It allows you to create a robust regtest environment which you can turn on and off at will using Podman. The final environment includes a lot of useful tools, namely:

1. A bitcoin core node and daemon (serving compact block filters)

2. bitcoin-cli enabled

3. An Electrum server

4. An Esplora server

5. A block explorer

6. Useful aliases and just commands for working with the daemon from your command line

Read the article linked above for all the information on how to use the container to its fullest, but here is a quick cheatsheet:

## Usage

You can use the aliases defined in the `aliases.sh` file directly, but even better is to use the [`just`](https://github.com/casey/just) tool and leverage the commands defined in the `justfile`.

```shell

just mine 21

just sendto 


just bitcoindlogs

just esploralogs

```


## Building, Starting, and Stopping the Pod

```shell

# Building the container

cd ~/podman/regtest-in-a-pod/

podman machine start regtest

podman --connection regtest build --tag localhost/regtest:v1.0.0 --file ./Containerfile

podman create --name RegtestBitcoinEnv --publish 18443:18443 --publish 18444:18444 --publish 3002:3002 --publish 3003:3003 --publish 60401:60401 localhost/regtest:v1.1.0

podman start RegtestBitcoinEnv

source aliases.sh

# Using the container

cd ~/podman/regtest-in-a-pod/

podman machine start regtest

podman start RegtestBitcoinEnv

source aliases.sh

# podmine

# podcli

# explorer

# Stopping the container and the machine

podman stop RegtestBitcoinEnv

podman machine stop regtest

```