Skip to content

feat(api): add tonlib types page#1882

Open
laviniat1996 wants to merge 1 commit intomainfrom
tonlib-types
Open

feat(api): add tonlib types page#1882
laviniat1996 wants to merge 1 commit intomainfrom
tonlib-types

Conversation

@laviniat1996
Copy link
Collaborator

@laviniat1996 laviniat1996 commented Feb 28, 2026

closes #1870

Add a new page with details about tonlib types.

TonLib types are the low level data structures defined by TON’s core client library (TonLib) that describe how blockchain entities like accounts, transactions, messages, and cells are represented and transmitted.

@laviniat1996 laviniat1996 self-assigned this Feb 28, 2026
@laviniat1996 laviniat1996 added the scope: api OpenAPI specs and relevant sub-directories in the /ecosystem/api/toncenter folder label Feb 28, 2026
@laviniat1996 laviniat1996 marked this pull request as draft February 28, 2026 01:16
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No documentation issues detected.

@reveloper reveloper marked this pull request as ready for review March 5, 2026 04:21
@reveloper reveloper requested a review from aigerimu March 5, 2026 04:22
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the detailed TonLib reference work; in ecosystem/api/toncenter/v2-tonlib-types.mdx there is one inline suggestion to align the schema link and tone with the style guide—please apply the inline suggestion.

Comment on lines +10 to +11
- **TonLib types** (e.g. `raw.fullAccountState`, `tvm.cell`) come from the [TonLib TL schema](https://github.com/ton-blockchain/ton/blob/master/tl/generate/scheme/tonlib_api.tl), the type definition language used by the C++ library powering this API.
- **Extended types** (prefixed with `ext.`) are added by TON Center to provide parsed, developer-friendly representations not available in the base TonLib schema.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[HIGH] Non-permalink TL schema reference and marketing-style language

The overview bullet links to the TonLib TL schema using the moving master branch (https://github.com/ton-blockchain/ton/blob/master/tl/generate/scheme/tonlib_api.tl) on a normative reference page. The style guide’s stable permalink rule requires versioned or permanent URLs for normative code references and forbids moving targets like master or main when a versioned URL exists. The adjacent bullet also describes extended types as “developer-friendly representations”, which is a subjective, marketing-style adjective banned by the style guide in technical sections. Together, these issues reduce reproducibility and undermine the neutral, factual tone expected for reference documentation.

Suggested change
- **TonLib types** (e.g. `raw.fullAccountState`, `tvm.cell`) come from the [TonLib TL schema](https://github.com/ton-blockchain/ton/blob/master/tl/generate/scheme/tonlib_api.tl), the type definition language used by the C++ library powering this API.
- **Extended types** (prefixed with `ext.`) are added by TON Center to provide parsed, developer-friendly representations not available in the base TonLib schema.

Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!

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

Labels

scope: api OpenAPI specs and relevant sub-directories in the /ecosystem/api/toncenter folder

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Ecosystem > API > TON Center > API v2 > Tonlib Types]

2 participants