sbt-how-it-works #494

skywardboundd · 2025-09-26T19:03:33Z

Closes #104

Shvandre

lgtm

Shvandre

Let's add some code examples from SBT implementation

github-actions · 2025-10-07T06:15:52Z

To fix the formatting issues:

Install necessary dependencies: npm ci
Then, run this command:

npx remark -o --quiet --silently-ignore standard/tokens/sbt/how-works.mdx

verytactical

By the time article explains how to "prove ownership", I still have no idea what am I proving ownership of. The article is supposed to explain how SBTs work.

Code samples requested above can actually be separated into "how to" articles.

standard/tokens/sbt/how-works.mdx

verytactical · 2025-10-07T10:13:07Z

Please fill out PR title and description.

github-actions · 2025-10-12T10:25:25Z

To fix the formatting issues:

Install necessary dependencies: npm ci
Then, run this command:

npx remark -o --silent --silently-ignore standard/tokens/sbt/how-works.mdx

github-actions · 2025-10-12T11:48:29Z

To fix the formatting issues:

Install necessary dependencies: npm ci
Then, run this command:

npx remark -o --silent --silently-ignore standard/tokens/sbt/how-it-works.mdx

github-actions · 2025-10-13T09:35:43Z

Thanks for the updates to the SBT docs. I found a couple of high‑severity formatting/terminology issues that should be addressed before merge.

Findings (2)

High (2)

[HIGH] Code identifier uses incorrect name and formatting

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/536670015910fb5e95a7322b681c88828f5b769f/standard/tokens/sbt/how-it-works.mdx?plain=1#L16-L17

Description:
The note refers to the field as query id (with a space), while the TL‑B schema on this page and typical usage elsewhere use query_id (underscore). Code identifiers and field names should appear in code font with exact spelling to avoid confusion and ensure copy/grep fidelity. The mismatch is visible alongside the TL‑B block that uses query_id.

Suggestion:

- **Nota bene: in all schemes below you will see the `query id` field. Nowadays the field is almost deprecated, and protocols itself doesn't need it.
+ **Nota bene: in all schemes below you will see the `query_id` field. Nowadays the field is almost deprecated, and protocols itself doesn't need it.

[HIGH] Types/identifiers in tables lack code font and incorrect casing

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/536670015910fb5e95a7322b681c88828f5b769f/standard/tokens/sbt/how-it-works.mdx?plain=1#L48-L55

Description:
In the “Ownership proof” table, type names appear as plain text (e.g., uint64, MsgAddress, Cell, Bool), and one occurrence uses the wrong case and form (“maybe Cell”). Types and identifiers should use code formatting with exact case; the corresponding TL‑B shows content:(Maybe ^Cell). Inconsistent formatting and casing reduce clarity and hinder copy/scan workflows.

Suggestion:
Wrap type names in backticks and fix casing to match TL‑B terminology (e.g., uint64, MsgAddress, Cell, Bool, uint256, Maybe Cell). Example for the incorrect row:

- | `content`    | maybe Cell | SBT content if it was requested with `with_content=true`. 
+ | `content`    | `Maybe Cell` | SBT content if it was requested with `with_content=true`.

Notes:

Apply backticks consistently to Type cells in this table for uint64, MsgAddress, Cell, Bool, and uint256.

github-actions · 2025-10-13T09:45:42Z

To fix the formatting issues:

Install necessary dependencies: npm ci
Then, run this command:

npx remark -o --silent --silently-ignore standard/tokens/sbt/how-it-works.mdx standard/tokens/sbt/overview.mdx

github-actions · 2025-10-13T09:57:24Z

Thanks for the updates to the SBT documentation under standard/tokens/sbt. One style fix is needed before merge.

Findings (1)

High (1)

[HIGH] Types in tables lack code formatting

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/ee9d8c7e890eed1fca3396a4cdb303391a40e452/standard/tokens/sbt/how-it-works.mdx?plain=1#L41-L44

Description:
In the “Type” column of multiple tables, code identifiers (e.g., uint64, MsgAddress, Cell, Bool, and “maybe Cell”) appear as plain text. Per style guide 6.3, code, filenames, paths, API endpoints, flags, and literals must use code formatting, which is a HIGH requirement (see https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L270). The same issue appears in other tables at L48–L55, L89–L106, L132–L141, and L169–L171.

Suggestion:
Wrap type identifiers in backticks. Example for the first table:

- | `query_id`        | uint64     | Links the request `prove_ownership` and the response `ownership_proof` to each other. To ensure this process works correctly, always use a unique query ID. |
- | `dest`            | MsgAddress | Address of the target contract to receive the proof.                                                                                                        |
- | `forward_payload` | Cell       | Arbitrary data forwarded to the target contract.                                                                                                            |
- | `with_content`    | Bool       | If `true`, attach SBT `content`.                                                                                                                            |
+ | `query_id`        | `uint64`   | Links the request `prove_ownership` and the response `ownership_proof` to each other. To ensure this process works correctly, always use a unique query ID. |
+ | `dest`            | `MsgAddress` | Address of the target contract to receive the proof.                                                                                                      |
+ | `forward_payload` | `Cell`     | Arbitrary data forwarded to the target contract.                                                                                                            |
+ | `with_content`    | `Bool`     | If `true`, attach SBT `content`.                                                                                                                            |

Apply the same backtick formatting to all “Type” cells in the tables at L48–L55, L89–L106, L132–L141, and L169–L171.

github-actions · 2025-10-13T10:31:05Z

To fix the formatting issues:

Install necessary dependencies: npm ci
Then, run this command:

npx remark -o --silent --silently-ignore standard/tokens/sbt/how-it-works.mdx standard/tokens/sbt/overview.mdx

Shvandre

I like it

standard/tokens/sbt/overview.mdx

anton-trunov

let's fix the overview page too

anton-trunov · 2025-10-14T08:33:55Z

standard/tokens/sbt/how-works.mdx

why empty and not deleted?