Skip to content

Commit 4cb360e

Browse files
committed
docs: update docs
1 parent abada77 commit 4cb360e

23 files changed

+1296
-837
lines changed

packages/dapi/README.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,7 @@ DAPI is designed to be run on the Dash masternode network, providing a decentral
1313

1414
## Documentation
1515

16-
Comprehensive documentation for DAPI is available in the [doc](./doc) directory:
17-
18-
- [Getting Started](./doc/getting-started.md) - Quick start guide for developers
19-
- [Architecture](./doc/architecture.md) - Overview of DAPI's design
20-
- [Configuration](./doc/configuration.md) - Configure DAPI for your needs
21-
- [Endpoints](./doc/endpoints/index.md) - Available API endpoints
22-
23-
## Getting Started
24-
25-
To get started with DAPI, see the [Getting Started](./doc/getting-started.md) guide which covers:
26-
27-
- Installation and configuration
28-
- Setting up dependencies
29-
- Running DAPI processes
30-
- Making API requests
16+
DAPI documentaion is available in the [doc](./doc/index.md) directory and [website](https://docs.dash.org/projects/platform/en/stable/docs/explanations/dapi.html).
3117

3218
## License
3319

packages/dapi/doc/architecture.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ This document explains the high-level architecture of DAPI, its components, and
44

55
## Overview
66

7-
DAPI (Decentralized API) serves as the gateway to the Dash network, providing access to both Dash Core blockchain functionality and Dash Platform (Evolution) features. Unlike traditional centralized APIs, DAPI is designed to run on the Dash masternode network, ensuring high availability and censorship resistance.
7+
DAPI (Decentralized API) serves as the gateway to the Dash network, providing access to both Dash Core blockchain functionality and Dash Platform (Evolution) features.
8+
Unlike traditional centralized APIs, DAPI is designed to run on the Dash masternode network, ensuring high availability and censorship resistance.
89

910
## Architecture Diagram
1011

@@ -41,7 +42,7 @@ DAPI (Decentralized API) serves as the gateway to the Dash network, providing ac
4142

4243
## Key Components
4344

44-
### API Process (`api.js`)
45+
### API Process
4546

4647
The API process is the main entry point for DAPI. It handles the basic gRPC and JSON-RPC endpoints, including both Core and Platform functionality.
4748

@@ -197,6 +198,13 @@ DAPI connects to Tenderdash (a modified version of Tendermint) which serves as t
197198
- If it matches, the transaction is sent to the client with merkle proofs
198199
4. The stream continues until the client disconnects
199200

201+
## Security
202+
203+
DAPI protects connections by using TLS to encrypt communication between clients and the masternodes.
204+
This encryption safeguards transmitted data from unauthorized access, interception, or tampering.
205+
Platform gRPC endpoints provide an additional level of security by optionally returning cryptographic proofs.
206+
Successful proof verification guarantees that the server responded without modifying the requested data.
207+
200208
## Deployment Considerations
201209

202210
DAPI is designed to be deployed on masternode. The prefered and officaially supported way is to use [dashmate](https://docs.dash.org/en/stable/docs/user/network/dashmate/index.html).
@@ -212,13 +220,10 @@ Key events that are logged include:
212220
- Server listening status
213221
- Error conditions
214222

215-
## Configuration
223+
## Endpoints
216224

217-
Both processes share the same configuration infrastructure, reading environment variables or a `.env` file.
218-
See the [Configuration](./configuration.md) document for details on available options.
225+
See the [endpoints](./endpoints/index.md) document for details on available endpoints.
219226

220227
## Further Information
221228

222-
- For more details about the processes, see [Processes](./processes.md)
223-
- For configuration options, see [Configuration](./configuration.md)
224-
- For available endpoints, see [Endpoints](./endpoints/index.md)
229+
- Consult the [Dash Platform Developer Documentation](https://docs.dash.org/projects/platform/en/stable/) for more information about the broader Dash Platform ecosystem

packages/dapi/doc/configuration.md

Lines changed: 0 additions & 132 deletions
This file was deleted.

packages/dapi/doc/endpoints/core-endpoints.md

Lines changed: 0 additions & 176 deletions
This file was deleted.

0 commit comments

Comments
 (0)