leongaban / edge-currency-bitcoin

Implements Bitcoin support following the Airbitz currency plugin API

Edge Bitcoin Currency Plugin

Implements Bitcoin send/receive functionality per the spec for currency plugins for edge-login

Installing

Since this package is not on NPM, you will have to use the current git version

npm i git+ssh://[email protected]/Airbitz/airbitz-currency-bitcoin.git -s

import { bitcoinCurrencyPluginFactory } from `edge-currency-bitcoin`

Now you can pass bitcoinCurrencyPluginFactory to edge-login.

const context = makeEdgeContext({
  apiKey: YOUR_API_KEY,
  plugins: [ bitcoinCurrencyPluginFactory ]
})

This plugin exposes the following otherSettings which can be set using abcAccount.updateSettings()

{
  enableOverrideServers: boolean,
  electrumServers: Array<Array[String, String]>,
  feeInfoServer: String
}

enableOverrideServers = true will force the plugin to ONLY use the electrum servers specified in electrumServers. electrumServers should be in the format [[DNS name], [port]]. ie [h.1209k.com, 50001]. feeInfoServer should be the fee server, should have the same API as https://bitcoinfees.21.co/api/v1/fees/list.

Contributing

Run npm install to download dependencies and build the library, then run npm run test to run the unit tests.

All sources are in the JavaScript Standard Style + Prettier. We check files prior to each commit, so if you have formatting issues, you can run npm run format to fix them automatically.

If you use Visual Studio Code, consider installing the prettier-vscode extension. You'll want to enable the prettier.eslintIntegration configuration option for this to work seamlessly with Standard.

If you use Atom, you can use prettier-atom. You'll want to check the "ESLint Integration" setting for this to work seamlessly with Standard.