chore(web-client): v12 tutorials clean up by Keinberger · Pull Request #145 · 0xMiden/tutorials

Keinberger · 2025-11-25T14:20:29Z

This PR brings the following changes:

Switches web client tutorials to use yarn instead of pnpm. This was discussed between me and @WiktorStarczewski on Slack, as we both agreed on implementing yarn going forward. yarn is the most widely used Node package manager at the moment and the go-to standard for projects.
Implements a fix inside of the "Increment Count of the Counter Contract" tutorial to update the explanation of authentication components.
Implements a custom .prettierrc config file for all typescript code, that is more aligned with industry best practices (using single quotes instead of double quotes) for Typescript / Web development (proposed by @WiktorStarczewski )

…rkdown

WiktorStarczewski

LGTM

partylikeits1983 · 2025-11-25T21:36:00Z

docs/src/web-client/counter_contract_tutorial.md

+### Authentication Component

-If the `increment_count` procedure did not call the `account::incr_nonce` procedure during its execution, only the deployer of the counter contract would be able to increment the count of the smart contract (if the RpoFalcon512 component was added to the account, in this case we didn't add it).
+**Important**: Starting with Miden Client 0.10.0, all accounts must have an authentication component. For smart contracts that don't require authentication (like our counter contract), we use a `NoAuth` component.


Let's remove the reference to 0.10.0. Let's just say:

Suggested change

**Important**: Starting with Miden Client 0.10.0, all accounts must have an authentication component. For smart contracts that don't require authentication (like our counter contract), we use a `NoAuth` component.

**Important**: All accounts must have an authentication component. For smart contracts that do not require authentication (like our counter contract), we use a `NoAuth` component.

Nit: lets stick to avoiding contractions in our docs. Other projects follow this standard in technical writing. For example: https://docs.soliditylang.org/en/latest/contributing.html#expand-contractions

partylikeits1983 · 2025-11-25T21:36:42Z

docs/src/web-client/counter_contract_tutorial.md

+**Important**: Starting with Miden Client 0.10.0, all accounts must have an authentication component. For smart contracts that don't require authentication (like our counter contract), we use a `NoAuth` component.

-In essence, if a procedure performs a state change in the Miden smart contract, and does not call `account::incr_nonce` at some point during its execution, this function can be equated to having an `onlyOwner` Solidity modifer, meaning only the user with knowledge of the private key of the account can execute transactions that result in a state change.
+This `NoAuth` component allows any user to interact with the smart contract without requiring signature verification.ivate key of the account can execute transactions that result in a state change.


Nit: spelling

partylikeits1983 · 2025-11-25T21:37:54Z

docs/src/web-client/creating_multiple_notes_tutorial.md

-# Creating Multiple Notes in a Single Transaction
-


Did you mean to remove the heading?

Yes, I removed it as docusaurus md files should not have a dedicated heading (linter warning) if the heading is already specified as a "title" property at the start of the file.

partylikeits1983 · 2025-11-25T21:38:53Z

docs/src/web-client/creating_multiple_notes_tutorial.md

-  "0x67dc56bd0cbe629000006f36d81029",
+  '0xbf1db1694c83841000008cefd4fce0',
+  '0xee1a75244282c32000010a29bed5f4',
+  '0x67dc56bd0cbe629000006f36d81029',


Nit: update to use bech32 format

partylikeits1983 · 2025-11-25T21:39:06Z

docs/src/web-client/creating_multiple_notes_tutorial.md

-    "0x67dc56bd0cbe629000006f36d81029",
+    '0xbf1db1694c83841000008cefd4fce0',
+    '0xee1a75244282c32000010a29bed5f4',
+    '0x67dc56bd0cbe629000006f36d81029',


Nit: same thing here

partylikeits1983 · 2025-11-25T21:41:36Z

docs/src/web-client/unauthenticated_note_how_to.md

-# How to Use Unauthenticated Notes
-


Same as other comment, did you mean to remove this title?

Yes, I removed it as docusaurus md files should not have a dedicated heading (linter warning) if the heading is already specified as a "title" property at the start of the file.

partylikeits1983 · 2025-11-25T21:42:29Z

web-client/lib/createMintConsume.ts

  );

-  const nodeEndpoint = "https://rpc.testnet.miden.io:443";
+  const nodeEndpoint = 'https://rpc.testnet.miden.io:443';


Not sure we need the port number 443 anymore. Could you check?

Just checked, runs fine without the port, will remove!

partylikeits1983 · 2025-11-25T21:42:53Z

web-client/lib/createMintConsume.ts


  // 7. Send tokens to Bob
-  const bobAccountId = "0x599a54603f0cf9000000ed7a11e379";
+  const bobAccountId = '0x599a54603f0cf9000000ed7a11e379';


Same as other comment, but most likely for separate PR, we should use bech32 now.

partylikeits1983 · 2025-11-25T21:43:17Z

web-client/lib/multiSendWithDelegatedProver.ts


  const client = await WebClient.createClient(
-    "https://rpc.testnet.miden.io:443",
+    'https://rpc.testnet.miden.io:443',


Same as other comment, can we remove the port number now?

partylikeits1983 · 2025-11-25T21:43:32Z

web-client/lib/multiSendWithDelegatedProver.ts

-    "0xbf1db1694c83841000008cefd4fce0",
-    "0xee1a75244282c32000010a29bed5f4",
-    "0x67dc56bd0cbe629000006f36d81029",
+    '0xbf1db1694c83841000008cefd4fce0',


Keinberger · 2025-11-25T22:37:40Z

FYI, I will open a subsequent PR to bring back the bech32 format for the web-client tutorials.

Created an issue to track this here: #146

Keinberger added 5 commits November 25, 2025 11:14

chore(web-client): update tutorial markdowns for v12

7bfa199

chore(web-client): implement custom prettier config for web client ma…

0742257

…rkdown

chore(web-client): replace package lock json with yarn in demo project

5723efb

chore(web-client): linting

8967e6c

chore(web-client): linting markdown files

bc141b3

Keinberger requested review from WiktorStarczewski and partylikeits1983 November 25, 2025 14:20

Keinberger mentioned this pull request Nov 25, 2025

chore(web-client): implement final fixes for v12 snapshot 0xMiden/miden-docs#101

Merged

WiktorStarczewski approved these changes Nov 25, 2025

View reviewed changes

partylikeits1983 requested changes Nov 25, 2025

View reviewed changes

Keinberger merged commit cf68ba8 into main Nov 25, 2025
6 checks passed

Keinberger deleted the keinberger/v12-tutorials-cleanup branch November 25, 2025 22:37

Keinberger restored the keinberger/v12-tutorials-cleanup branch November 25, 2025 22:51

	Important: Starting with Miden Client 0.10.0, all accounts must have an authentication component. For smart contracts that don't require authentication (like our counter contract), we use a `NoAuth` component.
	Important: All accounts must have an authentication component. For smart contracts that do not require authentication (like our counter contract), we use a `NoAuth` component.

Conversation

Keinberger commented Nov 25, 2025

Uh oh!

WiktorStarczewski left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Keinberger commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Keinberger commented Nov 25, 2025 •

edited

Loading