[Community] Web SDK survival kit — private note block hints, sync wait, note fingerprints
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 21
- Avg merge
- 12h 14m
- Merged PRs (30d)
- 41
Description
### Summary
Community reference repo documenting **repeatable Web SDK patterns** for private-note delivery, sync waiting, note-list UI updates, and BigInt-safe amounts.
**Repo:** https://github.com/kutluhaneth46/miden-dev-survival-kit
### Motivation
Several open issues describe the same failure modes this kit encodes as copy-paste helpers:
| Kit module | Related issue | Contributor PR |
|------------|---------------|----------------|
| `block-hint.ts` — `after_block_num` for `sendPrivateNote` | #262 | #353 |
| `note-fingerprint.ts` — status-aware `setNotesIfChanged` | #304 | #351 |
| `sync-wait.ts` — poll `syncState` past target block | #320 | #332 |
| `amount.ts` — BigInt base-unit scaling | — | guardian-dashboard #49 |
The helpers are **framework-agnostic TypeScript** (no wasm) so app authors can adopt the patterns before upgraded SDK builds land, and tests document expected behavior.
### What it is / isn't
- ✅ Portable patterns + unit tests + cheat-sheet README
- ✅ Cross-links to official [react-sdk wallet example](https://github.com/0xMiden/web-sdk/tree/main/packages/react-sdk/examples/wallet)
- ❌ Not a full wallet app (see `0xMiden/wallet`, react-sdk examples)
- ❌ Not a replacement for upstream fixes — PRs above remain the durable solution
### Ask
1. Is a community “survival kit” doc like this useful in `miden-docs` or tutorials, or should it stay external?
2. Any corrections to the block-hint / fingerprint semantics before wider sharing?
Related open PRs from the same contributor: #332, #334, #351, #353.
### Additional context
Unofficial community resource — feedback welcome.
Contributor guide
Research direction
Review the community repo at https://github.com/kutluhaneth46/miden-dev-survival-kit to understand the four helper modules: block-hint.ts, note-fingerprint.ts, sync-wait.ts, and amount.ts. Check how they integrate with the existing Web SDK and the related PRs (#332, #334, #351, #353). Determine if this material should be incorporated into miden-docs or remain external, and verify the semantics of block-hint and fingerprint patterns against the linked issues.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100