Skip to content

Document seed lifecycle guidance

Viet Tan Tran requested to merge github/fork/ihsraham/feat/seed-lifecycle-docs into develop

Created by: ihsraham

Summary

  • Adds seed lifecycle guidance under Core SDK memory management, including a reference snippet using a mutable Uint8Array.
  • Clarifies that dispose() clears keys and account state managed by WDK, but does not zero the seed value passed by the app.
  • Adds supporting notes in Concepts, the Core SDK API reference, and central seed setup pages.
  • Improves discoverability with a direct Core SDK overview card and a renamed Core SDK Usage card for seed lifecycle guidance.
  • Rebased on fresh develop (87db2dd) and refreshed the PR screenshots against the updated IA.

Screenshots

Core SDK overview: direct Seed Lifecycle & Disposal card.

Core SDK overview showing the Seed Lifecycle and Disposal card

Core SDK Usage: renamed Error Handling & Seed Lifecycle card.

Core SDK Usage page showing the Error Handling and Seed Lifecycle card

Source basis

  • WDK stores the seed passed to its constructor and passes it to registered wallet managers.
  • The base wallet manager dispose() disposes accounts/signers, but does not mutate its stored seed.

Validation

  • git diff --check
  • PATH="/opt/homebrew/Cellar/node@22/22.22.2_1/bin:$PATH" npm run check:meta
  • PATH="/opt/homebrew/Cellar/node@22/22.22.2_1/bin:$PATH" npm run check:redirects
  • PATH="/opt/homebrew/Cellar/node@22/22.22.2_1/bin:$PATH" LINK_CHECK_EXTERNAL=false npm run check:links
  • PATH="/opt/homebrew/Cellar/node@22/22.22.2_1/bin:$PATH" npm run build

Notes:

  • Build completed with existing unrelated docType warnings.
  • The local link checks and final build link pass found 0 broken links.

Merge request reports