4 releases
0.2.5 | Jan 7, 2024 |
---|---|
0.2.4 | Jan 4, 2024 |
0.2.3 | Aug 22, 2023 |
0.2.0 | Dec 26, 2021 |
#4 in #miner
40 downloads per month
160KB
4K
SLoC
Kaspa-miner
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.1
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:
--devfund <devfund-address> Mine a percentage of the blocks to the Kaspa devfund [default: Off]
--devfund-percent <devfund-percent> The percentage of blocks to send to the devfund [default: 1]
-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-address kaspa:XXXXX
This will run the miner on all the available CPU cores.
Devfund
NOTE: This feature is off by default
The devfund is a fund managed by the Kaspa community in order to fund Kaspa development
A miner that wants to mine a percentage into the dev-fund can pass the following flags:
kaspa-miner --mining-address= XXX --devfund=kaspa:precqv0krj3r6uyyfa36ga7s0u9jct0v4wg8ctsfde2gkrsgwgw8jgxfzfc98
and can pass --devfund-precent=XX.YY
to mine only XX.YY% of the blocks into the devfund (passing --devfund
without specifying a percent will default to 1%)
Donation Address
kaspa:qzvqtx5gkvl3tc54up6r8pk5mhuft9rtr0lvn624w9mtv4eqm9rvc9zfdmmpu
Dependencies
~10–40MB
~560K SLoC