Skip to content

Commit

Permalink
[Branding] bitcoin -> navcoin
Browse files Browse the repository at this point in the history
  • Loading branch information
mxaddict committed Feb 16, 2024
1 parent 7363041 commit 4864047
Show file tree
Hide file tree
Showing 19 changed files with 59 additions and 59 deletions.
4 changes: 2 additions & 2 deletions contrib/devtools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ options, as all its configuration is set at the top of the file. It runs many ti
pypy3 contrib/devtools/headerssync-params.py
```

gen-bitcoin-conf.sh
gen-navcoin-conf.sh
===================

Generates a navcoin.conf file in `share/examples/` by parsing the output from `navcoind --help`. This script is run during the
Expand All @@ -112,7 +112,7 @@ repository. To use this tool with out-of-tree builds set `BUILDDIR`. For
example:

```bash
BUILDDIR=$PWD/build contrib/devtools/gen-bitcoin-conf.sh
BUILDDIR=$PWD/build contrib/devtools/gen-navcoin-conf.sh
```

security-check.py and test-security-check.py
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ BUILDDIR=${BUILDDIR:-$TOPDIR}
BINDIR=${BINDIR:-$BUILDDIR/src}
BITCOIND=${BITCOIND:-$BINDIR/navcoind}
SHARE_EXAMPLES_DIR=${SHARE_EXAMPLES_DIR:-$TOPDIR/share/examples}
EXAMPLE_CONF_FILE=${EXAMPLE_CONF_FILE:-$SHARE_EXAMPLES_DIR/bitcoin.conf}
EXAMPLE_CONF_FILE=${EXAMPLE_CONF_FILE:-$SHARE_EXAMPLES_DIR/navcoin.conf}

[ ! -x "$BITCOIND" ] && echo "$BITCOIND not found or not executable." && exit 1

Expand All @@ -22,19 +22,19 @@ fi
if [ -n "$DIRTY" ]
then
echo -e "WARNING: $BITCOIND was built from a dirty tree.\n"
echo -e "To safely generate a bitcoin.conf file, please commit your changes to $BITCOIND, rebuild, then run this script again.\n"
echo -e "To safely generate a navcoin.conf file, please commit your changes to $BITCOIND, rebuild, then run this script again.\n"
fi

echo 'Generating example bitcoin.conf file in share/examples/'
echo 'Generating example navcoin.conf file in share/examples/'

# create the directory, if it doesn't exist
mkdir -p "${SHARE_EXAMPLES_DIR}"

# create the header text
cat > "${EXAMPLE_CONF_FILE}" << 'EOF'
##
## bitcoin.conf configuration file.
## Generated by contrib/devtools/gen-bitcoin-conf.sh.
## navcoin.conf configuration file.
## Generated by contrib/devtools/gen-navcoin-conf.sh.
##
## Lines beginning with # are comments.
## All possible configuration options are provided. To use, copy this file
Expand Down
4 changes: 2 additions & 2 deletions contrib/guix/libexec/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -354,9 +354,9 @@ mkdir -p "$DISTSRC"
;;
esac

# copy over the example bitcoin.conf file. if contrib/devtools/gen-bitcoin-conf.sh
# copy over the example navcoin.conf file. if contrib/devtools/gen-navcoin-conf.sh
# has not been run before buildling, this file will be a stub
cp "${DISTSRC}/share/examples/bitcoin.conf" "${DISTNAME}/"
cp "${DISTSRC}/share/examples/navcoin.conf" "${DISTNAME}/"

cp -r "${DISTSRC}/share/rpcauth" "${DISTNAME}/share/"

Expand Down
2 changes: 1 addition & 1 deletion contrib/init/navcoind.conf
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ env BITCOIND_GROUP="bitcoin"
env BITCOIND_PIDDIR="/var/run/navcoind"
# upstart can't handle variables constructed with other variables
env BITCOIND_PIDFILE="/var/run/navcoind/navcoind.pid"
env BITCOIND_CONFIGFILE="/etc/bitcoin/bitcoin.conf"
env BITCOIND_CONFIGFILE="/etc/navcoin/navcoin.conf"
env BITCOIND_DATADIR="/var/lib/navcoind"

expect fork
Expand Down
2 changes: 1 addition & 1 deletion contrib/init/navcoind.openrc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ else
BITCOIND_DEFAULT_DATADIR="/var/lib/navcoind"
fi

BITCOIND_CONFIGFILE=${BITCOIND_CONFIGFILE:-/etc/bitcoin/bitcoin.conf}
BITCOIND_CONFIGFILE=${BITCOIND_CONFIGFILE:-/etc/navcoin/navcoin.conf}
BITCOIND_PIDDIR=${BITCOIND_PIDDIR:-/var/run/navcoind}
BITCOIND_PIDFILE=${BITCOIND_PIDFILE:-${BITCOIND_PIDDIR}/navcoind.pid}
BITCOIND_DATADIR=${BITCOIND_DATADIR:-${BITCOIND_DEFAULT_DATADIR}}
Expand Down
2 changes: 1 addition & 1 deletion contrib/init/navcoind.openrcconf
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# /etc/conf.d/navcoind: config file for /etc/init.d/navcoind

# Config file location
#BITCOIND_CONFIGFILE="/etc/bitcoin/bitcoin.conf"
#BITCOIND_CONFIGFILE="/etc/navcoin/navcoin.conf"

# What directory to write pidfile to? (created and owned by $BITCOIND_USER)
#BITCOIND_PIDDIR="/var/run/navcoind"
Expand Down
4 changes: 2 additions & 2 deletions contrib/init/navcoind.service
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# See "man systemd.service" for details.

# Note that almost all daemon options could be specified in
# /etc/bitcoin/bitcoin.conf, but keep in mind those explicitly
# /etc/navcoin/navcoin.conf, but keep in mind those explicitly
# specified as arguments in ExecStart= will override those in the
# config file.

Expand All @@ -19,7 +19,7 @@ Wants=network-online.target

[Service]
ExecStart=/usr/bin/navcoind -pid=/run/navcoind/navcoind.pid \
-conf=/etc/bitcoin/bitcoin.conf \
-conf=/etc/navcoin/navcoin.conf \
-datadir=/var/lib/navcoind \
-startupnotify='systemd-notify --ready' \
-shutdownnotify='systemd-notify --stopping'
Expand Down
2 changes: 1 addition & 1 deletion doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The Bitcoin repo's [root README](/README.md) contains relevant information on th

### Miscellaneous
- [Assets Attribution](assets-attribution.md)
- [bitcoin.conf Configuration File](bitcoin-conf.md)
- [navcoin.conf Configuration File](bitcoin-conf.md)
- [CJDNS Support](cjdns.md)
- [Files](files.md)
- [Fuzz-testing](fuzzing.md)
Expand Down
4 changes: 2 additions & 2 deletions doc/build-osx.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,9 +248,9 @@ Before running, you may create an empty configuration file:
```shell
mkdir -p "/Users/${USER}/Library/Application Support/Bitcoin"

touch "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
touch "/Users/${USER}/Library/Application Support/Bitcoin/navcoin.conf"

chmod 600 "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
chmod 600 "/Users/${USER}/Library/Application Support/Bitcoin/navcoin.conf"
```

You can monitor the download process by looking at the debug.log file:
Expand Down
6 changes: 3 additions & 3 deletions doc/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Windows | `%APPDATA%\Bitcoin\` <sup>[\[1\]](#note1)</sup>

2. A custom data directory path can be specified with the `-datadir` option.

3. All content of the data directory, except for `bitcoin.conf` file, is chain-specific. This means the actual data directory paths for non-mainnet cases differ:
3. All content of the data directory, except for `navcoin.conf` file, is chain-specific. This means the actual data directory paths for non-mainnet cases differ:

Chain option | Data directory path
-------------------------------|------------------------------
Expand All @@ -57,7 +57,7 @@ Subdirectory | File(s) | Description
`wallets/` | | [Contains wallets](#multi-wallet-environment); can be specified by `-walletdir` option; if `wallets/` subdirectory does not exist, wallets reside in the [data directory](#data-directory-location)
`./` | `anchors.dat` | Anchor IP address database, created on shutdown and deleted at startup. Anchors are last known outgoing block-relay-only peers that are tried to re-connect to on startup
`./` | `banlist.json` | Stores the addresses/subnets of banned nodes.
`./` | `bitcoin.conf` | User-defined [configuration settings](bitcoin-conf.md) for `navcoind` or `navcoin-qt`. File is not written to by the software and must be created manually. Path can be specified by `-conf` option
`./` | `navcoin.conf` | User-defined [configuration settings](bitcoin-conf.md) for `navcoind` or `navcoin-qt`. File is not written to by the software and must be created manually. Path can be specified by `-conf` option
`./` | `navcoind.pid` | Stores the process ID (PID) of `navcoind` or `navcoin-qt` while running; created at start and deleted on shutdown; can be specified by `-pid` option
`./` | `debug.log` | Contains debug information and general logging generated by `navcoind` or `navcoin-qt`; can be specified by `-debuglogfile` option
`./` | `fee_estimates.dat` | Stores statistics used to estimate minimum transaction fees required for confirmation
Expand All @@ -67,7 +67,7 @@ Subdirectory | File(s) | Description
`./` | `onion_v3_private_key` | Cached Tor onion service private key for `-listenonion` option
`./` | `i2p_private_key` | Private key that corresponds to our I2P address. When `-i2psam=` is specified the contents of this file is used to identify ourselves for making outgoing connections to I2P peers and possibly accepting incoming ones. Automatically generated if it does not exist.
`./` | `peers.dat` | Peer IP address database (custom format)
`./` | `settings.json` | Read-write settings set through GUI or RPC interfaces, augmenting manual settings from [bitcoin.conf](bitcoin-conf.md). File is created automatically if read-write settings storage is not disabled with `-nosettings` option. Path can be specified with `-settings` option
`./` | `settings.json` | Read-write settings set through GUI or RPC interfaces, augmenting manual settings from [navcoin.conf](bitcoin-conf.md). File is created automatically if read-write settings storage is not disabled with `-nosettings` option. Path can be specified with `-settings` option
`./` | `.cookie` | Session RPC authentication cookie; if used, created at start and deleted on shutdown; can be specified by `-rpccookiefile` option
`./` | `.lock` | Data directory lock file

Expand Down
12 changes: 6 additions & 6 deletions doc/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Configuration
---------------------------------

Running navcoind as a daemon does not require any manual configuration. You may
set the `rpcauth` setting in the `bitcoin.conf` configuration file to override
set the `rpcauth` setting in the `navcoin.conf` configuration file to override
the default behaviour of using a special cookie for authentication.

This password does not have to be remembered or typed as it is mostly used
Expand All @@ -44,7 +44,7 @@ This allows for running navcoind without having to do any manual configuration.
relative to the data directory. `wallet` *only* supports relative paths.

For an example configuration file that describes the configuration settings,
see `share/examples/bitcoin.conf`.
see `share/examples/navcoin.conf`.

Paths
---------------------------------
Expand All @@ -54,7 +54,7 @@ Paths
All three configurations assume several paths that might need to be adjusted.

Binary: /usr/bin/navcoind
Configuration file: /etc/bitcoin/bitcoin.conf
Configuration file: /etc/navcoin/navcoin.conf
Data directory: /var/lib/navcoind
PID file: /var/run/navcoind/navcoind.pid (OpenRC and Upstart) or
/run/navcoind/navcoind.pid (systemd)
Expand All @@ -74,18 +74,18 @@ bitcoin group to do so. This does not allow
for the listing of files under the directory.

NOTE: It is not currently possible to override `datadir` in
`/etc/bitcoin/bitcoin.conf` with the current systemd, OpenRC, and Upstart init
`/etc/navcoin/navcoin.conf` with the current systemd, OpenRC, and Upstart init
files out-of-the-box. This is because the command line options specified in the
init files take precedence over the configurations in
`/etc/bitcoin/bitcoin.conf`. However, some init systems have their own
`/etc/navcoin/navcoin.conf`. However, some init systems have their own
configuration mechanisms that would allow for overriding the command line
options specified in the init files (e.g. setting `BITCOIND_DATADIR` for
OpenRC).

### macOS

Binary: /usr/local/bin/navcoind
Configuration file: ~/Library/Application Support/Bitcoin/bitcoin.conf
Configuration file: ~/Library/Application Support/Bitcoin/navcoin.conf
Data directory: ~/Library/Application Support/Bitcoin
Lock file: ~/Library/Application Support/Bitcoin/.lock

Expand Down
18 changes: 9 additions & 9 deletions doc/bitcoin-conf.md → doc/navcoin-conf.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `bitcoin.conf` Configuration File
# `navcoin.conf` Configuration File

The configuration file is used by `navcoind`, `navcoin-qt` and `navcoin-cli`.

Expand Down Expand Up @@ -51,24 +51,24 @@ rpcport=4000

## Configuration File Path

The configuration file is not automatically created; you can create it using your favorite text editor. By default, the configuration file name is `bitcoin.conf` and it is located in the Bitcoin data directory, but both the Bitcoin data directory and the configuration file path may be changed using the `-datadir` and `-conf` command-line options.
The configuration file is not automatically created; you can create it using your favorite text editor. By default, the configuration file name is `navcoin.conf` and it is located in the Bitcoin data directory, but both the Bitcoin data directory and the configuration file path may be changed using the `-datadir` and `-conf` command-line options.

The `includeconf=<file>` option in the `bitcoin.conf` file can be used to include additional configuration files.
The `includeconf=<file>` option in the `navcoin.conf` file can be used to include additional configuration files.

### Default configuration file locations

Operating System | Data Directory | Example Path
-- | -- | --
Windows | `%APPDATA%\Bitcoin\` | `C:\Users\username\AppData\Roaming\Bitcoin\bitcoin.conf`
Linux | `$HOME/.bitcoin/` | `/home/username/.bitcoin/bitcoin.conf`
macOS | `$HOME/Library/Application Support/Bitcoin/` | `/Users/username/Library/Application Support/Bitcoin/bitcoin.conf`
Windows | `%APPDATA%\Bitcoin\` | `C:\Users\username\AppData\Roaming\Bitcoin\navcoin.conf`
Linux | `$HOME/.bitcoin/` | `/home/username/.navcoin/navcoin.conf`
macOS | `$HOME/Library/Application Support/Bitcoin/` | `/Users/username/Library/Application Support/Bitcoin/navcoin.conf`

An example configuration file can be generated by [contrib/devtools/gen-bitcoin-conf.sh](../contrib/devtools/gen-bitcoin-conf.sh).
An example configuration file can be generated by [contrib/devtools/gen-navcoin-conf.sh](../contrib/devtools/gen-navcoin-conf.sh).
Run this script after compiling to generate an up-to-date configuration file.
The output is placed under `share/examples/bitcoin.conf`.
The output is placed under `share/examples/navcoin.conf`.
To use the generated configuration file, copy the example file into your data directory and edit it there, like so:

```
# example copy command for linux user
cp share/examples/bitcoin.conf ~/.bitcoin
cp share/examples/navcoin.conf ~/.bitcoin
```
2 changes: 1 addition & 1 deletion doc/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Release Process
* Update translations see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#synchronising-translations).
* Update release candidate version in `configure.ac` (`CLIENT_VERSION_RC`).
* Update manpages (after rebuilding the binaries), see [gen-manpages.py](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/README.md#gen-manpagespy).
* Update bitcoin.conf and commit, see [gen-bitcoin-conf.sh](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/README.md#gen-bitcoin-confsh).
* Update navcoin.conf and commit, see [gen-navcoin-conf.sh](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/README.md#gen-navcoin-confsh).

### Before every major and minor release

Expand Down
2 changes: 1 addition & 1 deletion doc/zmq.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ For instance:
Each PUB notification has a topic and body, where the header
corresponds to the notification type. For instance, for the
notification `-zmqpubhashtx` the topic is `hashtx` (no null
terminator). These options can also be provided in bitcoin.conf.
terminator). These options can also be provided in navcoin.conf.

The topics are:

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# This is a placeholder file. Please follow the instructions in `contrib/devtools/README.md` to generate a bitcoin.conf file.
# This is a placeholder file. Please follow the instructions in `contrib/devtools/README.md` to generate a navcoin.conf file.
4 changes: 2 additions & 2 deletions src/common/init.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ std::optional<ConfigError> InitConfig(ArgsManager& args, SettingsAbortFn setting
// possible for the config file to cause another configuration to be
// used, though. Specifying a conf= option in the config file causes a
// parse error, and specifying a datadir= location containing another
// bitcoin.conf file just ignores the other file.)
// navcoin.conf file just ignores the other file.)
const fs::path orig_datadir_path{args.GetDataDirBase()};
const fs::path orig_config_path{AbsPathForConfigVal(args, args.GetPathArg("-conf", BITCOIN_CONF_FILENAME), /*net_specific=*/false)};

Expand Down Expand Up @@ -62,7 +62,7 @@ std::optional<ConfigError> InitConfig(ArgsManager& args, SettingsAbortFn setting
fs::create_directories(net_path / "wallets");
}

// Show an error or warning if there is a bitcoin.conf file in the
// Show an error or warning if there is a navcoin.conf file in the
// datadir that is being ignored.
const fs::path base_config_path = base_path / BITCOIN_CONF_FILENAME;
if (fs::exists(base_config_path) && !fs::equivalent(orig_config_path, base_config_path)) {
Expand Down
2 changes: 1 addition & 1 deletion src/interfaces/node.h
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ class Node
//! would be ignored because it is also specified in the command line.
virtual bool isSettingIgnored(const std::string& name) = 0;

//! Return setting value from <datadir>/settings.json or bitcoin.conf.
//! Return setting value from <datadir>/settings.json or navcoin.conf.
virtual common::SettingsValue getPersistentSetting(const std::string& name) = 0;

//! Update a setting in <datadir>/settings.json.
Expand Down
2 changes: 1 addition & 1 deletion src/test/getarg_tests.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ BOOST_AUTO_TEST_CASE(patharg)
// Check negated and default argument handling. Specifying an empty argument
// is the same as not specifying the argument. This is convenient for
// scripting so later command line arguments can override earlier command
// line arguments or bitcoin.conf values. Currently the -dir= case cannot be
// line arguments or navcoin.conf values. Currently the -dir= case cannot be
// distinguished from -dir case with no assignment, but #16545 would add the
// ability to distinguish these in the future (and treat the no-assign case
// like an imperative command or an error).
Expand Down
Loading

0 comments on commit 4864047

Please sign in to comment.