Merge pull request #333 from opentensor/fix/propagate-features

fix: feature propagation

.github/workflows/check-rust.yml

@@ -4,7 +4,6 @@ concurrency:
   group: ci-${{ github.ref }}
   cancel-in-progress: true
 
-
 on:
   ## Run automatically for all PRs against main, regardless of what the changes are
   ## to be safe and so we can more easily force re-run the CI when github is being
@@ -270,8 +269,8 @@ jobs:
           cargo clippy -- -D clippy::panic \
                           -D clippy::todo \
                           -D clippy::unimplemented
-# -D clippy::indexing_slicing \
-# -D clippy::unwrap_used \
+  # -D clippy::indexing_slicing \
+  # -D clippy::unwrap_used \
 
   # ensures cargo fix has no trivial changes that can be applied
   cargo-fix:
@@ -331,3 +330,25 @@ jobs:
           else
               echo "No changes detected after running 'cargo fix --workspace' ✅"
           fi
+
+  check-feature-propagation:
+    name: zepter run check
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Install stable Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+
+      - name: Install Zepter
+        run: cargo install --locked -q zepter && zepter --version
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Dont clone historic commits.
+
+      - name: Check features
+        run: zepter run check

node/Cargo.toml

@@ -85,6 +85,10 @@ runtime-benchmarks = [
 	"node-subtensor-runtime/runtime-benchmarks",
 	"frame-benchmarking/runtime-benchmarks",
 	"frame-benchmarking-cli/runtime-benchmarks",
+	"frame-system/runtime-benchmarks",
+	"sc-service/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks",
+	"pallet-commitments/runtime-benchmarks"
 ]
 pow-faucet = []
 
@@ -93,4 +97,8 @@ pow-faucet = []
 try-runtime = [
 	"node-subtensor-runtime/try-runtime",
 	"try-runtime-cli/try-runtime",
+	"frame-system/try-runtime",
+	"pallet-transaction-payment/try-runtime",
+	"sp-runtime/try-runtime",
+	"pallet-commitments/try-runtime"
 ]

pallets/admin-utils/Cargo.toml

@@ -48,6 +48,24 @@ std = [
 	"scale-info/std",
 	"pallet-subtensor/std",
 	"sp-consensus-aura/std",
+	"pallet-balances/std",
+	"sp-runtime/std",
+	"sp-tracing/std",
+	"sp-weights/std",
+	"log/std"
+]
+runtime-benchmarks = [
+	"frame-benchmarking/runtime-benchmarks",
+	"frame-support/runtime-benchmarks",
+	"frame-system/runtime-benchmarks",
+	"pallet-balances/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks",
+	"pallet-subtensor/runtime-benchmarks"
+]
+try-runtime = [
+	"frame-support/try-runtime",
+	"frame-system/try-runtime",
+	"pallet-balances/try-runtime",
+	"sp-runtime/try-runtime",
+	"pallet-subtensor/try-runtime"
 ]
-runtime-benchmarks = ["frame-benchmarking/runtime-benchmarks"]
-try-runtime = ["frame-support/try-runtime"]

pallets/collective/Cargo.toml

@@ -48,4 +48,8 @@ runtime-benchmarks = [
 	"frame-system/runtime-benchmarks",
 	"sp-runtime/runtime-benchmarks",
 ]
-try-runtime = ["frame-support/try-runtime"]
+try-runtime = [
+	"frame-support/try-runtime",
+	"frame-system/try-runtime",
+	"sp-runtime/try-runtime"
+]

pallets/commitments/Cargo.toml

@@ -43,11 +43,19 @@ std = [
 	"frame-system/std",
 	"scale-info/std",
 	"sp-std/std",
+	"sp-runtime/std",
+	"enumflags2/std"
 ]
 runtime-benchmarks = [
 	"frame-benchmarking/runtime-benchmarks",
 	"frame-support/runtime-benchmarks",
 	"frame-system/runtime-benchmarks",
 	"sp-runtime/runtime-benchmarks",
+	"pallet-balances/runtime-benchmarks"
+]
+try-runtime = [
+	"frame-support/try-runtime",
+	"frame-system/try-runtime",
+	"pallet-balances/try-runtime",
+	"sp-runtime/try-runtime"
 ]
-try-runtime = ["frame-support/try-runtime"]

pallets/registry/Cargo.toml

@@ -42,11 +42,17 @@ std = [
 	"frame-system/std",
 	"scale-info/std",
 	"sp-std/std",
+	"sp-runtime/std",
+	"enumflags2/std"
 ]
 runtime-benchmarks = [
 	"frame-benchmarking/runtime-benchmarks",
 	"frame-support/runtime-benchmarks",
 	"frame-system/runtime-benchmarks",
 	"sp-runtime/runtime-benchmarks",
 ]
-try-runtime = ["frame-support/try-runtime"]
+try-runtime = [
+	"frame-support/try-runtime",
+	"frame-system/try-runtime",
+	"sp-runtime/try-runtime"
+]

pallets/subtensor/Cargo.toml

