You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update non-tutorial Platform docs against current public repos (#139)
* Refresh Platform docs for current public sources
* Refine Platform docs scope and stale explanations
* Address Platform docs PR feedback
* Polish SDK doc links and setup versions
Copy file name to clipboardExpand all lines: docs/explanations/dpns.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ After voting ends, the name is either awarded to one of the identities or locked
67
67
Assuming masternodes do not vote to lock, the identity receiving the most votes takes ownership of the name. However, if the vote locks the name, no identity receives it. If only one identity requests the name, they will receive it even if no masternodes vote.
68
68
69
69
:::{note}
70
-
Locked names can no longer be requested or awarded in Dash Platform v1, but the plan is to change this in future updates.
70
+
Locked names cannot currently be re-requested or awarded. This policy may be revisited in future Platform releases.
Copy file name to clipboardExpand all lines: docs/explanations/fees.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,8 @@ Fees on Dash Platform are divided into two main categories:
16
16
Storage fees cover the costs to store the various types of data throughout the network, while processing fees cover the computational costs incurred by the masternodes to process state transitions. For everyday use, processing fees are minuscule compared to storage fees. However, they are important in the prevention of attacks on the network, in which case they become prohibitively expensive.
17
17
18
18
:::{tip}
19
-
Comprehensive details regarding fees will be available in an upcoming *Dash Platform Fee System* DIP.
19
+
For the implementation-level constants and limits currently used by Platform, see the
@@ -46,7 +47,7 @@ Given fluctuations of the Dash price, a variable *Fee Multiplier* provides a way
46
47
feePaid = initialFee * feeMultiplier
47
48
```
48
49
49
-
The Fee Multiplier is subject to change at any time at the discretion of the masternodes via a voting mechanism. Dash Core Group research indicates maintaining fees at approximately 2x the cost of hosting the network is optimal.
50
+
The Fee Multiplier is subject to change at any time via network governance and protocol updates.
50
51
51
52
<!-- Uncomment once link available
52
53
An in-depth look at the Fee Multiplier can be found at **link**
@@ -58,7 +59,8 @@ In an attempt to minimize Dash Platform's storage requirements, users are incent
58
59
59
60
## User Tip
60
61
61
-
Wallets will be enabled to give users the option to provide a tip to the block proposer in hopes of incentivizing them to include their state transition in the next block. This feature will be especially useful in times of high traffic.
62
+
Platform supports a user tip component that can be used to incentivize inclusion of a state
63
+
transition in the next block, especially during periods of high traffic.
62
64
63
65
## Formula
64
66
@@ -70,4 +72,4 @@ The high level formula for a state transition's fee is:
70
72
71
73
<!-- Uncomment once DIP available
72
74
See *DIPXX: Dash Platform Fee System* for a detailed breakdown of each component.
Copy file name to clipboardExpand all lines: docs/explanations/platform-protocol.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,14 +42,14 @@ For additional detail, see the [State Transition](../explanations/platform-proto
42
42
43
43
## Versions
44
44
45
-
| Version | Information |
46
-
| :------ | :---------- |
47
-
| 0.25 | See details in the [GitHub release](https://github.com/dashpay/platform/releases/tag/v0.25.0). |
48
-
| 0.24 | See details in the [GitHub release](https://github.com/dashpay/platform/releases/tag/v0.24.0). |
49
-
| 0.23 | See details in the [GitHub release](https://github.com/dashpay/platform/releases/tag/v0.23.0). |
50
-
| 0.22 | See details in the [GitHub release](https://github.com/dashpay/platform/releases/tag/v0.22.0). |
51
-
| 0.21 | See details in the [GitHub release](https://github.com/dashevo/js-dpp/releases/tag/v0.21.0). |
52
-
| 0.20 | This release updated to a newer version of JSON Schema (2020-12 spec) and also switched to a new regex module ([Re2](https://github.com/google/re2)) for improved security. See more details in the [GitHub release](https://github.com/dashevo/js-dpp/releases/tag/v0.20.0). |
45
+
Platform Protocol evolves together with the public Dash Platform codebase. For the latest
46
+
implementation details and release history, see the
47
+
[Dash Platform monorepo](https://github.com/dashpay/platform) and the
Copy file name to clipboardExpand all lines: docs/intro/what-is-dash-platform.md
+27-8Lines changed: 27 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,21 @@
4
4
5
5
# What is Dash Platform
6
6
7
-
Dash Platform is a [Web3](https://en.wikipedia.org/wiki/Web3) technology stack for building decentralized applications on the Dash network. The two main architectural components, [Drive](../explanations/drive.md) and [DAPI](../explanations/dapi.md), turn the Dash P2P network into a cloud that developers can integrate with their applications.
7
+
Dash Platform is a [Web3](https://en.wikipedia.org/wiki/Web3) technology stack for building
8
+
decentralized applications on the Dash network. It is best understood as a decentralized data
9
+
storage and application layer on top of Dash: developers define schemas and submit structured state
10
+
transitions instead of deploying arbitrary user-written code on-chain.
11
+
12
+
Its core components, [Drive](../explanations/drive.md) and [DAPI](../explanations/dapi.md),
13
+
provide structured data storage, identity primitives, rich queries, and verifiable data access on
14
+
top of the Dash network.
15
+
16
+
:::{tip}
17
+
Dash Platform is developed in the open. For the current implementation details, package layout, and
18
+
build instructions, see the [Dash Platform monorepo](https://github.com/dashpay/platform). For a
19
+
broader architectural walkthrough of the Rust codebase, see the
@@ -18,19 +32,22 @@ Dash Platform is a [Web3](https://en.wikipedia.org/wiki/Web3) technology stack f
18
32
19
33
### Decentralized Cloud Storage
20
34
21
-
Store your application data in the safest place on the Internet. All data stored on the Dash network is protected by Dash's consensus algorithm, ensuring data integrity and availability.
35
+
Store structured application data on the Dash network with consensus-backed integrity and
36
+
availability.
22
37
23
38
### Reduced Data Silos
24
39
25
-
Because your application data is stored across many nodes on the Dash network, it is safe and always available for customers, business partners, and investors.
40
+
Because application data is stored across the Dash masternode network, it can be shared and queried
41
+
without relying on a single hosted backend.
26
42
27
43
### Client Libraries
28
44
29
45
Write code and integrate with Dash Platform using the languages that matter to your business. Don't worry about understanding blockchain infrastructure: a growing number of client libraries abstract away the complexity typically associated with working on blockchain-based networks.
30
46
31
47
### Instant Data Confirmation
32
48
33
-
Unlike many blockchain-based networks, data stored on the platform is instantly confirmed by the Dash consensus algorithm to ensure the best user experience for users. With Dash Platform, you can gain the advantages of a blockchain-based storage network without the usual UX compromises.
49
+
Unlike many blockchain-based networks, Platform is designed for fast finality and proof-based data
50
+
verification, making it practical for light clients and user-facing applications.
34
51
35
52
```{eval-rst}
36
53
.. figure:: ../../img/join-community.svg
@@ -48,12 +65,14 @@ DAPI is a _decentralized_ HTTP API exposing [JSON-RPC](https://www.jsonrpc.org/)
48
65
49
66
DAPI provides developers the same access and security as running their own Dash node without the cost and maintenance overhead. Unlike traditional APIs which have a single point of failure, DAPI allows clients to connect to different instances depending on resource availability in the Dash network.
50
67
51
-
Developers can connect to DAPI directly or use a client library. This initial client library, dapi-client, is a relatively simple API wrapper developed by Dash Core Group to provide function calls to the DAPI endpoints.
68
+
Developers can connect to DAPI directly or use higher-level SDKs and client libraries maintained in
69
+
the Dash Platform monorepo. These libraries handle connection management, data serialization, and
70
+
common application workflows. A major design goal of Platform is that clients can verify responses
71
+
with proofs rather than trusting the node that served them.
52
72
53
-
The source for both DAPI and dapi-client are available on GitHub:
73
+
The source for these components is available on GitHub:
Copy file name to clipboardExpand all lines: docs/reference/platform-proofs.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@
4
4
5
5
# Platform Proofs
6
6
7
-
>❗️ Platform v0.22.0
8
-
>
9
-
> Note: As part of the transition from MongoDB to Dash's [GroveDB](https://github.com/dashpay/grovedb), proofs will be not be available for at least the initial version of Platform v0.22.
7
+
Platform proofs are an important part of Dash Platform's trust model. When a response is requested
8
+
with `prove: true`, Platform can return proof data that allows clients to verify that the response
9
+
matches consensus state.
10
10
11
11
Since data verification is a critical aspect of Dash Platform, all [Platform endpoints](../reference/dapi-endpoints-platform-endpoints.md) can provide an optional proof that the response is correct. Set the optional `prove` parameter (`"prove": true`) in the request to receive a proof that contains the requested data.
12
12
@@ -57,9 +57,10 @@ Dash Platform 0.21.0 introduced updates to support returning multiple store tree
57
57
-`documentsProof`
58
58
-`stateTransitionProof`
59
59
60
-
> 🚧
61
-
>
62
-
> Dash Platform 0.21.0 introduced a 4 byte [protocol version](https://github.com/dashevo/js-dpp/pull/325) that is prepended to the binary format and is not part of the CBOR-encoded data. When parsing proofs it is necessary to exclude these bytes before decoding the returned data with CBOR.
60
+
:::{note}
61
+
Some proof payloads include a 4-byte protocol version prefix that is not part of the CBOR-encoded
62
+
value. When decoding those values, strip the version prefix before CBOR decoding.
or [Platform TUI](https://github.com/dashpay/platform-tui/).
49
+
Currently, names can be registered using the [DashPay Android wallet](https://play.google.com/store/apps/details?id=hashengineering.darkcoin.wallet).
50
+
Developers and other technical users may want to experiment with registering names using the [Dash Evo Tool](https://github.com/dashpay/dash-evo-tool) or the [JavaScript SDK](https://docs.dash.org/projects/platform/en/stable/docs/tutorials/identities-and-names/register-a-name-for-an-identity.html).
|[rs-sdk](https://github.com/dashpay/platform/tree/master/packages/rs-sdk)| Rust SDK for building applications on Dash Platform |
19
-
|[rs-sdk-ffi](https://github.com/dashpay/platform/tree/master/packages/rs-sdk-ffi) / [swift-sdk](https://github.com/dashpay/platform/tree/master/packages/swift-sdk)|FFI layer and iOS/Swift SDK|
20
-
|[wasm-sdk](https://github.com/dashpay/platform/tree/master/packages/wasm-sdk)| WebAssembly bindings for browser-based applications|
21
+
|[js-evo-sdk](https://github.com/dashpay/platform/tree/master/packages/js-evo-sdk)| JavaScript tooling for connecting to Platform, creating identities, and submitting state transitions|
22
+
|[rs-sdk](https://github.com/dashpay/platform/tree/master/packages/rs-sdk)| Rust-first SDK for building applications and verifying Platform data|
23
+
|[rs-sdk-ffi](https://github.com/dashpay/platform/tree/master/packages/rs-sdk-ffi) / [swift-sdk](https://github.com/dashpay/platform/tree/master/packages/swift-sdk)|Shared components used for Swift and other native integrations|
24
+
|[wasm-sdk](https://github.com/dashpay/platform/tree/master/packages/wasm-sdk)| WebAssembly-oriented bindings for browser and hybrid environments|
0 commit comments