Skip to main content

Midnight Wallet API

Midnight Wallet API provides a comprehensive interface for wallet operations, defining the structure of the wallet state, the methods for interacting with it, and the types and variables used within.

Link to related documentation

2 April 2025

Midnight Wallet API 4.0.0 Release Notes​

Stable Release​

  • Version: 4.0.0
  • Audience: Wallet developers, integration engineers, node operators
  • Environment: Production-ready
important

If you upgrade to wallet-4.0.0, the balances inside the wallets will no longer be visible. Please ensure you have backed up any critical data or completed necessary transactions before upgrading

This release (4.0.0) is considered stable and production-ready. It can safely be deployed in public and production environments.

Key Changes & Highlights​

  • Bech32m Address format: This version supports both, bech32m and hex (legacy) formats. The default format is Bech32m.

Changelog​

Breaking Changes​

Address format change

  • Impact: The default address format is bech32m
  • Action Required: When implementing the wallet API, the address format should be implemented accordingly.

New Features​

Bech32m address format

  • Description: The address format allows users to distinguish addresses, public keys and private keys based on the network they’re generated for (undeployed, devnet, testnet, mainnet) and the type of address this is, i.e a shielded address or unshielded address.
  • Usage/Configuration: It’s enabled by default.

Upgrade/Installation/Migration Instructions​

Prerequisites​

None

Step-by-Step Instructions​

Update your dapp connector API version to @midnight-ntwrk/wallet-api@4.0.0

Post-Upgrade Verification​

The version above is installed

Compatibility​

  • Operating Systems: None.
  • Third-Party Tools: Node.js >=18
  • Midnight Ecosystem Compatibility: Wallet SDK needs to be updated to support this (already one).