-
Notifications
You must be signed in to change notification settings - Fork 1
add ecosystem -> rpc -> overview #875
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.
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
base: main
Are you sure you want to change the base?
Conversation
To fix the formatting issues:
npx remark -o --silent --silently-ignore ecosystem/rpc/overview.mdx |
1 similar comment
To fix the formatting issues:
npx remark -o --silent --silently-ignore ecosystem/rpc/overview.mdx |
Thanks for the RPC overview updates. One high-severity style‑guide fix is needed before merge. Findings (1)High (1)[HIGH] Admonitions use / instead ofDescription: Suggestion: --- 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> |
accde66
to
78c0979
Compare
4bb527b
to
2cd7e37
Compare
Thanks for the PR. I reviewed the changes between |
@laviniat1996 All APIs listed here are "official" within the TON Ecosystem, so we shouldn't categorize them as official / non-official. 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. |
Closes #159
This PR adds an overview page for the ecosystem RPC section: