CoinImp

Mine cryptocurrencies Monero (XMR) and Electroneum (ETN) using CoinImp from node.js

This Project is a fork of CoinHive, which uses CoinImp instead of CoinHive to mine cryptocurrencies

Install

npm install -g coin-imp

Usage

const CoinImp = require('coin-imp');

(async () => {
  // Create miner
  const miner = await CoinImp('7591494ad1e56601bc8358580d567b319753bc773de35ce1f0d53bb8e4b97186'); // CoinImp's Site Key

  // Start miner
  await miner.start();

  // Listen on events
  miner.on('found', () => console.log('Found!'));
  miner.on('accepted', () => console.log('Accepted!'));
  miner.on('update', data =>
    console.log(`
    Hashes per second: ${data.hashesPerSecond}
    Total hashes: ${data.totalHashes}
    Accepted hashes: ${data.acceptedHashes}
  `)
  );

  // Stop miner
  setTimeout(async () => await miner.stop(), 60000);
})();

CLI

Usage:

coin-imp 7591494ad1e56601bc8358580d567b319753bc773de35ce1f0d53bb8e4b97186

Options:

  --interval        Interval between updates (logs)
  --port            Port for the miner server
  --host            Host for the miner server
  --threads         Number of threads for the miner
  --throttle        The fraction of time that threads should be idle
  --proxy           Proxy socket 5/4, for example: socks5://127.0.0.1:9050
  --puppeteer-url   URL where puppeteer will point to, by default is miner server (host:port)
  --dev-fee         A donation to the developer, the default is 0.001 (0.1%)
  --pool-host       A custom stratum pool host, it must be used in combination with --pool-port
  --pool-port       A custom stratum pool port, it must be used in combination with --pool-host
  --pool-pass       A custom stratum pool password, if not provided the default one is 'x'

API

• CoinImp(siteKey[, options]): Returns a promise of a Miner instance. It requires a CoinImp Site Key. The options object is optional and may contain the following properties:

  • interval: Interval between update events in ms. Default is 1000.

  • port: Port for the miner server. Default is 3002.

  • host: Host for the miner server. Default is localhost.

  • threads: Number of threads. Default is navigator.hardwareConcurrency (number of CPU cores).

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

  • proxy: Puppeteer's proxy socket 5/4 (ie: socks5://127.0.0.1:9050).

  • launch: The options that will be passed to puppeteer.launch(options). See Puppeteer Docs.

  • pool: This allows you to use a different pool. It has to be an Stratum based pool. This object must contain the following properties:

    • host: The pool's host.

    • port: The pool's port.

    • pass: The pool's password. If not provided the default one is "x".

  • devFee: A donation to send to the developer. Default is 0.001 (0.1%).

• miner.start(): Connect to the pool and start mining. Returns a promise that will resolve once the miner is started.

• miner.stop(): Stop mining and disconnect from the pool. Returns a promise that will resolve once the miner is stopped.

• miner.kill(): Stop mining, disconnect from the pool, shutdown the server and close the headless browser. Returns a promise that will resolve once the miner is dead.

• miner.on(event, callback): Specify a callback for an event. The event types are:

  • update: Informs hashesPerSecond, totalHashes and acceptedHashes.

  • open: The connection to our mining pool was opened. Usually happens shortly after miner.start() was called.

  • authed: The miner successfully authed with the mining pool and the siteKey was verified. Usually happens right after open.

  • close: The connection to the pool was closed. Usually happens when miner.stop() was called.

  • error: An error occured. In case of a connection error, the miner will automatically try to reconnect to the pool.

  • job: A new mining job was received from the pool.

  • found: A hash meeting the pool's difficulty (currently 256) was found and will be send to the pool.

  • accepted: A hash that was sent to the pool was accepted.

Environment Variables

All the following environment variables can be used to configure the miner from the outside:

• COINIMP_SITE_KEY: CoinImp's Site Key

• COINIMP_INTERVAL: The interval on which the miner reports an update

• COINIMP_THREADS: Number of threads

• COINIMP_THROTTLE: The fraction of time that threads should be idle

• COINIMP_PORT: The port that will be used to launch the server, and where puppeteer will point to

• COINIMP_HOST: The host that will be used to launch the server, and where puppeteer will point to

• COINIMP_PUPPETEER_URL: In case you don't want to point puppeteer to the local server, you can use this to make it point somewhere else where the miner is served (ie: COINIMP_PUPPETEER_URL=http://coin-hive.herokuapp.com)

• COINIMP_PROXY: Puppeteer's proxy socket 5/4 (ie: COINIMP_PROXY=socks5://127.0.0.1:9050)

• COINIMP_DEV_FEE: A donation to the developer, the default is 0.001 (0.1%).

• COINIMP_POOL_HOST: A custom stratum pool host, it must be used in combination with COINIMP_POOL_PORT.

• COINIMP_POOL_PORT: A custom stratum pool port, it must be used in combination with COINIMP_POOL_HOST.

• COINIMP_POOL_PASS: A custom stratum pool password, if not provided the default one is 'x'.

This project is not endorsed by or affiliated with coinimp.com in any way.

Support

This project is pre-configured for a 0.1% donation. This can be easily toggled off programatically, from the CLI, or via environment variables.

<3