Config Refresh by MicahMaphet · Pull Request #4049 · bitpay/bitcore

MicahMaphet · 2025-11-10T20:11:37Z

Reload config files bitcore-node
bitcore-node workers reload their configs on SIGUSR1
Use the scripts/reloadConfig.sh to send SIGUSR1 to pids contained in new pids directory
Reload all workers:

$ ./scripts/reloadConfig.sh
Reload configs for all workers: 264191 242416

List active workers:

$ ./scripts/reloadConfig.sh list
all
api

Reload configs for specified workers:

$ ./scripts/reloadConfig.sh all api
Sent reload signal(s) SIGUSR1 to 'all api'
pids: 264191 242416

Not all of the config options reload properly, e.g. numWorkers.
What is known to work:

changing peer connections
disabling and enabling peers
RPC connections (at least for the purposes of the /fee route)
API port

…nfig refresh

…st all workers, --help, and more friendly to other shells

…fig port change

Copilot

Pull request overview

Adds runtime configuration reloading to bitcore-node workers (via SIGUSR1) and updates code to read configuration through the new ConfigService rather than a static config object.

Changes:

Refactors config loading to be reloadable (src/config.ts now exports a loader; src/services/config.ts owns the live config and reload logic).
Adds SIGUSR1-triggered reload behaviors (API port reload; P2P manager/Bitcoin peer refresh) and a helper script that signals running worker PIDs.
Updates tests and various modules/routes/adapters to use Config.get() / Config.updateConfig().

Reviewed changes

Copilot reviewed 32 out of 40 changed files in this pull request and generated 17 comments.

Show a summary per file

File	Description
packages/bitcore-node/test/verification/rpc-verify.ts	Switches RPC creds lookup to `Config.get()`
packages/bitcore-node/test/unit/services/worker.test.ts	Uses `Config.updateConfig` to control `numWorkers` during tests
packages/bitcore-node/test/unit/services/p2p.test.ts	Formatting-only changes
packages/bitcore-node/test/unit/models/transaction.test.ts	Formatting-only changes
packages/bitcore-node/test/unit/adapters/factory.test.ts	Uses `Config.get()` for external provider config in tests
packages/bitcore-node/test/unit/adapters/alchemy.test.ts	Uses `Config.get()` for external provider config in tests
packages/bitcore-node/test/integration/websocket.test.ts	Uses `Config.get()` for chain/network RPC creds
packages/bitcore-node/test/integration/wallet-benchmark.test.ts	Uses `Config.get()` for chain/network RPC creds; formatting tweaks
packages/bitcore-node/test/integration/verification.test.ts	Uses `Config.get()` for chain/network RPC creds
packages/bitcore-node/test/integration/routes/block.test.ts	Formatting-only changes
packages/bitcore-node/test/integration/models/wallet.test.ts	Uses `Config.get()` for chain/network RPC creds
packages/bitcore-node/test/integration/models/transaction.test.ts	Formatting-only changes
packages/bitcore-node/test/integration/models/coin.test.ts	Formatting-only changes
packages/bitcore-node/test/integration/models/block.test.ts	Formatting-only changes
packages/bitcore-node/test/integration/matic/p2p.test.ts	Uses `Config.get()` for chain/network config
packages/bitcore-node/test/integration/ethereum/p2p.test.ts	Uses `Config.get()` for chain/network config
packages/bitcore-node/test/helpers/integration.ts	Uses `Config.get()` for dbHost in integration setup
packages/bitcore-node/test/benchmark/benchmark.ts	Uses `Config.get()` for dbHost in benchmark setup
packages/bitcore-node/src/workers/p2p.ts	Writes/cleans up a pid file for reload signaling
packages/bitcore-node/src/workers/api.ts	Writes/cleans up a pid file for reload signaling (primary process)
packages/bitcore-node/src/workers/all.ts	Writes/cleans up a pid file for reload signaling (primary process)
packages/bitcore-node/src/services/worker.ts	Uses `Config.get().numWorkers` to size the cluster (but import path currently broken)
packages/bitcore-node/src/services/p2p.ts	Adds SIGUSR1 handling to stop/start P2P workers based on updated config
packages/bitcore-node/src/services/config.ts	Introduces reloadable `ConfigService` and SIGUSR1/message-based reload propagation
packages/bitcore-node/src/services/api.ts	Adds API port reload behavior on reload signals/messages
packages/bitcore-node/src/routes/status.ts	Switches to `Config.get().chains` (but import path currently broken)
packages/bitcore-node/src/routes/index.ts	Switches networks discovery to `Config.get().chains`
packages/bitcore-node/src/routes/api/wallet.ts	Uses `Config.get()` for socket BWS key lookup (but import path currently broken)
packages/bitcore-node/src/routes/api/fee.ts	Uses `Config.get()` for default fee mode (but import path currently broken)
packages/bitcore-node/src/providers/chain-state/svm/api/csp.ts	Formatting-only changes
packages/bitcore-node/src/providers/chain-state/external/adapters/alchemy.ts	Reads Alchemy API key from `Config.get()`
packages/bitcore-node/src/providers/chain-state/evm/api/routes.ts	Reads Moralis webhook config from `Config.get()`
packages/bitcore-node/src/providers/chain-state/evm/api/csp.ts	Formatting-only changes
packages/bitcore-node/src/modules/ripple/api/csp.ts	Switches Ripple config access to `Config.get().chains[...]`
packages/bitcore-node/src/modules/moralis/api/csp.ts	Switches Moralis config access to `Config.get()` (but import path currently broken)
packages/bitcore-node/src/modules/bitcoin/p2p.ts	Adds SIGUSR1-driven peer reload logic based on updated config
packages/bitcore-node/src/config.ts	Changes default export from config object to `loadConfig()` function
packages/bitcore-node/scripts/reloadConfig.sh	New script to signal workers listed in pid files
packages/bitcore-node/Dockerfile	Alters container startup command (currently invalid)
conf	New file containing ANSI-colored diff output (appears accidental)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-17T20:28:53Z

