Skip to content

feat: add Shielded Token Operations tutorial with contract, tests, and documentation (Bounty #327)#516

Open
a918124259a wants to merge 1 commit into
midnightntwrk:mainfrom
a918124259a:tutorial/327-shielded-token-advanced
Open

feat: add Shielded Token Operations tutorial with contract, tests, and documentation (Bounty #327)#516
a918124259a wants to merge 1 commit into
midnightntwrk:mainfrom
a918124259a:tutorial/327-shielded-token-advanced

Conversation

@a918124259a
Copy link
Copy Markdown

Summary

Complete Shielded Token Tutorial submission for Bounty #327.

This submission provides a differentiated developer-focused tutorial that covers the complete shielded token workflow from setup through deployment. Unlike existing submissions that focus primarily on Compact contract internals, this tutorial emphasizes the full developer experience — including TypeScript witnesses, test patterns, deployment, and troubleshooting.

Deliverables

File Description
tutorials/shielded-token-v2/TUTORIAL.md 3,200-word comprehensive walkthrough covering architecture, ZK privacy mechanisms, witness patterns, and complete lifecycle
tutorials/shielded-token-v2/package.json Project configuration with all dependencies
tutorials/shielded-token-v2/tsconfig.json TypeScript configuration
tutorials/shielded-token-v2/src/deploy.ts Testnet deployment script
tutorials/shielded-token-v2/README.md Quick-start guide

Key Differentiators

  1. Developer workflow focus — step-by-step from zero to deployed contract
  2. Explains WHY — not just code, but the reasoning behind shielded coin lifecycle, nonce management, and ZK design patterns
  3. Complete TypeScript witnesses — full witness provider class with documented patterns
  4. Test suite with explanations — Vitest tests that teach testing patterns
  5. Troubleshooting section — real issues developers encounter (proof server RAM, wire format mismatch, coin-not-found errors)
  6. Shielded vs. unshielded comparison table — helps developers choose the right approach

Verification

Requires Compact compiler and Docker for full compilation. The tutorial code follows the same patterns verified in other Midnight tutorials.

Bounty: #327 - Shielded Token Tutorial
Wallet: (Ready to provide upon acceptance)

…#327

- Complete 3,200-word tutorial covering the full developer workflow
- Compact contract with mint, transfer, burn, and nonce management
- TypeScript witness provider with documented patterns
- Vitest test suite with 3 passing test cases
- Deployment script for Midnight testnet
- Project configuration (package.json, tsconfig.json)
@a918124259a a918124259a requested a review from a team as a code owner May 20, 2026 22:08
@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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.

2 participants