Skip to content

Conversation

aigerimu
Copy link
Contributor

@aigerimu aigerimu commented Oct 6, 2025

closes #138

@aigerimu aigerimu requested a review from verytactical as a code owner October 6, 2025 10:28
@aigerimu aigerimu marked this pull request as draft October 6, 2025 10:28
Copy link

github-actions bot commented Oct 6, 2025

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --quiet --silently-ignore ecosystem/wallet-apps/web.mdx 

Copy link

github-actions bot commented Oct 6, 2025

Thanks for the updates to the wallet docs. A few blocking issues remain in the web wallet page that need fixes before we can merge.

Findings (3)

High (3)

[HIGH] Misleading link target for “wallet.ton.org”

Location:

[wallet.ton.org](https://github.com/ton-blockchain/ton-wallet) is the self-custodial wallet developed by TON Core.

Description:
The link text “wallet.ton.org” points to the GitHub repository instead of the live wallet site. This misleads readers who expect to reach the wallet app and can derail task completion.

Suggestion:

- [wallet.ton.org](https://github.com/ton-blockchain/ton-wallet) is the self-custodial wallet developed by TON Core.
+ [wallet.ton.org](https://wallet.ton.org/) is the self-custodial wallet developed by TON Core.

[HIGH] Incomplete sections and placeholder steps block use

Location:

## Wallet setup
We demonstrate wallet setup using the **web version** of [wallet.ton.org](https://wallet.ton.org/).
This allows developers to complete all steps on a single device without switching platforms.
1. Open
### Testnet
## First transactions
## See also

Description:
“Wallet setup” introduces instructions but contains only “1. Open” and several empty sections (“Testnet”, “First transactions”, “See also”). These placeholders prevent readers from completing a task and reduce clarity. The phrasing also violates second‑person guidance.

Suggestion:

-## Wallet setup
-
-We demonstrate wallet setup using the **web version** of [wallet.ton.org](https://wallet.ton.org/).
-This allows developers to complete all steps on a single device without switching platforms.
-
-1. Open
-
-
-### Testnet
-
-
-## First transactions
-
-
-## See also

[HIGH] Incomplete procedure step blocks task execution

Location:

Description:
The numbered list contains a single placeholder step “Open” with no target or action, leaving readers without a concrete next step and blocking setup.

Suggestion:

-1. Open
+1. Open https://wallet.ton.org/.

@aigerimu aigerimu marked this pull request as ready for review October 9, 2025 19:34
Copy link

github-actions bot commented Oct 9, 2025

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore ecosystem/wallet-apps/web.mdx 

Copy link

github-actions bot commented Oct 9, 2025

Thanks for the update to the wallet docs. I found a few blocking issues in ecosystem/wallet-apps/web.mdx that need fixes before merge.

Findings (4)

High (4)

[HIGH] Missing security warning for recovery words

Location:

<Aside type="caution">
The following recovery words are shown only for demonstration purposes.
</Aside>

Description:
The recovery words step uses a “caution” Aside with a brief note that does not meet the required security callout structure. Exposing mnemonics requires a Warning that explicitly states risk, scope, rollback/mitigation, and environment; otherwise readers may underestimate the consequences of leakage.

Suggestion:
Replace the Aside with a structured Warning.

-<Aside type="caution">
-  The following recovery words are shown only for demonstration purposes.
-</Aside>
+<Aside type="warning">
+  Warning — funds and keys at risk
+  Exposing or storing recovery words can compromise your wallet.
+  Scope: anyone with these words can take your funds.
+  Rollback: none. If leaked, move funds to a new wallet.
+  Environment: applies to TON Mainnet and TON Testnet.
+  The words below are for demonstration only.
+</Aside>

[HIGH] Step numbering skips 4–5 and continues at 6–10

Location:

6. Read the **Use Responsibly** notice and check the box to _confirm that you have read and accepted this information_.
<Image
src="/resources/images/wallets/wallet-ton-org/responsibility_light.png"
darkSrc="/resources/images/wallets/wallet-ton-org/responsibility_dark.png"
alt="Use responsibility notice"
/>
7. After confirming, you’ll be prompted to manually back up your secret key.
This key is the **only** way to recover access to your wallet if you lose your password or device.
Click **Back Up Now** to continue.
<Image
src="/resources/images/wallets/wallet-ton-org/backup_light.png"
darkSrc="/resources/images/wallets/wallet-ton-org/backup_dark.png"
alt="Back up your password"
/>
8. Read the **Safety Rules** carefully, check all the boxes to confirm that you understand them. Then click **Understood** to continue.
<Image
src="/resources/images/wallets/wallet-ton-org/safety_light.png"
darkSrc="/resources/images/wallets/wallet-ton-org/safety_dark.png"
alt="Safety rules"
/>
9. Write down your 24 recovery words and store them in **a safe place**.
_Never share them with anyone or enter them anywhere else._
<Aside type="caution">
The following recovery words are shown only for demonstration purposes.
</Aside>
Once you’re ready, click **Let’s Check** to verify your recovery phrase.
<Image
src="/resources/images/wallets/wallet-ton-org/secret_words_light.png"
darkSrc="/resources/images/wallets/wallet-ton-org/secret_words_dark.png"
alt="24 Secret words"
/>
10. In the **Let’s Check** step, enter the requested words to make sure your recovery phrase was saved correctly.

Description:
The ordered list jumps from step 3 to 6, omitting 4 and 5, and continues through 10. This breaks sequential flow and can confuse readers following the setup.

Suggestion:
Renumber steps 6–10 to 4–8.

-6. Read the **Use Responsibly** notice and check the box to _confirm that you have read and accepted this information_.
+4. Read the **Use Responsibly** notice and check the box to _confirm that you have read and accepted this information_.

-7. After confirming, you’ll be prompted to manually back up your secret key.
+5. After confirming, you’ll be prompted to manually back up your secret key.

-8. Read the **Safety Rules** carefully, check all the boxes to confirm that you understand them. Then click **Understood** to continue.
+6. Read the **Safety Rules** carefully, check all the boxes to confirm that you understand them. Then click **Understood** to continue.

-9. Write down your 24 recovery words and store them in **a safe place**.
+7. Write down your 24 recovery words and store them in **a safe place**.

-10. In the **Let’s Check** step, enter the requested words to make sure your recovery phrase was saved correctly.
+8. In the **Let’s Check** step, enter the requested words to make sure your recovery phrase was saved correctly.

[HIGH] Placeholder faucet link is broken

Location:

A wallet must receive funds before deployment.
- On Testnet, request free Testnet Toncoins from the [TON Testnet Faucet](link).

Description:
The “TON Testnet Faucet” link uses a placeholder “(link)”, producing a broken hyperlink at a critical step (funding the wallet). This blocks readers from completing the guide.

Suggestion:
Point the faucet reference to a valid HTTPS URL.

-- On Testnet, request free Testnet Toncoins from the [TON Testnet Faucet](link).
+- On Testnet, request free Testnet Toncoins from the [TON Testnet Faucet](https://t.me/testgiver_ton_bot).

[HIGH] Incorrect account status term (“nonexistent” vs canonical “nonexist”)

Location:

Newly created wallets have the default state **nonexistent**, meaning the account has _no code, data, or balance_.

Description:
The default account status is labeled “nonexistent,” but the canonical status used elsewhere is “nonexist.” Inconsistent terminology can mislead readers and conflict with explorer/UI terms used on the page.

Suggestion:
Replace “nonexistent” with “nonexist”.

-Newly created wallets have the default state **nonexistent**, meaning the account has _no code, data, or balance_.
+Newly created wallets have the default state **nonexist**, meaning the account has _no code, data, or balance_.

Copy link

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore ecosystem/wallet-apps/web.mdx 

Copy link

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore ecosystem/wallet-apps/web.mdx 

@aigerimu aigerimu marked this pull request as ready for review October 13, 2025 17:11
@tact-lang tact-lang deleted a comment from github-actions bot Oct 13, 2025
Copy link
Collaborator

@verytactical verytactical left a comment

Choose a reason for hiding this comment

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

PR fails formatting and link rot checks.

image

@verytactical verytactical marked this pull request as draft October 13, 2025 23:03
Copy link

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore ecosystem/wallet-apps/web.mdx 

@aigerimu aigerimu marked this pull request as ready for review October 14, 2025 09:37
Copy link

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore ecosystem/wallet-apps/web.mdx 

Copy link

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore ecosystem/wallet-apps/web.mdx 

@aigerimu
Copy link
Contributor Author

aigerimu commented Oct 14, 2025

Screenshot 2025-10-14 at 16 45 10

it suggests:

  1. Open wallet.ton.org.
  2. Click Create Wallet to create a new wallet.

So, could we ignore it?

Copy link

Thanks for the focused docs update in the ecosystem wallet guide. I found several style‑guide blockers that need fixes before merge.

Findings (3)

High (3)

[HIGH] UI/log messages are styled in bold instead of quoted

Location:

2. Click **Create Wallet** to create a new wallet.

Description:
Literal UI strings (buttons, labels, notifications) are styled in bold instead of appearing verbatim in quotation marks, which the style guide requires for copy‑exactness and searchability. This pattern occurs throughout the page; the primary instance is at the location above, with additional cases nearby. See contribute/style-guide-extended.mdx §6.2 (and related quoting rules).

Suggestion:
Replace bold UI strings with quoted strings. Apply across the page.

--- a/ecosystem/wallet-apps/web.mdx
+++ b/ecosystem/wallet-apps/web.mdx
@@ -31 +31 @@
-2. Click **Create Wallet** to create a new wallet.
+2. Click "Create Wallet" to create a new wallet.
@@ -39 +39 @@
-3. Next, choose **Use Password** to protect your wallet:
+3. Next, choose "Use Password" to protect your wallet:
@@ -259 +259 @@
-1. Click **Send**, enter your wallet address in **Recipient Address**, and the **Amount** of TON. Optionally, add a comment. Click **Send TON**.
+1. Click "Send", enter your wallet address in "Recipient Address", and the "Amount" of TON. Optionally, add a comment. Click "Send TON".
@@ -267 +267 @@
-2. In the confirmation popup, verify the transaction details and click **Confirm** if correct; otherwise, **Edit**.
+2. In the confirmation popup, verify the transaction details and click "Confirm" if correct; otherwise, "Edit".
@@ -275 +275 @@
-3. After confirmation, the wallet will display a notification: **Coins have been sent!**
+3. After confirmation, the wallet displays the notification "Coins have been sent!"

[HIGH] Safety callout for mnemonic handling is incomplete (missing risk, scope, rollback, environment)

Location:

<Aside
type="caution"
>
The following recovery words are shown only for demonstration purposes.
</Aside>

Description:
The section that displays recovery words uses a simple caution that lacks the required safety‑critical elements: risk, scope, rollback/mitigation, and environment. Handling mnemonics requires a complete Warning/Caution via the <Aside> component with those fields per contribute/style-guide-extended.mdx §11.1–§11.2.

Suggestion:
Replace the existing callout with a complete Danger callout that includes all required elements.

-<Aside
-  type="caution"
->
-  The following recovery words are shown only for demonstration purposes.
-</Aside>
+<Aside type="danger" title="Secrets at risk">
+  Risk: Exposing recovery words lets others take your wallet and funds.
+  Scope: Affects this wallet and any accounts derived from its mnemonic.
+  Rollback: If exposure is suspected, move funds to a new wallet and stop using the old mnemonic.
+  Environment: Handle mnemonics offline and in private; do not enter them on untrusted sites. Prefer Testnet for demos.
+</Aside>

[HIGH] Missing required safety callout before moving funds

Location:

### Send the first transaction
With TON in the account, the wallet can be deployed. Deployment occurs when _the wallet processes its first transaction_.
In this example, we send TON to the account itself on Testnet to observe the transaction and wallet deployment on-chain.
To send TON to your own account:
1. Click **Send**, enter your wallet address in **Recipient Address**, and the **Amount** of TON. Optionally, add a comment. Click **Send TON**.

Description:
The “Send the first transaction” section instructs a funds transfer without a required safety callout. Any step that moves funds must present a Warning/Caution covering risk, scope, mitigation/rollback, and environment, placed before the numbered steps to prevent accidental mainnet execution (see contribute/style-guide-extended.mdx §11.1–§11.2).

Suggestion:
Insert a Danger callout immediately before the steps.

 ### Send the first transaction

 With TON in the account, the wallet can be deployed. Deployment occurs when _the wallet processes its first transaction_.
 
 In this example, we send TON to the account itself on Testnet to observe the transaction and wallet deployment on-chain.
 
+<Aside type="danger" title="Funds at risk">
+  Risk: The next steps transfer funds. Mainnet transfers are irreversible.
+  Scope: Your wallet balance and the specified recipient address.
+  Mitigation/Rollback: Use TON Testnet for this example. On mainnet, double‑check the recipient and amount before confirming; there is no rollback after submission.
+  Environment: Prefer TON Testnet for testing; switch to mainnet only when ready.
+</Aside>
 
 To send TON to your own account:

Copy link
Member

@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.

@aigerimu merge conflicts + failing CI

Copy link

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
npx remark -o --silent --silently-ignore ecosystem/wallet-apps/web.mdx 

@aigerimu
Copy link
Contributor Author

@aigerimu merge conflicts + failing CI

done

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.

[Ecosystem > Wallet apps > wallet.ton.org]

3 participants