feat(api): add ton-validators-rewards-api#1978
Conversation
|
| reward and staking data directly from TON liteservers through `tongo`. | ||
|
|
||
| <Aside type="note"> | ||
| The source does not define a public hosted base URL. The examples in this |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| The service listens on port `8080` by default. | ||
|
|
||
| When `-config` is not set, startup downloads | ||
| `https://ton.org/global-config.json` and uses the liteservers from that file. | ||
|
|
There was a problem hiding this comment.
[HIGH] Unsafe mainnet‑default global config without safety callout
Lines 31–35 explain that when -config is not set, startup downloads https://ton.org/global-config.json and uses the liteservers from that file, which is the TON Mainnet global configuration. This means that following the basic “build and start the binary” steps implicitly connects to Mainnet liteservers, yet the page provides no <Aside> callout describing the mainnet scope or recommending safer configs for experimentation. The style guide requires explicit Caution or Warning asides whenever instructions may touch mainnet resources, funds, or validator operations, so the current instructions under‑communicate this risk.
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| ## Verify | ||
|
|
||
| Check the health endpoint: | ||
|
|
||
| ```bash | ||
| curl http://localhost:8080/health | ||
| ``` | ||
|
|
||
| Expected output: | ||
|
|
||
| ```json | ||
| {"status":"ok"} | ||
| ``` | ||
|
|
||
| Open the Swagger UI: | ||
|
|
||
| ```text | ||
| http://localhost:8080/swagger | ||
| ``` |
There was a problem hiding this comment.
[MEDIUM] Mixed code and URL in non‑copyable Swagger step
The “Open the Swagger UI” step at lines 85–103 uses a text fenced block containing only http://localhost:8080/swagger. As a result, the primary action is expressed as a raw URL inside what looks like a code block, which is neither a shell command nor clearly distinguished from expected output. The style guide encourages using clear imperative sentences for actions and reserving fenced blocks for commands or structured output; a bare URL in a generic code fence is harder to copy‑paste correctly and inconsistent with how earlier steps present commands.
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
|
Thanks for the updates here—there are a couple of suggestions around Per-comment submission: 5 posted, 1 failed. Unposted inline comments (raw text):
|
…cs and align wording with source - update overview, run locally, and API reference pages - align descriptions and commands with ton-validators-rewards-api - add source and config links, and clean up related sections - update navigation and custom dictionary entries
delovoyhomie
force-pushed
the
validator-rewards-API
branch
2 times, most recently
from
ad8e55b to
b494399
Compare
3 participants
Closes #1917