Nigiri A delicious docker box for special Bitcoin, Lightning and Liquid cookings

BY KEYHUNTER 19.02.2024
Nigiri A delicious docker box for special Bitcoin, Lightning and Liquid cookings

GitHub: https://github.com/vulpemventures/nigiri

Nigiri is a command-line interface (CLI) tool that simplifies the process of setting up a Bitcoin regtest environment. With Nigiri, users can quickly and easily fire up a Bitcoin regtest box, along with Electrs and Esplora, two popular tools for Bitcoin developers. Nigiri also includes faucet and push commands, which make it easy to test Bitcoin applications and services.

Regtest is a testing environment for Bitcoin that simulates the Bitcoin network without using real bitcoins. This allows developers to test their Bitcoin applications and services without risking real money. Electrs is a Bitcoin full node software that indexes the Bitcoin blockchain and provides an API for querying it. Esplora is a web-based block explorer that allows users to view and analyze the Bitcoin blockchain.

Nigiri simplifies the process of setting up a Bitcoin regtest environment by providing a single command that sets up all the necessary components. This includes the Bitcoin Core software, Electrs, Esplora, and a Bitcoin faucet, which provides free test bitcoins for testing purposes.

The faucet command in Nigiri makes it easy to obtain test bitcoins for testing purposes. The push command allows users to send test bitcoins to other addresses on the regtest network. These commands simplify the process of testing Bitcoin applications and services, making it easier for developers to test their applications without risking real money.

Overall, Nigiri is a powerful tool for Bitcoin developers who want to quickly and easily set up a Bitcoin regtest environment. With Nigiri, developers can test their applications and services without risking real money, and can easily obtain test bitcoins for testing purposes. The faucet and push commands make it easy to simulate real-world Bitcoin transactions, allowing developers to test their applications in a realistic environment.

Nigiri is a command-line interface (CLI) tool that allows you to quickly set up a Bitcoin regtest box with Electrs and Esplora. Regtest is a private blockchain that you can use for testing and experimentation without having to worry about real Bitcoin transactions. Electrs is a lightweight, high-performance Electrum server that provides fast access to blockchain data, while Esplora is a blockchain explorer that allows you to view transactions and blocks on the regtest network.

Nigiri also includes a faucet command that allows you to generate test Bitcoin addresses with pre-mined funds, and a push command that allows you to send transactions on the regtest network. With Nigiri, you can quickly and easily set up a Bitcoin regtest environment for testing and experimentation without having to worry about the complexities of setting up a full Bitcoin node.

In summary, Nigiri is a powerful tool for anyone who wants to experiment with Bitcoin and blockchain technology in a private and secure environment. With its simple CLI interface and built-in Electrs and Esplora integration, Nigiri makes it easy to set up a Bitcoin regtest box and start exploring the world of Bitcoin and blockchain technology.

script that you can use to run nigiri in a docker container:

#!/usr/bin/env python3

import docker
import os

# set the docker client and image name
client = docker.from_env()
image_name = 'nigiri'

# create a docker container
container = client.containers.run(
    image=image_name,
    ports={'80': '80'},
    volumes={'/var/run/docker.sock': '/var/run/docker.sock'},
    detach=true
)

# wait for the container to start
print("waiting for the container to start...")
container.wait()

# get the ip address of the container
ip_address = container.attrs['networksettings']['networks']['bridge']['ipaddress']

# print the url of the nigiri dashboard
print(f"nigiri dashboard is available at: http://{ip_address}:80")

# stop and remove the container
print("stopping and removing the container...")
container.stop()
container.remove()

this script creates a docker container with the nigiri image, maps port 80 to the host, and mounts the docker socket volume so that nigiri can access the docker api. it then waits for the container to start, gets its ip address, prints the url of the nigiri dashboard, and stops and removes the container.

to use this script, you will need to have python 3.x and docker installed on your system. you can run it by saving it to a file (e.g. run_nigiri.py) and executing it with python run_nigiri.py.

Useful information for enthusiasts:

Contact me via Telegram: @ExploitDarlenePRO