Skip to content

Add configurations sections to CORE #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
qlpqlp wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add configurations sections to CORE #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 138 additions & 14 deletions core/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,154 @@
"manifestVersion": 1,
"meta": {
"name": "Dogecoin Core",
"version": "0.0.10",
"version": "0.0.11",
"logoPath": "logo.png",
"shortDescription": "Run a full core node on your dogebox",
"longDescription": "This pup launches and configures a full Dogecoin Core node on your dogebox, allowing you to sync the blockchain and contribute to the network.",
"longDescription": "This pup launches and configures a full Dogecoin Core node on your dogebox, allowing you to sync the blockchain and contribute to the network.\n\nIMPORTANT: After saving configuration changes, you must DISABLE and then ENABLE the CORE pup to apply the new settings.",

@SomeoneWeird SomeoneWeird Mar 9, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can probably define a restartCommand or something in the nix build section of the manifest that we trigger when a configuration option changes. Or maybe something as simple as sending a SIGHUP to the running process.

"upstreamVersions": {
"Core": "v1.14.9"
}
},
"config": {
"sections": null
"sections": [
{
"name": "Node Features",
"description": "Enable/disable node features and indexing. After saving changes below, disable and re-enable this pup to apply settings.",
"fields": [
{
"name": "ENABLE_TXINDEX",
"label": "Enable Transaction Index",
"type": "toggle",
"default": true
}
]
},
{
"name": "RPC",
"description": "RPC server configuration",
"fields": [
{
"name": "ENABLE_RPC",
"label": "Enable RPC Server",
"type": "toggle",
"default": true
},
{
"name": "RPC_USERNAME",
"label": "RPC Username",
"type": "text",
"default": "dogebox_core_pup_temporary_static_username"
},
{
"name": "RPC_PASSWORD",
"label": "RPC Password",
"type": "password",
"default": "dogebox_core_pup_temporary_static_password"
},
{
"name": "RPC_PORT",
"label": "RPC Port",
"type": "text",
"default": "22555"
},
{
"name": "RPC_ALLOWED_IPS",
"label": "RPC Allowed IPs (comma-separated)",
"type": "text",
"default": "0.0.0.0/0"
},
{
"name": "RPCBIND_ADDRESS",
"label": "RPC Bind Address (optional, overrides auto)",
"type": "text",
"default": ""
}
]
},
{
"name": "Network",
"description": "P2P network and connection settings",
"fields": [
{
"name": "PORT",
"label": "P2P Port",
"type": "text",
"default": "22556"
},
{
"name": "MAXCONNECTIONS",
"label": "Max Connections",
"type": "text",
"default": "125"
}
]
},
{
"name": "ZMQ",
"description": "ZMQ message queue endpoints",
"fields": [
{
"name": "ENABLE_ZMQ",
"label": "Enable ZMQ",
"type": "toggle",
"default": true
},
{
"name": "ZMQ_PUBHASHTX",
"label": "ZMQ Publish Hash TX",
"type": "text",
"default": ""
},
{
"name": "ZMQ_PUBRAWBLOCK",
"label": "ZMQ Publish Raw Block",
"type": "text",
"default": ""
},
{
"name": "ZMQ_PUBRAWTX",
"label": "ZMQ Publish Raw TX",
"type": "text",
"default": ""
}
]
},
{
"name": "Advanced",
"description": "Advanced performance and debugging options",
"fields": [
{
"name": "PRUNE",
"label": "Prune (MB, 0 to disable)",
"type": "text",
"default": "0"
},
{
"name": "DBCACHE",
"label": "Database Cache (MB)",
"type": "text",
"default": "300"
},
{
"name": "DEBUG",
"label": "Debug Level",
"type": "text",
"default": ""
},
{
"name": "UACOMMENT",
"label": "User Agent Comment",
"type": "text",
"default": ""
}
]
}
]
},
"container": {
"build": {
"nixFile": "pup.nix",
"nixFileSha256": "3f903cfaef48e5416b47719f8103fba7a9498e41e6137f6c89c225111a7bd6bf"
"nixFileSha256": "ZRyZ1ecKKRe0+UR5Jaq6kazke9/nJvL9yS1i4F5ajak="
},
"services": [
{
Expand Down Expand Up @@ -56,21 +189,12 @@
},
{
"name": "rpc",
"type": "http",
"port": 22555,
"interfaces": [
"core-rpc"
],
"listenOnHost": false
},
{
"name": "rpc-tcp",
"type": "tcp",
"port": 22555,
"interfaces": [
"core-rpc"
],
"listenOnHost": false
"listenOnHost": true

@SomeoneWeird SomeoneWeird Mar 9, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think instead of hardcoding this to true we need to be able to template this file with some of the configuration options selected. This is a much larger change, but our goal is to allow multiple core instances to run side-by-side for comparison, and this will break that.

},
{
"name": "zmq",
Expand Down
129 changes: 111 additions & 18 deletions core/pup.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,120 @@ let

dogecoind = pkgs.writeScriptBin "run.sh" ''
#!${pkgs.stdenv.shell}
if [ ! -f /storage/rpcuser.txt ] || [ ! -f /storage/rpcpassword.txt ]; then
RPCUSER=dogebox_core_pup_temporary_static_username
RPCPASS=dogebox_core_pup_temporary_static_password

echo "$RPCUSER" > /storage/rpcuser.txt
echo "$RPCPASS" > /storage/rpcpassword.txt
# RPC Configuration (from manifest config or defaults)

@SomeoneWeird SomeoneWeird Mar 9, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a much larger file now - we should pull it out into core/start.sh or something and read it off disk from pup.nix so we get all the fancy syntax highlighting etc

ENABLE_RPC="''${ENABLE_RPC:-1}"
RPCUSER="''${RPC_USERNAME:-dogebox_core_pup_temporary_static_username}"
RPCPASS="''${RPC_PASSWORD:-dogebox_core_pup_temporary_static_password}"
RPC_PORT="''${RPC_PORT:-22555}"
RPC_ALLOWED_IPS="''${RPC_ALLOWED_IPS:-0.0.0.0/0}"

# Node Features (from manifest config or defaults)
ENABLE_TXINDEX="''${ENABLE_TXINDEX:-1}"
ENABLE_ZMQ="''${ENABLE_ZMQ:-1}"

# Network Configuration (from manifest config or defaults)
P2P_PORT="''${PORT:-22556}"
MAXCONNECTIONS="''${MAXCONNECTIONS:-125}"

# Advanced Configuration (from manifest config or defaults)
PRUNE="''${PRUNE:-0}"
DBCACHE="''${DBCACHE:-300}"
DEBUG="''${DEBUG:-}"

# User Agent Comment
UACOMMENT="''${UACOMMENT:-}"

# ZMQ Advanced (custom endpoints)
ZMQ_PUBHASHTX="''${ZMQ_PUBHASHTX:-}"
ZMQ_PUBRAWBLOCK="''${ZMQ_PUBRAWBLOCK:-}"
ZMQ_PUBRAWTX="''${ZMQ_PUBRAWTX:-}"

# Wallet Features (disabled by default - cannot be enabled)
ZAPWALLETTXES="''${ZAPWALLETTXES:-0}"

# RPC Network Binding
RPCBIND_ADDRESS="''${RPCBIND_ADDRESS:-}"

# Persist RPC credentials to storage for monitor/logger access
echo "$RPCUSER" > /storage/rpcuser.txt
echo "$RPCPASS" > /storage/rpcpassword.txt

# Build dogecoind arguments
if [ "$ENABLE_RPC" = "1" ] || [ "$ENABLE_RPC" = "true" ]; then
DOGECOIND_ARGS="-port=$P2P_PORT -datadir=${storageDirectory} -rpc=1 -rpcuser=$RPCUSER -rpcpassword=$RPCPASS -rpcport=$RPC_PORT"
else
RPCUSER=$(cat /storage/rpcuser.txt)
RPCPASS=$(cat /storage/rpcpassword.txt)
DOGECOIND_ARGS="-port=$P2P_PORT -datadir=${storageDirectory} -rpc=0"
fi

${dogecoind_bin}/bin/dogecoind \
-port=22556 \
-datadir=${storageDirectory} \
-rpc=1 \
-rpcuser=$RPCUSER \
-rpcpassword=$RPCPASS \
-rpcbind=$DBX_PUP_IP \
-rpcport=22555 \
-rpcallowip=0.0.0.0/0 \
-zmqpubhashblock=tcp://0.0.0.0:28332

# Add RPC configuration only if RPC is enabled
if [ "$ENABLE_RPC" = "1" ] || [ "$ENABLE_RPC" = "true" ]; then
# Add RPC bind address (use custom if provided, otherwise use container IP)
if [ ! -z "$RPCBIND_ADDRESS" ]; then
DOGECOIND_ARGS="$DOGECOIND_ARGS -rpcbind=$RPCBIND_ADDRESS"
else
DOGECOIND_ARGS="$DOGECOIND_ARGS -rpcbind=$DBX_PUP_IP"
fi

# Add RPC allowed IPs (comma-separated to individual -rpcallowip flags)
IFS=',' read -ra IPS <<< "$RPC_ALLOWED_IPS"
for IP in "''${IPS[@]}"; do
DOGECOIND_ARGS="$DOGECOIND_ARGS -rpcallowip=$(echo $IP | xargs)"
done
fi

# Add transaction index if enabled
if [ "$ENABLE_TXINDEX" = "1" ] || [ "$ENABLE_TXINDEX" = "true" ]; then
DOGECOIND_ARGS="$DOGECOIND_ARGS -txindex=1"
fi

# Add ZMQ if enabled
if [ "$ENABLE_ZMQ" = "1" ] || [ "$ENABLE_ZMQ" = "true" ]; then
if [ ! -z "$ZMQ_PUBHASHBLOCK" ]; then
DOGECOIND_ARGS="$DOGECOIND_ARGS -zmqpubhashblock=$ZMQ_PUBHASHBLOCK"
else
DOGECOIND_ARGS="$DOGECOIND_ARGS -zmqpubhashblock=tcp://$DBX_PUP_IP:28332"
fi

# Add optional ZMQ endpoints if specified
if [ ! -z "$ZMQ_PUBHASHTX" ]; then
DOGECOIND_ARGS="$DOGECOIND_ARGS -zmqpubhashtx=$ZMQ_PUBHASHTX"
fi
if [ ! -z "$ZMQ_PUBRAWBLOCK" ]; then
DOGECOIND_ARGS="$DOGECOIND_ARGS -zmqpubrawblock=$ZMQ_PUBRAWBLOCK"
fi
if [ ! -z "$ZMQ_PUBRAWTX" ]; then
DOGECOIND_ARGS="$DOGECOIND_ARGS -zmqpubrawtx=$ZMQ_PUBRAWTX"
fi
fi

# Add user agent comment if specified
if [ ! -z "$UACOMMENT" ]; then
DOGECOIND_ARGS="$DOGECOIND_ARGS -uacomment=$UACOMMENT"
fi

# Add max connections if not default
if [ ! -z "$MAXCONNECTIONS" ] && [ "$MAXCONNECTIONS" != "125" ]; then
DOGECOIND_ARGS="$DOGECOIND_ARGS -maxconnections=$MAXCONNECTIONS"
fi

# Add prune if enabled (value in MB, 0 = disabled)
if [ ! -z "$PRUNE" ] && [ "$PRUNE" != "0" ]; then
DOGECOIND_ARGS="$DOGECOIND_ARGS -prune=$PRUNE"
fi

# Add database cache if not default
if [ ! -z "$DBCACHE" ] && [ "$DBCACHE" != "300" ]; then
DOGECOIND_ARGS="$DOGECOIND_ARGS -dbcache=$DBCACHE"
fi

# Add debug level if specified
if [ ! -z "$DEBUG" ]; then
DOGECOIND_ARGS="$DOGECOIND_ARGS -debug=$DEBUG"
fi

# Run dogecoind with constructed arguments
${dogecoind_bin}/bin/dogecoind $DOGECOIND_ARGS
'';

monitor = pkgs.buildGoModule {
Expand Down