Skip to content

1 GB Canary Sidechain using Drivechain #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Sjors wants to merge 1 commit into from
Closed

1 GB Canary Sidechain using Drivechain #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 9 additions & 66 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,82 +1,25 @@
Drivechain project sidechain branch
Drivechain 1 GB sidechain branch
=====================================

[![Build Status](https://travis-ci.org/drivechain-project/bitcoin.svg?branch=sidechainBMM)](https://travis-ci.org/drivechain-project/bitcoin)
[![Build Status](https://travis-ci.org/sjors/bitcoin.svg?branch=sidechain-1gb)](https://travis-ci.org/sjors/bitcoin)

http://drivechain.info
Based on the Drivechain Project's [example sidechain](https://github.com/drivechain-project/bitcoin/tree/sidechainBMM), which is in turn based on [Bitcoin Core v0.14](https://github.com/bitcoin/bitcoin/tree/v0.14.2).

What is Bitcoin?
----------------
Learn more about Drivechain at http://drivechain.info. In particular, you'll need [their mainchainBMM branch](https://github.com/drivechain-project/bitcoin/tree/mainchainBMM) to run the mainchain side.

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

For more information, as well as an immediately useable, binary version of
the Bitcoin Core software, see https://bitcoin.org/en/download, or read the
[original whitepaper](https://bitcoincore.org/bitcoin.pdf).
This project is not affiliated with the "official" Drivechain project. More importantly, _do not use this code with real bitcoin_. Then again, you only live once.

License
-------

Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
Same as Bitcoin Core, namely the MIT license. See [COPYING](COPYING) for more
information or see https://opensource.org/licenses/MIT.

Development Process
-------------------

The `master` branch is regularly built and tested, but is not guaranteed to be
completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created
regularly to indicate new official, stable release versions of Bitcoin Core.

The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).

The developer [mailing list](https://lists.linuxfoundation.org/mailman/listinfo/bitcoin-dev)
should be used to discuss complicated or controversial changes before working
on a patch set.

Developer IRC can be found on Freenode at #bitcoin-core-dev.

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](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).

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`

The Travis CI system makes sure that every pull request is built for Windows, Linux, and OS X, 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/projects/p/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.
The best place to see work in progress is this [pull request](https://github.com/Sjors/bitcoin/pull/1).

**Important**: We do not accept translation changes as GitHub pull requests because the next
pull from Transifex would automatically overwrite them again.
Pull requests should be made against the `sidechain-1gb` branch. This branch will be rebased as the upstream `sidechainBMM` branch is updated, which in turn is hopefully updated whenever Bitcoin Core releases a new version.

Translators should also subscribe to the [mailing list](https://groups.google.com/forum/#!forum/bitcoin-translators).
The `sidechain-1gb-experimental` branch will be used to try out various combinations of pull requests. It may be forced pushed over at any time.