Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add warning about js-sdk security #2106

Closed
wants to merge 3 commits into from
Closed

docs: add warning about js-sdk security #2106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2677027
docs: add warning about js-sdk security
thephez Sep 4, 2024
3c01295
docs: update js-sdk warning
thephez Sep 5, 2024
0a72525
docs: add security warning to wallet-lib readme
thephez Sep 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/js-dash-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@

Dash library for JavaScript/TypeScript ecosystem (Wallet, DAPI, Primitives, BLS, ...)

**Warning: This SDK should only be used in production when connected to trusted nodes. Although it
provides easy access to Dash Platform without requiring a full node, it does not support Dash
Platform’s proofs or verify synchronized blockchain data. Therefore, it is less secure than the
[Rust SDK](../rs-sdk/), which requests proofs for all queried data.**

Dash library provides access via [DAPI](https://dashplatform.readme.io/docs/explanation-dapi) to use both the Dash Core network and Dash Platform on [supported networks](https://github.com/dashpay/platform/#supported-networks). The Dash Core network can be used to broadcast and receive payments. Dash Platform can be used to manage identities, register data contracts for applications, and submit or retrieve application data via documents.

## Table of Contents
Expand Down
5 changes: 5 additions & 0 deletions packages/wallet-lib/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@

A pure and extensible JavaScript Wallet Library for Dash

**Warning: This library should only be used in production when connected to trusted nodes. Although
it provides easy access to wallet functionality without requiring a full node, it does not verify
synchronized blockchain data (e.g., the masternode list, InstantSend transactions, ChainLocks) or
check transactions against block headers.**

## Table of Contents
- [Install](#install)
- [Usage](#usage)
Expand Down
Loading