dogecoin/README.md

140 lines
6.6 KiB
Markdown
Raw Normal View History

# Dogecoin Core [DOGE, Ð]
==========================
2019-11-13 21:51:17 +01:00
![Dogecoin](https://static.tumblr.com/ppdj5y9/Ae9mxmxtp/300coin.png)
[![Build Status](https://travis-ci.org/dogecoin/dogecoin.svg?branch=1.14-dev)](https://travis-ci.org/dogecoin/dogecoin) [![tip for next commit](https://tip4commit.com/projects/702.svg)](https://tip4commit.com/github/dogecoin/dogecoin)
## What is Dogecoin? Such coin
Dogecoin is a cryptocurrency like Bitcoin, although it does not use SHA256 as its proof of work (POW). Taking development cues from Tenebrix and Litecoin, Dogecoin currently employs a simplified variant of scrypt.
2019-11-13 21:51:17 +01:00
https://dogecoin.com/
## License Much license
Dogecoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
information or see https://opensource.org/licenses/MIT.
2010-09-23 20:06:50 +02:00
## Development and contributions omg developers
Development is ongoing, and the development team, as well as other volunteers, can freely work in their own trees and submit pull requests when features or bug fixes are ready.
2010-12-19 16:39:36 +01:00
#### Version strategy
Version numbers are following ```major.minor.patch``` semantics.
2015-09-24 15:28:07 +02:00
#### Branches
There are 3 types of branches in this repository:
2015-09-24 15:28:07 +02:00
- **master:** Stable, contains the latest version of the latest *major.minor* release.
- **maintenance:** Stable, contains the latest version of previous releases, which are still under active maintenance. Format: ```<version>-maint```
- **development:** Unstable, contains new code for planned releases. Format: ```<version>-dev```
2015-09-24 15:28:07 +02:00
*Master and maintenance branches are exclusively mutable by release. Planned releases will always have a development branch and pull requests should be submitted against those. Maintenance branches are there for* ***bug fixes only,*** *please submit new features against the development branch with the highest version.*
#### Contributions
2011-09-27 04:22:19 +02:00
Developers are strongly encouraged to write [unit tests](src/test/README.md) for new code, and to
2015-11-18 00:26:07 +01:00
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](/src/test/README.md).
2015-11-18 00:26:07 +01:00
There are also [regression and integration tests](/qa) of the RPC interface, written
in Python, that are run automatically on the build server.
These tests can be run (if the [test dependencies](/qa) are installed) with: `qa/pull-tester/rpc-tests.py`
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.
## Very Much Frequently Asked Questions
### How much doge can exist? So many puppies!
Early 2015 (approximately a year and a half after release) there will be approximately 100,000,000,000 coins.
Each subsequent block will grant 10,000 coins to encourage miners to continue to secure the network and make up for lost wallets on hard drives/phones/lost encryption passwords/etc.
### How to get doge? To the moon!
2018-10-23 07:27:13 +02:00
Dogecoin uses a simplified variant of the scrypt key derivation function as its proof of work with a target time of one minute per block and difficulty readjustment after every block. The block rewards are fixed and halve every 100,000 blocks. Starting with the 600,000th block, a permanent reward of 10,000 Dogecoin per block will be issued.
2018-10-23 07:27:13 +02:00
Originally, a different payout scheme was envisioned with block rewards being determined by taking the maximum reward as per the block schedule and applying the result of a Mersenne Twister pseudo-random number generator to arrive at a number between 0 and the maximum reward. This was changed starting with block 145,000, to prevent large pools from gaming the system and mining only high reward blocks. At the same time, the difficulty retargeting was also changed from four hours to once per block (every minute), implementing an algorithm courtesy of the DigiByte Coin development team, to lessen the impact of sudden increases and decreases of network hashing rate.
The current block reward schedule:
199,999: 01,000,000 Dogecoin
100,000144,999: 0500,000 Dogecoin
145,000199,999: 250,000 Dogecoin
200,000299,999: 125,000 Dogecoin
300,000399,999: 62,500 Dogecoin
400,000499,999: 31,250 Dogecoin
500,000599,999: 15,625 Dogecoin
600,000+: 10,000 Dogecoin
The original block reward schedule, with one-minute block targets and four-hour difficulty readjustment:
199,999: 01,000,000 Dogecoin
100,000199,999: 0500,000 Dogecoin
200,000299,999: 0250,000 Dogecoin
300,000399,999: 0125,000 Dogecoin
400,000499,999: 062,500 Dogecoin
500,000599,999: 031,250 Dogecoin
600,000+: 10,000 Dogecoin
### Wow plz make dogecoind/dogecoin-cli/dogecoin-qt
The following are developer notes on how to build Dogecoin on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
- [OSX Build Notes](doc/build-osx.md)
- [Unix Build Notes](doc/build-unix.md)
2019-11-13 21:51:17 +01:00
- [Windows Build Notes](doc/build-windows.md)
### Such ports
RPC 22555
P2P 22556
2019-11-13 21:51:17 +01:00
![](https://dogesay.com/3f5a00acf72df93528b6bb7cd0a4fd0c.jpeg)
## Development tips and tricks
**compiling for debugging**
Run `configure` with the `--enable-debug` option, then `make`. Or run `configure` with
`CXXFLAGS="-g -ggdb -O0"` or whatever debug flags you need.
**debug.log**
If the code is behaving strangely, take a look in the debug.log file in the data directory;
error and debugging messages are written there.
The `-debug=...` command-line option controls debugging; running with just `-debug` will turn
on all categories (and give you a very large debug.log file).
The Qt code routes `qDebug()` output to debug.log under category "qt": run with `-debug=qt`
to see it.
**testnet and regtest modes**
Run with the `-testnet` option to run with "play dogecoins" on the test network, if you
are testing multi-machine code that needs to operate across the internet.
If you are testing something that can run on one machine, run with the `-regtest` option.
In regression test mode, blocks can be created on-demand; see qa/rpc-tests/ for tests
that run in `-regtest` mode.
**DEBUG_LOCKORDER**
2014-05-23 16:30:38 +02:00
Dogecoin Core is a multithreaded application, and deadlocks or other multithreading bugs
can be very difficult to track down. Compiling with `-DDEBUG_LOCKORDER` (`configure
CXXFLAGS="-DDEBUG_LOCKORDER -g"`) inserts run-time checks to keep track of which locks
are held, and adds warnings to the debug.log file if inconsistencies are detected.