forked from bitcoin/bitcoin
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
38 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,78 +1,55 @@ | ||
| Bitcoin Core integration/staging tree | ||
| ===================================== | ||
| # Vincoin ~ The [Bitcoin](https://github.com/bitcoin/bitcoin) Experiment | ||
| Back in 2019, at the dawn of "_cryptocurrencies_" and other faulty Bitcoin implementations, the idea of **Vincoin** emerged. | ||
|
|
||
| https://bitcoincore.org | ||
| It is imagined to expand Bitcoin basic functionalities and allow huge group(s) of people get better understanding, access and usage of this technology. | ||
|
|
||
| For an immediately usable, binary version of the Bitcoin Core software, see | ||
| https://bitcoincore.org/en/download/. | ||
| Most importantly, every user is guaranteed equal amount of coins upon registration, **free of charge**. | ||
|
|
||
| What is Bitcoin Core? | ||
| --------------------- | ||
|
|
||
| Bitcoin Core connects to the Bitcoin peer-to-peer network to download and fully | ||
| validate blocks and transactions. It also includes a wallet and graphical user | ||
| interface, which can be optionally built. | ||
| ## Key differences | ||
| _Vincoin_ is mostly based on Bitcoin features (regular fork), but has major key differences: | ||
| - total amount of coins in circulation | ||
| - initial amout of coins every user is guaranteed with | ||
| - restricted, non-public access (zKP based) | ||
| - **0%** mining fees | ||
| - improved hashing algos | ||
| - general (economical) narrative | ||
|
|
||
| Further information about Bitcoin Core is available in the [doc folder](/doc). | ||
| ## General narrative | ||
| Sole purpose of _Vincoin_ is to be distributed to a group of people, allowing their economical potential to grow. Having equal amount of coins, straight at the start, provides greater opportunities and expanded decision set for it's participants. Eventually, _Vincoin_ coin "value" may be compared with other currencies, allowing for price duality for every good/product _Vincoin_ network processes. | ||
|
|
||
| License | ||
| ------- | ||
| ### No mining fees | ||
| _Vincoin_ follows good old Torrent, DC++, Napster, SETI@Home and TOR (or any similar distributed network) philosophies. | ||
| Maintaining the network nodes **isn't** something that should be "_incentivized_" by earning transaction fees but rather by understanding the greater goal of providing advanced coin exchange system for it's users. | ||
| Vincoin coders are born in past century so they grew up under different network mentality... | ||
|
|
||
| Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more | ||
| information or see https://opensource.org/licenses/MIT. | ||
| ### Restricted access (zKP based) | ||
| Providing that every user is given equal amount of coins upon accessing the system, _Vincoin_ network introduces additional layer of security **NOT allowing public access** to the system. Users will be providing "known proof" of their origin (eg. Passport number, Social ID) which will be validated using _zero knowledge proofs_ validation schemes. Thus requiring "external" validator solely for this purpose. | ||
|
|
||
| Development Process | ||
| ------------------- | ||
| ### Improved hashing algos | ||
| _Vincoin_ utilizes modern hashing algos, mainly _[argon2](https://en.wikipedia.org/wiki/Argon2)_ family and _[Zero Knowledge Proofs (zKP)](https://en.wikipedia.org/wiki/Zero-knowledge_proof)_ validation schemes. | ||
|
|
||
| The `master` branch is regularly built (see `doc/build-*.md` for instructions) and tested, but it is not guaranteed to be | ||
| completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created | ||
| regularly from release branches to indicate new official, stable release versions of Bitcoin Core. | ||
| ## Installation instructions | ||
| _TBD_ | ||
|
|
||
| The https://github.com/bitcoin-core/gui repository is used exclusively for the | ||
| development of the GUI. Its master branch is identical in all monotree | ||
| repositories. Release branches and tags do not exist, so please do not fork | ||
| that repository unless it is for development reasons. | ||
|
|
||
| The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md) | ||
| and useful hints for developers can be found in [doc/developer-notes.md](doc/developer-notes.md). | ||
| ## Contribution gudelines | ||
| _TBD_ | ||
|
|
||
| Testing | ||
| ------- | ||
| ## Licensing | ||
| **VINCOIN** is published under MIT license. | ||
|
|
||
| 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. | ||
| ### Contributors | ||
| - [Vexy](https://github.com/vexy): `6302D860 B74CBD34 6482DBA2 518766D0 8213DBC0` | ||
|
|
||
| ### Automated Testing | ||
| > Vincoin is in _early alpha stage_. Expect bugs and incomplete features. | ||
| Developers are strongly encouraged to write [unit tests](src/test/README.md) 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](/src/test/README.md). | ||
| <p align="center"> | ||
| <a href="https://stackexchange.com/users/215166"> | ||
| <img src="https://stackexchange.com/users/flair/215166.png?theme=clean" width="208" height="58" alt="profile for Vexy on Stack Exchange, a network of free, community-driven Q&A sites" title="profile for Vexy on Stack Exchange, a network of free, community-driven Q&A sites"> | ||
| </a> | ||
| </p> | ||
|
|
||
| There are also [regression and integration tests](/test), written | ||
| in Python. | ||
| These tests can be run (if the [test dependencies](/test) are installed) with: `test/functional/test_runner.py` | ||
| --- | ||
| Copyright (c) 2019 [Vexy](https://github.com/vexy) | ||
|
|
||
| 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 | ||
| [Bitcoin Core's Transifex page](https://www.transifex.com/bitcoin/bitcoin/). | ||
|
|
||
| Translations are periodically pulled from Transifex and merged into the git repository. See the | ||
| [translation process](doc/translation_process.md) 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. |