Skip to content

Conversation

@memearchivarius
Copy link
Collaborator

@memearchivarius memearchivarius commented Oct 1, 2025

Closes #656.

We wanted to introduce this info in our original docs and here's a draft.

@github-actions
Copy link

github-actions bot commented Oct 1, 2025

Thanks for the focused doc updates to standard/wallets/gas-benchmarks.mdx. A few wording, acronym, and formatting fixes are needed to align with the style guide and improve clarity.

Findings (8)

Medium (6)

Click to expand

[MEDIUM] Define “TON” on first mention

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/c87cf5eada58246addecb4cb39fdc9c79e9903a3/standard/wallets/gas-benchmarks.mdx?plain=1#L5-L5

Description:
“TON” appears without expansion on first mention. Per the style guide, spell out the term on first use and follow with the acronym to improve clarity and translation. Subsequent uses may remain as “TON”.

Suggestion:
Introduce the acronym on first mention.

-This page provides gas consumption benchmarks for TON wallet contracts measured in both sandbox (local testing) and on-chain (testnet/mainnet) environments.
+This page provides gas consumption benchmarks for The Open Network (TON) wallet contracts measured in both sandbox (local testing) and on-chain (testnet/mainnet) environments.

[MEDIUM] Throat-clearing opening sentence

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/c87cf5eada58246addecb4cb39fdc9c79e9903a3/standard/wallets/gas-benchmarks.mdx?plain=1#L5-L5

Description:
The opening “This page provides …” is a meta statement that delays the substance. The repository’s docs emphasize concise, action-first phrasing. Rewriting it to lead with the content improves scannability and aligns with the page’s direct style elsewhere.

Suggestion:
Replace with an answer-first statement.

-This page provides gas consumption benchmarks for TON wallet contracts measured in both sandbox (local testing) and on-chain (testnet/mainnet) environments.
+Gas consumption benchmarks for TON wallet contracts in sandbox (local testing) and on-chain (testnet/mainnet) environments.

[MEDIUM] Define “VM” on first mention

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/c87cf5eada58246addecb4cb39fdc9c79e9903a3/standard/wallets/gas-benchmarks.mdx?plain=1#L9-L9

Description:
“VM” is used without expansion on first mention. Expanding to “virtual machine (VM)” improves clarity for readers less familiar with the term and follows the acronym rule. Later instances can use “VM” alone.

Suggestion:
Expand “VM” on first mention.

-Gas costs vary between sandbox and on-chain due to different VM configurations, but the relative comparison between wallet versions remains consistent.
+Gas costs vary between sandbox and on-chain due to different virtual machine (VM) configurations, but the relative comparison between wallet versions remains consistent.

[MEDIUM] Avoid informal abbreviation “msgs”

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/c87cf5eada58246addecb4cb39fdc9c79e9903a3/standard/wallets/gas-benchmarks.mdx?plain=1#L15-L15

Description:
The abbreviation “msgs” may confuse readers and violates the acronym/term clarity rule. Replace with the full word “messages” and use “and” instead of “&”. This also appears later at standard/wallets/gas-benchmarks.mdx?plain=1#L100-L100; update both instances for consistency.

Suggestion:
Replace “msgs” with “messages” (and “&” with “and”) in both occurrences.

-| **V5**         | 4,939         | 4,439          | +65-78% vs V3, supports gasless & batch (up to 255 msgs) |
+| **V5**         | 4,939         | 4,439          | +65-78% vs V3, supports gasless and batch (up to 255 messages) |
-- Single V5 batch (255 msgs) cheaper than 255 separate V3 externals
+- Single V5 batch (255 messages) cheaper than 255 separate V3 externals

[MEDIUM] Missing code formatting and inconsistent version casing (methodology)

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/c87cf5eada58246addecb4cb39fdc9c79e9903a3/standard/wallets/gas-benchmarks.mdx?plain=1#L73-L76

Description:
Identifiers and flags should use code formatting for clarity (e.g., “@ton/sandbox”, “@ton/ton”, “PAY_GAS_SEPARATELY”). Align version tag casing with in-page usage to avoid inconsistency.

Suggestion:
Format identifiers with backticks and align version casing.

 **Sandbox measurements:**
