https://github.com/jtgrassie/xmr-wasm
A Monero WebAssembly based miner
https://github.com/jtgrassie/xmr-wasm
monero monero-mining webassembly xmr
Last synced: about 1 year ago
JSON representation
A Monero WebAssembly based miner
- Host: GitHub
- URL: https://github.com/jtgrassie/xmr-wasm
- Owner: jtgrassie
- License: other
- Created: 2018-05-06T15:13:36.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-28T00:22:13.000Z (over 7 years ago)
- Last Synced: 2025-04-06T21:14:20.227Z (about 1 year ago)
- Topics: monero, monero-mining, webassembly, xmr
- Language: C
- Homepage:
- Size: 247 KB
- Stars: 108
- Watchers: 19
- Forks: 36
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A Monero WebAssembly based miner
The core aim of this project is to provide a completely open source, browser based, Monero miner. It has a companion project, [my fork](https://github.com/jtgrassie/xmr-node-proxy) of Snipa's **xmr-node-proxy** which adds a WebSocket based branch for allowing this miner to connect through to various mining pools.
Whilst browser mining can be used maliciously, there are many non-malicious use-cases, such as charitable donations (the very reason this project started). A defining aspect to whether web mining is done in a fair way is that of user consent. My recommendation is therefore to ensure the end-user knows the page will be mining and offer them controls such as starting and stopping, and options for how much processing time the mining should use.
## Compiling
To compile, you first need a working setup of the WebAssembly toolchain. Follow instructions at [webassembly.org](http://webassembly.org/getting-started/developers-guide/).
Then simply run `make` in the root directory of this repository. This will output to the build/debug folder.
For an optimized release version, just run `make TYPE=release`.
To test locally, just tack `run` onto the end of the above commands, which will start a local server for testing (required to load the WebAssembly module).
## License
Please see [LICENSE](LICENSE)