Skip to content

Conversation

laviniat1996
Copy link
Collaborator

@laviniat1996 laviniat1996 commented Oct 15, 2025

Closes #159

This PR adds an overview page for the ecosystem RPC section:

  • explains the three types of APIs available for fetching data on TON
  • the main diffs between them (http vs indexer, adnl vs http)
  • tells devs what the best use is for each one
  • documents official and third party providers, including docs links and enpoints

@laviniat1996 laviniat1996 changed the title Rpc overview add ecosystem -> rpc -> overview Oct 15, 2025
Copy link

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore ecosystem/rpc/overview.mdx 

1 similar comment
Copy link

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore ecosystem/rpc/overview.mdx 

Copy link

Thanks for the RPC overview updates. One high-severity style‑guide fix is needed before merge.

Findings (1)

High (1)

[HIGH] Admonitions use / instead of

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/2d35f88d104109aa926eef2ce5ee302e839a21d4/ecosystem/rpc/overview.mdx?plain=1#L14-L20

Description:
This page uses <Note>/<Tip> instead of the required <Aside> with a supported type, violating the admonition rule. The style guide mandates <Aside> with only note, tip, caution, and danger types (see https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L842-L846). The same issue also appears at ecosystem/rpc/overview.mdx:29-31, 61-64, and 90-94. These lines are newly added in the PR and risk inconsistent rendering and tooling.

Suggestion:
Replace <Note>/<Tip> blocks with <Aside> and import the component at the top of the page.

--- a/ecosystem/rpc/overview.mdx
+++ b/ecosystem/rpc/overview.mdx
@@
 ---
 title: "Overview"
 description: "Understand the main ways to access the TON blockchain."
 ---
+import { Aside } from '/snippets/aside.jsx';
@@
-<Note>
+<Aside type="note">
 **Indexed vs Non-Indexed**  
 In TON, APIs differ by how deeply they process data before returning it.  
 **Non-indexed APIs** fetch results from liteservers through `tonlibjson`. They’re simple and fast, but the data comes directly from the node: no decoding, joins, or long-term history.  
 **Indexed APIs** run an indexer alongside a node. The indexer reads blocks from RocksDB, decodes transactions and actions, and stores them in PostgreSQL for structured access.  
 That extra database layer makes it possible to query decoded, historical, and aggregated data without talking to the node directly.
-</Note>
+</Aside>
@@
-<Note>
+<Aside type="note">
 For production, it’s recommended to integrate at least two providers to ensure uptime.
-</Note>
+</Aside>
@@
-<Tip>
+<Aside type="tip">
 Prefer **Indexed APIs** for nearly all read operations, as they provide broader coverage, better performance, and decoded data.  
 Use **HTTP APIs** when you need to **send messages or transactions** directly to the network.
-</Tip>
+</Aside>
@@
-<Tip>
+<Aside type="tip">
 For most applications, prefer an **Indexed API** for reads, because it provides broader coverage and faster, decoded data.  
 Use **HTTP** when you need to **send messages or transactions** directly to the network.  
 Choose **ADNL** for low-level, verifiable access or when running your own node or validator infrastructure.
-</Tip>
+</Aside>

@laviniat1996 laviniat1996 marked this pull request as draft October 15, 2025 12:39
Copy link

Thanks for the PR. I reviewed the changes between main and pr_head; I found no issues and no fixes are needed.

@laviniat1996 laviniat1996 self-assigned this Oct 16, 2025
@reveloper
Copy link
Collaborator

@laviniat1996
I recommend arranging the structure closer to the original APIs overview, as readers should first find possible ways to build their solutions and then access more explanations on types differences.

All APIs listed here are "official" within the TON Ecosystem, so we shouldn't categorize them as official / non-official.
Instead, we can group them by type and then provide a more detailed explanation of what each type means.

This API list was reviewed just a month ago. The problem point on I suggested SDKs, I mentioned @ton/ton, because we have no other choice at the moment.

cc @verytactical

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Ecosystem > RPC > Overview]

2 participants