https://github.com/justintarthur/apoclypsebm
The ApoCLypse Bitcoin Miner
https://github.com/justintarthur/apoclypsebm
bitcoin cryptocurrency gpu mining opencl opencl-kernels python sha-2 sha-256 sha256 simd simd-vector vector-math
Last synced: 3 months ago
JSON representation
The ApoCLypse Bitcoin Miner
- Host: GitHub
- URL: https://github.com/justintarthur/apoclypsebm
- Owner: JustinTArthur
- License: other
- Created: 2013-03-31T23:25:08.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2020-05-22T09:15:53.000Z (over 5 years ago)
- Last Synced: 2025-06-09T09:44:31.164Z (4 months ago)
- Topics: bitcoin, cryptocurrency, gpu, mining, opencl, opencl-kernels, python, sha-2, sha-256, sha256, simd, simd-vector, vector-math
- Language: Python
- Homepage:
- Size: 380 KB
- Stars: 17
- Watchers: 1
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# apoclypsebm - The ApoCLypse Bitcoin Miner
## Background
This hobby project maintained by
[Justin T. Arthur](https://github.com/JustinTArthur) undertakes the quixotic
task of maintaining a modern Bitcoin miner for programmable compute devices like
GPUs. It was forked from the PyOpenCL Bitcoin Miner (poclbm), a project authored
by [m0mchil](https://github.com/m0mchil) and contributors.
It features an OpenCL Kernel that has incorporated ideas or code from:
* [diapolo](https://github.com/diapolo)
* [m0mchil](https://github.com/m0mchil)
* [neurobox](https://bitcointalk.org/index.php?action=profile;u=106397)
* [phataeus](https://sourceforge.net/u/phateus/)
* [rethaw](https://bitcointalk.org/index.php?action=profile;u=18618)
If your work is represented herein and I didn't give you credit, please let me
know. At the moment, I reserve no rights to the mining driver or the OpenCL
kernel. They were derived from public domain works.
## Economy
At the time of writing, on-chip implementations of the Bitcoin mining algorithm
will outperform this software in both time and joules expended. Under most
conditions, mining blocks on a Bitcoin chain where on-chip implementations are
competing would be at a tremendous waste of expended resources.
## Maintenance Notes
It looks like the work sourcing threads run into i/o issues occasionally due to
using the not-thread-safe Python http lib. I don't aim to address this as most
of the threaded communication ought to be completely replaced by an event runner
like asyncio or trio at some point.
Thanks to @momchil for the original `getwork` code, @luke-jr @sipa and @vsergeev
for helping me understand getblocktemplate.
## Installation
In an environment with Python 3.5+:
pip3 install apoclypsebm
## Usage
apoclypse [OPTION]... SERVER[#tag]...
`SERVER` is one or more [http[s]|stratum://]user:pass@host:port (required)
[#tag] is an optional per server user-friendly name displayed in stats.
### Options
```
Options:
--version show program's version number and exit
-h, --help show this help message and exit
--verbose verbose output, suitable for redirection to log file
-q, --quiet suppress all output except hash rate display
--proxy=PROXY specify as
[[socks4|socks5|http://]user:pass@]host:port (default
proto is socks5)
--no-ocl don't use OpenCL
--no-bfl don't use Butterfly Labs
--stratum-proxies search for and use stratum proxies in subnet
-d DEVICE, --device=DEVICE
comma separated device IDs, by default will use all
(for OpenCL - only GPU devices)
-a ADDRESS, --address=ADDRESS
Bitcoin address to spend the block reward to if
allowed. Required for solo mining, ignored with
stratum or getwork sources.
--coinbase-msg=COINBASE_MSG
Custom text to include in the coinbase of the
generation tx if allowed, encoded as UTF-8.
default=ApoCLypse
Miner Options:
-r RATE, --rate=RATE
hash rate display interval in seconds, default=1 (60
with --verbose)
-e ESTIMATE, --estimate=ESTIMATE
estimated rate time window in seconds, default 900 (15
minutes)
-t TOLERANCE, --tolerance=TOLERANCE
use fallback pool only after N consecutive connection
errors, default 2
-b FAILBACK, --failback=FAILBACK
attempt to fail back to the primary pool after N
seconds, default 60
--cutoff-temp=CUTOFF_TEMP
AMD GPUs, BFL only. For GPUs requires
github.com/mjmvisser/adl3. Comma separated
temperatures at which to skip kernel execution, in C,
default=95
--cutoff-interval=CUTOFF_INTERVAL
how long to not execute calculations if CUTOFF_TEMP is
reached, in seconds, default=0.01
--no-server-failbacks
disable using failback hosts provided by server
OpenCL Options:
Every option except 'platform' and 'vectors' can be specified as a
comma separated list. If there aren't enough entries specified, the
last available is used. Use --vv to specify per-device vectors usage.
-p PLATFORM, --platform=PLATFORM
use platform by id
-k KERNEL, --kernel=KERNEL
OpenCL Kernel to use. Defaults to apoclypse-0
-w WORKSIZE, --worksize=WORKSIZE
work group size, default is maximum reported by the
driver.
-f FRAMES, --frames=FRAMES
will try to bring single kernel execution to 1/frames
seconds, default=30, increase this for less desktop
lag
-s FRAME_SLEEP, --sleep=FRAME_SLEEP
sleep per frame in seconds, default 0
--vv=VECTORS Specifies size of SIMD vectors per selected device.
Only size 0 (no vectors) and 2 supported for now.
Comma separated for each device. e.g. 0,2,2
-v, --vectors Use 2-item vectors for all devices.
```
### Examples
Solo mining against a Bitcoin Core node's RPC port:
apoclypse --address bc1qf2277gpv3hlewlqq2cuvf77qz5xcjzr7njf3s9 --verbose http://u:p@127.0.0.1:8332
Mining on OpenCL platform 0, device 1 against a stratum server:
apoclypse -p 0 -d 1 --verbose stratum://u:p@us-east.stratum.hushpool.io:3333