Rust

Update to frame-decode 0.17.1 and update CHANGELOG with frame-decode updates #6357

Workflow file for this run

	name: Rust

	on:
	push:
	# Run jobs when commits are pushed to
	# master or release-like branches:
	branches:
	- master
	# If we want to backport changes to an old release, push a branch
	# eg v0.40.x and CI will run on it. PRs merging to such branches
	# will also trigger CI.
	- v0.[0-9]+.x
	pull_request:
	# Run jobs for any external PR that wants
	# to merge to master, too:
	branches:
	- master
	- v0.[0-9]+.x

	concurrency:
	group: ${{ github.ref }}-${{ github.workflow }}
	cancel-in-progress: true

	env:
	CARGO_TERM_COLOR: always
	# Increase wasm test timeout from 20 seconds (default) to 1 minute.
	WASM_BINDGEN_TEST_TIMEOUT: 60

	jobs:
	fmt:
	name: Cargo fmt
	runs-on: ubuntu-latest
	steps:
	- name: Checkout sources
	uses: actions/checkout@v6

	- name: Install Rust nightly toolchain
	uses: actions-rs/toolchain@v1
	with:
	profile: minimal
	toolchain: stable
	override: true
	components: rustfmt

	- name: Rust Cache
	uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1

	- name: Cargo fmt
	run: cargo fmt --all -- --check

	machete:
	name: Check unused dependencies
	runs-on: ubuntu-latest
	steps:
	- name: Checkout sources
	uses: actions/checkout@v6

	- name: Use substrate and polkadot node binaries
	uses: ./.github/workflows/actions/use-nodes

	- name: Install Rust stable toolchain
	uses: actions-rs/toolchain@v1
	with:
	profile: minimal
	toolchain: stable
	override: true

	- name: Rust Cache
	uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1

	- name: Install cargo-machete
	run: cargo install cargo-machete

	- name: Check unused dependencies
	run: cargo machete

	clippy:
	name: Cargo clippy
	runs-on: parity-large
	needs: [fmt, machete]
	steps:
	- name: Checkout sources
	uses: actions/checkout@v6

	- name: Use substrate and polkadot node binaries
	uses: ./.github/workflows/actions/use-nodes

	- name: Install Rust stable toolchain
	uses: actions-rs/toolchain@v1
	with:
	profile: minimal
	toolchain: stable
	components: clippy
	override: true

	- name: Rust Cache
	uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1

	- name: Run clippy
	run: \|
	cargo clippy --all-targets --features light-client -- -D warnings
	cargo clippy -p subxt-lightclient --no-default-features --features web -- -D warnings
	cargo clippy -p subxt --no-default-features --features web -- -D warnings
	cargo clippy -p subxt --no-default-features --features web,light-client -- -D warnings

	wasm_clippy:
	name: Cargo clippy (WASM)
	runs-on: ubuntu-latest
	needs: [fmt, machete]
	steps:
	- name: Checkout sources
	uses: actions/checkout@v6

	- name: Use substrate and polkadot node binaries
	uses: ./.github/workflows/actions/use-nodes

	- name: Install Rust stable toolchain
	uses: actions-rs/toolchain@v1
	with:
	profile: minimal
	toolchain: stable
	target: wasm32-unknown-unknown
	override: true
	components: clippy

	- name: Rust Cache
	uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1

	- name: Run clippy
	run: cargo clippy -p subxt --no-default-features --features web,light-client,jsonrpsee --target wasm32-unknown-unknown -- -D warnings

	check:
	name: Cargo check
	runs-on: parity-large
	needs: [fmt, machete]
	steps:
	- name: Checkout sources
	uses: actions/checkout@v6

	- name: Use substrate and polkadot node binaries
	uses: ./.github/workflows/actions/use-nodes

	- name: Install Rust stable toolchain
	uses: actions-rs/toolchain@v1
	with:
	profile: minimal
	toolchain: stable
	override: true

	- name: Rust Cache
	uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1

	- name: Install cargo-hack
	uses: baptiste0928/cargo-install@v3
	with:
	crate: cargo-hack
	version: 0.5

	# A basic check over all targets together. This may lead to features being combined etc,
	# and doesn't test combinations of different features.
	- name: Cargo check all targets.
	run: cargo check --all-targets

	# Next, check each subxt feature in isolation.
	# - `native` feature must always be enabled
	# - `web` feature is always ignored.
	- name: Cargo hack; check each subxt feature
	run: cargo hack -p subxt --each-feature check --exclude-features web --features native

	# And with subxt-rpcs
	- name: Cargo hack; check each subxt-rpcs feature
	run: cargo hack -p subxt-rpcs --each-feature check --exclude-features web --features native

	# And with subxt-signer
	- name: Cargo hack; check each subxt-signer feature
	run: cargo hack -p subxt-signer --each-feature check --exclude-features web --features native

	# And for subxt-lightclient.
	- name: Cargo check subxt-lightclient
	run: cargo hack -p subxt-lightclient --each-feature check --exclude-features web --features native

	# Next, check all other crates.
	- name: Cargo hack; check each feature/crate on its own
	run: cargo hack --exclude subxt --exclude subxt-signer --exclude subxt-lightclient --exclude subxt-rpcs --exclude-all-features --each-feature check --workspace

	# Check the full examples, which aren't a part of the workspace so are otherwise ignored.
	- name: Cargo check parachain-example
	run: cargo check --manifest-path examples/parachain-example/Cargo.toml
	- name: Cargo check ffi-example
	run: cargo check --manifest-path examples/ffi-example/Cargo.toml

	ffi_example:
	name: Run FFI Example
	runs-on: ubuntu-latest
	needs: [check]
	steps:
	- name: Checkout sources
	uses: actions/checkout@v6

	- name: Use substrate and polkadot node binaries
	uses: ./.github/workflows/actions/use-nodes

	- name: Install Rust stable toolchain
	uses: actions-rs/toolchain@v1
	with:
	profile: minimal
	toolchain: stable
	target: wasm32-unknown-unknown
	override: true

	- name: Rust Cache
	uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1

	- name: Install
	uses: actions/setup-node@v4
	with:
	# Node version 20 and higher seem to cause an issue with the JS example so stick to 19 for now.
	node-version: 19.x

	- name: Cargo check/run ffi-example
	run: \|
	# Start node on port 8000
	substrate-node --dev --rpc-port 8000 > /dev/null 2>&1 &

	# Build the Rust code (hopefully gives long enough for substrate server to start, too):
	cd examples/ffi-example
	cargo build

	# Run the python version of the FFI code:
	echo "Running Python FFI example..."
	python3 src/main.py
	echo "Python FFI example completed with exit code $?"

	# Run the node version of the FFI code
	echo "Installing Node.js dependencies..."
	npm i
	echo "Running Node FFI example..."
	node src/main.js
	echo "Node FFI example completed with exit code $?"

	pkill substrate-node

	wasm_check:
	name: Cargo check (WASM)
	runs-on: ubuntu-latest
	needs: [fmt, machete]
	steps:
	- name: Checkout sources
	uses: actions/checkout@v6

	- name: Install Rust stable toolchain
	uses: actions-rs/toolchain@v1
	with:
	profile: minimal
	toolchain: stable
	target: wasm32-unknown-unknown
	override: true

	- name: Rust Cache
	uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1

	- name: Cargo check web features which require wasm32 target.
	run: \|
	cargo check -p subxt-rpcs --target wasm32-unknown-unknown --no-default-features --features web
	cargo check -p subxt-rpcs --target wasm32-unknown-unknown --no-default-features --features web,reconnecting-rpc-client

	# Check WASM examples, which aren't a part of the workspace and so are otherwise missed:
	- name: Cargo check WASM examples
	run: \|
	cargo check --manifest-path examples/wasm-example/Cargo.toml --target wasm32-unknown-unknown

	docs:
	name: Check documentation and run doc tests
	runs-on: parity-large
	needs: [fmt, machete]
	timeout-minutes: 30
	steps:
	- name: Checkout sources
	uses: actions/checkout@v6

	- name: Use substrate and polkadot node binaries
	uses: ./.github/workflows/actions/use-nodes

	- name: Install Rust stable toolchain
	uses: actions-rs/toolchain@v1
	with:
	profile: minimal
	toolchain: stable
	override: true

	- name: Rust Cache
	uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1

	- name: Check internal documentation links
	run: RUSTDOCFLAGS="--deny rustdoc::broken_intra_doc_links" cargo doc --workspace --no-deps --document-private-items

	- name: Run cargo test on documentation
	run: cargo test --doc --features reconnecting-rpc-client

	basic_tests:
	name: Cargo test
	runs-on: parity-large
	needs: [clippy, wasm_clippy, check, wasm_check, docs]
	timeout-minutes: 45
	steps:
	- name: Checkout sources
	uses: actions/checkout@v6

	- name: Use substrate and polkadot node binaries
	uses: ./.github/workflows/actions/use-nodes

	- name: Install Rust stable toolchain
	uses: actions-rs/toolchain@v1
	with:
	profile: minimal
	toolchain: stable
	override: true

	- name: Run subxt-signer no-std tests
	run: cargo test --manifest-path signer/tests/no-std/Cargo.toml

	- name: Run crate tests
	run: cargo test --workspace --exclude integration-tests

	integration_tests:
	name: "Integration tests"
	runs-on: parity-large
	needs: [clippy, wasm_clippy, check, wasm_check, docs]
	timeout-minutes: 45
	strategy:
	matrix:
	# Test each of these features in our integration tests:
	feature:
	- default
	- reconnecting-rpc
	- legacy-backend
	- chainhead-backend
	steps:
	- name: Checkout sources
	uses: actions/checkout@v6

	- name: Use substrate and polkadot node binaries
	uses: ./.github/workflows/actions/use-nodes

	- name: Install Rust stable toolchain
	uses: actions-rs/toolchain@v1
	with:
	profile: minimal
	toolchain: stable
	override: true

	- name: Run crate tests
	run: cargo test -p integration-tests --features ${{ matrix.feature }}

	wasm_tests:
	name: Test (WASM)
	runs-on: ubuntu-latest
	needs: [clippy, wasm_clippy, check, wasm_check, docs]
	timeout-minutes: 30
	env:
	# Set timeout for wasm tests to be much bigger than the default 20 secs.
	WASM_BINDGEN_TEST_TIMEOUT: 300

	steps:
	- uses: actions/checkout@v6

	- name: Install wasm-pack
	run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf \| sh

	- name: Install firefox
	uses: browser-actions/setup-firefox@latest

	- name: Install chrome
	uses: browser-actions/setup-chrome@latest

	- name: Use substrate and polkadot node binaries
	uses: ./.github/workflows/actions/use-nodes

	- name: Rust Cache
	uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1

	- name: Run subxt WASM tests
	run: \|
	# `listen-addr` is used to configure p2p to accept websocket connections instead of TCP.
	# `node-key` provides a deterministic p2p address.
	substrate-node --dev --node-key 0000000000000000000000000000000000000000000000000000000000000001 --listen-addr /ip4/0.0.0.0/tcp/30333/ws > /dev/null 2>&1 &
	wasm-pack test --headless --firefox
	wasm-pack test --headless --chrome
	pkill substrate-node
	working-directory: testing/wasm-rpc-tests

	- name: Run subxt-signer WASM tests
	run: \|
	wasm-pack test --headless --firefox
	wasm-pack test --headless --chrome
	working-directory: signer/tests/wasm

	flaky_lightclient_wasm_tests:
	name: Flaky lightclient WASM tests
	runs-on: ubuntu-latest
	needs: [clippy, wasm_clippy, check, wasm_check, docs]
	timeout-minutes: 10
	env:
	# Set timeout for wasm tests to be much bigger than the default 20 secs.
	WASM_BINDGEN_TEST_TIMEOUT: 300

	steps:
	- uses: actions/checkout@v6

	- name: Install wasm-pack
	run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf \| sh

	- name: Rust Cache
	uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1

	- name: Run subxt-lightclient WASM tests
	id: test
	working-directory: testing/wasm-lightclient-tests
	run: \|
	# These tests connect to RPC nodes and so don't need a local node running.
	if wasm-pack test --headless --firefox && wasm-pack test --headless --chrome; then
	echo "result=success" >> $GITHUB_OUTPUT
	else
	echo "result=failure" >> $GITHUB_OUTPUT
	fi

	- name: Report flaky test result
	uses: actions/github-script@v7
	with:
	script: \|
	const result = '${{ steps.test.outputs.result }}';
	await github.rest.checks.create({
	owner: context.repo.owner,
	repo: context.repo.repo,
	name: 'Flaky: Lightclient WASM tests',
	head_sha: context.sha,
	conclusion: result === 'success' ? 'success' : 'neutral',
	output: {
	title: result === 'success' ? 'Tests passed' : 'Tests failed (flaky)',
	summary: result === 'success'
	? 'All lightclient WASM tests passed.'
	: 'Lightclient WASM tests failed. These tests are known to be flaky and do not block the PR.'
	}
	});

	flaky_lightclient_integration_tests:
	name: "Flaky lightclient integration tests (${{ matrix.feature }})"
	runs-on: parity-large
	needs: [clippy, wasm_clippy, check, wasm_check, docs]
	timeout-minutes: 10
	strategy:
	matrix:
	# Test each of the backends with the light client.
	feature:
	- default
	- legacy-backend
	- chainhead-backend
	steps:
	- name: Checkout sources
	uses: actions/checkout@v6

	- name: Use substrate and polkadot node binaries
	uses: ./.github/workflows/actions/use-nodes

	- name: Install Rust stable toolchain
	uses: actions-rs/toolchain@v1
	with:
	profile: minimal
	toolchain: stable
	override: true

	- name: Run crate tests
	id: test
	run: \|
	if cargo test -p integration-tests --features light-client-rpc,${{ matrix.feature }}; then
	echo "result=success" >> $GITHUB_OUTPUT
	else
	echo "result=failure" >> $GITHUB_OUTPUT
	fi

	- name: Report flaky test result
	uses: actions/github-script@v7
	with:
	script: \|
	const result = '${{ steps.test.outputs.result }}';
	const feature = '${{ matrix.feature }}';
	await github.rest.checks.create({
	owner: context.repo.owner,
	repo: context.repo.repo,
	name: `Flaky: Lightclient integration tests (${feature})`,
	head_sha: context.sha,
	conclusion: result === 'success' ? 'success' : 'neutral',
	output: {
	title: result === 'success' ? 'Tests passed' : 'Tests failed (flaky)',
	summary: result === 'success'
	? `Lightclient integration tests (${feature}) passed.`
	: `Lightclient integration tests (${feature}) failed. These tests are known to be flaky and do not block the PR.`
	}
	});

	nostd_tests:
	name: "Test (no_std)"
	runs-on: ubuntu-latest
	needs: [machete, docs]
	timeout-minutes: 30
	steps:
	- name: Checkout sources
	uses: actions/checkout@v6

	# Note: needs nighly toolchain because otherwise we cannot define custom lang-items.
	- name: Install Rust nightly toolchain
	uses: actions-rs/toolchain@v1
	with:
	profile: minimal
	toolchain: nightly
	override: true
	target: thumbv7em-none-eabi

	- name: Install the gcc-arm-none-eabi linker
	run: sudo apt install gcc-arm-none-eabi

	- name: Rust Cache
	uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2.8.1

	# Note: We currently do not have a way to run real tests in a `no_std` environment.
	# We can only make sure that they compile to ARM thumb ISA.
	# Running the binary and inspecting the output would require an actual machine with matching ISA or some sort of emulator.
	- name: Compile `no-std-tests` crate to `thumbv7em-none-eabi` target.
	run: cargo build --target thumbv7em-none-eabi
	working-directory: testing/no-std-tests

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update to frame-decode 0.17.1 and update CHANGELOG with frame-decode updates #6357

Workflow file

Update to frame-decode 0.17.1 and update CHANGELOG with frame-decode updates #6357

Uh oh!

Workflow file for this run