-- Framework: Blueprint + @ton/sandbox
-- Wallets: Official implementations from @ton/ton (V3R2, V4, V5R1) and ton-blockchain/highload-wallet-contract-v3
-- Test scenario: Simple transfer of [REDACTED] TON with PAY_GAS_SEPARATELY mode
+- Framework: Blueprint + `@ton/sandbox`
+- Wallets: Official implementations from `@ton/ton` (v3r2, v4, v5r1) and `ton-blockchain/highload-wallet-contract-v3`
+- Test scenario: Simple transfer of [REDACTED] TON with `PAY_GAS_SEPARATELY` mode

[MEDIUM] Capitalize “TON Testnet” when used as proper name

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/c87cf5eada58246addecb4cb39fdc9c79e9903a3/standard/wallets/gas-benchmarks.mdx?plain=1#L79-L79

Description:
When referring to the named network, use “TON Testnet” (proper name), not “TON testnet”. This aligns with term bank rules for network names and ensures consistent capitalization.

Suggestion:
Capitalize “Testnet”.

-- Network: TON testnet
+- Network: TON Testnet

Low (2)

Click to expand

[LOW] Link text casing inconsistent with existing docs (“Wallet V5” vs “Wallet v5”)

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/c87cf5eada58246addecb4cb39fdc9c79e9903a3/standard/wallets/gas-benchmarks.mdx?plain=1#L109-L109

Description:
The link text uses “Wallet V5” while the page body and other docs prefer “Wallet v5”. Consistent casing improves searchability and internal coherence.

Suggestion:
Match established casing.

-- [Wallet V5](/standard/wallets/v5) — Latest wallet standard
+- [Wallet v5](/standard/wallets/v5) — Latest wallet standard

[LOW] Vague “Similar” phrasing in results

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/c87cf5eada58246addecb4cb39fdc9c79e9903a3/standard/wallets/gas-benchmarks.mdx?plain=1#L28-L28

Description:
“On-chain: Similar …” is vague and less informative than a precise comparison. Clearer phrasing increases reader confidence. The same phrasing appears again in the V4 section (standard/wallets/gas-benchmarks.mdx?plain=1#L40-L40).

Suggestion:
Use explicit, scannable wording in both places.

-- On-chain: Similar (comment doesn't affect compute gas)
+- On-chain: Approximately the same (comment text does not affect compute gas)
-- On-chain: Similar
+- On-chain: Approximately the same

@anton-trunov anton-trunov requested a review from pyAndr3w October 1, 2025 17:45
@pyAndr3w
Copy link
Collaborator

pyAndr3w commented Oct 1, 2025

In Highload v3 we must account for the forward fee in addition to the gas fee. Because the wallet’s flow executes two transactions, the forward fee will be about x2 that of a standard wallet.

Copy link
Collaborator

@anton-trunov anton-trunov left a comment

Choose a reason for hiding this comment

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

@verytactical verytactical marked this pull request as draft October 10, 2025 15:38
@github-actions
Copy link

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore standard/wallets/gas-benchmarks.mdx 

@github-actions
Copy link

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore standard/wallets/gas-benchmarks.mdx 

@github-actions
Copy link

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore standard/wallets/gas-benchmarks.mdx 

@verytactical verytactical marked this pull request as draft October 23, 2025 19:11
@anton-trunov
Copy link
Collaborator

@memearchivarius ping

@memearchivarius memearchivarius marked this pull request as ready for review October 30, 2025 08:37
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.

@anton-trunov anton-trunov requested a review from pyAndr3w October 30, 2025 15:32
@github-actions
Copy link

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore standard/wallets/gas-benchmarks.mdx 


## Code examples

Check [gas-research](https://github.com/memearchivarius/gas-research) and [tolk-bench](https://github.com/ton-blockchain/tolk-bench) projects for code examples.
Copy link
Collaborator

Choose a reason for hiding this comment

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

we should move the scripts to https://github.com/ton-org/docs-examples, there should be no links to personal repos in the docs, unless it's some kind of SDK which happens to live there

Copy link
Collaborator

Choose a reason for hiding this comment

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

Also, why tolk-bench in this article?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Because it's useful example of precise tests

Copy link
Collaborator

Choose a reason for hiding this comment

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

we don't want to provide more info than we need to, especially if it is not relevant to the case

@anton-trunov anton-trunov marked this pull request as draft October 30, 2025 16:52
@anton-trunov
Copy link
Collaborator

@skywardboundd is going to take over this PR and re-do the tests

@verytactical
Copy link
Collaborator

Closing in favor of #1072

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Wallets] Gas benchmarks

7 participants