diff --git a/cumulus/parachains/runtimes/assets/asset-hub-rococo/build.rs b/cumulus/parachains/runtimes/assets/asset-hub-rococo/build.rs
index 60f8a125129ff1344a1799246e931acdb1d139d5..239ccac19ec7778039fb1ee56f4e772b3ddd3711 100644
--- a/cumulus/parachains/runtimes/assets/asset-hub-rococo/build.rs
+++ b/cumulus/parachains/runtimes/assets/asset-hub-rococo/build.rs
@@ -15,11 +15,7 @@
#[cfg(feature = "std")]
fn main() {
- substrate_wasm_builder::WasmBuilder::new()
- .with_current_project()
- .export_heap_base()
- .import_memory()
- .build()
+ substrate_wasm_builder::WasmBuilder::build_using_defaults();
}
#[cfg(not(feature = "std"))]
diff --git a/cumulus/parachains/runtimes/assets/asset-hub-westend/build.rs b/cumulus/parachains/runtimes/assets/asset-hub-westend/build.rs
index 60f8a125129ff1344a1799246e931acdb1d139d5..239ccac19ec7778039fb1ee56f4e772b3ddd3711 100644
--- a/cumulus/parachains/runtimes/assets/asset-hub-westend/build.rs
+++ b/cumulus/parachains/runtimes/assets/asset-hub-westend/build.rs
@@ -15,11 +15,7 @@
#[cfg(feature = "std")]
fn main() {
- substrate_wasm_builder::WasmBuilder::new()
- .with_current_project()
- .export_heap_base()
- .import_memory()
- .build()
+ substrate_wasm_builder::WasmBuilder::build_using_defaults();
}
#[cfg(not(feature = "std"))]
diff --git a/cumulus/parachains/runtimes/collectives/collectives-westend/build.rs b/cumulus/parachains/runtimes/collectives/collectives-westend/build.rs
index 60f8a125129ff1344a1799246e931acdb1d139d5..239ccac19ec7778039fb1ee56f4e772b3ddd3711 100644
--- a/cumulus/parachains/runtimes/collectives/collectives-westend/build.rs
+++ b/cumulus/parachains/runtimes/collectives/collectives-westend/build.rs
@@ -15,11 +15,7 @@
#[cfg(feature = "std")]
fn main() {
- substrate_wasm_builder::WasmBuilder::new()
- .with_current_project()
- .export_heap_base()
- .import_memory()
- .build()
+ substrate_wasm_builder::WasmBuilder::build_using_defaults();
}
#[cfg(not(feature = "std"))]
diff --git a/cumulus/parachains/runtimes/contracts/contracts-rococo/build.rs b/cumulus/parachains/runtimes/contracts/contracts-rococo/build.rs
index 60f8a125129ff1344a1799246e931acdb1d139d5..239ccac19ec7778039fb1ee56f4e772b3ddd3711 100644
--- a/cumulus/parachains/runtimes/contracts/contracts-rococo/build.rs
+++ b/cumulus/parachains/runtimes/contracts/contracts-rococo/build.rs
@@ -15,11 +15,7 @@
#[cfg(feature = "std")]
fn main() {
- substrate_wasm_builder::WasmBuilder::new()
- .with_current_project()
- .export_heap_base()
- .import_memory()
- .build()
+ substrate_wasm_builder::WasmBuilder::build_using_defaults();
}
#[cfg(not(feature = "std"))]
diff --git a/cumulus/parachains/runtimes/glutton/glutton-westend/build.rs b/cumulus/parachains/runtimes/glutton/glutton-westend/build.rs
index 1580e6f07bec466c644ccab1f4591d384632135e..2f311357403c0c179103a91d180c42d4e29f84a7 100644
--- a/cumulus/parachains/runtimes/glutton/glutton-westend/build.rs
+++ b/cumulus/parachains/runtimes/glutton/glutton-westend/build.rs
@@ -16,9 +16,5 @@
use substrate_wasm_builder::WasmBuilder;
fn main() {
- WasmBuilder::new()
- .with_current_project()
- .export_heap_base()
- .import_memory()
- .build()
+ WasmBuilder::build_using_defaults();
}
diff --git a/cumulus/parachains/runtimes/testing/penpal/build.rs b/cumulus/parachains/runtimes/testing/penpal/build.rs
index 9c9cde9a25a1a8ab1780b7df7e068264459a31af..c2fa89aa7028510ab3f95a152ababcffbecd280f 100644
--- a/cumulus/parachains/runtimes/testing/penpal/build.rs
+++ b/cumulus/parachains/runtimes/testing/penpal/build.rs
@@ -16,11 +16,7 @@
#[cfg(feature = "std")]
fn main() {
- substrate_wasm_builder::WasmBuilder::new()
- .with_current_project()
- .export_heap_base()
- .import_memory()
- .build()
+ substrate_wasm_builder::WasmBuilder::build_using_defaults();
}
#[cfg(not(feature = "std"))]
diff --git a/cumulus/parachains/runtimes/testing/rococo-parachain/build.rs b/cumulus/parachains/runtimes/testing/rococo-parachain/build.rs
index 60f8a125129ff1344a1799246e931acdb1d139d5..239ccac19ec7778039fb1ee56f4e772b3ddd3711 100644
--- a/cumulus/parachains/runtimes/testing/rococo-parachain/build.rs
+++ b/cumulus/parachains/runtimes/testing/rococo-parachain/build.rs
@@ -15,11 +15,7 @@
#[cfg(feature = "std")]
fn main() {
- substrate_wasm_builder::WasmBuilder::new()
- .with_current_project()
- .export_heap_base()
- .import_memory()
- .build()
+ substrate_wasm_builder::WasmBuilder::build_using_defaults();
}
#[cfg(not(feature = "std"))]
diff --git a/cumulus/test/runtime/build.rs b/cumulus/test/runtime/build.rs
index 5e5f6a35a505a957a3494285b7b649e6ee4e61f7..ebd5c178cba07e2889b6501a9be490344467d228 100644
--- a/cumulus/test/runtime/build.rs
+++ b/cumulus/test/runtime/build.rs
@@ -18,16 +18,10 @@
fn main() {
use substrate_wasm_builder::WasmBuilder;
- WasmBuilder::new()
- .with_current_project()
- .export_heap_base()
- .import_memory()
- .build();
+ WasmBuilder::build_using_defaults();
- WasmBuilder::new()
- .with_current_project()
+ WasmBuilder::init_with_defaults()
.enable_feature("increment-spec-version")
- .import_memory()
.set_file_name("wasm_binary_spec_version_incremented.rs")
.build();
}
diff --git a/polkadot/runtime/rococo/build.rs b/polkadot/runtime/rococo/build.rs
index 0b7ee77b0d0d3b984a168f8cefe02a9e00e8f86c..403c31ff21c70f679059fa5b7e65478d309ba6a3 100644
--- a/polkadot/runtime/rococo/build.rs
+++ b/polkadot/runtime/rococo/build.rs
@@ -16,18 +16,11 @@
#[cfg(feature = "std")]
fn main() {
- substrate_wasm_builder::WasmBuilder::new()
- .with_current_project()
- .import_memory()
- .export_heap_base()
- .build();
+ substrate_wasm_builder::WasmBuilder::build_using_defaults();
- substrate_wasm_builder::WasmBuilder::new()
- .with_current_project()
+ substrate_wasm_builder::WasmBuilder::init_with_defaults()
.set_file_name("fast_runtime_binary.rs")
.enable_feature("fast-runtime")
- .import_memory()
- .export_heap_base()
.build();
}
diff --git a/polkadot/runtime/test-runtime/build.rs b/polkadot/runtime/test-runtime/build.rs
index 404ba3f2fdbdfdc68d35d0dd08958448f30d90c6..caf24317d0b3e1e30bdc63ba2a5e6388b820be57 100644
--- a/polkadot/runtime/test-runtime/build.rs
+++ b/polkadot/runtime/test-runtime/build.rs
@@ -17,9 +17,5 @@
use substrate_wasm_builder::WasmBuilder;
fn main() {
- WasmBuilder::new()
- .with_current_project()
- .import_memory()
- .export_heap_base()
- .build()
+ WasmBuilder::build_using_defaults();
}
diff --git a/polkadot/runtime/westend/build.rs b/polkadot/runtime/westend/build.rs
index 428c971bc132a5c7e856e6485246c4fd2ff57822..0b3e12c78c746517a32538c8c1e5f9da63747fc5 100644
--- a/polkadot/runtime/westend/build.rs
+++ b/polkadot/runtime/westend/build.rs
@@ -17,9 +17,5 @@
use substrate_wasm_builder::WasmBuilder;
fn main() {
- WasmBuilder::new()
- .with_current_project()
- .import_memory()
- .export_heap_base()
- .build()
+ WasmBuilder::build_using_defaults();
}
diff --git a/prdoc/pr_4177.prdoc b/prdoc/pr_4177.prdoc
new file mode 100644
index 0000000000000000000000000000000000000000..29d011c93516c35af2049dafdec035e4f888ffec
--- /dev/null
+++ b/prdoc/pr_4177.prdoc
@@ -0,0 +1,12 @@
+title: "wasm-builder: Make it easier to build a WASM binary"
+
+doc:
+ - audience: [Runtime Dev, Node Dev]
+ description: |
+ Combines all the recommended calls of the `WasmBuilder` into
+ `build_using_defaults()` or `init_with_defaults()` if more changes are required.
+ Otherwise the interface doesn't change and users can still continue to use
+ the "old" interface.
+
+crates:
+ - name: substrate-wasm-builder
diff --git a/substrate/utils/wasm-builder/src/builder.rs b/substrate/utils/wasm-builder/src/builder.rs
index d2aaff448bc5fdc2f2c1cb73774e0d7603ae90db..163703fbec628327c0ba3dc0683972285af71e30 100644
--- a/substrate/utils/wasm-builder/src/builder.rs
+++ b/substrate/utils/wasm-builder/src/builder.rs
@@ -116,6 +116,39 @@ impl WasmBuilder {
WasmBuilderSelectProject { _ignore: () }
}
+ /// Build the WASM binary using the recommended default values.
+ ///
+ /// This is the same as calling:
+ /// ```no_run
+ /// substrate_wasm_builder::WasmBuilder::new()
+ /// .with_current_project()
+ /// .import_memory()
+ /// .export_heap_base()
+ /// .build();
+ /// ```
+ pub fn build_using_defaults() {
+ WasmBuilder::new()
+ .with_current_project()
+ .import_memory()
+ .export_heap_base()
+ .build();
+ }
+
+ /// Init the wasm builder with the recommended default values.
+ ///
+ /// In contrast to [`Self::build_using_defaults`] it does not build the WASM binary directly.
+ ///
+ /// This is the same as calling:
+ /// ```no_run
+ /// substrate_wasm_builder::WasmBuilder::new()
+ /// .with_current_project()
+ /// .import_memory()
+ /// .export_heap_base();
+ /// ```
+ pub fn init_with_defaults() -> Self {
+ WasmBuilder::new().with_current_project().import_memory().export_heap_base()
+ }
+
/// Enable exporting `__heap_base` as global variable in the WASM binary.
///
/// This adds `-Clink-arg=--export=__heap_base` to `RUST_FLAGS`.
diff --git a/substrate/utils/wasm-builder/src/lib.rs b/substrate/utils/wasm-builder/src/lib.rs
index 178e499e8f5bb6d7531d73004e2f37e1e9b1d146..9ebab38b9cb2f727594e310f1e6d27c221f528dc 100644
--- a/substrate/utils/wasm-builder/src/lib.rs
+++ b/substrate/utils/wasm-builder/src/lib.rs
@@ -33,15 +33,9 @@
//! use substrate_wasm_builder::WasmBuilder;
//!
//! fn main() {
-//! WasmBuilder::new()
-//! // Tell the builder to build the project (crate) this `build.rs` is part of.
-//! .with_current_project()
-//! // Make sure to export the `heap_base` global, this is required by Substrate
-//! .export_heap_base()
-//! // Build the Wasm file so that it imports the memory (need to be provided by at instantiation)
-//! .import_memory()
-//! // Build it.
-//! .build()
+//! // Builds the WASM binary using the recommended defaults.
+//! // If you need more control, you can call `new` or `init_with_defaults`.
+//! WasmBuilder::build_using_defaults();
//! }
//! ```
//!
diff --git a/templates/minimal/runtime/build.rs b/templates/minimal/runtime/build.rs
index b7676a70dfe843e2cd47fc600ef599bbe7bff591..e6f92757e225475ff744a4a0cf931787463d1544 100644
--- a/templates/minimal/runtime/build.rs
+++ b/templates/minimal/runtime/build.rs
@@ -18,10 +18,6 @@
fn main() {
#[cfg(feature = "std")]
{
- substrate_wasm_builder::WasmBuilder::new()
- .with_current_project()
- .export_heap_base()
- .import_memory()
- .build();
+ substrate_wasm_builder::WasmBuilder::build_using_defaults();
}
}
diff --git a/templates/parachain/runtime/build.rs b/templates/parachain/runtime/build.rs
index 02d6973f29cf4e48691247d8ee02b500d540c4f5..bb05afe02b1fc526d1c7a2c64514e7f25f33c7be 100644
--- a/templates/parachain/runtime/build.rs
+++ b/templates/parachain/runtime/build.rs
@@ -1,10 +1,6 @@
#[cfg(feature = "std")]
fn main() {
- substrate_wasm_builder::WasmBuilder::new()
- .with_current_project()
- .export_heap_base()
- .import_memory()
- .build()
+ substrate_wasm_builder::WasmBuilder::build_using_defaults();
}
/// The wasm builder is deactivated when compiling
diff --git a/templates/solochain/runtime/build.rs b/templates/solochain/runtime/build.rs
index c03d618535be03e94d4d48aacfedb674847e4646..f262c320393bf29ab0d54151803ca8b91d8e451b 100644
--- a/templates/solochain/runtime/build.rs
+++ b/templates/solochain/runtime/build.rs
@@ -1,10 +1,6 @@
fn main() {
#[cfg(feature = "std")]
{
- substrate_wasm_builder::WasmBuilder::new()
- .with_current_project()
- .export_heap_base()
- .import_memory()
- .build();
+ substrate_wasm_builder::WasmBuilder::build_using_defaults();
}
}