Merge pull request nbd-wtf#13 from nbd-wtf/modern_wallet

Modern wallet with migration

Author: rsafier

Dockerfile

@@ -29,7 +29,9 @@ ENV BITCOIN_DIR /root/.bitcoin
 ENV NBITS=${NBITS}
 ENV SIGNETCHALLENGE=${SIGNETCHALLENGE}
 ENV PRIVKEY=${PRIVKEY}
-
+ENV PRIVKEY_MODE=${PRIVKEY_MODE:-"descriptor"}
+ENV CHAIN_TIP_AGE=${CHAIN_TIP_AGE:-"7200"}
+ENV MINE_GENESIS=${MINE_GENESIS:-"0"}
 ENV RPCUSER=${RPCUSER:-"bitcoin"}
 ENV RPCPASSWORD=${RPCPASSWORD:-"bitcoin"}
 ENV COOKIEFILE=${COOKIEFILE:-"false"}

README.md

@@ -2,23 +2,28 @@
 
 ## 📌 Table of Contents
 
-- [🔍 Overview](#-overview)
-- [🛠 Environment Variables](#-environment-variables)
-  - [⛏ Mining Configuration](#-mining-configuration)
-  - [🌐 RPC Configuration](#-rpc-configuration)
-  - [🌍 Network Configuration](#-network-configuration)
-  - [📡 ZMQ Configuration](#-zmq-configuration)
-  - [🔧 Additional Configuration](#-additional-configuration)
-- [🚀 Building and Running the Docker Image](#-building-and-running-the-docker-image)
-- [🔧 Docker Commands](#-docker-commands)
-- [📜 License](#-license)
+- [Bitcoin Signet Docker Image](#bitcoin-signet-docker-image)
+  - [📌 Table of Contents](#-table-of-contents)
+  - [🔍 Overview](#-overview)
+  - [🛠 Environment Variables](#-environment-variables)
+    - [⛏ Mining Configuration:](#-mining-configuration)
+    - [🌐 RPC Configuration:](#-rpc-configuration)
+    - [🌍 Network Configuration:](#-network-configuration)
+    - [📡 ZMQ Configuration:](#-zmq-configuration)
+    - [🔧 Additional Configuration:](#-additional-configuration)
+  - [🚀 Building and Running the Docker Image](#-building-and-running-the-docker-image)
+  - [🔧 Docker Commands](#-docker-commands)
+  - [📜 License](#-license)
 
 ---
 
 ## 🔍 Overview
 
 Bitcoin Signet provides a sandboxed environment for Bitcoin, allowing developers and testers to simulate the Bitcoin network without the risks associated with the main or test networks. This Docker image facilitates the deployment and configuration of a Signet node, offering a range of customizable options through environment variables.
 
+Versions prior to 29.0 were using BDB wallet, system will automaticly update your wallet to new descriptor format.
+`PRIVKEY` prior to 29.0 was a WIF, now is descriptor on new wallets. 
+
 ## 🛠 Environment Variables
 
 ### ⛏ Mining Configuration:
@@ -28,15 +33,21 @@ Bitcoin Signet provides a sandboxed environment for Bitcoin, allowing developers
 - `MINERENABLED`: Flag to enable the mining chain. (**mining mode only**)
 - `NBITS`: Sets the minimum difficulty in mining. (**mining mode only**)
 - `PRIVKEY`: Private key of the Signet signer. If `MINERENABLED=1` and not provided, it will be generated. (**mining mode only**)
+- `PRIVKEY_MODE`: `descriptor` - provide descriptors (wallets from >=v29.0) or `legacy` - provide WIF (method used prior to <v29.0 to init signet challenge)
 - `MINETO`: Address to mine to. If not provided, a new address will be generated for each block. (**mining mode only**)
 - `SIGNETCHALLENGE`: Sets the valid block producer for this Signet. Required for client-mode.
-  - If `MINERENABLED=1` and not provided, it will be generated. If provided, `PRIVKEY` must also be populated.
+- If `MINERENABLED=1` and not provided, it will be generated. If provided, `PRIVKEY` must also be populated.
+- `CHAIN_TIP_AGE`: 7200s (2hrs), will not start miner until chain-tip timestamp vs local is <= this value, allows things to sync up before trying to mine bad blacks.
+- `MINE_GENESIS`: set to 1 if you are starting a new chain, will mine first block so passes `CHAIN_TIP_AGE` check.
 
 ### 🌐 RPC Configuration:
 
 - `RPCUSER`: bitcoind RPC User.
 - `RPCPASSWORD`: bitcoind RPC password.
-
+- `RPCTHREADS`: # of work threads (default 16)
+- `RPCSERVERTIMEOUT`: RPC timeout (default 600s)
+- `RPCWORKQUEUE`: RPC queue lenght (50)
+ 
 ### 🌍 Network Configuration:
 
 - `ONIONPROXY`: Tor SOCK5 endpoint.

docker-entrypoint.sh

@@ -16,6 +16,12 @@ if [[ ! -f "${BITCOIN_DIR}/install_done" ]]; then
   install.sh #this is config based on args passed into mining node or peer.
 else
   echo "install_done file exists, skipping setup process."
+  if [[ ! -f "${BITCOIN_DIR}/uses_modern_wallet" ]]; then
+    echo "Hmm looks like you are using a legacy wallet, lets get that migrated over."
+    migrate.sh
+    sleep 4
+    echo "Migration complete, lets start bitcoind."
+  fi
   echo "rewrite bitcoin.conf"
   gen-bitcoind-conf.sh >~/.bitcoin/bitcoin.conf
 fi

gen-signet-keys.sh

@@ -1,52 +1,56 @@
 DATADIR=${DATADIR:-"regtest-temp"}
 BITCOINCLI=${BITCOINCLI:-"bitcoin-cli -regtest -datadir=$DATADIR "}
-BITCOIND=${BITCOIND:-"bitcoind -datadir=$DATADIR -regtest -daemon -deprecatedrpc=create_bdb"}
+BITCOIND=${BITCOIND:-"bitcoind -datadir=$DATADIR -regtest -daemon"}
 
-write_files() {
-    # echo "ADDR=" $ADDR
-    echo "PRIVKEY=" $PRIVKEY
-    # echo "PUBKEY=" $PUBKEY
+write_files() { 
+    echo "PRIVKEY=" 
+    cat $BITCOIN_DIR/PRIVKEY.txt
     echo "SIGNETCHALLENGE=" $SIGNETCHALLENGE
-    # echo $ADDR > ~/.bitcoin/ADDR.txt
-    echo $PRIVKEY >~/.bitcoin/PRIVKEY.txt
-    # echo $PUBKEY > ~/.bitcoin/PUBKEY.txt
-    echo $SIGNETCHALLENGE >~/.bitcoin/SIGNETCHALLENGE.txt
+    echo $ADDR > $BITCOIN_DIR/ADDR.txt
+    echo $PUBKEY > $BITCOIN_DIR/PUBKEY.txt
+    echo $SIGNETCHALLENGE >$BITCOIN_DIR/SIGNETCHALLENGE.txt
 }
 
-if [[ "$MINERENABLED" == "1" && ("$SIGNETCHALLENGE" == "" || "$PRIVKEY" == "") ]]; then
-    echo "Generating new signetchallange and privkey."
-    #clean if exists
-    rm -rf $DATADIR
-    #make it fresh
-    mkdir $DATADIR
-    #kill any daemon running stuff
-    pkill bitcoind
-    #minimal config file (hardcode bitcoin:bitcoin for rpc)
-    echo "
-    regtest=1
-    server=1
-    rpcauth=bitcoin:c8c8b9740a470454255b7a38d4f38a52\$e8530d1c739a3bb0ec6e9513290def11651afbfd2b979f38c16ec2cf76cf348a
-    rpcuser=bitcoin
-    rpcpassword=bitcoin
-    " >$DATADIR/bitcoin.conf
-    #start daemon
-    $BITCOIND -wallet="temp"
-    #wait a bit for startup
-    sleep 5s
-    #create wallet
-    $BITCOINCLI -named createwallet wallet_name="temp" descriptors=false
-    #export future signet seeding key data
-    ADDR=$($BITCOINCLI getnewaddress "" legacy)
-    PRIVKEY=$($BITCOINCLI dumpprivkey $ADDR)
-    PUBKEY=$($BITCOINCLI getaddressinfo $ADDR | jq .pubkey | tr -d '""')
-    #don't need regtest anymore
-    $BITCOINCLI stop
-    SIGNETCHALLENGE=$(echo '5121'$PUBKEY'51ae')
-
-    #cleanup
-    rm -rf $DATADIR
-else
-    echo "Imported signetchallange and privkey being used."
+if [[ "$MINERENABLED" == "1" ]]; then
+    if [[ ("$SIGNETCHALLENGE" == "" || "$PRIVKEY" == "") ]]; then
+        echo "Generating new signetchallange and privkey."
+        #clean if exists
+        rm -rf $DATADIR
+        #make it fresh
+        mkdir $DATADIR
+        #kill any daemon running stuff
+        pkill bitcoind
+        #minimal config file (hardcode bitcoin:bitcoin for rpc)
+        echo "
+        regtest=1
+        server=1
+        rpcauth=bitcoin:c8c8b9740a470454255b7a38d4f38a52\$e8530d1c739a3bb0ec6e9513290def11651afbfd2b979f38c16ec2cf76cf348a
+        rpcuser=bitcoin
+        rpcpassword=bitcoin
+        " >$DATADIR/bitcoin.conf
+        #start daemon
+        $BITCOIND -wallet="temp"
+        #wait a bit for startup
+        sleep 5s
+        
+        #create wallet
+        $BITCOINCLI -named createwallet wallet_name="temp" descriptors=true
+        #Get the signet script from the 86 descriptor
+        ADDR=$($BITCOINCLI getnewaddress)
+        SIGNETCHALLENGE=$($BITCOINCLI getaddressinfo $ADDR | jq -r ".scriptPubKey")
+        PUBKEY=$($BITCOINCLI getaddressinfo $ADDR | jq .pubkey | tr -d '""')
+        # Dumping descriptor wallet privatekey 
+        $BITCOINCLI listdescriptors true | jq -r ".descriptors | .[].desc" >> $BITCOIN_DIR/PRIVKEY.txt
+        
+        #don't need regtest anymore
+        $BITCOINCLI stop 
+        #cleanup
+        rm -rf $DATADIR
+    else
+        echo "$PRIVKEY" > $BITCOIN_DIR/PRIVKEY.txt
+        echo "$SIGNETCHALLENGE" > $BITCOIN_DIR/SIGNETCHALLENGE.txt
+        echo "Imported signetchallange and privkey being used."
+    fi
 fi
 
 write_files

import_wif_to_descriptor.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+set -euo pipefail
+
+
+WIF_PRIVKEY=$(cat ${BITCOIN_DIR}/PRIVKEY.txt)
+
+# Step 1: Construct input descriptor with WIF
+#INPUT_DESC="pk($WIF)"
+#BASE_DESC="combo($WIF_PRIVKEY)"
+
+BASE_DESC="multi(1,$WIF_PRIVKEY)"
+# Step 2: Get checksum (must preserve private key in input, do NOT use returned descriptor)
+CHECKSUM=$(bitcoin-cli getdescriptorinfo "$BASE_DESC" | jq -r .checksum)
+# Step 3: Final descriptor with checksum
+FINAL_DESC="${BASE_DESC}#${CHECKSUM}"
+# Step 4: Build import JSON with rescan
+IMPORT_JSON=$(cat <<EOF
+[{
+  "desc": "$FINAL_DESC",
+  "timestamp": "now",
+  "label": "bdb-migrated-signet"
+}]
+EOF
+)
+# Step 5: Import descriptor into wallet
+echo "Importing descriptor for signet multisig(1 of 1)..."
+bitcoin-cli importdescriptors "$IMPORT_JSON"
+
+
+BASE_DESC="combo($WIF_PRIVKEY)"
+# Step 2: Get checksum (must preserve private key in input, do NOT use returned descriptor)
+CHECKSUM=$(bitcoin-cli getdescriptorinfo "$BASE_DESC" | jq -r .checksum)
+# Step 3: Final descriptor with checksum
+FINAL_DESC="${BASE_DESC}#${CHECKSUM}"
+# Step 4: Build import JSON with rescan
+IMPORT_JSON=$(cat <<EOF
+[{
+  "desc": "$FINAL_DESC",
+  "timestamp": "now",
+  "label": "bdb-migrated-signet"
+}]
+EOF
+)
+# Step 5: Import descriptor into wallet
+echo "Importing descriptor for signet combo()..."
+bitcoin-cli importdescriptors "$IMPORT_JSON"

install.sh

@@ -1,7 +1,8 @@
+touch ${BITCOIN_DIR}/uses_modern_wallet
 echo "Generate or import keyset"
 gen-signet-keys.sh
 echo "Generate bitcoind configuration"
-gen-bitcoind-conf.sh >~/.bitcoin/bitcoin.conf
+gen-bitcoind-conf.sh >${BITCOIN_DIR}/bitcoin.conf
 echo "Setup Signet"
 setup-signet.sh
 
@@ -10,4 +11,4 @@ if [[ "$MINE_GENESIS" == "1" ]]; then
     mine-genesis.sh
 fi
 
-touch ~/.bitcoin/install_done
+touch ${BITCOIN_DIR}/install_done

migrate.sh

@@ -0,0 +1,16 @@
+CLI="bitcoin-cli -datadir=${BITCOIN_DIR}" 
+
+bitcoind --daemonwait
+sleep 5
+$CLI migratewallet custom_signet
+if [[ $? -ne 0 ]]; then
+    echo "Migration failed, exiting."
+    exit 1
+fi 
+echo "Migrating privkey to descriptor format."
+import_wif_to_descriptor.sh
+echo "Private key imported into wallet as descriptor."
+touch "${BITCOIN_DIR}/uses_modern_wallet"
+echo "Migration completed successfully."
+$CLI stop
+sleep 5

mine-genesis.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-ADDR=${ADDR:-$(bitcoin-cli getnewaddress "" legacy)}
+ADDR=${ADDR:-$(bitcoin-cli getnewaddress "gen0" bech32)}
 NBITS=${NBITS:-"1e0377ae"} #minimum difficulty in signet
 miner --cli="bitcoin-cli" generate --address=$ADDR --grind-cmd="bitcoin-util grind" --nbits=$NBITS --set-block-time=$(date +%s)
 

mine.sh

@@ -1,8 +1,16 @@
 #!/bin/bash
+set -Eeuo pipefail
+# Define mining constants
+CLI="bitcoin-cli -datadir=${BITCOIN_DIR}" 
+GRIND="bitcoin-util grind"
+
 NBITS=${NBITS:-"1e0377ae"} #minimum difficulty in signet
 
+echo "Waiting until Chain tip age is < $CHAIN_TIP_AGE seconds before mining start..."
+wait_chain_sync.sh $CHAIN_TIP_AGE
 while true; do
     ADDR=${MINETO:-$(bitcoin-cli getnewaddress)}
+    echo "Mining to address:" $ADDR
     if [[ -f "${BITCOIN_DIR}/BLOCKPRODUCTIONDELAY.txt" ]]; then
         BLOCKPRODUCTIONDELAY_OVERRIDE=$(cat ~/.bitcoin/BLOCKPRODUCTIONDELAY.txt)
         echo "Delay OVERRIDE before next block" $BLOCKPRODUCTIONDELAY_OVERRIDE "seconds."
@@ -14,6 +22,9 @@ while true; do
             sleep $BLOCKPRODUCTIONDELAY
         fi
     fi
-    echo "Mine To:" $ADDR
-    miner --cli="bitcoin-cli" generate --grind-cmd="bitcoin-util grind" --address=$ADDR --nbits=$NBITS --set-block-time=$(date +%s)
+    #echo "Mine To:" $ADDR --addr=$ADDR 
+    miner --cli="bitcoin-cli" generate --grind-cmd="bitcoin-util grind" --addr=$ADDR --nbits=$NBITS  --set-block-time=$(date +%s) || true
+
 done
+
+ 

run.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # run bitcoind
-bitcoind --daemonwait -deprecatedrpc=create_bdb
+bitcoind --daemonwait
 sleep 5
 echo "get magic"
 magic=$(cat /root/.bitcoin/signet/debug.log | grep -m1 magic)  

setup-signet.sh

@@ -1,14 +1,49 @@
-PRIVKEY=${PRIVKEY:-$(cat ~/.bitcoin/PRIVKEY.txt)}
-DATADIR=${DATADIR:-~/.bitcoin/}
-bitcoind -datadir=$DATADIR --daemonwait -persistmempool -deprecatedrpc=create_bdb
-bitcoin-cli -datadir=$DATADIR -named createwallet wallet_name="custom_signet" load_on_startup=true descriptors=false
-
-#only used in case of mining node
-if [[ "$MINERENABLED" == "1" ]]; then
-    bitcoin-cli -datadir=$DATADIR importprivkey $PRIVKEY
-    ## for future with descriptor wallets, cannot seem to get it working yet
-    # descinfo=$(bitcoin-cli getdescriptorinfo "wpkh(${PRIVKEY})")
-    # checksum=$(echo "$descinfo" | jq .checksum | tr -d '"' | tr -d "\n")
-    # desc='[{"desc":"wpkh('$PRIVKEY')#'$checksum'","timestamp":0,"internal":false}]'
-    # bitcoin-cli -datadir=$DATADIR importdescriptors $desc
+
+bitcoind -datadir=$BITCOIN_DIR --daemonwait -persistmempool #-deprecatedrpc=create_bdb
+bitcoin-cli -datadir=$BITCOIN_DIR -named createwallet wallet_name="custom_signet" load_on_startup=true descriptors=true
+
+
+# Set privkey if pushed from ENV and doesn't exist in file systems yet.
+if [ ! -f "$BITCOIN_DIR/PRIVKEY.txt" ]; then
+    echo "$PRIV_KEY" > "$BITCOIN_DIR/PRIVKEY.txt"
+fi
+
+#only used in case of mining node and modern wallet
+if [[ -f "${BITCOIN_DIR}/uses_modern_wallet" && "$MINERENABLED" == "1" ]]; then
+
+    if [ "$PRIVKEY_MODE" == "legacy" ]; then
+        import_wif_to_descriptor.sh
+    else
+        line_count=0
+        while read line; do
+            # Increment the line counter
+            line_count=$((line_count+1))
+            
+            # Check if the line count is even or odd
+            if [ $((line_count % 2)) -eq 0 ]; then
+                is_even="true"
+            else
+                is_even="false"
+            fi
+            
+            DESCRIPTORS="
+            {
+                \"desc\": \"${line}\",
+                \"timestamp\": 0,
+                \"active\": true,
+                \"internal\": ${is_even},
+                \"range\": [
+                    0,
+                    999
+                ]
+            }"
+            
+            DESCRIPTORS="[${DESCRIPTORS//[$'\t\r\n ']}]"
+            
+            bitcoin-cli -datadir=$BITCOIN_DIR importdescriptors "$DESCRIPTORS" 2>&1 > /dev/null
+            
+        done < $BITCOIN_DIR/PRIVKEY.txt
+    fi
+
+    
 fi