{"id":28523051,"url":"https://github.com/justintarthur/apoclypsebm","last_synced_at":"2025-07-08T15:04:52.872Z","repository":{"id":7769007,"uuid":"9137780","full_name":"JustinTArthur/apoclypsebm","owner":"JustinTArthur","description":"The ApoCLypse Bitcoin Miner","archived":false,"fork":false,"pushed_at":"2020-05-22T09:15:53.000Z","size":389,"stargazers_count":17,"open_issues_count":5,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-09T09:44:31.164Z","etag":null,"topics":["bitcoin","cryptocurrency","gpu","mining","opencl","opencl-kernels","python","sha-2","sha-256","sha256","simd","simd-vector","vector-math"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JustinTArthur.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-03-31T23:25:08.000Z","updated_at":"2025-06-08T10:24:51.000Z","dependencies_parsed_at":"2022-09-09T16:01:41.236Z","dependency_job_id":null,"html_url":"https://github.com/JustinTArthur/apoclypsebm","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/JustinTArthur/apoclypsebm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JustinTArthur%2Fapoclypsebm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JustinTArthur%2Fapoclypsebm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JustinTArthur%2Fapoclypsebm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JustinTArthur%2Fapoclypsebm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JustinTArthur","download_url":"https://codeload.github.com/JustinTArthur/apoclypsebm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JustinTArthur%2Fapoclypsebm/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263843045,"owners_count":23518709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin","cryptocurrency","gpu","mining","opencl","opencl-kernels","python","sha-2","sha-256","sha256","simd","simd-vector","vector-math"],"created_at":"2025-06-09T09:38:36.985Z","updated_at":"2025-07-06T03:31:29.186Z","avatar_url":"https://github.com/JustinTArthur.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# apoclypsebm - The ApoCLypse Bitcoin Miner\n## Background\nThis hobby project maintained by\n[Justin T. Arthur](https://github.com/JustinTArthur) undertakes the quixotic\ntask of maintaining a modern Bitcoin miner for programmable compute devices like\nGPUs. It was forked from the PyOpenCL Bitcoin Miner (poclbm), a project authored\nby [m0mchil](https://github.com/m0mchil) and contributors.\n\nIt features an OpenCL Kernel that has incorporated ideas or code from:\n* [diapolo](https://github.com/diapolo)\n* [m0mchil](https://github.com/m0mchil)\n* [neurobox](https://bitcointalk.org/index.php?action=profile;u=106397)\n* [phataeus](https://sourceforge.net/u/phateus/)\n* [rethaw](https://bitcointalk.org/index.php?action=profile;u=18618)\n\nIf your work is represented herein and I didn't give you credit, please let me\nknow. At the moment, I reserve no rights to the mining driver or the OpenCL\nkernel. They were derived from public domain works.\n\n## Economy\nAt the time of writing, on-chip implementations of the Bitcoin mining algorithm\nwill outperform this software in both time and joules expended. Under most\nconditions, mining blocks on a Bitcoin chain where on-chip implementations are\ncompeting would be at a tremendous waste of expended resources.\n\n## Maintenance Notes\nIt looks like the work sourcing threads run into i/o issues occasionally due to\nusing the not-thread-safe Python http lib. I don't aim to address this as most\nof the threaded communication ought to be completely replaced by an event runner\nlike asyncio or trio at some point.\n\nThanks to @momchil for the original `getwork` code, @luke-jr @sipa and @vsergeev\nfor helping me understand getblocktemplate. \n\n## Installation\nIn an environment with Python 3.5+:\n\n    pip3 install apoclypsebm\n\n## Usage\n    apoclypse [OPTION]... SERVER[#tag]...\n\n`SERVER` is one or more [http[s]|stratum://]user:pass@host:port (required)  \n[#tag] is an optional per server user-friendly name displayed in stats.\n\n### Options\n```\nOptions:\n  --version             show program's version number and exit\n  -h, --help            show this help message and exit\n  --verbose             verbose output, suitable for redirection to log file\n  -q, --quiet           suppress all output except hash rate display\n  --proxy=PROXY         specify as\n                        [[socks4|socks5|http://]user:pass@]host:port (default\n                        proto is socks5)\n  --no-ocl              don't use OpenCL\n  --no-bfl              don't use Butterfly Labs\n  --stratum-proxies     search for and use stratum proxies in subnet\n  -d DEVICE, --device=DEVICE\n                        comma separated device IDs, by default will use all\n                        (for OpenCL - only GPU devices)\n  -a ADDRESS, --address=ADDRESS\n                        Bitcoin address to spend the block reward to if\n                        allowed. Required for solo mining, ignored with\n                        stratum or getwork sources.\n  --coinbase-msg=COINBASE_MSG\n                        Custom text to include in the coinbase of the\n                        generation tx if allowed, encoded as UTF-8.\n                        default=ApoCLypse\n\n  Miner Options:\n    -r RATE, --rate=RATE\n                        hash rate display interval in seconds, default=1 (60\n                        with --verbose)\n    -e ESTIMATE, --estimate=ESTIMATE\n                        estimated rate time window in seconds, default 900 (15\n                        minutes)\n    -t TOLERANCE, --tolerance=TOLERANCE\n                        use fallback pool only after N consecutive connection\n                        errors, default 2\n    -b FAILBACK, --failback=FAILBACK\n                        attempt to fail back to the primary pool after N\n                        seconds, default 60\n    --cutoff-temp=CUTOFF_TEMP\n                        AMD GPUs, BFL only. For GPUs requires\n                        github.com/mjmvisser/adl3. Comma separated\n                        temperatures at which to skip kernel execution, in C,\n                        default=95\n    --cutoff-interval=CUTOFF_INTERVAL\n                        how long to not execute calculations if CUTOFF_TEMP is\n                        reached, in seconds, default=0.01\n    --no-server-failbacks\n                        disable using failback hosts provided by server\n\n  OpenCL Options:\n    Every option except 'platform' and 'vectors' can be specified as a\n    comma separated list. If there aren't enough entries specified, the\n    last available is used. Use --vv to specify per-device vectors usage.\n\n    -p PLATFORM, --platform=PLATFORM\n                        use platform by id\n    -k KERNEL, --kernel=KERNEL\n                        OpenCL Kernel to use. Defaults to apoclypse-0\n    -w WORKSIZE, --worksize=WORKSIZE\n                        work group size, default is maximum reported by the\n                        driver.\n    -f FRAMES, --frames=FRAMES\n                        will try to bring single kernel execution to 1/frames\n                        seconds, default=30, increase this for less desktop\n                        lag\n    -s FRAME_SLEEP, --sleep=FRAME_SLEEP\n                        sleep per frame in seconds, default 0\n    --vv=VECTORS        Specifies size of SIMD vectors per selected device.\n                        Only size 0 (no vectors) and 2 supported for now.\n                        Comma separated for each device. e.g. 0,2,2\n    -v, --vectors       Use 2-item vectors for all devices.\n```\n\n### Examples\nSolo mining against a Bitcoin Core node's RPC port:\n\n    apoclypse --address bc1qf2277gpv3hlewlqq2cuvf77qz5xcjzr7njf3s9 --verbose http://u:p@127.0.0.1:8332\n\nMining on OpenCL platform 0, device 1 against a stratum server:\n\n    apoclypse -p 0 -d 1 --verbose stratum://u:p@us-east.stratum.hushpool.io:3333\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjustintarthur%2Fapoclypsebm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjustintarthur%2Fapoclypsebm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjustintarthur%2Fapoclypsebm/lists"}