Commit d1d9e161 authored by BigBlockIfTrue's avatar BigBlockIfTrue

Various Markdown fixes for proper display on docs.bitcoincashnode.org

Also contains some ABC->BCHN updating in
doc/gitian-building/gitian-building-manual.md.
parent 16bab221
......@@ -15,7 +15,7 @@ of resources.
Our main development repository is currently located at
https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node
[https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node](https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node)
This features the project code, an issue tracker and facilities to see
project progress and activities, even in detailed form such as individual
......@@ -34,7 +34,7 @@ our main development and interactive support for users of our node.
Other social media resources such as our Telegram and Twitter are linked
from the project website at
https://bitcoincashnode.org
[https://bitcoincashnode.org](https://bitcoincashnode.org)
On all our channels, we seek to facilitate development of Bitcoin Cash Node,
and to welcome and support people who wish to participate.
......@@ -103,11 +103,11 @@ Here are some handy links for development practices aligned with Bitcoin Cash No
Getting set up with the Bitcoin Cash Node Repository
----------------------------------------------
1. Create an account at https://gitlab.com/ if you don't have one yet
1. Create an account at [https://gitlab.com](https://gitlab.com) if you don't have one yet
2. Install Git on your machine
Git documentation can be found at: https://git-scm.com/
Git documentation can be found at: [https://git-scm.com](https://git-scm.com)
To install these packages on Debian or Ubuntu, type: `sudo apt-get install git`
......@@ -121,7 +121,7 @@ Enter a file in which to save the key (/home/*username*/.ssh/id_rsa): [Press ent
4. Upload your SSH public key to GitLab
- Go to: `https://gitlab.com, log in
- Go to: [https://gitlab.com](https://gitlab.com), log in
- Under "User Settings", "SSH Keys", add your public key
......@@ -129,7 +129,7 @@ Paste contents from: `$HOME/.ssh/id_rsa.pub`
5. Create a personal fork of the Bitcoin Cash Node repository for your work
- Sign into GitLab under your account, then visit the project at https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node
- Sign into GitLab under your account, then visit the project at [https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node](https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node)
- Click the 'Fork' button on the top right, and choose to fork the project to your personal GitLab space.
......@@ -182,7 +182,7 @@ sudo apt-get install clang-format-8 clang-tidy-8 clang-tools-8
If not available in the distribution, `clang-format-8` and `clang-tidy` can be
installed from https://releases.llvm.org/download.html or https://apt.llvm.org.
installed from [https://releases.llvm.org/download.html](https://releases.llvm.org/download.html) or [https://apt.llvm.org](https://apt.llvm.org).
For example, for macOS:
```
......@@ -246,7 +246,7 @@ What to work on
---------------
If you are looking for a useful task to contribute to the project, a good place
to start is the list of issues at https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node/-/issues
to start is the list of issues at [https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node/-/issues](https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node/-/issues)
Look for issues marked with a label 'good-first-issue'.
......
......@@ -81,23 +81,23 @@ contact at imaginary dot username dot btc at gmail dot com
Neighboring projects that may be affected by bugs, potential exploits, or other security vulnerabilities that are disclosed to Bitcoin Cash Node will be passed along information regarding disclosures that we believe could impact them. As per the standard referenced above, we are disclosing these relationships here:
* [Bitcoin Unlimited](https://www.bitcoinunlimited.info)
* Security Contacts: security at bitcoinunlimited dot info
* Disclosure Policy: https://github.com/BitcoinUnlimited/BitcoinUnlimited/blob/release/SECURITY.md
* Security Contacts: security at bitcoinunlimited dot info
* Disclosure Policy: [https://github.com/BitcoinUnlimited/BitcoinUnlimited/blob/release/SECURITY.md](https://github.com/BitcoinUnlimited/BitcoinUnlimited/blob/release/SECURITY.md)
* [BCHD](https://bchd.cash)
* Security Contacts: Chris Pacia (ctpacia at gmail dot com) and Josh Ellithorpe (quest at mac dot com)
* Disclosure Policy: see README information at https://github.com/gcash/bchd/
* Security Contacts: Chris Pacia (ctpacia at gmail dot com) and Josh Ellithorpe (quest at mac dot com)
* Disclosure Policy: see README information at [https://github.com/gcash/bchd/](https://github.com/gcash/bchd/)
* [Flowee](https://flowee.org)
* Security Contact: tomz at freedommail dot ch
* Disclosure Policy: see https://gitlab.com/FloweeTheHub/thehub
* Security Contact: tomz at freedommail dot ch
* Disclosure Policy: see [https://gitlab.com/FloweeTheHub/thehub](https://gitlab.com/FloweeTheHub/thehub)
* [Knuth](https://github.com/k-nuth/kth/)
* Security Contact: fpelliccioni at gmail dot com
* Disclosure Policy: see https://github.com/k-nuth/kth/blob/master/README.md#security-disclosures
* Security Contact: fpelliccioni at gmail dot com
* Disclosure Policy: see [https://github.com/k-nuth/kth/blob/master/README.md#security-disclosures](https://github.com/k-nuth/kth/blob/master/README.md#security-disclosures)
* [Bitcoin Verde](https://github.com/SoftwareVerde/bitcoin-verde/)
* Security Contact: josh at softwareverde dot com
* Security Contact: josh at softwareverde dot com
We have approached several other projects and are waiting for responses from them.
......
......@@ -2,7 +2,7 @@
This document describes the working rules, workflow, terminology and guidelines that developers and testers should be familiar with while working on the Bitcoin Cash Node repository and issue tracker at
https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node/
[https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node/](https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node/)
## BCHN GitLab workflow
......@@ -102,7 +102,6 @@ Committers can add prefix tags to their commit messages and MR titles to provide
These tags have no special meaning to GitLab (at least not yet) and are simply for human consumption at this stage.They are not well standardized, but below you will find a section documenting some better known commit tags.
**WIP**
When a merge requested is prefixed by "WIP:", GitLab blocks merging of the MR.
......
......@@ -3,7 +3,7 @@
(updated for Fedora 31)
# Preparation
## Preparation
Minimal build requirements:
......
This diff is collapsed.
......@@ -11,7 +11,7 @@ to connect to BCH compatible peers.
General expectations for DNS Seed operators
===========================================
-------------------------------------------
Bitcoin attempts to minimize the level of trust in DNS seeds,
but DNS seeds still pose a small amount of risk for the network.
......
......@@ -16,7 +16,7 @@ The util tests are run as part of `make check` target. The functional
tests are run by the Teamcity continuous build process whenever a diff is
created or updated on Phabricator. Both sets of tests can also be run locally.
# Running functional tests locally
## Running functional tests locally
Build for your system first. Be sure to enable wallet, utils and daemon when
you configure. Tests will not run otherwise.
......@@ -195,7 +195,7 @@ The warning message will now be printed to the `sys.stderr` output.
Util tests can be run locally by running `test/util/bitcoin-util-test.py`.
Use the `-v` option for verbose output.
# Writing functional tests
## Writing functional tests
#### Example test
......
......@@ -13,6 +13,8 @@ Comments-URI: https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node/-/merge_req
Comments-Summary: BCHN internal review comments.
```
# getblocktemplatelight
## Abstract
......@@ -309,17 +311,17 @@ merkle_root = hashes[0]
## References
- [1] BIP 22: getblocktemplate - Fundamentals
- [2] BIP 23: getblocktemplate - Pooled Mining
- [3] https://github.com/btccom/bitcoin-abc-1/commit/e87774c8ee724a0e9ecbc289236920ea1aa04a83
- [4] src/rpc/mining.cpp, see `MakeMerkleBranch` function
- [5] https://reference.cash/protocol/blockchain/block/block-header
- [6] https://reference.cash/protocol/p2p/compact__int/
- [7] https://reference.cash/protocol/blockchain/block/#coinbase-transaction
- [8] https://reference.cash/protocol/blockchain/transaction/
- [9] https://github.com/BitcoinUnlimited/BitcoinUnlimited/blob/release/doc/miner.md#getminingcandidate-and-submitminingsolution
- [1] [BIP22: getblocktemplate - Fundamentals](https://github.com/bitcoin/bips/blob/master/bip-0022.mediawiki/)
- [2] [BIP23: getblocktemplate - Pooled Mining](https://github.com/bitcoin/bips/blob/master/bip-0023.mediawiki/)
- [3] [https://github.com/btccom/bitcoin-abc-1/commit/e87774c8ee724a0e9ecbc289236920ea1aa04a83](https://github.com/btccom/bitcoin-abc-1/commit/e87774c8ee724a0e9ecbc289236920ea1aa04a83)
- [4] [src/rpc/mining.cpp](../src/rpc/mining.cpp), see `MakeMerkleBranch` function
- [5] [https://reference.cash/protocol/blockchain/block/block-header](https://reference.cash/protocol/blockchain/block/block-header)
- [6] [https://reference.cash/protocol/p2p/compact__int/](https://reference.cash/protocol/p2p/compact__int/)
- [7] [https://reference.cash/protocol/blockchain/block/#coinbase-transaction](https://reference.cash/protocol/blockchain/block/#coinbase-transaction)
- [8] [https://reference.cash/protocol/blockchain/transaction/](https://reference.cash/protocol/blockchain/transaction/)
- [9] [https://github.com/BitcoinUnlimited/BitcoinUnlimited/blob/release/doc/miner.md#getminingcandidate-and-submitminingsolution](https://github.com/BitcoinUnlimited/BitcoinUnlimited/blob/release/doc/miner.md#getminingcandidate-and-submitminingsolution)
# Copyright
## Copyright
This document is licensed under the Creative Commons CC0 1.0 Universal license.
......@@ -18,15 +18,6 @@ VM image to avoid 'contaminating' the build.
The instructions below use the automated script [gitian-build.py](https://github.com/bitcoin-cash-node/bitcoin-cash-node/blob/master/contrib/gitian-build.py) which only works in Debian/Ubuntu. For manual steps and instructions for fully offline signing, see [this guide](./gitian-building/gitian-building-manual.md).
## Table of Contents
* [Gitian building](gitian-building.md#gitian-building)
* [Table of Contents](gitian-building.md#table-of-contents)
* [Preparing the Gitian builder host](gitian-building.md#preparing-the-gitian-builder-host)
* [MacOS code signing](gitian-building.md#macos-code-signing)
* [Initial Gitian Setup](gitian-building.md#initial-gitian-setup)
* [Build binaries](gitian-building.md#build-binaries)
## Preparing the Gitian builder host
The first step is to prepare the host environment that will be used to perform the Gitian builds.
......
# Setup Debian virtual machine on VirtualBox
Table of Contents
-----------------
- [Create a new VirtualBox VM](#create-a-new-virtualbox-vm)
- [Connecting to the VM](#connecting-to-the-vm)
Create a new VirtualBox VM
--------------------------
In the VirtualBox GUI click "New" and choose the following parameters in the wizard:
......
Getting and building the inputs
-------------------------------
At this point you have two options, you can either use the automated script (found in [https://github.com/Bitcoin-ABC/bitcoin-abc/blob/master/contrib/gitian-build.py](https://github.com/Bitcoin-ABC/bitcoin-abc/blob/master/contrib/gitian-build.py), only works in Debian/Ubuntu) or you could manually do everything by following this guide.
At this point you have two options, you can either use the automated script (found in [contrib/gitian-build.py](../../contrib/gitian-build.py), only works in Debian/Ubuntu) or you could manually do everything by following this guide.
If you are using the automated script, then run it with the `--setup` command. Afterwards, run it with the `--build` command (example: `contrib/gitian-build.py -b signer 0.15.0`). Otherwise ignore this.
Follow the instructions in [https://github.com/bitcoin/bitcoin/blob/master/doc/release-process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/release-process.md#fetch-and-create-inputs-first-time-or-when-dependency-versions-change)
......@@ -10,10 +10,10 @@ manual intervention. Also optionally follow the next step: 'Seed the Gitian sour
and offline git repositories' which will fetch the remaining files required for building
offline.
Building Bitcoin ABC
--------------------
Building Bitcoin Cash Node
--------------------------
To build Bitcoin ABC (for Linux, OS X and Windows) just follow the steps under 'perform
To build Bitcoin Cash Node (for Linux, OS X and Windows) just follow the steps under 'perform
Gitian builds' in [https://github.com/bitcoin/bitcoin/blob/master/doc/release-process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/release-process.md#setup-and-perform-gitian-builds) in the bitcoin repository.
This may take some time as it will build all the dependencies needed for each descriptor.
......@@ -33,7 +33,7 @@ Output from `gbuild` will look something like
remote: Total 57959 (delta 0), reused 0 (delta 0), pack-reused 57958
Receiving objects: 100% (57959/57959), 53.76 MiB | 484.00 KiB/s, done.
Resolving deltas: 100% (41590/41590), done.
From https://github.com/Bitcoin-ABC/bitcoin-abc.git
From https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node.git
... (new tags, new branch etc)
--- Building for trusty amd64 ---
Stopping target if it is up
......@@ -59,11 +59,11 @@ and inputs.
For example:
```bash
URL=https://github.com/Bitcoin-ABC/bitcoin-abc.git
URL=https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node.git
COMMIT=v0.18.5
./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ../bitcoin-abc/contrib/gitian-descriptors/gitian-linux.yml
./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ../bitcoin-abc/contrib/gitian-descriptors/gitian-win.yml
./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ../bitcoin-abc/contrib/gitian-descriptors/gitian-osx.yml
./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ../bitcoin-cash-node/contrib/gitian-descriptors/gitian-linux.yml
./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ../bitcoin-cash-node/contrib/gitian-descriptors/gitian-win.yml
./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ../bitcoin-cash-node/contrib/gitian-descriptors/gitian-osx.yml
```
Building fully offline
......@@ -90,7 +90,7 @@ LXC_ARCH=amd64 LXC_SUITE=buster on-target -u root dpkg --add-architecture i386
LXC_ARCH=amd64 LXC_SUITE=buster on-target -u root apt-get update
LXC_ARCH=amd64 LXC_SUITE=buster on-target -u root \
-e DEBIAN_FRONTEND=noninteractive apt-get --no-install-recommends -y install \
$( sed -ne '/^packages:/,/^[^-]/ {/^- .*/{s/"//g;s/- //;p}}' ../bitcoin-abc/contrib/gitian-descriptors/*|sort|uniq )
$( sed -ne '/^packages:/,/^[^-]/ {/^- .*/{s/"//g;s/- //;p}}' ../bitcoin-cash-node/contrib/gitian-descriptors/*|sort|uniq )
LXC_ARCH=amd64 LXC_SUITE=buster on-target -u root apt-get -q -y purge grub
LXC_ARCH=amd64 LXC_SUITE=buster on-target -u root -e DEBIAN_FRONTEND=noninteractive apt-get -y dist-upgrade
```
......@@ -109,7 +109,7 @@ sudo service apt-cacher-ng restart
Then when building, override the remote URLs that gbuild would otherwise pull from the Gitian descriptors::
```bash
cd ~
export URL=${HOME}/bitcoin-abc
export URL=${HOME}/bitcoin-cash-node
export COMMIT=<commmit hash or tag>
./bin/gbuild --commit bitcoin=${COMMIT} --url bitcoin=${URL} ${URL}/contrib/gitian-descriptors/gitian-win.yml
......
# Setting up Debian for Gitian building
** Table of Contents **
* [Setting up Debian for Gitian building](gitian-building-setup-gitian-debian.md#setting-up-debian-for-gitian-building)
* [Installing Gitian](gitian-building-setup-gitian-debian.md#installing-gitian)
* [Setting up the Gitian image](gitian-building-setup-gitian-debian.md#setting-up-the-gitian-image)
* [Downloading dependencies](gitian-building-setup-gitian-debian.md#downloading-dependencies)
In this section we will be setting up the Debian installation for Gitian building.
We assume that a user `gitianuser` with sudo privileges was previously added.
......
......@@ -12,7 +12,7 @@ licenses until a specific process is established.
Translations in Bitcoin Core
============================
----------------------------
The Bitcoin-Core project has been designed to support multiple localisations. This makes adding new phrases, and completely new languages easily achievable. For managing all application translations, Bitcoin-Core makes use of the Transifex online translation management tool.
......
# XVersionMessage: BCH node extended version and configuration fields
DRAFT specification
Version: 0.1.0
Authors: Awemany, Griffith
......@@ -8,7 +9,7 @@ Authors: Awemany, Griffith
## Overview
Using the `version` message in the Bitcoin protocol (for more details,
see https://en.bitcoin.it/wiki/Protocol_documentation#version), peers
see [https://en.bitcoin.it/wiki/Protocol_documentation#version](https://en.bitcoin.it/wiki/Protocol_documentation#version)), peers
announce their capabilities and preferences to each other. The
`version` message is limited in scope to a fixed set of well-known
fields.
......@@ -192,7 +193,7 @@ document.
## Implementation prefixes
The list of implementations prefixes can be found here:
https://reference.cash/protocol/p2p/xversionkeys/
[https://reference.cash/protocol/p2p/xversionkeys/](https://reference.cash/protocol/p2p/xversionkeys/)
An implementation not listed here, but wanting to extend the `xversion`
map can pick an unused prefix but is strongly suggested to communicate
......@@ -225,6 +226,6 @@ can be found in the files `src/xversionmessage.h` and
## References
- [1] https://reference.cash/protocol/#command
- [2] https://reference.cash/protocol/network/messages/
- [3] https://reference.cash/protocol/p2p/compact__int/
- [1] [https://reference.cash/protocol/#command](https://reference.cash/protocol/#command)
- [2] [https://reference.cash/protocol/network/messages/](https://reference.cash/protocol/network/messages/)
- [3] [https://reference.cash/protocol/p2p/compact__int/](https://reference.cash/protocol/p2p/compact__int/)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment