-
Notifications
You must be signed in to change notification settings - Fork 5
feat: add ton center self host http api guide #890
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
This comment was marked as resolved.
This comment was marked as resolved.
|
Thanks for the update in the TON Center RPC docs. I found a couple of HIGH style‑guide blockers to address before merge. Findings (2)High (2)[HIGH] External links include tracking parametersLocation:
Description: Suggestion: --- a/ecosystem/rpc/toncenter/self-hosted-ton-center-v2.mdx
+++ b/ecosystem/rpc/toncenter/self-hosted-ton-center-v2.mdx
@@
-[▶️ Watch Guide](https://www.canva.com/design/DAGuzMRoHjI/7FaLbvC29bSmS_JFykiu2g/watch?utm_content=DAGuzMRoHjI\&utm_campaign=designshare\&utm_medium=link2\&utm_source=uniquelinks\&utlId=h72f6e944b5)
+[▶️ Watch Guide](https://www.canva.com/design/DAGuzMRoHjI/7FaLbvC29bSmS_JFykiu2g/watch)
@@
-[▶️ Watch Guide](https://www.canva.com/design/DAGuygDmwKk/TxCNWeDg4QjdTUSKkhAa2A/watch?utm_content=DAGuygDmwKk\&utm_campaign=designshare\&utm_medium=link2\&utm_source=uniquelinks\&utlId=hed091a20b9)
+[▶️ Watch Guide](https://www.canva.com/design/DAGuygDmwKk/TxCNWeDg4QjdTUSKkhAa2A/watch)[HIGH] Emoji used in prose link textLocation:
Description: Suggestion: - [▶️ Watch Guide](https://www.canva.com/design/DAGuzMRoHjI/7FaLbvC29bSmS_JFykiu2g/watch?utm_content=DAGuzMRoHjI\&utm_campaign=designshare\&utm_medium=link2\&utm_source=uniquelinks\&utlId=h72f6e944b5)
+ [Watch guide](https://www.canva.com/design/DAGuzMRoHjI/7FaLbvC29bSmS_JFykiu2g/watch?utm_content=DAGuzMRoHjI\&utm_campaign=designshare\&utm_medium=link2\&utm_source=uniquelinks\&utlId=h72f6e944b5)
- [▶️ Watch Guide](https://www.canva.com/design/DAGuygDmwKk/TxCNWeDg4QjdTUSKkhAa2A/watch?utm_content=DAGuygDmwKk\&utm_campaign=designshare\&utm_medium=link2\&utm_source=uniquelinks\&utlId=hed091a20b9)
+ [Watch guide](https://www.canva.com/design/DAGuygDmwKk/TxCNWeDg4QjdTUSKkhAa2A/watch?utm_content=DAGuygDmwKk\&utm_campaign=designshare\&utm_medium=link2\&utm_source=uniquelinks\&utlId=hed091a20b9) |
| title: Self-Host API v2 (HTTP) | ||
| --- | ||
|
|
||
| ## Overview |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please don't start an article with 2 headers in a row.
The part without a header is an overview.
|
|
||
| This guide explains how to self-host the TON HTTP API (v2) locally using either: | ||
|
|
||
| - **Docker (recommended for production setups):** Works on any x86\_64 and arm64 OS with Docker available. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Too much bold text.
|
|
||
| This guide explains how to self-host the TON HTTP API (v2) locally using either: | ||
|
|
||
| - **Docker (recommended for production setups):** Works on any x86\_64 and arm64 OS with Docker available. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
List items have a structure: name, purpose, platforms. Such lists are best formatted as tables.
Platform list should be a list.
|
|
||
| This guide explains how to self-host the TON HTTP API (v2) locally using either: | ||
|
|
||
| - **Docker (recommended for production setups):** Works on any x86\_64 and arm64 OS with Docker available. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docker is a containerization solution. Python is a programming language. They shouldn't be listed as equivalent solutions.
It's very likely that inside of a Docker image there is the very same Python code.
|
|
||
| ## Recommended hardware | ||
|
|
||
| - **CPU architecture:** x86\_64 or arm64. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bold.
|
|
||
| | Flag | Description | | ||
| | ------------------------------------ | -------------------------------------- | | ||
| | `--liteserver-config` | Path or URL to LiteServer config file | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How would it distinguish /foo *nix path from /foo relative URL?
|
|
||
| | Flag | Description | | ||
| | ------------------------------------ | -------------------------------------- | | ||
| | `--liteserver-config` | Path or URL to LiteServer config file | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's LiteServer?
| | `--liteserver-config` | Path or URL to LiteServer config file | | ||
| | `--tonlib-keystore` | Path to keystore directory | | ||
| | `--parallel-requests-per-liteserver` | Max concurrent requests per LiteServer | | ||
| | `--cdll-path` | Path to `tonlibjson` binary | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's tonlibjson?
|
|
||
| | Flag | Description | | ||
| | ---------------- | ----------------------------------------------- | | ||
| | `--logs-level` | Logging level: `DEBUG`, `INFO`, `WARNING`, etc. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there any documentation about the things that might be found in logs?
| | Flag | Description | | ||
| | ---------------- | ----------------------------------------------- | | ||
| | `--logs-level` | Logging level: `DEBUG`, `INFO`, `WARNING`, etc. | | ||
| | `--logs-jsonify` | Print logs in JSON format | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a schema for this JSON?
Closes #722