Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 2.3 KB

README.md

File metadata and controls

56 lines (41 loc) · 2.3 KB
Raw

Kaspa-miner

Build status Latest version License dependency status

A Rust binary for file encryption to multiple participants.

Installation

From Sources

With Rust's package manager cargo, you can install kaspa-miner via:

cargo install kaspa-miner

From Binaries

The release page includes precompiled binaries for Linux, macOS and Windows.

Usage

To start mining you need to run kaspad and have an address to send the rewards to. There's a guide here on how to run a full node and how to generate addresses: https://github.com/kaspanet/docs/blob/main/Getting%20Started/Full%20Node%20Installation.md

Help:

kaspa-miner 0.2.0
A Kaspa high performance CPU miner

USAGE:
    kaspa-miner [FLAGS] [OPTIONS] --mining-address <mining-address>

FLAGS:
    -d, --debug                   Enable debug logging level
    -h, --help                    Prints help information
        --mine-when-not-synced    Mine even when kaspad says it is not synced, only useful when passing `--allow-submit-
                                  block-when-not-synced` to kaspad  [default: false]
        --testnet                 Use testnet instead of mainnet [default: false]
    -V, --version                 Prints version information

OPTIONS:
    -s, --kaspad-address <kaspad-address>    The IP of the kaspad instance [default: 127.0.0.1]
    -a, --mining-address <mining-address>    The Kaspa address for the miner reward
    -t, --threads <num-threads>              Amount of miner threads to launch [default: number of logical cpus]
    -p, --port <port>                        Kaspad port [default: Mainnet = 16111, Testnet = 16211]

To start mining you just need to run the following:

./kaspa-miner --mining-addr kaspa:XXXXX

This will run the miner on all the available CPU cores.

Donation Address

kaspa:qzvqtx5gkvl3tc54up6r8pk5mhuft9rtr0lvn624w9mtv4eqm9rvc9zfdmmpu