
Product
Introducing Tier 1 Reachability: Precision CVE Triage for Enterprise Teams
Socket’s new Tier 1 Reachability filters out up to 80% of irrelevant CVEs, so security teams can focus on the vulnerabilities that matter.
@thorwallet/xchain-bitcoin
Advanced tools
Custom Bitcoin client and utilities used by XChainJS clients
@xchainjs/xchain-client
client
- Custom client for communicating with Bitcoin using BIP39 bitcoinjs-lib and WIFyarn 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
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)
Initialize client and use class methods:
import { Client, Network } from '../src/client'
// Create a new client interface
const btcClient = new Client({ network: 'mainnet', nodeUrl: 'https://sochain.com/api/v2' })
// Set phrase
btcClient.setPhrase('phrase here')
// Get address
const address = btcClient.getAddress()
// Get balance
const balance = await btcClient.getBalance()
// Transfer with feeRate
const txid = await btcClient.transfer({ asset: AssetBTC, recipient: 'recipient address here', amount: baseAmount(100, BTC_DECIMAL), feeRate: 1 })
// Transfer with default feeRate (default is `fast`)
const txid = await btcClient.transfer({ asset: AssetBTC, recipient: 'recipient address here', amount: baseAmount(100, BTC_DECIMAL) })
// Get fee estimations
const { fast, fastest, average } = await btcClient.getFees()
// Get feeRate estimations
const { fast, fastest, average } = await btcClient.getFeeRates()
// Search transactions
const transactions = await btcClient.getTransactions({ address: 'address here', limit: 4 })
// Get a transaction with a given txId/hash
const txData = await btcClient.getTransactionData('b660ee07167cfa32681e2623f3a29dc64a089cabd9a3a07dd17f9028ac956eb8')
FAQs
Custom Bitcoin client and utilities used by XChainJS clients
The npm package @thorwallet/xchain-bitcoin receives a total of 0 weekly downloads. As such, @thorwallet/xchain-bitcoin popularity was classified as not popular.
We found that @thorwallet/xchain-bitcoin demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket’s new Tier 1 Reachability filters out up to 80% of irrelevant CVEs, so security teams can focus on the vulnerabilities that matter.
Research
/Security News
Ongoing npm supply chain attack spreads to DuckDB: multiple packages compromised with the same wallet-drainer malware.
Security News
The MCP Steering Committee has launched the official MCP Registry in preview, a central hub for discovering and publishing MCP servers.