https://github.com/elichai/kaspa-miner

A fast CPU miner for Kaspa
https://github.com/elichai/kaspa-miner

Last synced: 20 days ago
JSON representation

A fast CPU miner for Kaspa

• Host: GitHub
• URL: https://github.com/elichai/kaspa-miner
• Owner: elichai
• License: apache-2.0
• Created: 2021-11-13T17:28:04.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-07T16:43:09.000Z (10 months ago)
• Last Synced: 2024-10-09T22:11:06.430Z (about 1 month ago)
• Language: Rust
• Size: 176 KB
• Stars: 85
• Watchers: 9
• Forks: 90
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# Kaspa-miner

[![Build status](https://github.com/elichai/kaspa-miner/workflows/ci/badge.svg)](https://github.com/elichai/kaspa-miner/actions)

[![Latest version](https://img.shields.io/crates/v/kaspa-miner.svg)](https://crates.io/crates/kaspa-miner)

![License](https://img.shields.io/crates/l/kaspa-miner.svg)

[![dependency status](https://deps.rs/repo/github/elichai/kaspa-miner/status.svg)](https://deps.rs/repo/github/elichai/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:

```sh

cargo install kaspa-miner

```

### From Binaries

The [release page](https://github.com/elichai/kaspa-miner/releases) includes precompiled binaries for Linux, macOS and Windows.

# Usage

To start mining you need to run [kaspad](https://github.com/kaspanet/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 

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             Mine a percentage of the blocks to the Kaspa devfund [default: Off]

        --devfund-percent     The percentage of blocks to send to the devfund [default: 1]

    -s, --kaspad-address       The IP of the kaspad instance [default: 127.0.0.1]

    -a, --mining-address       The Kaspa address for the miner reward

    -t, --threads                 Amount of miner threads to launch [default: number of logical cpus]

    -p, --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`