Skip to content

Conversation

@ap211unitech
Copy link
Member

@ap211unitech ap211unitech commented Dec 8, 2025

📝 Description

This PR adds comprehensive documentation for the sr25519 migration from WASM to pure JavaScript implementation (@scure/sr25519), corresponding to polkadot-js/common#1971.

🤔 Why This Documentation is Needed

The SR25519 migration represents a breaking change:

  • ❌ Old: Async WASM operations requiring initialization
  • ✅ New: Synchronous pure JS operations (no initialization needed)
  • Although function signatures remain compatible, the removal of async operations and WASM initialization is a breaking change in behavior. This guide ensures developers can cleanly migrate and take advantage of the performance improvements.

Copy link
Member

@TarikGul TarikGul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine, I would also mention that the cryptoAwaitReady and can work in conjunction with the non async stuff. Since most usecases might have multiple crypto imports.

@ap211unitech ap211unitech merged commit 3e61cf5 into master Dec 9, 2025
1 check passed
@ap211unitech ap211unitech deleted the feat/sr25519-migration-guide branch December 9, 2025 08:41
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.

5 participants