mirror of
https://github.com/dogecoin/dogecoin.git
synced 2026-01-31 18:40:58 +00:00
ee17885742
The discord shortened URL has been hijacked for a while and this has been routing users to a potentially malicious environment. To remove this risk completely, this removes all URLs that are not under github.com/dogecoin/dogecoin, to reduce the impact of any future URL hijacking.
90 lines
4.1 KiB
Markdown
90 lines
4.1 KiB
Markdown
<h1 align="center">
|
|
<img src="https://raw.githubusercontent.com/dogecoin/dogecoin/master/share/pixmaps/dogecoin256.svg" alt="Dogecoin" width="256"/>
|
|
<br/><br/>
|
|
Dogecoin Core [DOGE, Ð]
|
|
</h1>
|
|
|
|
**IMPORTANT: Starting August 2024, the `master` branch has become the primary
|
|
integration branch and has become unstable. Please check out a tagged version
|
|
before compiling production binaries.**
|
|
|
|
For internationalized documentation, see the index at [doc/intl](doc/intl/README.md).
|
|
|
|
Dogecoin is a community-driven cryptocurrency that was inspired by a Shiba Inu meme. The Dogecoin Core software allows anyone to operate a node in the Dogecoin blockchain networks and uses the Scrypt hashing method for Proof of Work. It is adapted from Bitcoin Core and other cryptocurrencies.
|
|
|
|
For information about the default fees used on the Dogecoin network, please
|
|
refer to the [fee recommendation](doc/fee-recommendation.md).
|
|
|
|
## Usage 💻
|
|
|
|
To start your journey with Dogecoin Core, see the [installation guide](INSTALL.md) and the [getting started](doc/getting-started.md) tutorial.
|
|
|
|
The JSON-RPC API provided by Dogecoin Core is self-documenting and can be browsed with `dogecoin-cli help`, while detailed information for each command can be viewed with `dogecoin-cli help <command>`.
|
|
|
|
### Such ports
|
|
|
|
Dogecoin Core by default uses port `22556` for peer-to-peer communication that
|
|
is needed to synchronize the "mainnet" blockchain and stay informed of new
|
|
transactions and blocks. Additionally, a JSONRPC port can be opened, which
|
|
defaults to port `22555` for mainnet nodes. It is strongly recommended to not
|
|
expose RPC ports to the public internet.
|
|
|
|
| Function | mainnet | testnet | regtest |
|
|
| :------- | ------: | ------: | ------: |
|
|
| P2P | 22556 | 44556 | 18444 |
|
|
| RPC | 22555 | 44555 | 18332 |
|
|
|
|
## Ongoing development - Moon plan 🌒
|
|
|
|
Dogecoin Core is an open source and community driven software. The development
|
|
process is open and publicly visible; anyone can see, discuss and work on the
|
|
software.
|
|
|
|
Main development resources:
|
|
|
|
* [GitHub Projects](https://github.com/dogecoin/dogecoin/projects) is used to
|
|
follow planned and in-progress work for upcoming releases.
|
|
* [GitHub Discussions](https://github.com/dogecoin/dogecoin/discussions) is used
|
|
to discuss features, planned and unplanned, related to both the development of
|
|
the Dogecoin Core software, the underlying protocols and the DOGE asset.
|
|
|
|
### Version strategy
|
|
Version numbers are following ```major.minor.patch``` semantics.
|
|
|
|
### Branches
|
|
There are 4 types of branches in this repository:
|
|
|
|
- **master:** Unstable, contains the latest code under development.
|
|
- **maintenance:** Stable, contains the latest version of previous releases,
|
|
which are still under active maintenance. Format: ```<version>-maint```
|
|
- **development:** Unstable, contains new code for upcoming releases. Format: ```<version>-dev```
|
|
- **archive:** Stable, immutable branches for old versions that no longer change
|
|
because they are no longer maintained.
|
|
|
|
***Submit your pull requests against `master`***
|
|
|
|
*Maintenance branches are exclusively mutable by release. When a release is*
|
|
*planned, a development branch will be created and commits from master will*
|
|
*be cherry-picked into these by maintainers.*
|
|
|
|
## Contributing 🤝
|
|
|
|
If you find a bug or experience issues with this software, please report it
|
|
using the [issue system](https://github.com/dogecoin/dogecoin/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5Bbug%5D+).
|
|
|
|
Please see [the contribution guide](CONTRIBUTING.md) to see how you can
|
|
participate in the development of Dogecoin Core. There are often
|
|
[topics seeking help](https://github.com/dogecoin/dogecoin/labels/help%20wanted)
|
|
where your contributions will have high impact and get very appreciation. wow.
|
|
|
|
## Very Much Frequently Asked Questions ❓
|
|
|
|
Do you have a question regarding Dogecoin? An answer is perhaps already in the
|
|
[FAQ](doc/FAQ.md) or the
|
|
[Q&A section](https://github.com/dogecoin/dogecoin/discussions/categories/q-a)
|
|
of the discussion board!
|
|
|
|
## License - Much license ⚖️
|
|
Dogecoin Core is released under the terms of the MIT license. See
|
|
[COPYING](COPYING) for more information.
|