substrate-docs icon indicating copy to clipboard operation
substrate-docs copied to clipboard

Forkless runtime upgrades tutorial requires a note that "compressed" compact.compressed.wasm should be used in the parachain environment

Open ltfschoen opened this issue 3 years ago • 0 comments

Is there an existing issue?

  • [X] I have searched the existing issues

Experiencing problems? Have you tried our Stack Exchange first?

  • [X] This is not a support question.

Content request

The Forkless runtime upgrade tutorial here shows how to perform a runtime upgrade, but only suggests using the x_runtime.compact.wasm file, but does not mention using the x_runtime.compact.compressed.wasm file instead, which is significantly smaller.

This presents an issue for parachain developers who are following the Cumulus tutorial here, as they might go through the process of spending unnecessary time pruning their parachain codebase excessively to try to reduce the size of the x_runtime.compact.wasm when they could have just used the x_runtime.compact.compressed.wasm file all along. This happened to me and it cost me a few days of my time unnecessarily, so I would hope the documentation could be updated to save other developers the same grief and increase awareness.

An real world example of why this small change is necessary is published in this Substrate StackExchange post https://substrate.stackexchange.com/q/784/83 where it was also highlighted that the compressed wasm file even saves space on-chain and over the network.

Are you willing to help with this request?

Yes!

ltfschoen avatar Mar 24 '22 08:03 ltfschoen