Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amir20/sha-miner
Simple miner for understanding how cryptocurrency mining works
https://github.com/amir20/sha-miner
blockchain cryptocurrency golang miner
Last synced: 3 months ago
JSON representation
Simple miner for understanding how cryptocurrency mining works
- Host: GitHub
- URL: https://github.com/amir20/sha-miner
- Owner: amir20
- Created: 2017-11-07T00:26:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T17:30:28.000Z (about 1 year ago)
- Last Synced: 2024-10-14T10:45:41.395Z (4 months ago)
- Topics: blockchain, cryptocurrency, golang, miner
- Language: Go
- Homepage:
- Size: 11.7 KB
- Stars: 37
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# What is sha-miner?
This project was created to understand how cryto-currency miners work. For a while, I have understood at a high-level what miners do but the best way for me to really understand was to implement it myself.
# How does the project work
I read the source code for [geth](https://github.com/ethereum/go-ethereum) to understand how `difficulty` is implemented and how `hashrate` was computed. This example miner uses all of your CPU cores to "mine" a nonce where `hash(nonce + message) <= threshold`. I use sha-256.
# How is this different than the real implementation
Real miners start with a random number to increase the chances of one miner mining a block. And, instead of using bytes of a string, the bytes of the currently block that is being mined will be used. Finally, this example uses `sha-256` while etherum uses `KECCAK-256`.
# Does it use GPU?
I wish. I haven't figured out how to leverage GPU with Go yet. Geth doesn't support [GPU officially](https://ethereum.gitbooks.io/frontier-guide/content/gpu.html) but they are working on it. The C++ implementation does support GPU.
# Usage
```
$ sha-miner -h
Usage of sha-miner:
-d, --difficulty uint Difficulty value to use for mining (default 100000000)
-m, --message string Message to compute the hash (default "Hello world.")
-t, --threads int Total number of threads to use. Defaults to number of CPUs (default 1)
```
# Installation
For the latest binaries, download them [here](https://github.com/amir20/sha-miner/releases).
# Installation from source
You need to have `pflag` and `go-metrics`. You can install them by doing
```
go get -u github.com/rcrowley/go-metrics
go get -u github.com/spf13/pflag
```
[Goreleaser](https://goreleaser.com/#fpm_linux_packages) is used to build binaries for all operating systems. You need to have `rpmbuild` and `fpm` installed. You can do so by doing `brew install rpm` and follow the installation instruction for [fpm](http://fpm.readthedocs.io/en/latest/installing.html).
# Example Output
```
$ sha-miner -m "This is sample data"
Effective Hashrate is 0.00 MH/s
Effective Hashrate is 5.87 MH/s
Effective Hashrate is 5.81 MH/s
Effective Hashrate is 5.81 MH/s
Found nonce 11529215046083745388 with hashrate of 5.77 MH/s
```