mirror of https://github.com/dashpay/dash.git synced 2024-12-23 19:12:47 +01:00

Dash - Reinventing Cryptocurrency

bitcoin blockchain cryptocurrency dash governance instant masternode p2p privacy

Go to file

pasta 7530f3d245 Some checks failed CI / Build Image (push) Failing after 2m9s Details CI / Build Dependencies (arm-linux, arm-linux-gnueabihf) (push) Has been skipped Details CI / Build Dependencies (linux64, x86_64-pc-linux-gnu) (push) Has been skipped Details CI / Build (arm-linux, arm-linux, arm-linux-gnueabihf) (push) Has been skipped Details CI / Build (linux64, linux64, x86_64-pc-linux-gnu) (push) Has been skipped Details CI / Build (linux64_cxx20, linux64, x86_64-pc-linux-gnu) (push) Has been skipped Details CI / Build (linux64_fuzz, linux64, x86_64-pc-linux-gnu) (push) Has been skipped Details CI / Build (linux64_nowallet, linux64, x86_64-pc-linux-gnu) (push) Has been skipped Details CI / Build (linux64_sqlite, linux64, x86_64-pc-linux-gnu) (push) Has been skipped Details CI / Build (linux64_tsan, linux64, x86_64-pc-linux-gnu) (push) Has been skipped Details CI / Build (linux64_ubsan, linux64, x86_64-pc-linux-gnu) (push) Has been skipped Details Label Merge Conflicts / main (push) Failing after 2m49s Details Check Merge Fast-Forward Only / check_merge (push) Successful in 1m51s Details Guix Build / build-image (push) Failing after 6m6s Details Guix Build / build (aarch64-linux-gnu) (push) Has been skipped Details Guix Build / build (arm-linux-gnueabihf) (push) Has been skipped Details Guix Build / build (arm64-apple-darwin) (push) Has been skipped Details Guix Build / build (x86_64-apple-darwin) (push) Has been skipped Details Guix Build / build (powerpc64-linux-gnu) (push) Has been skipped Details Guix Build / build (x86_64-linux-gnu) (push) Has been skipped Details Guix Build / build (riscv64-linux-gnu) (push) Has been skipped Details Guix Build / build (x86_64-w64-mingw32) (push) Has been skipped Details Merge #6490 : ci: container improvements `04ce1fea52` ci: deduplicate macOS SDK setup logic (Kittywhiskers Van Gogh) `8dd0db7de9` ci: fix "LC_ALL: cannot change locale (en_US.UTF-8)" in Guix container (Kittywhiskers Van Gogh) `187fe17650` ci: don't stage packages in `/tmp`, reduce layers for `cppcheck` build (Kittywhiskers Van Gogh) `eef863554a` ci: install `i386` packages only if host is `amd64`, merge layers (Kittywhiskers Van Gogh) `e7702292d1` ci: purge package manager cache after each interaction (Kittywhiskers Van Gogh) `b7099eed47` ci: remove redundant `version` attribute, avoid `lldb` personality error (Kittywhiskers Van Gogh) `64cdc42130` ci: add LLVM library path to `LD_LIBRARY_PATH` and GDB allowlist (Kittywhiskers Van Gogh) `440fd3fe21` ci: drop distro LLVM packages, move Clang install up, set defaults (Kittywhiskers Van Gogh) Pull request description: ## Additional Information * This pull request pulls container-specific changes from [dash#6387](https://github.com/dashpay/dash/pull/6387), [dash#6400](https://github.com/dashpay/dash/pull/6400) and [dash#6421](https://github.com/dashpay/dash/pull/6421) * The `HOST` check before running `setup_sdk.sh` isn't a part of the script itself as the script is written to be independent of external variables set. The caller is expected to know the conditions needed to run `setup_sdk.sh` as the script is _relatively_ agnostic to its environment. * The `version` attribute in the [`develop`](`a8e2316d6f/contrib/containers/develop/docker-compose.yml`) and [`guix`](`a8e2316d6f/contrib/containers/guix/docker-compose.yml`) container's `docker-compose.yml` has been dropped as the attribute has been deprecated in the compose spec ([source](`65ef9f4a5d/spec.md (version-top-level-element-obsolete)`)). * Using `LD_LIBRARY_PATH` to point to LLVM's libraries are acceptable and will not interfere with executing binaries built using the distro's packaged compiler as it will eventually search default paths and find the libraries shipped with the distro ([source](https://man7.org/linux/man-pages/man8/ld.so.8.html)). * Currently, running LLDB will result in a "personality set failed: Operation not permitted" error ([source](https://discourse.llvm.org/t/running-lldb-in-a-container/76801)). This is caused by its attempt at disabling ASLR for debugging. To work around this error, the container will now operate under relaxed restrictions (`seccomp=unconfined`). As disabling ASLR is valuable when debugging and the container is meant for developers (i.e. it isn't used for CI), we have opted to relax restrictions instead of skipping ASLR disablement. * As of `develop` (`a8e2316d6f`), packages built by the container are stored in `/tmp`, which is inadvisable as it is the same directory used to store functional test runs and it's not too difficult to delete `/tmp`'s contents to save space in a long running [`develop`](`a8e2316d6f/contrib/containers/develop/docker-compose.yml`) container and then realize that both `shellcheck` and `cppcheck` are stored there and now you have to ditch the container you're working in and restart it. * To remedy this, packages are now built and stored in `/opt` in accordance with the FHS ([source](https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch03s13.html)). `/usr/local` was a contender but it's pre-populated, meanwhile `ls /opt` would give you a very quick picture of what's built for the container. * `/tmp` will not be entirely empty because [pypa/pip#10753](https://github.com/pypa/pip/issues/10753) results in residual `.pem` files leaking into `/tmp` and `pyenv` stores its build log there and keeping it around has some debug value. ## 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 - [x] I have added or updated relevant unit/integration/functional/e2e tests (note: N/A) - [x] I have made corresponding changes to the documentation (note: N/A) - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_ ACKs for top commit: UdjinM6: ACK `04ce1fea52` PastaPastaPasta: utACK `04ce1fea52` Tree-SHA512: 5442ae06cb73b9bc4eec908803548195ae8fd9150422789e5f98578ad01a303b5361f9ba42fe8faee27ac91e38328b7771e4ba42b296dfa70ecbbfc7d10436b6		2024-12-16 22:29:09 -06:00
.github	trivial: sort `BUILD_TARGET` on GitHub and in `matrix.sh` alphabetically	2024-12-15 13:12:04 +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#24391: stop overriding user autoconf flags	2024-12-15 09:08:22 +00:00
ci	Merge #6490 : ci: container improvements	2024-12-16 22:29:09 -06:00
contrib	ci: deduplicate macOS SDK setup logic	2024-12-16 12:13:27 +00:00
depends	merge bitcoin#27314: Fix handling of `CXX=clang++` when building `qt` package	2024-12-15 13:08:29 +00:00
doc	merge bitcoin#29452: document that BIP324 on by default	2024-12-14 12:00:51 +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 #6300 : backport: Merge bitcoin#23642, 22794, 23316, 24365, gui#517, 24219, 23253, 24449, 22543	2024-12-16 21:01:12 -06:00
test	Merge #6300 : backport: Merge bitcoin#23642, 22794, 23316, 24365, gui#517, 24219, 23253, 24449, 22543	2024-12-16 21:01:12 -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 #6490 : ci: container improvements	2024-12-16 22:29:09 -06: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#25422: globally define NOMINMAX when building with mingw-w64	2024-12-15 09:08:22 +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 supported versions in SECURITY.md	2024-12-07 07:58:19 +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.