react-coinhive
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/react-coinhive package

1.0.2 • Public • Published

react-coinhive

Mine cryptocurrency in your browser. This uses Coin-Hive to mine Monero (XMR).

Installation

npm install --save react-coinhive

Usage

import React from 'react';
import CoinHive from 'react-coinhive';
 
export default MyClass extends React.Component {
  render() {
    return (
      <CoinHive
        userName="Maya"
        siteKey="caP8U8pZXH6n0f53eV3fdpwOvpmTAD3C"
        autoThreads={false}
        threads={2}
        src={CoinHive.src.authedmine}
        onInit={miner => setInterval(
          () => console.log(CoinHive.getMinerData(miner))
          , 1000
        )}
      />
    )
  }
}

Props

  • siteKey: Your Coin-Hive Site Key.

  • userName: If used, the miner will be created with CoinHive.User(siteKey, userName). By default the miner is created with CoinHive.Anonymous(siteKey).

  • src : Source url of the js script minier. Requires a string. Default is CoinHiveClient.src.coinhive ('https://coinhive.com/lib/coinhive.min.js') Available default values :

      CoinHiveClient.src = {
        coinhive: 'https://coinhive.com/lib/coinhive.min.js',
        authedmine : 'https://authedmine.com/lib/authedmine.min.js',
      };
  • threads: The number of threads the miner should start with. Default is 2.

  • throttle: The fraction of time that threads should be idle. Default is 0.

  • onInit: A function that takes the miner instance as argument. It's called when the miner is created.

  • onStart: A function that takes the miner instance as argument. It's called every time the miner is started.

  • onStop: A function that takes the miner instance as argument. It's called every time the miner is stopped.

Disclaimer

I have nothing to do with coin-hive.com.

Package Sidebar

Install

npm i react-coinhive

Weekly Downloads

24

Version

1.0.2

License

MIT

Last publish

Collaborators

  • dragma