Prep to release v0.42.0

.github/workflows/rust.yml

@@ -253,6 +253,7 @@ jobs:
     name: Check documentation and run doc tests
     runs-on: parity-large
     needs: [fmt, machete]
+    timeout-minutes: 30
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4

CHANGELOG.md

@@ -4,6 +4,100 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.42.0] - 2025-05-09
+
+The primary benefit of this release is introducing support for the [_about-to-be-stabilised-in-polkadot-sdk_](https://github.com/paritytech/polkadot-sdk/pull/8443) V16 metadata, and with that, support for calling Pallet View Functions on runtimes which will support this. Pallet View Functions are used much like Runtime APIs, except that they are declared in specific pallets and not declared at the runtime-wide level, allowing pallets to carry their own APIs with them.
+
+### Pallet View Functions
+
+Calling a Pallet View Function in this Subxt release will look like:
+
+```rust
+use runtime::proxy::view_functions::check_permissions::{Call, ProxyType};
+
+// Construct the call, providing the two arguments.
+let view_function_call = runtime::view_functions()
+    .proxy()
+    .check_permissions(
+        Call::System(runtime::system::Call::remark { remark: b"hi".to_vec() }),
+        ProxyType::Any
+    );
+
+// Submit the call and get back a result.
+let _is_call_allowed = api
+    .view_functions()
+    .at_latest()
+    .await?
+    .call(view_function_call)
+    .await?;
+```
+
+Like Runtime APIs and others, the dynamic API can also be used to call into Pallet View Functions, which has the advantage of not needing the statically generated interface, but the downside of not being strongly typed. This looks like the following:
+
+```rust
+use scale_value::value;
+
+let metadata = api.metadata();
+
+// Look up the query ID for the View Function in the node metadata:
+let query_id = metadata
+    .pallet_by_name("Proxy")
+    .unwrap()
+    .view_function_by_name("check_permissions")
+    .unwrap()
+    .query_id();
+
+// Construct the call, providing the two arguments.
+let view_function_call = subxt::dynamic::view_function_call(
+    *query_id,
+    vec![
+        value!(System(remark(b"hi".to_vec()))), 
+        value!(Any())
+    ],
+);
+
+// Submit the call and get back a result.
+let _is_call_allowed = api
+    .view_functions()
+    .at_latest()
+    .await?
+    .call(view_function_call)
+    .await?;
+```
+
+### Updated `Config` trait
+
+Another change to be aware of is that [our `Config` trait has been tweaked](https://github.com/paritytech/subxt/pull/1974). The `Hash` associated type is no longer needed, as it can be obtained via the `Hasher` associated type already, and `PolkadotConfig`/`SubstrateConfig` now set the hasher by default to be `DynamicHasher256`, which will (when V16 metadata is available for a runtime) automatically select between Keccak256 and BlakeTwo256 hashers depending on what the chain requires.
+
+### Other changes
+
+We also [solidify our support for V1 archive RPCs](https://github.com/paritytech/subxt/pull/1977), [upgrade the codebase to Rust 2024 edition](https://github.com/paritytech/subxt/pull/2001), and a bunch of other changes, the full list of which is here:
+
+### Added
+
+- Support v16 metadata and use it by default if it's available ([#1999](https://github.com/paritytech/subxt/pull/1999))
+- Metadata V16: Implement support for Pallet View Functions ([#1981](https://github.com/paritytech/subxt/pull/1981))
+- Metadata V16: Be more dynamic over which hasher is used. ([#1974](https://github.com/paritytech/subxt/pull/1974))
+
+### Changed
+
+- Update to 2024 edition ([#2001](https://github.com/paritytech/subxt/pull/2001))
+- Update Smoldot to latest version ([#1991](https://github.com/paritytech/subxt/pull/1991))
+- Update native test timeout to 45 mins ([#2002](https://github.com/paritytech/subxt/pull/2002))
+- chore(deps): tokio ^1.44.2 ([#1989](https://github.com/paritytech/subxt/pull/1989))
+- Add DefaultParams to allow more transaction extensions to be used when calling _default() methods ([#1979](https://github.com/paritytech/subxt/pull/1979))
+- Use wat instead of wabt to avoid CI cmake error (and use supported dep) ([#1980](https://github.com/paritytech/subxt/pull/1980))
+- Support v1 archive RPCs ([#1977](https://github.com/paritytech/subxt/pull/1977))
+- Support V16 metadata and refactor metadata code ([#1967](https://github.com/paritytech/subxt/pull/1967))
+- Allow submitting transactions ignoring follow events ([#1962](https://github.com/paritytech/subxt/pull/1962))
+- Improve error message regarding failure to extract metadata from WASM runtime ([#1961](https://github.com/paritytech/subxt/pull/1961))
+- Add docs for subxt-rpcs and fix example ([#1954](https://github.com/paritytech/subxt/pull/1954))
+
+### Fixed
+
+- Fix CLI storage diff ([#1958](https://github.com/paritytech/subxt/pull/1958))
+- chore: fix some typos ([#1997](https://github.com/paritytech/subxt/pull/1997))
+
 ## [0.41.0] - 2025-03-10
 
 This release makes two main changes:

cli/src/commands/diff.rs

@@ -18,7 +18,7 @@ use subxt_metadata::{
 /// Explore the differences between two nodes
 ///
 /// # Example
-/// ```
+/// ```text
 /// subxt diff ./artifacts/polkadot_metadata_small.scale ./artifacts/polkadot_metadata_tiny.scale
 /// subxt diff ./artifacts/polkadot_metadata_small.scale wss://rpc.polkadot.io:443
 /// ```

cli/src/commands/explore/mod.rs

@@ -20,6 +20,7 @@ mod runtime_apis;
 /// # Example
 ///
 /// Show the pallets and runtime apis that are available:
+///
 /// ```text
 /// subxt explore --file=polkadot_metadata.scale
 /// ```

cli/src/commands/explore/runtime_apis/mod.rs

@@ -19,7 +19,7 @@ use subxt_metadata::RuntimeApiMetadata;
 
 /// Runs for a specified runtime API trait.
 /// Cases to consider:
-/// ```txt
+/// ```text
 /// method is:
 ///   None => Show pallet docs + available methods
 ///   Some (invalid) => Show Error + available methods

codegen/src/api/constants.rs

@@ -14,7 +14,7 @@ use super::CodegenError;
 /// Generate constants from the provided pallet's metadata.
 ///
 /// The function creates a new module named `constants` under the pallet's module.
-/// ```ignore
+/// ```rust,ignore
 /// pub mod PalletName {
 ///     pub mod constants {
 ///     ...

codegen/src/api/events.rs

@@ -13,7 +13,7 @@ use subxt_metadata::PalletMetadata;
 ///
 /// The function creates a new module named `events` under the pallet's module.
 ///
-/// ```ignore
+/// ```rust,ignore
 /// pub mod PalletName {
 ///     pub mod events {
 ///     ...
@@ -24,7 +24,7 @@ use subxt_metadata::PalletMetadata;
 /// The function generates the events as rust structs that implement the `subxt::event::StaticEvent` trait
 /// to uniquely identify the event's identity when creating the extrinsic.
 ///
-/// ```ignore
+/// ```rust,ignore
 /// pub struct EventName {
 ///      pub event_param: type,
 /// }

codegen/src/api/mod.rs

@@ -410,19 +410,24 @@ pub struct StructFromVariant {
 /// Returns the TokenStream of the type alias module.
 ///
 /// E.g a struct like this:
-/// ```ignore
+///
+/// ```rust,ignore
 /// pub struct SetMaxCodeSize {
 ///     pub new: ::core::primitive::u32,
 /// }
 /// ```
+///
 /// will be made into this:
-/// ```ignore
+///
+/// ```rust,ignore
 /// pub struct SetMaxCodeSize {
 ///     pub new: set_max_code_size::New,
 /// }
 /// ```
+///
 /// And the type alias module will look like this:
-/// ```ignore
+///
+/// ```rust,ignore
 /// pub mod set_max_code_size {
 ///     use super::runtime_types;
 ///     pub type New = ::core::primitive::u32;

codegen/src/lib.rs

@@ -40,7 +40,7 @@ pub use syn;
 ///
 /// Generating an interface using all of the defaults:
 ///
-/// ```rust
+/// ```rust,standalone_crate
 /// use codec::Decode;
 /// use subxt_codegen::{ Metadata, CodegenBuilder };
 ///

rpcs/src/client/rpc_client.rs

@@ -106,7 +106,7 @@ impl std::ops::Deref for RpcClient {
 ///
 /// # Example
 ///
-/// ```rust
+/// ```rust,standalone_crate
 /// use subxt_rpcs::client::{ rpc_params, RpcParams };
 ///
 /// // If you provide no params you get `None` back
@@ -138,7 +138,7 @@ pub use rpc_params;
 ///
 /// # Example
 ///
-/// ```rust
+/// ```rust,standalone_crate
 /// use subxt_rpcs::client::RpcParams;
 ///
 /// let mut params = RpcParams::new();

signer/src/ecdsa.rs

@@ -48,7 +48,7 @@ impl Keypair {
     ///
     /// # Example
     ///
-    /// ```rust
+    /// ```rust,standalone_crate
     /// use subxt_signer::{ SecretUri, ecdsa::Keypair };
     /// use std::str::FromStr;
     ///
@@ -84,7 +84,7 @@ impl Keypair {
     ///
     /// # Example
     ///
-    /// ```rust
+    /// ```rust,standalone_crate
     /// use subxt_signer::{ bip39::Mnemonic, ecdsa::Keypair };
     ///
     /// let phrase = "bottom drive obey lake curtain smoke basket hold race lonely fit walk";
@@ -122,7 +122,7 @@ impl Keypair {
     ///
     /// # Example
     ///
-    /// ```rust
+    /// ```rust,standalone_crate
     /// use subxt_signer::{ bip39::Mnemonic, ecdsa::Keypair, DeriveJunction };
     ///
     /// let phrase = "bottom drive obey lake curtain smoke basket hold race lonely fit walk";
@@ -178,7 +178,7 @@ impl Keypair {
 
 /// Verify that some signature for a message was created by the owner of the [`PublicKey`].
 ///
-/// ```rust
+/// ```rust,standalone_crate
 /// use subxt_signer::{ bip39::Mnemonic, ecdsa };
 ///
 /// let keypair = ecdsa::dev::alice();

signer/src/eth.rs

@@ -46,7 +46,7 @@ impl Keypair {
     ///
     /// # Example
     ///
-    /// ```rust
+    /// ```rust,standalone_crate
     /// use subxt_signer::{ bip39::Mnemonic, eth::{ Keypair, DerivationPath } };
     ///
     /// let phrase = "bottom drive obey lake curtain smoke basket hold race lonely fit walk";
@@ -175,7 +175,7 @@ impl AsRef<[u8; 65]> for Signature {
 
 /// Verify that some signature for a message was created by the owner of the [`PublicKey`].
 ///
-/// ```rust
+/// ```rust,standalone_crate
 /// use subxt_signer::{ bip39::Mnemonic, eth };
 ///
 /// let keypair = eth::dev::alith();

signer/src/sr25519.rs

@@ -58,7 +58,7 @@ impl Keypair {
     ///
     /// # Example
     ///
-    /// ```rust
+    /// ```rust,standalone_crate
     /// use subxt_signer::{ SecretUri, sr25519::Keypair };
     /// use std::str::FromStr;
     ///
@@ -94,7 +94,7 @@ impl Keypair {
     ///
     /// # Example
     ///
-    /// ```rust
+    /// ```rust,standalone_crate
     /// use subxt_signer::{ bip39::Mnemonic, sr25519::Keypair };
     ///
     /// let phrase = "bottom drive obey lake curtain smoke basket hold race lonely fit walk";
@@ -144,7 +144,7 @@ impl Keypair {
     ///
     /// # Example
     ///
-    /// ```rust
+    /// ```rust,standalone_crate
     /// use subxt_signer::{ bip39::Mnemonic, sr25519::Keypair, DeriveJunction };
     ///
     /// let phrase = "bottom drive obey lake curtain smoke basket hold race lonely fit walk";
@@ -186,7 +186,7 @@ impl Keypair {
 
 /// Verify that some signature for a message was created by the owner of the [`PublicKey`].
 ///
-/// ```rust
+/// ```rust,standalone_crate
 /// use subxt_signer::{ bip39::Mnemonic, sr25519 };
 ///
 /// let keypair = sr25519::dev::alice();

subxt/src/backend/mod.rs

@@ -29,7 +29,7 @@ pub mod rpc {
         ///
         /// # Example
         ///
-        /// ```rust,no_run
+        /// ```rust,no_run,standalone_crate
         /// use std::time::Duration;
         /// use futures::StreamExt;
         /// use subxt::backend::rpc::reconnecting_rpc_client::{RpcClient, ExponentialBackoff};
@@ -541,7 +541,7 @@ mod test {
         /// - `current_runtime_version`
         /// - `call`
         /// The test covers them because they follow the simple pattern of:
-        /// ```no_run
+        /// ```rust,no_run,standalone_crate
         ///  async fn THE_THING(&self) -> Result<HashFor<T>, Error> {
         ///    retry(|| <DO THE THING> ).await
         ///  }
@@ -572,7 +572,7 @@ mod test {
         /// - `stream_all_block_headers`
         /// - `stream_best_block_headers`
         /// The test covers them because they follow the simple pattern of:
-        /// ```no_run
+        /// ```rust,no_run,standalone_crate
         /// async fn stream_the_thing(
         ///     &self,
         /// ) -> Result<StreamOfResults<(T::Header, BlockRef<HashFor<T>>)>, Error> {