electrum-proxy-middleware v1.0.0

README

Electrum Proxy Middleware

ExpressJS middleware to add functionality for proxying requests to Electrum servers

Coin types

BTC, LTC, DASH, ZEC

Requirements

Node >= 7.x

Installing

npm install github:agilie/electrum-proxy-middleware

const electrum = require('electrum-proxy-middleware');

app.use(electrum.router);

Running the tests

npm test

Examples

Here are some basic examples. For more details, refer to the ElectrumX Protocol Methods docs.

Protocol version

• URL

  </server/version?coinType=btc>

• Method:

  GET

• URL Params

Required:

coinType=[CoinType]

Optional:

netMode=[Netmode]

• Success Response:

  • Code: 200
  • Content:

• Error Response:

  • Code: 409
  • Content:

Confirmed and unconfirmed history of a script hash.

• URL

  </history/get_history?address=1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa&coinType=btc&page=1&pageSize=2>

• Method:

  GET

• URL Params

Required:

coinType=[CoinType]

address=[string]

Optional:

netMode=[Netmode]

page=[number]

pageSize=[number]

• Success Response:

  • Code: 200
  • Content:

• Error Response:

  • Code: 409
  • Content: