A NodeJS based stratum client for communication with stratum-capable pool.

This repository is a modified one of the arnabk/stratum-client but with the ability to be browserified into a browser environment. For more details, see this section and this PR

$ npm i stratum-client --save

const client = require('stratum-client');
const Client = client({
  server: "grlcgang.com",
  port: 3333,
  worker: "KorkyMonster.testing",
  password: "x",
  autoReconnectOnError: true,
  onConnect: () => console.log('Connected to server'),
  onClose: () => console.log('Connection closed'),
  onError: (error) => console.log('Error', error.message),
  onAuthorizeSuccess: () => console.log('Worker authorized'),
  onAuthorizeFail: () => console.log('WORKER FAILED TO AUTHORIZE OH NOOOOOO'),
  onNewDifficulty: (newDiff) => console.log('New difficulty', newDiff),
  onSubscribe: (subscribeData) => console.log('[Subscribe]', subscribeData),
  onNewMiningWork: (newWork) => console.log('[New Work]', newWork),
  onSubmitWorkSuccess: (error, result) => console.log("Yay! Our work was accepted!"),
  onSubmitWorkFail: (error, result) => console.log("Oh no! Our work was refused because: " + error),
});

Mining work can then be submitted through Client.submit(["<worker>","<job_id>","<extranonce2>","<ntime>","<nonce>"]); Worker must have been authorized correctly for work to register with a pool.

worker is required in order for onNewMiningWork() to receive new work continuously.

If password if not specified, the client will attempt to authenticate with 'x', which is good enough in most cases.

DEPRECATED: onAuthorize(error, result). If onAuthorizeSuccess or onAuthorizeFail is not provided, it will fall back to onAuthorize.

$ git clone https://github.com/arnabk/stratum-client
$ cd stratum-client
$ npm i

For running int tests. Make sure that you use a valid stratum server details

$ npm test

This module can also be browserified to work in a browser environment. However, the net module used by this module can't be browserified, so a polyfill is shipped in the repository, under browser/polyfills.

To browserify, run npm run browserify. The generated bundle can be found under browser/. On calling the browserify command, aliasify reroutes all net requires to the polyfill.

You need a Websocket/TCP proxy for this to work! Instead of connecting directly to a mining pool, the browser polyfill will connect to a specified websocket proxy, which will forward all data to a mining pool. A proxy such as this will work. After setting up the proxy, connect to the proxy instead of the pool.

Here, the proxy is running locally on port 8080.

The project is open for suggestion or feedback. If you notice any issues while developing or using this library, feel free to report it here