Skip to content

Commit b50fa7e

Browse files
committed
docs: add warnings about the js sdk
Since it doesn't request proofs it's less secure than it could be otherwise
1 parent da1cb73 commit b50fa7e

File tree

4 files changed

+24
-6
lines changed

4 files changed

+24
-6
lines changed

docs/sdk-js/overview.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@
1111

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

14+
:::{warning}
15+
The JavaScript SDK provides easy access to Dash Platform without requiring a full node;
16+
however, it **_does not support Dash Platform's proofs_**. Therefore, it is less secure than the
17+
[Rust SDK](../sdk-rs/overview.md), which requests proofs for all queried data.
18+
:::
19+
1420
Dash library provides access via [DAPI](../explanations/dapi.md) 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.
1521

1622
## Install

docs/tutorials/connecting-to-testnet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ npm install dash
2626

2727
### 2. Connect to Dash Platform
2828

29-
:::{attention}
29+
:::{tip}
3030
The JavaScript Dash SDK connects to testnet by default. Mainnet can only be accessed by [connecting via address](#connect-via-address).
3131
:::
3232

docs/tutorials/introduction.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@
66

77
The tutorials in this section walk through the steps necessary to begin building on Dash Platform using the Dash JavaScript SDK. As all communication happens via the masternode hosted decentralized API (DAPI), you can begin using Dash Platform immediately without running a local blockchain node.
88

9-
Building on Dash Platform requires first registering an Identity and then registering a Data Contract describing the schema of data to be stored. Once that is done, data can be stored and updated by submitting Documents that comply with the Data Contract.
10-
11-
:::{tip}
12-
You can clone a repository containing the code for all tutorials from <a href="https://github.com/dashpay/platform-readme-tutorials#readme" target="_blank">GitHub</a> or download it as a [zip file](https://github.com/dashpay/platform-readme-tutorials/archive/refs/heads/main.zip).
9+
:::{warning}
10+
Only the JavaScript SDK provides easy access to Dash Platform without requiring a full node;
11+
however, it **_does not support Dash Platform's proofs_**. Therefore, it is less secure than the
12+
[Rust SDK](../sdk-rs/overview.md), which requests proofs for all queried data.
1313
:::
1414

15+
Building on Dash Platform requires first registering an Identity and then registering a Data Contract describing the schema of data to be stored. Once that is done, data can be stored and updated by submitting Documents that comply with the Data Contract.
16+
1517
## Prerequisites
1618

1719
The tutorials in this section are written in JavaScript and use [Node.js](https://nodejs.org/en/about/). The following prerequisites are necessary to complete the tutorials:
@@ -22,6 +24,10 @@ The tutorials in this section are written in JavaScript and use [Node.js](https:
2224

2325
## Quickstart
2426

27+
:::{tip}
28+
You can clone a repository containing the code for all tutorials from <a href="https://github.com/dashpay/platform-readme-tutorials#readme" target="_blank">GitHub</a> or download it as a [zip file](https://github.com/dashpay/platform-readme-tutorials/archive/refs/heads/main.zip).
29+
:::
30+
2531
While going through each tutorial is advantageous, the subset of tutorials listed below get you from a start to storing data on Dash Platform most quickly:
2632

2733
- [Obtaining test funds](../tutorials/create-and-fund-a-wallet.md)

docs/tutorials/setup-sdk-client.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Setup SDK Client
22

3+
:::{warning}
4+
The JavaScript SDK provides easy access to Dash Platform without requiring a full node;
5+
however, it **_does not support Dash Platform's proofs_**. Therefore, it is less secure than the
6+
[Rust SDK](../sdk-rs/overview.md), which requests proofs for all queried data.
7+
:::
8+
39
In this tutorial we will show how to configure the client for use in the remaining tutorials.
410

511
## Prerequisites
@@ -10,7 +16,7 @@ In this tutorial we will show how to configure the client for use in the remaini
1016

1117
## Code
1218

13-
:::{attention}
19+
:::{tip}
1420
The JavaScript Dash SDK connects to testnet by default. Mainnet can only be accessed by [connecting via address](./connecting-to-testnet.md#connect-to-a-network).
1521
:::
1622

0 commit comments

Comments
 (0)