@@ -68,7 +68,41 @@ std = [
 	"scale-info/std",
 	"pallet-collective/std",
 	"pallet-membership/std",
+	"substrate-fixed/std",
+	"pallet-balances/std",
+	"pallet-transaction-payment/std",
+	"pallet-utility/std",
+	"sp-core/std",
+	"sp-io/std",
+	"sp-runtime/std",
+	"sp-std/std",
+	"sp-tracing/std",
+	"sp-version/std",
+	"hex/std",
+	"log/std",
+	"ndarray/std",
+	"serde/std",
+	"serde_bytes/std",
+	"serde_with/std"
+]
+runtime-benchmarks = [
+	"frame-benchmarking/runtime-benchmarks",
+	"frame-support/runtime-benchmarks",
+	"frame-system/runtime-benchmarks",
+	"pallet-balances/runtime-benchmarks",
+	"pallet-membership/runtime-benchmarks",
+	"pallet-utility/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks",
+	"pallet-collective/runtime-benchmarks"
+]
+try-runtime = [
+	"frame-support/try-runtime",
+	"frame-system/try-runtime",
+	"pallet-balances/try-runtime",
+	"pallet-membership/try-runtime",
+	"pallet-transaction-payment/try-runtime",
+	"pallet-utility/try-runtime",
+	"sp-runtime/try-runtime",
+	"pallet-collective/try-runtime"
 ]
-runtime-benchmarks = ["frame-benchmarking/runtime-benchmarks"]
-try-runtime = ["frame-support/try-runtime"]
 pow-faucet = []

pallets/subtensor/rpc/Cargo.toml

@@ -32,5 +32,12 @@ pallet-subtensor = { version = "4.0.0-dev", path = "../../subtensor", default-fe
 
 [features]
 default = ["std"]
-std = ["sp-api/std", "sp-runtime/std", "subtensor-custom-rpc-runtime-api/std"]
+std = [
+	"sp-api/std",
+	"sp-runtime/std",
+	"subtensor-custom-rpc-runtime-api/std",
+	"pallet-subtensor/std",
+	"codec/std",
+	"serde/std"
+]
 pow-faucet = []

pallets/subtensor/runtime-api/Cargo.toml

@@ -18,5 +18,10 @@ pallet-subtensor = { version = "4.0.0-dev", path = "../../subtensor", default-fe
 
 [features]
 default = ["std"]
-std = ["sp-api/std"]
+std = [
+	"sp-api/std",
+	"frame-support/std",
+	"pallet-subtensor/std",
+	"serde/std"
+]
 pow-faucet = []

runtime/Cargo.toml

@@ -129,6 +129,8 @@ std = [
 	"pallet-membership/std",
 	"pallet-registry/std",
 	"pallet-admin-utils/std",
+	"subtensor-custom-rpc-runtime-api/std",
+	"serde_json/std"
 ]
 runtime-benchmarks = [
 	"frame-benchmarking/runtime-benchmarks",
@@ -147,6 +149,10 @@ runtime-benchmarks = [
 	"pallet-registry/runtime-benchmarks",
 	"pallet-commitments/runtime-benchmarks",
 	"pallet-admin-utils/runtime-benchmarks",
+	"pallet-multisig/runtime-benchmarks",
+	"pallet-preimage/runtime-benchmarks",
+	"pallet-scheduler/runtime-benchmarks",
+	"pallet-sudo/runtime-benchmarks"
 ]
 try-runtime = [
 	"frame-try-runtime/try-runtime",
@@ -168,4 +174,8 @@ try-runtime = [
 	"pallet-multisig/try-runtime",
 	"pallet-scheduler/try-runtime",
 	"pallet-preimage/try-runtime",
+	"sp-runtime/try-runtime",
+	"pallet-admin-utils/try-runtime",
+	"pallet-commitments/try-runtime",
+	"pallet-registry/try-runtime"
 ]

zepter.yaml

@@ -0,0 +1,40 @@
+version:
+  format: 1
+  # Minimum version of the binary that is expected to work. This is just for printing a nice error
+  # message when someone tries to use an older version.
+  binary: 0.13.2
+
+# The examples in this file assume crate `A` to have a dependency on crate `B`.
+workflows:
+  check:
+    - [
+        "lint",
+        # Check that `A` activates the features of `B`.
+        "propagate-feature",
+        # These are the features to check:
+        "--features=try-runtime,runtime-benchmarks,std",
+        # Do not try to add a new section into `[features]` of `A` only because `B` expose that feature. There are edge-cases where this is still needed, but we can add them manually.
+        "--left-side-feature-missing=ignore",
+        # Ignore the case that `A` it outside of the workspace. Otherwise it will report errors in external dependencies that we have no influence on.
+        "--left-side-outside-workspace=ignore",
+        # Some features imply that they activate a specific dependency as non-optional. Otherwise the default behaviour with a `?` is used.
+        "--feature-enables-dep=try-runtime:frame-try-runtime,runtime-benchmarks:frame-benchmarking",
+        # Auxillary flags:
+        "--offline",
+        "--locked",
+        "--show-path",
+        "--quiet",
+      ]
+  # Same as `check`, but with the `--fix` flag.
+  default:
+    - [$check.0, "--fix"]
+
+# Will be displayed when any workflow fails:
+help:
+  text: |
+    Polkadot-SDK uses the Zepter CLI to detect abnormalities in the feature configuration.
+    It looks like one more more checks failed; please check the console output. You can try to automatically address them by running `zepter`.
+    Otherwise please ask directly in the Merge Request, GitHub Discussions or on Matrix Chat, thank you.
+  links:
+    - "https://github.com/paritytech/polkadot-sdk/issues/1831"
+    - "https://github.com/ggwpez/zepter"