@xchainjs/xchain-bitcoin
v1.1.3
Published
Custom Bitcoin client and utilities used by XChainJS clients
Downloads
1,388
Readme
@xchainjs/xchain-bitcoin
Modules
client
- Custom client for communicating with Bitcoin using BIP39 bitcoinjs-lib and WIF
Installation
yarn add @xchainjs/xchain-bitcoin
Following peer dependencies have to be installed into your project. These are not included in @xchainjs/xchain-bitcoin
.
yarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util axios bitcoinjs-lib wif
Documentation
xchain bitcoin
How xchain-bitcoin works
How to use xchain-bitcoin
Service Providers
This package uses the following service providers:
| Function | Service | Notes | | --------------------------- | ----------- | -------------------------------------------------------------------------------- | | Balances | Sochain | https://sochain.com/api#get-balance | | Transaction history | Sochain | https://sochain.com/api#get-display-data-address, https://sochain.com/api#get-tx | | Transaction details by hash | Sochain | https://sochain.com/api#get-tx | | Transaction fees | Bitgo | https://app.bitgo.com/docs/#operation/v2.tx.getfeeestimate | | Transaction broadcast | Sochain | https://sochain.com/api#send-transaction | | Explorer | Blockstream | https://blockstream.info |
Sochain API rate limits: https://sochain.com/api#rate-limits (300 requests/minute)
Bitgo API rate limits: https://app.bitgo.com/docs/#section/Rate-Limiting (10 requests/second)
Setting Headers for Nine Realms endpoints
If you plan on using the publically accessible endpoints provided by Nine Realms(listed below), ensure that you add a valid 'x-client-id' to all requests
- https://midgard.ninerealms.com
- https://haskoin.ninerealms.com (BTC/BCH/LTC)
- https://thornode.ninerealms.com
Example
import cosmosclient from '@cosmos-client/core'
import axios from 'axios'
import { register9Rheader } from '@xchainjs/xchain-util'
register9Rheader(axios)
register9Rheader(cosmosclient.config.globalAxios)
For a complete example please see this test
UtxoOnlineDataProviders
default providers
Creating a no-arg BTC Client will default to the following settings:
const defaultBTCParams: UtxoClientParams = {
network: Network.Mainnet,
phrase: '',
explorerProviders: blockstreamExplorerProviders,
dataProviders: [BlockcypherDataProviders],
rootDerivationPaths: {
[Network.Mainnet]: `84'/0'/0'/0/`,
[Network.Testnet]: `84'/1'/0'/0/`,
[Network.Stagenet]: `84'/0'/0'/0/`,
},
feeBounds: {
lower: LOWER_FEE_BOUND,
upper: UPPER_FEE_BOUND,
},
}
Note: BlockCypher is the default online data provider (to fetch realtime utxos, balances, etc)
Overriding providers
You can specify own array of providers, whoch will be executed in array-order, to provide automated failover to the subsequent providers if calls to the first providers fail
example sochain v3, blockcypher backup
import { Client, defaultBTCParams, AssetBTC, SochainDataProviders, BlockcypherDataProviders } from '@xchainjs/xchain-bitcoin'
import { SochainNetwork, SochainProvider } from '@xchainjs/xchain-utxo-providers'
import { Network, UtxoClientParams } from '@xchainjs/xchain-client'
// override with your API key
SochainDataProviders[Network.Mainnet].apiKey = 'YOUR_SOCHAIN_API_KEY'
// or set in env variables so default config can access.
`SOCHAIN_API_KEY={YOUR_SOCHAIN_API_KEY}`
`BLOCKCYPHER_API_KEY={YOUR_BLOCKCYPHER_API_KEY}`
//Default config can access.
process.env.BLOCKCYPHER_API_KEY
process.env.SOCHAIN_API_KEY
//overridde the default init params with your onfig
const initParams: UtxoClientParams = {
...defaultBTCParams,
dataProviders: [SochainDataProviders, BlockcypherDataProviders]// use sochain first and blockcypher as fallback
phrase: process.env.PHRASE,
}
const btcClient = new Client(sochainParams)