Update documentation for Bitcoin Cash Node (BCH, BCHN)

The MMGen Project 2020-12-16 22:27:55 +03:00
commit aa566e2229
Signed by: mmgen
GPG key ID: 3F8B1861E32B7DA2
5 changed files with 46 additions and 45 deletions

@ -6,7 +6,7 @@
* [Transacting and other basic operations](#a_tx)
* [Creating and deploying ERC20 tokens](#a_dt)
#### [Full support for Bcash (BCH) and Litecoin](#a_bch)
#### [Full support for Bitcoin Cash Node (BCH) and Litecoin](#a_bch)
#### [Key/address generation for Zcash (ZEC)](#a_zec)
@ -109,8 +109,7 @@ On your offline machine, sign the TX:
$ mmgen-txsign --coin=eth --token=eos ABC123-EOS[10,50000].rawtx
*You can also set up and use [autosigning][X] on the offline machine, of
course.*
*You can also set up and use [autosigning][X] on the offline machine.*
On your online machine, send the TX:
@ -197,15 +196,16 @@ View your MFT tracking wallet:
Other token parameters can also be customized. Type `scripts/create-token.py --help`
for details.
### <a name='a_bch'>Full support for Bcash (BCH) and Litecoin</a>
### <a name='a_bch'>Full support for Bitcoin Cash Node (BCH) and Litecoin</a>
Bcash and Litecoin are fully supported by MMGen, on the same level as Bitcoin.
Bitcoin Cash Node (BCH) and Litecoin are fully supported by MMGen, on the same
level as Bitcoin.
To use MMGen with Bcash or Litecoin, first make sure the respective Bitcoin ABC
and Litecoin daemons are properly installed ([source][si])([binaries][bi]),
To use MMGen with BCH or Litecoin, first make sure the Bitcoin Cash Node or
Litecoin daemons are properly installed ([source][si])([binaries][bi]),
[running][p8] and synced.
MMGen requires that the bitcoin-abc daemon be listening on non-standard
MMGen requires that the bitcoin-bchn daemon be listening on non-standard
[RPC port 8442][p8]. If your daemon version is >= 0.16.2, you must use the
`--usecashaddr=0` option.

@ -43,17 +43,13 @@ binaries are available for Bitcoin Core, Bitcoin ABC and Litecoin. See the
$ cd src
$ sudo install -sv bitcoind bitcoin-cli /usr/local/bin
### Compile and install Bitcoin ABC (optional):
### Compile and install Bitcoin Cash Node (optional):
> *Consider Bitcoin ABC to be experimental software. The author of the MMGen
> project has only partially reviewed its codebase and makes no guarantees
> regarding its safety or reliability.*
> If you want to transact BCH, also known as “Bitcoin Cash Node”, then first
> clone the Bitcoin Cash Node repository:
> If you want to transact BCH, also known as “Bitcoin Cash” or “Bcash”, then
> first clone the Bitcoin ABC repository:
$ git clone https://github.com/Bitcoin-ABC/bitcoin-abc
$ cd bitcoin-abc
$ git clone https://github.com/bitcoin-cash-node/bitcoin-cash-node
$ cd bitcoin-cash-node
> Then configure and build using the same configure and build steps as with
> Bitcoin Core above.
@ -62,9 +58,9 @@ binaries are available for Bitcoin Core, Bitcoin ABC and Litecoin. See the
> under a different name to avoid overwriting your Core daemon:
$ cd src
$ sudo install -sv bitcoind /usr/local/bin/bitcoind-abc
$ sudo install -sv bitcoind /usr/local/bin/bitcoind-bchn
> From now on, you’ll invoke the daemon as 'bitcoind-abc' instead of 'bitcoind'.
> From now on, you’ll invoke the daemon as 'bitcoind-bchn' instead of 'bitcoind'.
### Compile and install Litecoin Core (optional):
@ -92,3 +88,4 @@ same machine:
[01]: Install-Bitcoind
[02]: Install-Bitcoind#a_r
[bu]: https://github.com/bitcoin/bitcoin/blob/master/doc/build-unix.md
[bcha]: https://github.com/Bitcoin-ABC/bitcoin-abc

@ -25,13 +25,11 @@ more low-powered computer as your online machine.
>> 32-bit or 64-bit versions appropriate for your online and offline computers.
>> Windows users should choose the executable installer.
> **Bitcoin ABC (optional):**
> **Bitcoin Cash Node (optional):**
>> If you wish to transact BCH (Bcash), then download the appropriate [Bitcoin
>> ABC binary][abc] for your system as well. Windows users should choose the
>> executable installer.
>> *Consider the Bitcoin ABC binaries untrusted software. The author of the
>> MMGen project makes no guarantees regarding their safety or reliability.*
>> If you wish to transact BCH (Bitcoin Cash Node), then download the
>> appropriate [Bitcoin Cash Node binary][bchn] for your system as well.
>> Windows users should choose the executable installer.
> **Litecoin (optional):**
@ -46,19 +44,21 @@ more low-powered computer as your online machine.
>> **Windows:** Run the Windows installer with the default settings.
>> At the end of the installation process, uncheck the Run box to prevent the
>> client from starting.
>> Add `C:\Program Files\Bitcoin\daemon` to your [path][05].
>> Add `C:\Program Files\Bitcoin\daemon` to your [path][05].
>>
>> **Linux:** Unpack the archive and copy the `bitcoind` and `bitcoin-cli`
>> binaries to `/usr/local/bin`.
> **Bitcoin ABC (optional):**
> **Bitcoin Cash Node (optional):**
>> **Windows:** Run the Windows installer with the default settings.
>> At the end of the installation process, uncheck the Run box to prevent the
>> client from starting.
>> Add `C:\Program Files\Bitcoin-abc\daemon` to your [path][05].
>> Rename the file `bitcoind` in that folder to `bitcoind-abc` and
>> `bitcoin-cli` to `bitcoin-cli-abc`.
>> **Linux:** Unpack the archive, rename `bitcoind` to `bitcoind-abc` and
>> Add `C:\Program Files\Bitcoin-Cash-Node\daemon` to your [path][05].
>> Rename the file `bitcoind` in that folder to `bitcoind-bchn` and
>> `bitcoin-cli` to `bitcoin-cli-bchn`.
>>
>> **Linux:** Unpack the archive, rename `bitcoind` to `bitcoind-bchn` and
>> copy it to `/usr/local/bin`.
> **Litecoin (optional):**
@ -66,7 +66,8 @@ more low-powered computer as your online machine.
>> **Windows:** Run the Windows installer with the default settings.
>> At the end of the installation process, uncheck the Run box to prevent the
>> client from starting.
>> Add `C:\Program Files\Litecoin\daemon` to your [path][05].
>> Add `C:\Program Files\Litecoin\daemon` to your [path][05].
>>
>> **Linux:** Unpack the archive and copy the `litecoind` and
>> `litecoin-cli` binaries to `/usr/local/bin`.
@ -81,14 +82,15 @@ more low-powered computer as your online machine.
# Bitcoin Core:
$ bitcoind
# ABC:
$ mkdir $APPDATA/Bitcoin_ABC
$ bitcoind-abc --listen=0 --rpcport=8442 --datadir=$APPDATA/Bitcoin_ABC --usecashaddr=0
# Bitcoin Cash Node:
$ mkdir $APPDATA/Bitcoin-Cash-Node
$ bitcoind-bchn --listen=0 --rpcport=8442 --datadir=$APPDATA/Bitcoin-Cash-Node --usecashaddr=0
# Litecoin
$ litecoind
>> Note that the `--listen=0` argument is required only when running Core and ABC simultaneously.
>> Note that the `--listen=0` argument is required only when running Bitcoin
>> Core and Bitcoin Cash Node simultaneously.
> **Linux:**
@ -97,9 +99,9 @@ more low-powered computer as your online machine.
# Bitcoin Core:
$ bitcoind --daemon
# ABC:
$ mkdir ~/.bitcoin-abc
$ bitcoind-abc --daemon --listen=0 --rpcport=8442 --datadir=$HOME/.bitcoin-abc --usecashaddr=0
# Bitcoin Cash Node:
$ mkdir ~/.bitcoin-bchn
$ bitcoind-bchn --daemon --listen=0 --rpcport=8442 --datadir=$HOME/.bitcoin-bchn --usecashaddr=0
# Litecoin:
$ litecoind --daemon
@ -109,8 +111,8 @@ more low-powered computer as your online machine.
# Core:
$ bitcoin-cli help
# ABC:
$ bitcoin-cli-abc --rpcport=8442 help
# Bitcoin Cash Node:
$ bitcoin-cli-bchn --rpcport=8442 help
# Litecoin:
$ litecoin-cli help
@ -138,3 +140,4 @@ more low-powered computer as your online machine.
[05]: Editing-the-user-path-in-Windows
[abc]: https://download.bitcoinabc.org/
[lc]: https://download.litecoin.org/litecoin-0.17.1/
[bchn]: https://github.com/bitcoin-cash-node/bitcoin-cash-node

@ -191,7 +191,7 @@ Open your shell’s runtime configuration file in a text editor:
Add the following two lines to the end of the file, save and exit:
export PATH="/mingw64/bin:$PATH:/c/Program Files/Bitcoin/daemon:/c/Program Files/Litecoin/daemon:/c/Program Files/Bitcoin-abc/daemon"
export PATH="/mingw64/bin:$PATH:/c/Program Files/Bitcoin/daemon:/c/Program Files/Litecoin/daemon:/c/Program Files/Bitcoin-Cash-Node/daemon"
export PYTHONUTF8=1
Close and reopen the terminal window to update your working environment.
@ -337,8 +337,8 @@ Please be aware of the following, however:
+ Non-ASCII filenames cannot be used with the Monero wallet syncing tool. This
is an issue with the Monero wallet RPC daemon rather than MMGen.
+ The Bitcoin-ABC daemon cannot handle non-ASCII pathnames. This is an issue
with the Bitcoin-ABC implementation for Windows, not MMGen.
+ The Bitcoin Cash Node daemon cannot handle non-ASCII pathnames. This is an
issue with the Bitcoin Cash Node implementation for Windows, not MMGen.
[mh]: https://www.msys2.org
[mp]: https://sourceforge.net/projects/msys2

@ -34,7 +34,7 @@ Run the test suite, skipping altcoin tests:
### Complete testing (BTC plus all supported altcoins)
Make sure the [Bitcoin-ABC][ad], [Litecoin][ld] and [Monero][md]
Make sure the [Bitcoin Cash Node][cnd], [Litecoin][ld] and [Monero][md]
daemons are installed on your system.
Install [OpenEthereum, the Ethereum dependencies][oe] and the [Solidity
@ -125,6 +125,7 @@ commands’ output on the screen as they’re being run.
[bd]: Install-Bitcoind
[md]: https://getmonero.org/downloads/#linux
[ad]: https://download.bitcoinabc.org/
[cnd]: https://bitcoincashnode.org/
[ld]: https://download.litecoin.org/litecoin-0.17.1/
[oe]: Altcoin-and-Forkcoin-Support#a_oe
[sc]: Altcoin-and-Forkcoin-Support#a_dt