Skip to content

Commit 53bef0e

Browse files
committed
Prepare for 1.1.0 release, add @vsergeev credit.
1 parent 709c893 commit 53bef0e

File tree

4 files changed

+34
-14
lines changed

4 files changed

+34
-14
lines changed

README.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,33 @@ It features an OpenCL Kernel that has incorporated ideas or code from:
1414
If your work is represented herein and I didn't give you credit, please let me know. At the moment, I reserve no rights
1515
to the mining driver or the OpenCL kernel. They were derived from public domain works.
1616

17-
## New in Version 1.0.0
18-
* First release following the fork from [m0mchil/poclbm](https://github.com/m0mchil/poclbm). ([diff](https://github.com/m0mchil/poclbm/compare/master...JustinTArthur:v1.0.0))
19-
* Migrated code to Python 3. Requires Python 3.5+
20-
* Fix kernel compilation error in clang-based OpenCL compilers like macOS OpenCL and
21-
AMD ROCm.
22-
* Fix for not submitting shares to stratum servers reporting pdifficulty when server-side pdifficulty is below 1. By [luke-jr](https://github.com/luke-jr).
23-
* Minor performance improvements
24-
2517
## Economy
2618
At the time of writing, on-chip implementations of the Bitcoin mining algorithm will outperform this
2719
software in both time and joules expended. Under most conditions, mining blocks on a Bitcoin chain where
2820
on-chip implementations are competing would be at a tremendous waste of expended resources.
2921

22+
## New in Version 1.1.0
23+
This release focused on supporting the `getblocktemplate` call proposed in
24+
BIP 22 and BIP 23 and implemented by Bitcoin Core and btcd. This finally allows
25+
mining without a pool if you supply an address to mine coins to at the command
26+
line.
27+
28+
HTTP work sources now default to using `getblocktemplate` instead of `getwork`.
29+
This feature is new and might have bugs that could lead to loss of potential
30+
mining rewards.
31+
32+
It looks like the work sourcing threads run into i/o issues occasionally due to
33+
using the not-thread-safe Python http lib. I don't aim to address this as most
34+
of the threaded communication ought to be completely replaced by an event runner
35+
like asyncio or trio at some point.
36+
37+
Thanks to @momchil for the original `getwork` code, @luke-jr @sipa and @vsergeev
38+
for helping me understand getblocktemplate.
39+
3040
## Installation
31-
Python 3.5+ must be installed first. To install latest from master branch on GitHub:
41+
In an environment with Python 3.5+:
3242

33-
pip3 install git+git://github.com/JustinTArthur/apoclypsebm.git
43+
pip3 install apoclypsebm
3444

3545
## Usage
3646
apoclypse [OPTION]... SERVER[#tag]...
@@ -53,6 +63,15 @@ Python 3.5+ must be installed first. To install latest from master branch on Git
5363
-d DEVICE, --device=DEVICE
5464
comma separated device IDs, by default will use all
5565
(for OpenCL - only GPU devices)
66+
-a ADDRESS, --address=ADDRESS
67+
Bitcoin address to spend the block reward to if
68+
allowed. Required for solo mining, ignored with
69+
stratum or getwork sources.
70+
--coinbase-msg=COINBASE_MSG
71+
Custom text to include in the coinbase of the
72+
generation tx if allowed, encoded as UTF-8.
73+
default=ApoCLypse
74+
5675
5776
Miner Options:
5877
-r RATE, --rate=RATE

apoclypsebm/bitcoin.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
Bitcoin Network and Consensus Rules Code
33
Derived from BIP reference code and the Electrum project.
44
5-
https://github.com/spesmilo/electrum (MIT license)
65
https://github.com/bitcoin/bips (various licenses)
7-
6+
https://github.com/spesmilo/electrum (MIT license)
7+
https://github.com/vsergeev/ntgbtminer (MIT license)
88
"""
99
from enum import IntEnum
1010
from hashlib import sha256

apoclypsebm/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
VERSION = '1.0.0'
1+
VERSION = '1.1.0'

setup.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
args = {
1313
'name': 'apoclypsebm',
1414
'version': VERSION,
15-
'description': 'Python Driver for an OpenCL Bitcoin Miner',
15+
'description': 'The ApoCLypse Bitcoin Miner',
16+
'long_description': open('README.md').read(),
1617
'author': 'Justin T. Arthur',
1718
'author_email': 'justinarthur@gmail.com',
1819
'url': 'https://github.com/JustinTArthur/apoclypsebm/',

0 commit comments

Comments
 (0)