Skip to content

[BCN] Environmental variable option for bitcore.config.json path #4047

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
wants to merge 7 commits into
base: master
Choose a base branch
from
+36 −27
Open

[BCN] Environmental variable option for bitcore.config.json path #4047

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
dfc5f57
bitcore-node using environmental variable for bitcore.config.json pat…
MicahMaphet Nov 7, 2025
c8a35bd
added back --config argument and added config path by its directory o…
MicahMaphet Nov 7, 2025
17082f3
replace ~ with homedirectory in bitcore-node config (should fix circl…
MicahMaphet Nov 7, 2025
dc61fa0
actually assign homedir to config with ~
MicahMaphet Nov 7, 2025
7757af0
bug fix: use bitcoreNode part of bitcore.config.json
MicahMaphet Nov 7, 2025
4bdd52a
moved config finding back to findConfig function
MicahMaphet Nov 9, 2025
5994b2e
kenny's review changes: use path.join in config
MicahMaphet Nov 17, 2025
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
63 changes: 36 additions & 27 deletions packages/bitcore-node/src/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,48 @@
import fs from 'fs';
import { cpus, homedir } from 'os';
import path from 'path';
import logger from './logger';
import { ConfigType } from './types/Config';
import { merge } from './utils';
import parseArgv from './utils/parseArgv';

const program = parseArgv([], ['config']);

function findConfig(): ConfigType | undefined {
let foundConfig;
const envConfigPath = process.env.BITCORE_CONFIG_PATH;
const argConfigPath = program.config;
const configFileName = 'bitcore.config.json';
const bitcoreConfigPaths = [
`${homedir()}/${configFileName}`,
`../../../../${configFileName}`,
`../../${configFileName}`
];
const overrideConfig = argConfigPath || envConfigPath;
if (overrideConfig) {
bitcoreConfigPaths.unshift(overrideConfig);
let bitcoreConfigPath = program.config || process.env.BITCORE_CONFIG_PATH || '../../bitcore.config.json';
if (bitcoreConfigPath[0] === '~') {
bitcoreConfigPath = bitcoreConfigPath.replace('~', homedir());
}
// No config specified. Search home, bitcore and cur directory
for (const path of bitcoreConfigPaths) {
if (!foundConfig) {
try {
const expanded = path[0] === '~' ? path.replace('~', homedir()) : path;
// eslint-disable-next-line @typescript-eslint/no-require-imports
const bitcoreConfig = require(expanded) as { bitcoreNode: ConfigType };
foundConfig = bitcoreConfig.bitcoreNode;
} catch {
foundConfig = undefined;
}

if (!fs.existsSync(bitcoreConfigPath)) {
throw new Error(`No bitcore config exists at ${bitcoreConfigPath}`);
}

const bitcoreConfigStat = fs.statSync(bitcoreConfigPath);

if (bitcoreConfigStat.isDirectory()) {
if (!fs.existsSync(path.join(bitcoreConfigPath, 'bitcore.config.json'))) {
throw new Error(`No bitcore config exists in directory ${bitcoreConfigPath}`);
}
bitcoreConfigPath = path.join(bitcoreConfigPath, 'bitcore.config.json');
}
logger.info('Using config at: ' + bitcoreConfigPath);

let rawBitcoreConfig;
try {
rawBitcoreConfig = fs.readFileSync(bitcoreConfigPath).toString();
} catch (error) {
throw new Error(`Error in loading bitcore config\nFound file at ${bitcoreConfigPath}\n${error}`);
}
return foundConfig;

let bitcoreConfig;
try {
bitcoreConfig = JSON.parse(rawBitcoreConfig).bitcoreNode;
} catch (error) {
throw new Error(`Error in parsing bitcore config\nFound and loaded file at ${bitcoreConfigPath}\n${error}`);
}

return bitcoreConfig;
}

function setTrustedPeers(config: ConfigType): ConfigType {
Expand Down Expand Up @@ -95,8 +105,7 @@ const Config = function(): ConfigType {
}
};

const foundConfig = findConfig();
config = merge(config, foundConfig);
config = merge(config, findConfig());
if (!Object.keys(config.chains).length) {
Object.assign(config.chains, {
BTC: {
Expand All @@ -120,4 +129,4 @@ const Config = function(): ConfigType {
return config;
};

export default Config();
export default Config();