+      process.on('SIGUSR1', async () => {
+        this.reload();
+      });
+


The SIGUSR1 handler is registered inside start(), and it calls the async reload() without awaiting it. If ApiService is stopped/started again (including via reload() itself), this will accumulate duplicate signal handlers and can cause unhandled rejections. Register the handler once (e.g., in the constructor) and await this.reload().

Copilot · 2026-04-17T20:28:53Z

 import cluster, { Worker as ClusterWorker } from 'cluster';
 import { EventEmitter } from 'events';
-import config from '../config';
+import { Config } from '../../src/services/config';


The import path for Config is incorrect here: from src/services/worker.ts, ../../src/services/config resolves to src/src/services/config and will fail to compile. Import from the local services module instead (e.g., ./config or ../services/config).

Suggested change

import { Config } from '../../src/services/config';

import { Config } from './config';

Copilot · 2026-04-17T20:28:54Z

+  fs.unlinkSync('pids/p2p.pid');
+


fs.unlinkSync('pids/p2p.pid') will throw if the pid file is missing (e.g., already deleted, different working directory, or partial startup), which can prevent the rest of shutdown logic from running. Wrap this in a try/catch (or use fs.rmSync(..., { force: true })) and consider using an absolute path based on a known dir.

Copilot · 2026-04-17T20:28:54Z

  stopping = true;

+  if (cluster.isPrimary) {
+    fs.unlinkSync('pids/api.pid');


fs.unlinkSync('pids/api.pid') can throw if the pid file doesn't exist (or cwd differs), which can abort shutdown. Use a tolerant removal approach (try/catch or fs.rmSync(..., { force: true })) so stop() remains reliable.

Suggested change

fs.unlinkSync('pids/api.pid');

fs.rmSync('pids/api.pid', { force: true });

Copilot · 2026-04-17T20:28:54Z

      });
-
-      // Mock config.numWorkers
-      sandbox.stub(config, 'numWorkers').value(3);
-
+
+      Config.updateConfig({ numWorkers: 3 });
+
      // Clear the Worker service's internal state


This test updates the global Config singleton (Config.updateConfig({ numWorkers: 3 })) but never restores the previous value, which can leak state into other unit tests. Save the prior config/numWorkers in beforeEach and restore it in afterEach.

Copilot · 2026-04-17T20:28:56Z

 # Start the server
 WORKDIR /bitcore/packages/bitcore-node
-CMD ["node", "./build/src/server.js"]
+CMD ["node", ".*.tsserver.js"]


CMD ["node", ".*.tsserver.js"] does not point at a valid built entrypoint and will break the container startup. This should likely remain node ./build/src/server.js (or the correct compiled JS path) after the build step.

Suggested change

CMD ["node", ".*.tsserver.js"]

CMD ["node", "./build/src/server.js"]

Copilot · 2026-04-17T20:28:57Z

