@thorwallet/xchain-bitcoincash

v0.1.1-lazy.0

Custom bitcoincash client and utilities used by XChainJS clients For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

NPM

GitHub

Package Health Score

58 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Active

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.1.1-lazy.0	\|	01/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (3)

GitHub Stars: 112
Forks: 95
Contributors: 50

Direct Usage Popularity

The npm package @thorwallet/xchain-bitcoincash receives a total of 3 downloads a week. As such, we scored @thorwallet/xchain-bitcoincash popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @thorwallet/xchain-bitcoincash, we found that it has been starred 112 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 50
Funding: No

With more than 10 contributors for the @thorwallet/xchain-bitcoincash repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @thorwallet/xchain-bitcoincash is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 3
Open PR: 3
Last Release: 3 years ago
Last Commit: 2 months ago

Further analysis of the maintenance status of @thorwallet/xchain-bitcoincash based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @thorwallet/xchain-bitcoincash is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 7 Direct
Versions: 107
Install Size: 7.71 MB
Dist-tags: 2
# of Files: 42
Maintainers: 3
TS Typings: Yes

@thorwallet/xchain-bitcoincash has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

`@xchainjs/xchain-bitcoincash`

Modules

client - Custom client for communicating with Bitcoin Cash by using @psf/bitcoincashjs-lib

Installation

yarn add @xchainjs/xchain-bitcoincash

Following peer dependencies have to be installed into your project. These are not included in @xchainjs/xchain-bitcoincash.

yarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util axios @psf/bitcoincashjs-lib bchaddrjs

Service Providers

This package uses the following service providers:

Function	Service	Notes
Balances	Haskoin	https://api.haskoin.com/#/Address/getBalance
Transaction history	Haskoin	https://api.haskoin.com/#/Address/getAddressTxsFull
Transaction details by hash	Haskoin	https://api.haskoin.com/#/Transaction/getTransaction
Transaction fees	Bitgo	https://app.bitgo.com/docs/#operation/v2.tx.getfeeestimate
Transaction broadcast	Bitcoin Cash Node	https://developer.bitcoin.org/reference/rpc/sendrawtransaction.html
Explorer	Blockchain.com	https://www.blockchain.com

Haskoin API rate limits: No

Bitgo API rate limits: https://app.bitgo.com/docs/#section/Rate-Limiting (10 requests/second)

Usage

Initialize client and use class methods:

import { Client, Network } from '../src/client'

// Create a new client interface
const bchClient = new Client({ network: 'mainnet' })

// Set phrase
bchClient.setPhrase('phrase here')

// Get address
const address = bchClient.getAddress()

// Get balance
const balance = await bchClient.getBalance()

// Transfer with feeRate
const txid = await bchClient.transfer({ asset: AssetBCH, recipient: 'recipient address here', amount: baseAmount(100, BCH_DECIMAL), feeRate: 1 })

// Transfer with default feeRate (default is `fast`)
const txid = await bchClient.transfer({ asset: AssetBCH, recipient: 'recipient address here', amount: baseAmount(100, BCH_DECIMAL) })

// Get fee estimations
const { fast, fastest, average } = await bchClient.getFees()

// Get feeRate estimations
const { fast, fastest, average } = await bchClient.getFeeRates()

// Search transactions
const transactions = await bchClient.getTransactions({ address: 'address here', limit: 4 })

// Get a transaction with a given txId/hash
const txData = await bchClient.getTransactionData('b660ee07167cfa32681e2623f3a29dc64a089cabd9a3a07dd17f9028ac956eb8')

@thorwallet/xchain-bitcoincash dependencies

axios axios-mock-adapter bchaddrjs bitcoinjs-lib coininfo coinselect uniqid

@thorwallet/xchain-bitcoincash development dependencies

@psf/bitcoincashjs-lib @thorwallet/xchain-client @thorwallet/xchain-crypto @thorwallet/xchain-util @types/bchaddrjs @types/uniqid

FAQs

What is @thorwallet/xchain-bitcoincash?

Custom bitcoincash client and utilities used by XChainJS clients. Visit Snyk Advisor to see a full health score report for @thorwallet/xchain-bitcoincash, including popularity, security, maintenance & community analysis.

Is @thorwallet/xchain-bitcoincash popular?

The npm package @thorwallet/xchain-bitcoincash receives a total of 3 weekly downloads. As such, @thorwallet/xchain-bitcoincash popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @thorwallet/xchain-bitcoincash well maintained?

We found indications that @thorwallet/xchain-bitcoincash is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @thorwallet/xchain-bitcoincash safe to use?

While scanning the latest version of @thorwallet/xchain-bitcoincash, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 29 November-2024, at 09:04 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP