Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trey-jones/xmrwasp
Web and stratum proxy for Monero miners.
https://github.com/trey-jones/xmrwasp
cryptocurrency mining-proxy monero monero-mining
Last synced: 3 months ago
JSON representation
Web and stratum proxy for Monero miners.
- Host: GitHub
- URL: https://github.com/trey-jones/xmrwasp
- Owner: trey-jones
- License: gpl-3.0
- Created: 2017-12-16T02:19:49.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-21T13:35:09.000Z (almost 7 years ago)
- Last Synced: 2024-06-20T14:21:13.874Z (8 months ago)
- Topics: cryptocurrency, mining-proxy, monero, monero-mining
- Language: JavaScript
- Size: 1.23 MB
- Stars: 20
- Watchers: 6
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# XMR WASP
XMR WASP is a **W**ebsocket **A**nd **S**tratum **P**roxy for Monero (XMR) miners. It accepts connections from miners over both websocket and plain TCP sockets using the monero stratum protocol. Written in Go and partly inspired by XMRig-Proxy.
## Goals
* Enable browser mining [in a responsible way](#a-word-about-responsibility)
* Educate site owners and users about browser mining through the [example site](https://www.xmrwasp.com) which uses this project as a proxy.
## Features
* Easy to use - just configure and execute the binary.
* No dependencies.
* Configurable with either OS Environment or JSON file.
* Low system overhead per connection.
* Accepts most miners, including Browser Miners!
* Reduce Pool Load by using one connection for many miners.
* Release builds for many platforms (not all thoroughly tested)
## Installation
### Download
[Binary releases are available for most platforms](https://github.com/trey-jones/xmrwasp/releases)
Move to a directory in your system PATH if desired.
### Install with Go Toolchain
As long as you don't pass the `-d` flag, `go get` will install the package as well.
`go get github.com/trey-jones/xmrwasp`
### Get the Docker Image
`docker pull treyjones/xmrwasp`
## Usage
### Binary Releases
To use XMR WASP just execute the binary as in the examples (unix):
#### Using a JSON config file
`xmrwasp -c example/example.config.json &`
#### Setting Environment at Runtime
```bash
XMRWASP_URL='xmrpool.eu:3333' \
XMRWASP_LOGIN='47sfBPDL9qbDuF5stdrE8C6gVQXf15SeTN4BNxBZ3Ahs6LTayo2Kia2YES7MeN5FU7MKUrWAYPhmeFUYQ3v4JBAvKSPjigi.250+env_example' \
XMRWASP_PASSWORD='x' \
xmrwasp
```
To run in the background and write to a log file instead of stdout:
```bash
XMRWASP_URL='xmrpool.eu:3333' \
XMRWASP_LOGIN='47sfBPDL9qbDuF5stdrE8C6gVQXf15SeTN4BNxBZ3Ahs6LTayo2Kia2YES7MeN5FU7MKUrWAYPhmeFUYQ3v4JBAvKSPjigi.250+env_example' \
XMRWASP_PASSWORD='x' \
XMRWASP_LOG='xmrwasp.log' \
xmrwasp &
tail -f xmrwasp.log
```
### Docker
#### Environment Config
```bash
docker run --rm -e 'XMRWASP_URL=xmrpool.eu:3333' \
-e 'XMRWASP_LOGIN=47sfBPDL9qbDuF5stdrE8C6gVQXf15SeTN4BNxBZ3Ahs6LTayo2Kia2YES7MeN5FU7MKUrWAYPhmeFUYQ3v4JBAvKSPjigi.250+env_example' \
-e 'XMRWASP_PASSWORD=x' \
treyjones/xmrwasp
```
#### File Config
```bash
docker run --rm -v $(pwd)/example.config.json:/config/config.json \
treyjones/xmrwasp -c config.json
```
### Run the example with docker-compose
```bash
cd example
docker-compose up
```
### Configuration
Configuration can be done via system environment variables, or by invoking `xmrwasp` with the `-c` flag, and passing a path to a JSON config file.
#### Required Configuration Options
Environment | JSON | Desc.
----------- | ---- | ------------
XMRWASP_URL | url | Address of mining pool you will connect to. Without protocol.
XMRWASP_LOGIN | login | Login (often your monero address) used to connect to the mining pool.
XMRWASP_PASSWORD | password | Password used to connect to the mining pool.
#### All Configuration Options
Environment | JSON | Default | Desc.
----------- | ---- | ------- | ------------
XMRWASP_NOWEB | noweb | false | Don't serve websocket connections.
XMRWASP_NOTCP | notcp | true | Don't serve stratum+tcp connections.
XMRWASP_WSPORT | wsport | 8080 | Port to listen for websocket connections.
XMRWASP_STRPORT | strport | 1111 | Port to listen for stratum+tcp connections.
XMRWASP_WSS | wss | false | If true, try to serve websocket connections with TLS encryption.
XMRWASP_TLSCERT | tlscert | "" | Path to a TLS certificate file. Required for `wss = true`
XMRWASP_TLSKEY | tlscert | "" | Path to private key used to create the above certificate. Required for `wss = true`
XMRWASP_STATS | stats | 60 | XMR WASP will print a report to the log at this interval (seconds)
XMRWASP_LOG | log | STDOUT | Path to your desired log file. Will be created if necessary. Takes precedence over `nolog`
XMRWASP_NOLOG | nolog | false | If true, no log will be generated and nothing will be written to STDOUT.
XMRWASP_DONATE | donate | 2 | Percentage of mining time to do jobs for the donation server.
XMRWASP_DEBUG | debug | false | Print debug messages to the log.
## Compatibility
The example is using [CryptoNoter](https://github.com/cryptonoter/CryptoNoter) for the browser miner. Since the Monero miner in that library is ripped straight from CoinHive, the latter can be used as well. If there are other browser miners that you want compatibility for, you can make an issue here, and I'll do my best to make it work.
Same goes for other mining software. Most any miner that can connect to a stratum mining pool should be able to connect to this proxy, excluding Claymore, [for now](#roadmap). This proxy can also connect to another instance of itself, which is how donate works. If you have compatibility problems, let me know!
I also aim to have excellent compatibility with mining pools. I would love to know if you find a pool that isn't working with this proxy. If you are a pool operator I would love to have a conversation about how I can better handle errors, etc. Pool operators possibly have a lot to gain from their users connecting through a proxy since it reduces the number of connections that must be maintained by the pool (by a factor of up to 1000 in this case).
## A Word About Responsibility
One of the primary features of this piece of software has to do with enabling Monero mining in the browser. The author of this project believes that browser mining **can** be a win-win. Even a win-win-win (users, website owners, and the blockchain). The users **can** win by not being subjected to ads, if browser mining proves to be lucrative enough for a site owner to stay afloat. But they can also lose, and lose badly, if the site owner doesn't excercise some restraint over the opportunity. Here are some things that you, as a site owner, probably know, but might be tempted to *forget* for the sake of maybe mining a few extra Moneroj:
* Don't mine on mobile devices, lest you destroy their battery and their ability to browse your site.
* Don't mine without telling your users that you are doing it.
* Give your users a say in whether they participate in mining, and how much.
* Throttling the browser miner is a **good idea for everyone**.
## Roadmap
* Max connection lifetime and eventual spindown
* Web Interface exposing current status and history
* Multiple pool configs for fallback
* Performance Improvements: Faster release of memory on broken connections
* User Feedback?
* TLS support for stratum+tcp listeners
* Just tons of little things that could be better
* Linux package manager repositories?
## Support This Project
The project has a donation mechanism built in. By default it donates for 1 minute and 12 seconds (donate=2) of every hour. It does this without breaking your pool connection. This is configurable down to 36 seconds (donate=1) per hour. Or higher if you feel generous. Saavy users of course may find that they can disable the donation mechanism. If you do so, consider a one time donation.
* Monero: `47sfBPDL9qbDuF5stdrE8C6gVQXf15SeTN4BNxBZ3Ahs6LTayo2Kia2YES7MeN5FU7MKUrWAYPhmeFUYQ3v4JBAvKSPjigi`
* Bitcoin: `1NwemnZSLhJLnNUbzXvER6yNX55pv9tAcv`
### Support Through Development
I will gladly take a look at any pull requests that come my way. In particular if you wanted to take a stab at any of the following types of items that don't align very well with my skillset and interests:
* Making the [example app](https://www.xmrwasp.com) look nice
* Building (or mocking up) a nice looking dashboard for a future web interface feature
* Making a badass logo/emblem to represent the project.
* Enhancing the appearance of the logging output.
* Testing on Windows