+      for (const worker of this.workers) {
+        const { chain, network } = worker;
+        if (chainConfigs[chain][network].disabled) {
+          logger.info(`Stopping ${chain} ${network}`);


This reload handler assumes chainConfigs[chain][network] exists for every running worker. If a chain/network is removed from the config, chainConfigs[chain] can be undefined and this will throw when accessing .disabled. Add guards like chainConfigs[chain]?.[network] and decide whether to stop workers whose config was removed.

Copilot · 2026-04-17T20:28:57Z

 import { Validation } from '@bitpay-labs/crypto-wallet-core';
 import { Request, Response, Router } from 'express';
-import config from '../../config';
+import { Config } from '../../../src/services/config';


The import path for Config is incorrect here: src/routes/api/wallet.ts is under src/routes/api, so ../../../src/services/config resolves to src/src/services/config and will fail to compile. Import Config from ../../services/config.

Suggested change

import { Config } from '../../../src/services/config';

import { Config } from '../../services/config';

Copilot · 2026-04-17T20:28:57Z

+if [ $# = 0 ]; then
+  pid_paths=$dir/pids/*
+
+  for path in $pid_paths; do
+    pid=$(cat "$path")


If there are no pid files, pid_paths=$dir/pids/* may not expand and the loop will try to cat a literal glob. Add an explicit check that pid files exist (or use a glob-safe listing) before iterating, and avoid calling kill with an empty pid list.

Copilot · 2026-04-17T20:28:57Z

+      const uri = peer.host + ':' + peer.port;
+      configPeerUris.push(uri);
+      const hashes = Object.values(this.pool._addrs).map((a: any) => a.hash);
+      const addr = this.pool._addAddr({ ip: { v4: peer.host }, port: peer.port });
+      if (!hashes.includes(addr.hash)) {


reload() depends on non-public Pool internals (_addrs and _addAddr), which is brittle and may break on dependency upgrades. Prefer a public peer-management API if available, or encapsulate these internals behind an adapter so the rest of the worker isn’t coupled to private fields.

MicahMaphet marked this pull request as ready for review November 25, 2025 21:44

MicahMaphet marked this pull request as draft November 25, 2025 22:18

MicahMaphet marked this pull request as ready for review December 4, 2025 19:18

MicahMaphet marked this pull request as draft December 18, 2025 13:14

kajoseph added the BCN This pull request modifies the bitcore-node package label Dec 30, 2025

MicahMaphet changed the title ~~[BCN] Config Refresh~~ Config Refresh Jan 5, 2026

MicahMaphet added 12 commits March 14, 2026 23:32

added config reload function

a5eb24b

fixed build import and other compile errors

4dc58b0

added reloadRefresh script

4344e93

finished config refresh mechanism and create shell script to start co…

6ccf30e

…nfig refresh

reloadConfig.sh features: reload many workers, reload all workers, li…

b858f14

…st all workers, --help, and more friendly to other shells

fixed no args error

8e4d17a

show the change in the config and restart server on a new port on con…

01bbf5a

…fig port change

add node connections when added to config (does not remove nodes

4f4dc51

finished reloading+adding+removing peer connections on config refresh

903cb21

show worker pid and name in output for reload script

66894c5

disable and enable peers on config refresh

5bb2f09

merge master into config-refresh

44e8381

MicahMaphet force-pushed the config-refresh branch from 3301ede to 44e8381 Compare March 15, 2026 04:23

MicahMaphet added 2 commits April 14, 2026 13:23

Merge branch 'master' into config-refresh

2e19c59

fix some merge errors

dc1eb4f

MicahMaphet marked this pull request as ready for review April 17, 2026 18:41

kajoseph requested a review from Copilot April 17, 2026 20:22

Copilot started reviewing on behalf of kajoseph April 17, 2026 20:23 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Config Refresh#4049

Config Refresh#4049
MicahMaphet wants to merge 14 commits intobitpay:masterfrom
MicahMaphet:config-refresh

MicahMaphet commented Nov 10, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	import { Config } from '../../src/services/config';
	import { Config } from './config';

	fs.unlinkSync('pids/api.pid');
	fs.rmSync('pids/api.pid', { force: true });

	CMD ["node", ".*.tsserver.js"]
	CMD ["node", "./build/src/server.js"]

	import { Config } from '../../../src/services/config';
	import { Config } from '../../services/config';

Conversation

MicahMaphet commented Nov 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MicahMaphet commented Nov 10, 2025 •

edited

Loading