Problem / Context
Under docs/src/web-client/, there are runnable web tutorials for public note operations (mint_consume_create_tutorial.md), counter contracts, and foreign procedure invocations, but no tutorial for Private Note transfers.
In addition, existing notes in mint_consume_create_tutorial.md state that private notes must be exchanged manually out-of-band. Now that @miden-sdk/miden-sdk natively supports client.notes.sendPrivateNote() and client.notes.fetchPrivate() via the Note Transport Service, web dApp developers need a dedicated, end-to-end tutorial.
Proposed Solution
Add a new step-by-step tutorial at docs/src/web-client/private_notes_tutorial.md demonstrating:
- Initializing
MidenClient from @miden-sdk/miden-sdk in a Vite/React web app.
- Creating and sending a private P2ID note using
client.notes.sendPrivateNote().
- Transporting note metadata and fetching recipient private notes via
client.notes.fetchPrivate().
- Consuming the private note on the recipient web client and asserting updated account vault balances.
- Updating outdated private note disclaimers in
mint_consume_create_tutorial.md to link to this new tutorial.
Expected Impact
Fills the missing web tutorial gap and provides frontend developers with a runnable TypeScript reference for Miden's flagship privacy feature.
I would like to write and submit this tutorial. Could a maintainer please assign this issue to me?
Problem / Context
Under
docs/src/web-client/, there are runnable web tutorials for public note operations (mint_consume_create_tutorial.md), counter contracts, and foreign procedure invocations, but no tutorial for Private Note transfers.In addition, existing notes in
mint_consume_create_tutorial.mdstate that private notes must be exchanged manually out-of-band. Now that@miden-sdk/miden-sdknatively supportsclient.notes.sendPrivateNote()andclient.notes.fetchPrivate()via the Note Transport Service, web dApp developers need a dedicated, end-to-end tutorial.Proposed Solution
Add a new step-by-step tutorial at
docs/src/web-client/private_notes_tutorial.mddemonstrating:MidenClientfrom@miden-sdk/miden-sdkin a Vite/React web app.client.notes.sendPrivateNote().client.notes.fetchPrivate().mint_consume_create_tutorial.mdto link to this new tutorial.Expected Impact
Fills the missing web tutorial gap and provides frontend developers with a runnable TypeScript reference for Miden's flagship privacy feature.
I would like to write and submit this tutorial. Could a maintainer please assign this issue to me?