View sats-connect on Snyk Open Source Advisor

Package Health Score

78 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Sustainable

Security

No known security issues

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

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.3.1	\|	05/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.2.2	\|	04/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.1	\|	02/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.5.0	\|	07/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.0	\|	05/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ISC

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

Recognized

Weekly Downloads (11,250)

GitHub Stars: 66
Forks: 30
Contributors: 9

Direct Usage Popularity

The npm package sats-connect receives a total of 11,250 downloads a week. As such, we scored sats-connect popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package sats-connect, we found that it has been starred 66 times.

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

Community

Sustainable

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

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like sats-connect is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 19
Open PR: 1
Last Release: 2 days ago
Last Commit: 2 days ago

Further analysis of the maintenance status of sats-connect based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that sats-connect demonstrates a positive version release cadence with at least one new version released in the past 3 months.

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: 1 year
Dependencies: 3 Direct
Versions: 185
Install Size: 5.82 kB
Dist-tags: 3
# of Files: 4
Maintainers: 1
TS Typings: No

sats-connect 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

logo

Sats connect is a simple javascript library that connects apps to Bitcoin wallets like Xverse to retrieve user wallet addresses and sign transactions (PSBTs).

Developers building apps on the Bitcoin ecosystem can use Sats connect to interact with users' wallets:

Retrieve users' wallet address(es)
Request the signature of arbitrary messages for authentication purposes
Request the signature of partially signed Bitcoin transactions (PSBT)
Request BTC or Stacks transfers to one or multiple recipients
Request Stacks contract interactions and deployments
Inscribe sats with arbitrary content for ordinals & BRC-20 use cases

Quick start

npm i sats-connect

Usage

import

import Wallet from 'sats-connect';

Connect Wallet

const response = await Wallet.request('getAccounts', {
  purposes: [AddressPurpose.Payment, AddressPurpose.Ordinals, AddressPurpose.Stacks],
  message: 'Cool app wants to know your addresses!',
});

Request a wallet action

await Wallet.request('sendTransfer', {...});

Disconnect Wallet

await Wallet.disconnect();

Documentation

For full documentation, visit docs.xverse.app.

Development

Build the package

npm run build

Run example app

npm run dev:example

sats-connect dependencies

@sats-connect/make-default-provider-config @sats-connect/ui @sats-connect/core

sats-connect development dependencies

husky lint-staged prettier rimraf ts-jest tsup typescript

FAQs

What is sats-connect?

![logo](/example/public/sats-connect.svg). Visit Snyk Advisor to see a full health score report for sats-connect, including popularity, security, maintenance & community analysis.

Is sats-connect popular?

The npm package sats-connect receives a total of 11,250 weekly downloads. As such, sats-connect popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sats-connect well maintained?

We found that sats-connect demonstrated a healthy version release cadence and project activity. It has a community of 9 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is sats-connect safe to use?

The npm package sats-connect was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 9 May-2024, at 05:56 (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