From 280703b9d931dae081bc4f823e09990ab2040260 Mon Sep 17 00:00:00 2001 From: Adrian Gallagher Date: Sun, 12 May 2019 18:19:39 -0700 Subject: [PATCH] Litecoin: More branding --- .github/PULL_REQUEST_TEMPLATE.md | 6 +-- build_msvc/README.md | 10 ++--- .../test_bitcoin-qt/test_bitcoin-qt.vcxproj | 2 +- build_msvc/test_bitcoin/test_bitcoin.vcxproj | 2 +- doc/JSON-RPC-interface.md | 38 +++++++++---------- doc/release-process.md | 32 ---------------- src/bitcoin-cli.cpp | 2 +- src/init.cpp | 2 +- src/qt/macos_appnap.mm | 2 +- src/qt/test/addressbooktests.cpp | 2 +- src/qt/test/apptests.cpp | 2 +- src/wallet/rpcwallet.cpp | 2 +- test/functional/rpc_net.py | 4 +- .../test_framework/test_framework.py | 6 +-- 14 files changed, 40 insertions(+), 72 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 00d5478c4e..9489936958 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,7 +2,7 @@ Pull requests without a rationale and clear improvement may be closed immediately. Please provide clear motivation for your patch and explain how it improves -Bitcoin Core user experience or Bitcoin Core developer experience +Litecoin Core user experience or Litecoin Core developer experience significantly. * Any test improvements or new tests that improve coverage are always welcome. @@ -15,7 +15,7 @@ significantly. was fixed. * Features are welcome, but might be rejected due to design or scope issues. If a feature is based on a lot of dependencies, contributors should first - consider building the system outside of Bitcoin Core, if possible. + consider building the system outside of Litecoin Core, if possible. * Refactoring changes are only accepted if they are required for a feature or bug fix or otherwise improve developer experience significantly. For example, most "code style" refactoring changes require a thorough explanation why they @@ -25,7 +25,7 @@ significantly. preferred in the [developer notes](/doc/developer-notes.md), stylistic code changes are usually rejected. -Bitcoin Core has a thorough review process and even the most trivial change +Litecoin Core has a thorough review process and even the most trivial change needs to pass a lot of eyes and requires non-zero or even substantial time effort to review. There is a huge lack of active reviewers on the project, so patches often sit for a long time. diff --git a/build_msvc/README.md b/build_msvc/README.md index 63c5babf35..a6e97f7665 100644 --- a/build_msvc/README.md +++ b/build_msvc/README.md @@ -1,15 +1,15 @@ -Building Bitcoin Core with Visual Studio +Building Litecoin Core with Visual Studio ======================================== Introduction --------------------- -Solution and project files to build the Bitcoin Core applications (except Qt dependent ones) with Visual Studio 2017 can be found in the build_msvc directory. +Solution and project files to build the Litecoin Core applications (except Qt dependent ones) with Visual Studio 2017 can be found in the build_msvc directory. -Building with Visual Studio is an alternative to the Linux based [cross-compiler build](https://github.com/bitcoin/bitcoin/blob/master/doc/build-windows.md). +Building with Visual Studio is an alternative to the Linux based [cross-compiler build](https://github.com/litecoin-project/litecoin/blob/master/doc/build-windows.md). Dependencies --------------------- -A number of [open source libraries](https://github.com/bitcoin/bitcoin/blob/master/doc/dependencies.md) are required in order to be able to build Bitcoin. +A number of [open source libraries](https://github.com/litecoin-project/litecoin/blob/master/doc/dependencies.md) are required in order to be able to build Litecoin. Options for installing the dependencies in a Visual Studio compatible manner are: @@ -17,7 +17,7 @@ Options for installing the dependencies in a Visual Studio compatible manner are - Download the source code, build each dependency, add the required include paths, link libraries and binary tools to the Visual Studio project files. - Use [nuget](https://www.nuget.org/) packages with the understanding that any binary files have been compiled by an untrusted third party. -The external dependencies required for the Visual Studio build are (see the [dependencies doc](https://github.com/bitcoin/bitcoin/blob/master/doc/dependencies.md) for versions): +The external dependencies required for the Visual Studio build are (see the [dependencies doc](https://github.com/litecoin-project/litecoin/blob/master/doc/dependencies.md) for versions): - Berkeley DB, - OpenSSL, diff --git a/build_msvc/test_bitcoin-qt/test_bitcoin-qt.vcxproj b/build_msvc/test_bitcoin-qt/test_bitcoin-qt.vcxproj index a5d666c114..60b0aa97e2 100644 --- a/build_msvc/test_bitcoin-qt/test_bitcoin-qt.vcxproj +++ b/build_msvc/test_bitcoin-qt/test_bitcoin-qt.vcxproj @@ -23,7 +23,7 @@ 15.0 {51201D5E-D939-4854-AE9D-008F03FF518E} Win32Proj - test_bitcoinqt + test_litecoinqt diff --git a/build_msvc/test_bitcoin/test_bitcoin.vcxproj b/build_msvc/test_bitcoin/test_bitcoin.vcxproj index d05a03699f..d8e3949ef7 100644 --- a/build_msvc/test_bitcoin/test_bitcoin.vcxproj +++ b/build_msvc/test_bitcoin/test_bitcoin.vcxproj @@ -67,7 +67,7 @@ 15.0 {A56B73DB-D46D-4882-8374-1FE3FFA08F07} Win32Proj - test_bitcoin + test_litecoin x86-windows-static x64-windows-static diff --git a/doc/JSON-RPC-interface.md b/doc/JSON-RPC-interface.md index a0cfe84a3e..9d46647650 100644 --- a/doc/JSON-RPC-interface.md +++ b/doc/JSON-RPC-interface.md @@ -1,13 +1,13 @@ # JSON-RPC Interface -The headless daemon `bitcoind` has the JSON-RPC API enabled by default, the GUI -`bitcoin-qt` has it disabled by default. This can be changed with the `-server` +The headless daemon `litecoind` has the JSON-RPC API enabled by default, the GUI +`litecoin-qt` has it disabled by default. This can be changed with the `-server` option. In the GUI it is possible to execute RPC methods in the Debug Console Dialog. ## Versioning -The RPC interface might change from one major version of Bitcoin Core to the +The RPC interface might change from one major version of Litecoin Core to the next. This makes the RPC interface implicitly versioned on the major version. The version tuple can be retrieved by e.g. the `getnetworkinfo` RPC in `version`. @@ -19,21 +19,21 @@ were deprecated and how to re-enable them temporarily. ## Security -The RPC interface allows other programs to control Bitcoin Core, +The RPC interface allows other programs to control Litecoin Core, including the ability to spend funds from your wallets, affect consensus verification, read private data, and otherwise perform operations that can cause loss of money, data, or privacy. This section suggests how -you should use and configure Bitcoin Core to reduce the risk that its +you should use and configure Litecoin Core to reduce the risk that its RPC interface will be abused. - **Securing the executable:** Anyone with physical or remote access to - the computer, container, or virtual machine running Bitcoin Core can + the computer, container, or virtual machine running Litecoin Core can compromise either the whole program or just the RPC interface. This includes being able to record any passphrases you enter for unlocking - your encrypted wallets or changing settings so that your Bitcoin Core + your encrypted wallets or changing settings so that your Litecoin Core program tells you that certain transactions have multiple confirmations even when they aren't part of the best block chain. For - this reason, you should not use Bitcoin Core for security sensitive + this reason, you should not use Litecoin Core for security sensitive operations on systems you do not exclusively control, such as shared computers or virtual private servers. @@ -43,43 +43,43 @@ RPC interface will be abused. and passphrase). Any program on your computer with access to the file system and local network can obtain this level of access. Additionally, other programs on your computer can attempt to provide - an RPC interface on the same port as used by Bitcoin Core in order to + an RPC interface on the same port as used by Litecoin Core in order to trick you into revealing your authentication credentials. For this - reason, it is important to only use Bitcoin Core for + reason, it is important to only use Litecoin Core for security-sensitive operations on a computer whose other programs you trust. - **Securing remote network access:** You may optionally allow other - computers to remotely control Bitcoin Core by setting the `rpcallowip` + computers to remotely control Litecoin Core by setting the `rpcallowip` and `rpcbind` configuration parameters. These settings are only meant for enabling connections over secure private networks or connections that have been otherwise secured (e.g. using a VPN or port forwarding with SSH or stunnel). **Do not enable RPC connections over the public - Internet.** Although Bitcoin Core's RPC interface does use + Internet.** Although Litecoin Core's RPC interface does use authentication, it does not use encryption, so your login credentials are sent as clear text that can be read by anyone on your network path. Additionally, the RPC interface has not been hardened to withstand arbitrary Internet traffic, so changing the above settings to expose it to the Internet (even using something like a Tor hidden service) could expose you to unconsidered vulnerabilities. See - `bitcoind -help` for more information about these settings and other + `litecoind -help` for more information about these settings and other settings described in this document. - Related, if you use Bitcoin Core inside a Docker container, you may + Related, if you use Litecoin Core inside a Docker container, you may need to expose the RPC port to the host system. The default way to do this in Docker also exposes the port to the public Internet. Instead, expose it only on the host system's localhost, for example: - `-p 127.0.0.1:8332:8332` + `-p 127.0.0.1:9332:9332` -- **Secure authentication:** By default, Bitcoin Core generates unique +- **Secure authentication:** By default, Litecoin Core generates unique login credentials each time it restarts and puts them into a file - readable only by the user that started Bitcoin Core, allowing any of + readable only by the user that started Litecoin Core, allowing any of that user's RPC clients with read access to the file to login - automatically. The file is `.cookie` in the Bitcoin Core + automatically. The file is `.cookie` in the Litecoin Core configuration directory, and using these credentials is the preferred RPC authentication method. If you need to generate static login credentials for your programs, you can use the script in the - `share/rpcauth` directory in the Bitcoin Core source tree. As a final + `share/rpcauth` directory in the Litecoin Core source tree. As a final fallback, you can directly use manually-chosen `rpcuser` and `rpcpassword` configuration parameters---but you must ensure that you choose a strong and unique passphrase (and still don't use insecure diff --git a/doc/release-process.md b/doc/release-process.md index e84c24fa59..6893446dfa 100644 --- a/doc/release-process.md +++ b/doc/release-process.md @@ -274,38 +274,6 @@ Note: check that SHA256SUMS itself doesn't end up in SHA256SUMS, which is a spur - Update other repositories and websites for new version - - bitcoincore.org blog post - - - bitcoincore.org RPC documentation update - - - Update packaging repo - - - Notify BlueMatt so that he can start building [the PPAs](https://launchpad.net/~bitcoin/+archive/ubuntu/bitcoin) - - - Create a new branch for the major release "0.xx" (used to build the snap package) - - - Notify MarcoFalke so that he can start building the snap package - - - https://code.launchpad.net/~bitcoin-core/bitcoin-core-snap/+git/packaging (Click "Import Now" to fetch the branch) - - https://code.launchpad.net/~bitcoin-core/bitcoin-core-snap/+git/packaging/+ref/0.xx (Click "Create snap package") - - Name it "bitcoin-core-snap-0.xx" - - Leave owner and series as-is - - Select architectures that are compiled via gitian - - Leave "automatically build when branch changes" unticked - - Tick "automatically upload to store" - - Put "bitcoin-core" in the registered store package name field - - Tick the "edge" box - - Put "0.xx" in the track field - - Click "create snap package" - - Click "Request builds" for every new release on this branch (after updating the snapcraft.yml in the branch to reflect the latest gitian results) - - Promote release on https://snapcraft.io/bitcoin-core/releases if it passes sanity checks - - - This repo - - - Archive release notes for the new version to `doc/release-notes/` (branch `master` and branch of the release) - - - Create a [new GitHub release](https://github.com/bitcoin/bitcoin/releases/new) with a link to the archived release notes. - - Announce the release: - litecoin-dev mailing list diff --git a/src/bitcoin-cli.cpp b/src/bitcoin-cli.cpp index d337bdb777..8180524136 100644 --- a/src/bitcoin-cli.cpp +++ b/src/bitcoin-cli.cpp @@ -53,7 +53,7 @@ static void SetupCliArgs() gArgs.AddArg("-rpcport=", strprintf("Connect to JSON-RPC on (default: %u, testnet: %u, regtest: %u)", defaultBaseParams->RPCPort(), testnetBaseParams->RPCPort(), regtestBaseParams->RPCPort()), false, OptionsCategory::OPTIONS); gArgs.AddArg("-rpcuser=", "Username for JSON-RPC connections", false, OptionsCategory::OPTIONS); gArgs.AddArg("-rpcwait", "Wait for RPC server to start", false, OptionsCategory::OPTIONS); - gArgs.AddArg("-rpcwallet=", "Send RPC for non-default wallet on RPC server (needs to exactly match corresponding -wallet option passed to litecoind). This changes the RPC endpoint used, e.g. http://127.0.0.1:8332/wallet/", false, OptionsCategory::OPTIONS); + gArgs.AddArg("-rpcwallet=", "Send RPC for non-default wallet on RPC server (needs to exactly match corresponding -wallet option passed to litecoind). This changes the RPC endpoint used, e.g. http://127.0.0.1:9332/wallet/", false, OptionsCategory::OPTIONS); gArgs.AddArg("-stdin", "Read extra arguments from standard input, one per line until EOF/Ctrl-D (recommended for sensitive information such as passphrases). When combined with -stdinrpcpass, the first line from standard input is used for the RPC password.", false, OptionsCategory::OPTIONS); gArgs.AddArg("-stdinrpcpass", "Read RPC password from standard input as a single line. When combined with -stdin, the first line from standard input is used for the RPC password.", false, OptionsCategory::OPTIONS); } diff --git a/src/init.cpp b/src/init.cpp index 31772ffba9..7dfdd931a2 100644 --- a/src/init.cpp +++ b/src/init.cpp @@ -101,7 +101,7 @@ static const char* FEE_ESTIMATES_FILENAME="fee_estimates.dat"; /** * The PID file facilities. */ -static const char* BITCOIN_PID_FILENAME = "bitcoind.pid"; +static const char* BITCOIN_PID_FILENAME = "litecoind.pid"; static fs::path GetPidFile() { diff --git a/src/qt/macos_appnap.mm b/src/qt/macos_appnap.mm index 22a88782ab..ae560972a8 100644 --- a/src/qt/macos_appnap.mm +++ b/src/qt/macos_appnap.mm @@ -30,7 +30,7 @@ public: id processInfo = [NSProcessInfo processInfo]; if ([processInfo respondsToSelector:@selector(beginActivityWithOptions:reason:)]) { - activityId = [processInfo beginActivityWithOptions: activityOptions reason:@"Temporarily disable App Nap for bitcoin-qt."]; + activityId = [processInfo beginActivityWithOptions: activityOptions reason:@"Temporarily disable App Nap for litecoin-qt."]; [activityId retain]; } } diff --git a/src/qt/test/addressbooktests.cpp b/src/qt/test/addressbooktests.cpp index 7f5e92ea9f..2bb8824a39 100644 --- a/src/qt/test/addressbooktests.cpp +++ b/src/qt/test/addressbooktests.cpp @@ -149,7 +149,7 @@ void AddressBookTests::addressBookTests() // and fails to handle returned nulls // (https://bugreports.qt.io/browse/QTBUG-49686). QWARN("Skipping AddressBookTests on mac build with 'minimal' platform set due to Qt bugs. To run AppTests, invoke " - "with 'test_bitcoin-qt -platform cocoa' on mac, or else use a linux or windows build."); + "with 'test_litecoin-qt -platform cocoa' on mac, or else use a linux or windows build."); return; } #endif diff --git a/src/qt/test/apptests.cpp b/src/qt/test/apptests.cpp index da25d83175..c7cff5780a 100644 --- a/src/qt/test/apptests.cpp +++ b/src/qt/test/apptests.cpp @@ -61,7 +61,7 @@ void AppTests::appTests() // and fails to handle returned nulls // (https://bugreports.qt.io/browse/QTBUG-49686). QWARN("Skipping AppTests on mac build with 'minimal' platform set due to Qt bugs. To run AppTests, invoke " - "with 'test_bitcoin-qt -platform cocoa' on mac, or else use a linux or windows build."); + "with 'test_litecoin-qt -platform cocoa' on mac, or else use a linux or windows build."); return; } #endif diff --git a/src/wallet/rpcwallet.cpp b/src/wallet/rpcwallet.cpp index ee8e5a0fc1..6521e7d4d0 100644 --- a/src/wallet/rpcwallet.cpp +++ b/src/wallet/rpcwallet.cpp @@ -279,7 +279,7 @@ static UniValue setlabel(const JSONRPCRequest& request) RPCHelpMan{"setlabel", "\nSets the label associated with the given address.\n", { - {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address to be associated with a label."}, + {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The litecoin address to be associated with a label."}, {"label", RPCArg::Type::STR, RPCArg::Optional::NO, "The label to assign to the address."}, }, RPCResults{}, diff --git a/test/functional/rpc_net.py b/test/functional/rpc_net.py index b12eb1d9ec..83d95dabc6 100755 --- a/test/functional/rpc_net.py +++ b/test/functional/rpc_net.py @@ -118,7 +118,7 @@ class NetTest(BitcoinTestFramework): addr.time = 100000000 addr.nServices = NODE_NETWORK | NODE_WITNESS addr.ip = a - addr.port = 8333 + addr.port = 9333 msg.addrs.append(addr) self.nodes[0].p2p.send_and_ping(msg) @@ -130,7 +130,7 @@ class NetTest(BitcoinTestFramework): assert_greater_than(a["time"], 1527811200) # 1st June 2018 assert_equal(a["services"], NODE_NETWORK | NODE_WITNESS) assert a["address"] in imported_addrs - assert_equal(a["port"], 8333) + assert_equal(a["port"], 9333) assert_raises_rpc_error(-8, "Address count out of range", self.nodes[0].getnodeaddresses, -1) diff --git a/test/functional/test_framework/test_framework.py b/test/functional/test_framework/test_framework.py index 579dfd8c84..4ad25606c9 100755 --- a/test/functional/test_framework/test_framework.py +++ b/test/functional/test_framework/test_framework.py @@ -126,7 +126,7 @@ class BitcoinTestFramework(metaclass=BitcoinTestMetaClass): parser.add_argument("--pdbonfailure", dest="pdbonfailure", default=False, action="store_true", help="Attach a python debugger if test fails") parser.add_argument("--usecli", dest="usecli", default=False, action="store_true", - help="use bitcoin-cli instead of RPC for all commands") + help="use litecoin-cli instead of RPC for all commands") parser.add_argument("--perf", dest="perf", default=False, action="store_true", help="profile running nodes with perf for the duration of the test") self.add_options(parser) @@ -539,7 +539,7 @@ class BitcoinTestFramework(metaclass=BitcoinTestMetaClass): def skip_if_no_bitcoind_zmq(self): """Skip the running test if bitcoind has not been compiled with zmq support.""" if not self.is_zmq_compiled(): - raise SkipTest("bitcoind has not been built with zmq enabled.") + raise SkipTest("litecoind has not been built with zmq enabled.") def skip_if_no_wallet(self): """Skip the running test if wallet has not been compiled.""" @@ -549,7 +549,7 @@ class BitcoinTestFramework(metaclass=BitcoinTestMetaClass): def skip_if_no_cli(self): """Skip the running test if bitcoin-cli has not been compiled.""" if not self.is_cli_compiled(): - raise SkipTest("bitcoin-cli has not been compiled.") + raise SkipTest("litecoin-cli has not been compiled.") def is_cli_compiled(self): """Checks whether bitcoin-cli was compiled."""