Skip to content

Wallet SDK v1.2.0 release notes missing from docs site #1237

Description

@Gutopro

Where is the issue?

https://docs.midnight.network/sdks/official/wallet-developer-guide

Type of issue

  • Missing content
  • Outdated content
  • Inaccurate content

Description of the issue

The Wallet SDK installation docs list individual packages to install, each with a VERSION placeholder:

npm install @midnight-ntwrk/wallet-sdk-facade@VERSION
@midnight-ntwrk/wallet-sdk-hd@VERSION
@midnight-ntwrk/wallet-sdk-address-format@VERSION
@midnight-ntwrk/wallet-sdk-unshielded-wallet@VERSION
@midnight-ntwrk/wallet-sdk-shielded@VERSION
@midnight-ntwrk/wallet-sdk-dust-wallet@VERSION
@midnight-ntwrk/ledger-v8

The docs direct readers to "replace VERSION with the compatible version of the wallet SDK packages as defined in the release compatibility matrix." However, the compatibility matrix only lists a single combined version for "Wallet SDK" as a whole (e.g. 1.2.0) — it does not list per-package versions for wallet-sdk-facade, wallet-sdk-hd, wallet-sdk-address-format, wallet-sdk-unshielded-wallet, wallet-sdk-shielded, or wallet-sdk-dust-wallet individually.

Impact:

There's no way to resolve the VERSION placeholder for each package directly from the matrix as instructed. Developers following the install docs as written have to manually cross-check each package's version on npm themselves, which is error-prone and adds unnecessary friction to initial setup.

Steps to reproduce:

Visit the Wallet SDK installation docs page.
Attempt to replace VERSION in the install command using the linked release compatibility matrix.
Note that only a single "Wallet SDK" version is listed, not individual package versions.

Suggested change

Add individual version numbers for each Wallet SDK sub-package to the compatibility matrix, or update the install docs to link directly to each package's npm page / release notes if per-package versions are intentionally omitted.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions