mmgen-node-tools/README.md

MMGen Node Tools

Terminal-based utilities for Bitcoin and forkcoin full nodes

Requires modules from the MMGen online/offline cryptocurrency wallet.

Install:

If installing as user (without venv), make sure that ~/.local/bin is in PATH.

Windows/MSYS2:

Install MSYS2 and the MMGen Wallet dependencies, skipping installation of scrypt, libsecp256k1 and the wallet itself if desired.

Install some additional dependencies:

> $ pacman -S mingw-w64-ucrt-x86_64-python-pandas
> $ python3 -m pip install requests-futures
> $ python3 -m pip install --no-deps yahooquery
> ```

#### Linux, macOS:

> Install some [required packages][7] with your package manager and pip.

### Stable version:

bash $ python3 -m pip install --upgrade mmgen-node-tools

### Development version:

Install the latest development version of [MMGen Wallet][6] for your platform:

bash $ git clone https://github.com/mmgen/mmgen-node-tools $ cd mmgen-node-tools $ python3 -m build --no-isolation $ python3 -m pip install dist/*.whl

## Test:

*NOTE: the tests require that the MMGen Wallet and MMGen Node Tools repositories be
located in the same directory.*

#### Windows/MSYS2:

> *Tested only on NTFS – with ReFS your mileage may vary*
>
> Turn on Developer Mode to enable symlinks:
> ```
> Settings -> Update & Security -> For developers -> Developer Mode: On
> ```
> and add this to your `~/.bashrc`:
> ```bash
> export MSYS=winsymlinks:nativestrict
> ```
> Close and reopen the MSYS2 terminal to update your environment.

Initialize the test framework (must be run at least once after cloning, and
possibly again after a pull if tests have been updated):

$ test/init.sh

BTC-only testing:

$ test/test-release.sh -A

Full testing:

$ test/test-release.sh ```

---

Homepage: Clearnet | I2P | Onion
Code repository: Clearnet | I2P | Onion
Code repository mirrors: Github | Gitlab | Gitflic
Keybase | Twitter | Reddit | Bitcointalk
PGP Signing Key: 5C84 CB45 AEE2 250F 31A6 A570 3F8B 1861 E32B 7DA2
Donate:
 ⊙ BTC: bc1qxmymxf8p5ckvlxkmkwgw8ap5t2xuaffmrpexap
 ⊙ BCH: 15TLdmi5NYLdqmtCqczUs5pBPkJDXRs83w
 ⊙ XMR: 8B14zb8wgLuKDdse5p8f3aKpFqRdB4i4xj83b7BHYABHMvHifWxiDXeKRELnaxL5FySfeRRS5girgUvgy8fQKsYMEzPUJ8h