init.sh

Overview

`init.sh` is a Bash shell script designed to manage the lifecycle of a Bitcoin daemon process (`bitcoind`). Its primary purpose is to start the `bitcoind` node with a specific configuration tailored for a headless, server-oriented environment, and to gracefully stop the process upon receiving termination signals.

Key functionalities include:

• Launching bitcoind with customized parameters such as RPC configuration, data directory, ZeroMQ notifications, and memory settings.

• Capturing the process ID (PID) of the launched bitcoind instance.

• Handling UNIX signals (TERM and INT) to perform a clean shutdown of the Bitcoin daemon.

• Waiting on the bitcoind process to exit, ensuring orderly termination.

This script is typically used in containerized or server environments where automated startup and controlled shutdown of the Bitcoin node are required.

Detailed Explanation

Functions

start_coin()

**Purpose:** Starts the `bitcoind` daemon process with predefined configuration flags and runs it in the background.

**Implementation Details:**

• Runs bitcoind with:

  • RPC user and password for authentication.

  • RPC network binding and port settings.

  • Data directory set to /data.

  • Console output enabled.

  • Server mode enabled (-server=1).

  • Disables listening for incoming peer connections (-nolisten=1).

  • Enables transaction indexing (-txindex=1).

  • Disables the wallet functionality (-disablewallet=1).

  • Publishes transaction and block hash notifications via ZeroMQ on TCP port 28332.

  • Increases RPC work queue size and max memory pool.

  • Enlarges the database cache.

• Runs the command in the background (&) and stores the process ID in the global variable PID.

**Parameters:** None.

**Returns:** None (side effect: sets global `PID`).

**Usage Example:**

start_coin
echo "Bitcoin daemon started with PID $PID"

stop_coin()

**Purpose:** Gracefully stops the running `bitcoind` daemon by sending a kill signal to its process and waiting for it to exit.

**Implementation Details:**

• Outputs a message indicating the signal handling and target PID.

• Sends a SIGTERM to the process identified by PID.

• Enters a loop checking if the process is still alive (kill -0 returns success if process exists).

• Sleeps 1 second between checks to avoid busy waiting.

• Exits once the process is confirmed stopped.

**Parameters:** None.

**Returns:** None.

**Usage Example:**

stop_coin
echo "Bitcoin daemon stopped"

Signal Trap

**Purpose:** Sets up signal handlers to catch termination signals (`TERM` and `INT`) and invoke `stop_coin()` for clean shutdown.

**Implementation Details:**

• trap 'stop_coin' TERM INT binds the stop_coin function to signals SIGTERM and SIGINT.

• Ensures that if the script receives a Ctrl+C or a termination request, it will stop the Bitcoin daemon properly.

Main Execution Flow

1. Calls start_coin to launch the Bitcoin daemon in the background.

2. Waits for the daemon process to finish by calling wait $PID.

3. The script effectively runs until the Bitcoin daemon exits or a termination signal is received.

Important Implementation Details and Algorithms

• The script uses set -e which causes the script to exit immediately if any command returns a non-zero status, enhancing robustness.

• Background process management is done by capturing the PID after launching bitcoind with &.

• The stop_coin function uses kill -0 as a non-destructive way to check if the process is still alive.

• ZeroMQ (-zmqpubhashtx and -zmqpubhashblock) endpoints are configured to allow other components or services to subscribe to real-time Bitcoin transaction and block notifications.

• Disabling wallet functionality (-disablewallet=1) reduces resource usage and attack surface if wallet features are unnecessary.

• The script disables peer listening (-nolisten=1) indicating this node is not accepting inbound P2P connections, possibly acting as a backend or RPC node only.

• The use of fixed RPC credentials (user and password) is likely for simplicity or testing, but caution is advised in production environments.

Interaction With Other Components

• Bitcoin daemon (bitcoind): This script directly manages the lifecycle of bitcoind.

• External services or scripts: May consume ZeroMQ messages published on tcp://127.0.0.1:28332 for transaction and block events.

• RPC clients: Can connect to the daemon on port 8332 using the configured user/password credentials.

• System or container orchestrators: May send termination signals (TERM, INT) to this script to ensure clean shutdown of the Bitcoin node.

This script is often used as an entrypoint script in Docker containers or as a startup service script within server environments.

Visual Diagram

flowchart TD
    StartCoin["start_coin()"]
    StopCoin["stop_coin()"]
    TrapSignals["trap 'stop_coin' TERM INT"]
    WaitPID["wait $PID"]
    Bitcoind["bitcoind daemon"]

    StartCoin -->|starts| Bitcoind
    Bitcoind -->|runs with PID stored in $PID| WaitPID
    TrapSignals -->|on SIGTERM or SIGINT| StopCoin
    StopCoin -->|kill $PID and wait| Bitcoind
    WaitPID -->|blocks until Bitcoind exits| End["Script exits"]

Summary

`init.sh` is a lightweight and robust initialization script for running and managing a Bitcoin daemon in a controlled environment. It encapsulates the startup configuration, signal handling for graceful shutdown, and process monitoring in a few lines of Bash code. This script is suitable for deployment scenarios where automated and reliable Bitcoin node management is required, such as containerized deployments or dedicated server setups.