mirror of https://github.com/dashpay/dash.git synced 2024-12-24 11:32:46 +01:00

Dash - Reinventing Cryptocurrency

bitcoin blockchain cryptocurrency dash governance instant masternode p2p privacy

Go to file

pasta eb88589ea7 Merge #6428 : backport: merge bitcoin#24778, #24766 , #24849 , #24844 , #24853 , #24895 , #24802 , #24932 , partial bitcoin#23212, #23462 (lint backports) `852f55e23c` merge bitcoin#24932: Convert lint-locale-dependence.sh to Python (Kittywhiskers Van Gogh) `f745b7f7ef` merge bitcoin#24802: convert format strings linter test to python (Kittywhiskers Van Gogh) `a0b051b4ef` partial revert dash#4807: enable more multi-threading and caching in linters (Kittywhiskers Van Gogh) `7864c21645` merge bitcoin#24895: Convert lint-includes.sh to Python (Kittywhiskers Van Gogh) `f63bafe253` merge bitcoin#24853: Convert lint-git-commit-check.sh to Python (Kittywhiskers Van Gogh) `d463d7d397` fix: clone full history on GitHub Actions build job, track `develop` (Kittywhiskers Van Gogh) `d23b6614e8` merge bitcoin#24844: Convert lint-whitespace.sh to Python (Kittywhiskers Van Gogh) `fe165168ba` merge bitcoin#24849: Convert lint-logs.sh to Python (Kittywhiskers Van Gogh) `dbfd0b04e1` merge bitcoin#24766: convert spellchecking lint test to python (Kittywhiskers Van Gogh) `5c23addddd` merge bitcoin#24778: Convert Python dead code linter test to Python (Kittywhiskers Van Gogh) `829dcfb936` partial bitcoin#23462: Enable SC2046 and SC2086 shellcheck rules (Kittywhiskers Van Gogh) `df6be0e8c0` partial bitcoin#23212: enable mypy import checking (Kittywhiskers Van Gogh) `f77eca9256` fix: make sure that parallelized `lint-all` runs incl. python scripts (Kittywhiskers Van Gogh) `e220175d0f` merge bitcoin#22861: Update test README and lint script (Kittywhiskers Van Gogh) Pull request description: ## Additional Information * Dependency for https://github.com/dashpay/dash/pull/6429 * Even though support for Python scripts was extended to `lint-all` in [bitcoin#24762](`f226e8dc1f`) ([dash#6023](https://github.com/dashpay/dash/pull/6023)), the changes needed were not extended to parallelized linting added in [dash#4637](https://github.com/dashpay/dash/pull/4637). This meant the match expression didn't include non-shell scripts and additionally, `parallel` interpreted all scripts as Bash scripts. This has been resolved in this PR. * [bitcoin#23212](https://github.com/bitcoin/bitcoin/pull/23212) is partial as `--ignore-missing-imports` has not been removed from `mypy` arguments as the version of `mypy` used in the PR (0.910) isn't syntax aware to `imports` like [here](`f9d044d5ec/test/functional/test_framework/crypto/bip324_cipher.py (L16-L17)`) and [here](`f9d044d5ec/test/functional/test_framework/crypto/muhash.py (L9)`). <details> <summary>Lint errors:</summary> ``` dash@96b217d539f7:/src/dash$ ./test/lint/lint-python.sh Consider install flake8-cached for cached flake8 results. [...] test/functional/test_framework/crypto/muhash.py:9: error: Skipping analyzing ".chacha20": found module but no type hints or library stubs [import] test/functional/test_framework/crypto/ellswift.py:15: error: Cannot find implementation or library stub for module named "test_framework.crypto.secp256k1" [import] test/functional/test_framework/crypto/bip324_cipher.py:16: error: Skipping analyzing ".chacha20": found module but no type hints or library stubs [import] test/functional/test_framework/crypto/bip324_cipher.py:17: error: Skipping analyzing ".poly1305": found module but no type hints or library stubs [import] test/functional/test_framework/messages.py:29: error: Cannot find implementation or library stub for module named "test_framework.crypto.siphash" [import] test/functional/test_framework/messages.py:32: error: Cannot find implementation or library stub for module named "dash_hash" [import] test/functional/test_framework/script.py:20: error: Cannot find implementation or library stub for module named "test_framework.crypto.ripemd160" [import] test/functional/test_framework/key.py:16: error: Cannot find implementation or library stub for module named "test_framework.crypto" [import] test/functional/test_framework/v2_p2p.py:9: error: Cannot find implementation or library stub for module named "test_framework.crypto.bip324_cipher" [import] test/functional/test_framework/v2_p2p.py:10: error: Cannot find implementation or library stub for module named "test_framework.crypto.chacha20" [import] test/functional/test_framework/v2_p2p.py:11: error: Cannot find implementation or library stub for module named "test_framework.crypto.ellswift" [import] test/functional/test_framework/v2_p2p.py:12: error: Cannot find implementation or library stub for module named "test_framework.crypto.hkdf" [import] test/functional/p2p_v2_encrypted.py:22: error: Cannot find implementation or library stub for module named "test_framework.crypto.chacha20" [import] test/functional/feature_utxo_set_hash.py:12: error: Cannot find implementation or library stub for module named "test_framework.crypto.muhash" [import] Found 17 errors in 12 files (checked 275 source files) ``` </details> And upgrading to the latest version of `mypy` used upstream (1.4.1, [source](`f7144b24be/ci/lint/04_install.sh (L52)`)) brings syntax awareness but new errors. <details> <summary>Lint errors:</summary> ``` dash@96b217d539f7:/src/dash$ ./test/lint/lint-python.sh Consider install flake8-cached for cached flake8 results. [...] test/functional/test_framework/coverage.py:23: error: Incompatible default for argument "coverage_logfile" (default has type "None", argument has type "str") [assignment] test/functional/test_framework/coverage.py:23: note: PEP 484 prohibits implicit Optional. Accordingly, mypy has changed its default to no_implicit_optional=True test/functional/test_framework/coverage.py:23: note: Use https://github.com/hauntsaninja/no_implicit_optional to automatically upgrade your codebase test/functional/test_framework/util.py:322: error: Incompatible default for argument "timeout" (default has type "None", argument has type "int") [assignment] test/functional/test_framework/util.py:322: note: PEP 484 prohibits implicit Optional. Accordingly, mypy has changed its default to no_implicit_optional=True test/functional/test_framework/util.py:322: note: Use https://github.com/hauntsaninja/no_implicit_optional to automatically upgrade your codebase test/functional/test_framework/util.py:322: error: Incompatible default for argument "coveragedir" (default has type "None", argument has type "str") [assignment] test/functional/test_framework/messages.py:32: error: Cannot find implementation or library stub for module named "dash_hash" [import] test/functional/test_framework/test_framework.py:122: note: By default the bodies of untyped functions are not checked, consider using --check-untyped-defs [annotation-unchecked] test/functional/test_framework/test_framework.py:123: note: By default the bodies of untyped functions are not checked, consider using --check-untyped-defs [annotation-unchecked] test/functional/test_framework/test_framework.py:124: note: By default the bodies of untyped functions are not checked, consider using --check-untyped-defs [annotation-unchecked] test/functional/test_framework/test_framework.py:125: note: By default the bodies of untyped functions are not checked, consider using --check-untyped-defs [annotation-unchecked] test/functional/p2p_message_capture.py:48: note: By default the bodies of untyped functions are not checked, consider using --check-untyped-defs [annotation-unchecked] Found 6 errors in 5 files (checked 275 source files) ``` </details> * [bitcoin#23462](https://github.com/bitcoin/bitcoin/pull/23462) is partial as neither `SC2046` nor `SC2086` have been enabled. This backport was done for the sole purpose of backporting changes to shell scripts that would be replaced with their Python counterparts in later backports. The necessary changes needed to enable `SC2046` and `SC2086` will be done in a later pull request. * `actions/checkout` does not do a full clone nor tracks the default branch by default. It is already documented that `git merge-base` (used by `lint-git-commit-check.py` and `lint-whitespace.py`, [source](`4aaa314a57/test/lint/lint-git-commit-check.py (L45)`)) doesn't play nice with it (see [actions/checkout#423](https://github.com/actions/checkout/discussions/423)). No such issue exists on GitLab ([build](https://gitlab.com/dashpay/dash/-/jobs/8456260939#L113)), but it remains present on GitHub Actions ([build](https://github.com/dashpay/dash/actions/runs/11996049800/job/33440106874?pr=6428#step:7:103)). This PR does a full clone, switches to the `develop` branch, then switches back to the intended commit, as a workaround (see working build [here](https://github.com/dashpay/dash/pull/6428#issuecomment-2495980410)) * Changes to `run-lint-format-strings.py` made in [dash#4807](https://github.com/dashpay/dash/pull/4807) were reverted as they were interfering with `lint-format-strings.py` <details> <summary>Lint error:</summary> ``` dash@96b217d539f7:/src/dash$ ./test/lint/lint-format-strings.py Traceback (most recent call last): File "/src/dash/test/lint/run-lint-format-strings.py", line 308, in <module> main() File "/src/dash/test/lint/run-lint-format-strings.py", line 304, in main sys.exit(max(exit_codes)) ValueError: max() arg is an empty sequence Traceback (most recent call last): File "/src/dash/test/lint/run-lint-format-strings.py", line 308, in <module> main() File "/src/dash/test/lint/run-lint-format-strings.py", line 304, in main sys.exit(max(exit_codes)) ValueError: max() arg is an empty sequence ``` </details> ## Breaking Changes None expected. ## Checklist - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas (note: N/A) - [x] I have added or updated relevant unit/integration/functional/e2e tests - [x] I have made corresponding changes to the documentation - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_ ACKs for top commit: knst: utACK `852f55e23c` UdjinM6: utACK `852f55e23c` Tree-SHA512: e508311c00249e7e48f91ca23e6f62117c07497f9c4471d07659b233e43a9f4d09ee2bfe0dd76f0c9746209cdba5895cb002a708924daa19d7aa76869815a7d9		2024-12-04 09:51:41 -06:00
.github	fix: clone full history on GitHub Actions build job, track `develop`	2024-11-27 04:58:22 +00:00
.tx	fix: follow-up #5393 - should be used `[dash.dash_ents]` (#5472 )	2023-07-01 14:16:50 +03:00
build-aux/m4	Merge bitcoin/bitcoin#29859 : build: Fix false positive `CHECK_ATOMIC` test	2024-10-26 12:29:51 -05:00
ci	partial bitcoin#23462: Enable SC2046 and SC2086 shellcheck rules	2024-11-27 04:55:46 +00:00
contrib	partial bitcoin#23462: Enable SC2046 and SC2086 shellcheck rules	2024-11-27 04:55:46 +00:00
depends	merge bitcoin#30198: qt 5.15.14 and fix macOS build with Clang 18	2024-11-17 07:42:09 +00:00
doc	merge bitcoin#22861: Update test README and lint script	2024-11-27 04:55:46 +00:00
share	merge bitcoin#27676: Bump minimum required runtime version and prepare for building with upstream LLVM	2024-11-13 11:07:38 +00:00
src	Merge #6428 : backport: merge bitcoin#24778, #24766 , #24849 , #24844 , #24853 , #24895 , #24802 , #24932 , partial bitcoin#23212, #23462 (lint backports)	2024-12-04 09:51:41 -06:00
test	Merge #6428 : backport: merge bitcoin#24778, #24766 , #24849 , #24844 , #24853 , #24895 , #24802 , #24932 , partial bitcoin#23212, #23462 (lint backports)	2024-12-04 09:51:41 -06:00
.cirrus.yml	merge bitcoin#27676: Bump minimum required runtime version and prepare for building with upstream LLVM	2024-11-13 11:07:38 +00:00
.dockerignore	build: add dash minimal development environment container	2021-12-21 12:43:37 +05:30
.editorconfig	Merge #21123 : code style: Add EditorConfig file	2021-07-16 10:04:09 -05:00
.gitattributes	Separate protocol versioning from clientversion	2014-10-29 00:24:40 -04:00
.gitignore	merge bitcoin#24031: don't compress macOS DMG	2024-11-06 19:22:01 +00:00
.gitlab-ci.yml	merge bitcoin#28622: use macOS 14 SDK (Xcode 15.0)	2024-11-16 02:24:19 +00:00
.python-version	partial Merge bitcoin/bitcoin#28210 : build: Bump clang minimum supported version to 13	2024-10-06 13:36:27 -05:00
.style.yapf	Merge bitcoin/bitcoin#27802 : Update .style.yapf	2024-10-25 09:12:00 -05:00
autogen.sh	Merge bitcoin/bitcoin#27875 : build: make sure we can overwrite config.{guess,sub} before doing so	2024-10-25 09:12:01 -05:00
CMakeLists.txt	chore: Added missing sources files in CMake (#5503 )	2023-07-25 12:23:56 -05:00
configure.ac	merge bitcoin#22861: Update test README and lint script	2024-11-27 04:55:46 +00:00
CONTRIBUTING.md	Merge #6220 : backport: Merge bitcoin#18448,24433, 24139, 23001, (partial) 24339, (partial) core/gui#420	2024-09-27 12:29:08 -05:00
COPYING	docs: update license year range to 2024 (#5890 )	2024-02-22 20:56:43 -06:00
INSTALL.md	Dashify INSTALL.md and build-unix.md	2018-01-12 16:12:54 +01:00
libdashconsensus.pc.in	revert dash#1432: Rename consensus source library and API	2022-08-09 14:16:28 +05:30
Makefile.am	merge bitcoin#22861: Update test README and lint script	2024-11-27 04:55:46 +00:00
README.md	doc: make build steps more prominent	2024-07-18 01:22:42 -06:00
SECURITY.md	docs: update SECURITY.md supported versions	2024-07-16 15:32:39 +00:00

README.md

Dash Core staging tree

CI	master	develop
Gitlab

https://www.dash.org

For an immediately usable, binary version of the Dash Core software, see https://www.dash.org/downloads/.

Further information about Dash Core is available in ./doc/.

What is Dash?

Dash is an experimental digital currency that enables instant, private payments to anyone, anywhere in the world. Dash uses peer-to-peer technology to operate with no central authority: managing transactions and issuing money are carried out collectively by the network. Dash Core is the name of the open source software which enables the use of this currency.

For more information read the original Dash whitepaper.

License

Dash Core is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/licenses/MIT.

Development Process

The master branch is meant to be stable. Development is normally done in separate branches. Tags are created to indicate new official, stable release versions of Dash Core.

The develop branch is regularly built (see doc/build-*.md for instructions) and tested, but is not guaranteed to be completely stable.

The contribution workflow is described in CONTRIBUTING.md and useful hints for developers can be found in doc/developer-notes.md.

Build / Compile from Source

The ./configure, make, and cmake steps, as well as build dependencies, are in ./doc/ as well:

Linux: ./doc/build-unix.md
Ubuntu, Debian, Fedora, Arch, and others
macOS: ./doc/build-osx.md
Windows: ./doc/build-windows.md
OpenBSD: ./doc/build-openbsd.md
FreeBSD: ./doc/build-freebsd.md
NetBSD: ./doc/build-netbsd.md

Testing

Testing and code review is the bottleneck for development; we get more pull requests than we can review and test on short notice. Please be patient and help out by testing other people's pull requests, and remember this is a security-critical project where any mistake might cost people lots of money.

Automated Testing

Developers are strongly encouraged to write unit tests for new code, and to submit new unit tests for old code. Unit tests can be compiled and run (assuming they weren't disabled in configure) with: make check. Further details on running and extending unit tests can be found in /src/test/README.md.

There are also regression and integration tests, written in Python. These tests can be run (if the test dependencies are installed) with: test/functional/test_runner.py

The CI (Continuous Integration) systems make sure that every pull request is built for Windows, Linux, and macOS, and that unit/sanity tests are run automatically.

Manual Quality Assurance (QA) Testing

Changes should be tested by somebody other than the developer who wrote the code. This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward.

Translations

Changes to translations as well as new translations can be submitted to Dash Core's Transifex page.

Translations are periodically pulled from Transifex and merged into the git repository. See the translation process for details on how this works.

Important: We do not accept translation changes as GitHub pull requests because the next pull from Transifex would automatically overwrite them again.