https://github.com/brndnmtthws/cgminer-rest
RESTful HTTP API wrapper for cgminer
https://github.com/brndnmtthws/cgminer-rest
bitcoin-mining cgminer cgminer-api
Last synced: 10 months ago
JSON representation
RESTful HTTP API wrapper for cgminer
- Host: GitHub
- URL: https://github.com/brndnmtthws/cgminer-rest
- Owner: brndnmtthws
- License: gpl-3.0
- Created: 2018-12-17T00:29:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-04-30T13:16:37.000Z (about 5 years ago)
- Last Synced: 2024-10-11T11:53:51.769Z (over 1 year ago)
- Topics: bitcoin-mining, cgminer, cgminer-api
- Language: Rust
- Size: 8.79 MB
- Stars: 9
- Watchers: 4
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/brndnmtthws/cgminer-rest) [](https://crates.io/crates/cgminer-rest) [](https://coveralls.io/github/brndnmtthws/cgminer-rest?branch=master) [](https://dependabot.com)
# cgminer-rest: a RESTful HTTP wrapper for the cgminer API
This package provides a RESTful HTTP wrapper around the
[cgminer](https://github.com/ckolivas/cgminer) API. Cgminer has a somewhat
esoteric API, which isn't easy to use with standard HTTP-based tooling. Using
this tool, it's easy to interact with cgminer programmatically or using a UI,
such as through a web browser.
## Installing
The package can be installed from [crates.io](https://crates.io/) using the `cargo` tool:
```ShellSession
$ cargo install cgminer-rest
...
$ cgminer-rest
```
See [`Rocket.toml`](Rocket.toml) for configuration details. Instructions on using `Rocket.toml` [can be found here](https://rocket.rs/v0.4/guide/configuration/#rockettoml).
*Note: currently you must be running nightly rust. It is recommended that you use [rustup](https://github.com/rust-lang/rustup.rs) to manage your rust installation.*
## Example
## API
### Endpoints
🛰 Mounting /:
=> GET /version (version)
=> GET /config (config)
=> GET /summary (summary)
=> GET /devs (devs)
=> GET /devdetails (devdetails)
=> GET /stats (stats)
=> GET /coin (coin)
=> GET /usbstats (usbstats)
=> GET /lcd (lcd)
=> GET /notify (notify)
=> GET /privileged (privileged)
=> PUT /restart (restart)
=> PUT /check/ (check)
=> PUT /debug (debug)
=> PUT /hotplug (hotplug)
=> GET /lockstats (lockstats)
=> PUT /zero (zero)
🛰 Mounting /pools:
=> GET /pools (pools)
=> PUT /pools//switchto (switchpool)
=> PUT /pools//enable (enablepool)
=> PUT /pools//disable (disablepool)
=> POST /pools (addpool)
=> DELETE /pools/ (removepool)
=> PUT /pools//quota (poolquota)
🛰 Mounting /pga:
=> GET /pga/ (pga)
=> GET /pga/count (pgacount)
=> PUT /pga//enable (pgaenable)
=> PUT /pga//disable (pgadisable)
=> GET /pga//identify (pgaidentify)
=> PUT /pga/ (pgaset)
🛰 Mounting /asc:
=> GET /asc/ (asc)
=> GET /asc/count (asccount)
=> PUT /asc//enable (ascenable)
=> PUT /asc//disable (ascdisable)
=> GET /asc//identify (ascidentify)
=> PUT /asc/ (ascset)
## Project Goals
The goal of this project is to create a high quality API for working with
cgminer-based ASICs, in order to enable development of better tooling for
Bitcoin mining (such as [dragon-rest](https://github.com/brndnmtthws/dragon-rest) and [mother-of-dragons](https://github.com/brndnmtthws/mother-of-dragons)).
If ASIC vendors adopt one canonical API for mining hardware, it will become
much easier to build tooling that works well with many different types of
mining hardware. Nearly all ASIC vendors already use cgminer underneath,
however the cgminer API is esoteric and somewhat difficult to work with
compared to HTTP.