README.md

electrum-client-js

JavaScript implementation of Electrum Protocol Client.

This is a library that can communicate with the ElectrumX Server on tcp, ssl, ws and wss protocols.

Works in node.js and browser.

Implements methods described in Electrum Protocol methods documentation.

Subscriptions and notifications are also supported, please see example.

Continuous Integration

Latest CircleCI build status:

Install

npm install --save @keep-network/electrum-client-js

Usage

const ElectrumClient = require('@keep-network/electrum-client-js')

async function main() {
  const client = new ElectrumClient(
    'fortress.qtornado.com',
    50002,
    'ssl'
  )

  try {
    await client.connect(
      'electrum-client-js', // optional client name
      '1.4.2' // optional protocol version
    )

    const header = await client.blockchain_headers_subscribe()
    console.log('Current header:', header)

    await client.close()
  } catch (err) {
    console.error(err)
  }
}

main()

See more examples.