@xchainjs/xchain-bitcoin
TypeScript icon, indicating that this package has built-in type declarations

1.1.3 • Public • Published

@xchainjs/xchain-bitcoin

Modules

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

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

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)

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
1.1.383latest

Version History

VersionDownloads (Last 7 Days)Published
1.1.383
1.1.27
1.1.10
1.1.00
1.0.42
1.0.31
1.0.22
1.0.11
1.0.00
0.23.1910
0.23.180
0.23.170
0.23.160
0.23.150
0.23.140
0.23.131
0.23.120
0.23.110
0.23.100
0.23.90
0.23.731
0.23.60
0.23.42
0.23.30
0.23.20
0.23.07
0.22.44
0.22.30
0.22.20
0.22.10
0.22.00
0.21.40
0.21.30
0.21.20
0.21.10
0.21.00
0.20.90
0.20.82
0.20.70
0.20.60
0.20.50
0.20.40
0.20.20
0.20.10
0.20.00
0.19.00
0.18.40
0.18.20
0.18.11
0.18.00
0.18.0-alpha.20
0.18.0-alpha.10
0.17.10
0.17.00
0.16.00
0.15.132
0.15.120
0.15.114
0.15.100
0.15.90
0.15.80
0.15.70
0.15.60
0.15.50
0.15.41
0.15.30
0.15.20
0.15.10
0.15.00
0.13.01
0.12.20
0.12.00
0.11.10
0.11.00
0.10.10
0.10.00
0.9.00
0.8.20
0.8.11
0.8.00
0.7.10
0.7.00
0.6.00
0.5.10
0.5.00
0.4.41
0.4.30
0.4.20
0.4.10
0.4.00
0.3.30

Package Sidebar

Install

npm i @xchainjs/xchain-bitcoin

Weekly Downloads

164

Version

1.1.3

License

MIT

Unpacked Size

181 kB

Total Files

16

Last publish

Collaborators

  • xchainjsadmin
  • thorianite
  • polaris_9r
  • thorchain_org
  • _stu
  • veado
  • thatstrangeguy
  • junkai121
  • sarawut11
  • thorswap
  • hodrthemediocre