[framework] Add native function to check protocol feature flags in Move

Adds sui::protocol_config::is_feature_enabled() to allow Move code to query
protocol feature flags at runtime. This enables conditional logic and fallbacks
based on protocol version capabilities.

Author: lxfind

crates/sui-framework/docs/sui/protocol_config.md

@@ -0,0 +1,82 @@
+---
+title: Module `sui::protocol_config`
+---
+
+This module provides access to protocol configuration feature flags.
+Feature flags control the availability of various protocol features and
+are enabled/disabled at specific protocol versions during epoch changes.
+
+
+-  [Function `is_feature_enabled`](#sui_protocol_config_is_feature_enabled)
+    -  [Arguments](#@Arguments_0)
+    -  [Returns](#@Returns_1)
+    -  [Aborts](#@Aborts_2)
+    -  [Example (for framework use only)](#@Example_(for_framework_use_only)_3)
+
+
+<pre><code></code></pre>
+
+
+
+<a name="sui_protocol_config_is_feature_enabled"></a>
+
+## Function `is_feature_enabled`
+
+Checks if a specific protocol feature flag is enabled.
+
+Restricted to internal use within the sui-framework package only.
+If we need to use it in sui-system, we can add friend declarations.
+We should never need to expose this to user packages.
+
+
+<a name="@Arguments_0"></a>
+
+### Arguments
+
+* <code>feature_flag_name</code> - The name of the feature flag as bytes (e.g., b"enable_vdf")
+
+
+<a name="@Returns_1"></a>
+
+### Returns
+
+* <code><b>true</b></code> if the feature is enabled in the current protocol version
+* <code><b>false</b></code> if the feature is disabled
+
+
+<a name="@Aborts_2"></a>
+
+### Aborts
+
+* Error code 0: Feature flag name not found
+* Error code 1: Invalid feature flag name (not valid UTF-8)
+
+
+<a name="@Example_(for_framework_use_only)_3"></a>
+
+### Example (for framework use only)
+
+```move
+use sui::protocol_config;
+
+if (protocol_config::is_feature_enabled(b"enable_accumulators")) {
+// Accumulators are available
+};
+```
+
+
+<pre><code><b>public</b>(<a href="../sui/package.md#sui_package">package</a>) <b>fun</b> <a href="../sui/protocol_config.md#sui_protocol_config_is_feature_enabled">is_feature_enabled</a>(feature_flag_name: vector&lt;u8&gt;): bool
+</code></pre>
+
+
+
+<details>
+<summary>Implementation</summary>
+
+
+<pre><code><b>public</b>(<a href="../sui/package.md#sui_package">package</a>) <b>native</b> <b>fun</b> <a href="../sui/protocol_config.md#sui_protocol_config_is_feature_enabled">is_feature_enabled</a>(feature_flag_name: vector&lt;u8&gt;): bool;
+</code></pre>
+
+
+
+</details>

crates/sui-framework/packages/sui-framework/sources/protocol_config.move

@@ -0,0 +1,35 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+/// This module provides access to protocol configuration feature flags.
+/// Feature flags control the availability of various protocol features and
+/// are enabled/disabled at specific protocol versions during epoch changes.
+
+module sui::protocol_config;
+
+/// Checks if a specific protocol feature flag is enabled.
+///
+/// Restricted to internal use within the sui-framework package only.
+/// If we need to use it in sui-system, we can add friend declarations.
+/// We should never need to expose this to user packages.
+///
+/// # Arguments
+/// * `feature_flag_name` - The name of the feature flag as bytes (e.g., b"enable_vdf")
+///
+/// # Returns
+/// * `true` if the feature is enabled in the current protocol version
+/// * `false` if the feature is disabled
+///
+/// # Aborts
+/// * Error code 0: Feature flag name not found
+/// * Error code 1: Invalid feature flag name (not valid UTF-8)
+///
+/// # Example (for framework use only)
+/// ```move
+/// use sui::protocol_config;
+///
+/// if (protocol_config::is_feature_enabled(b"enable_accumulators")) {
+///     // Accumulators are available
+/// };
+/// ```
+public(package) native fun is_feature_enabled(feature_flag_name: vector<u8>): bool;

crates/sui-framework/packages/sui-framework/tests/protocol_config_tests.move

@@ -0,0 +1,33 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+#[test_only]
+module sui::protocol_config_tests;
+
+use sui::protocol_config;
+
+#[test]
+fun test_is_feature_enabled_true() {
+    let is_enabled = protocol_config::is_feature_enabled(b"advance_epoch_start_time_in_safe_mode");
+    assert!(is_enabled, 1);
+}
+
+#[test]
+fun test_is_feature_enabled_false() {
+    let is_enabled = protocol_config::is_feature_enabled(b"per_command_shared_object_transfer_rules");
+    assert!(!is_enabled, 1);
+}
+
+#[test]
+#[expected_failure(abort_code = 0)]
+fun test_is_feature_enabled_invalid_flag() {
+    protocol_config::is_feature_enabled(b"nonexistent_feature_flag_xyz");
+}
+
+#[test]
+#[expected_failure(abort_code = 1)]
+fun test_is_feature_enabled_invalid_utf8() {
+    // Invalid UTF-8 sequence: 0xFF is not valid UTF-8
+    let invalid_utf8 = vector[0xFF, 0xFE, 0xFD];
+    protocol_config::is_feature_enabled(invalid_utf8);
+}

crates/sui-framework/packages_compiled/sui-framework

@@ -1105,6 +1105,9 @@ ecvrf_verify
 ed25519_verify
 	public fun
 	0x2::ed25519
+is_feature_enabled
+	public(package) fun
+	0x2::protocol_config
 hash_to_input
 	public fun
 	0x2::vdf

crates/sui-framework/published_api.txt

@@ -240,56 +240,56 @@ validators:
         next_epoch_worker_address: ~
         extra_fields:
           id:
-            id: "0x41bab75a4999f01b96b0e9fb86616407b1646162329127308bfb83e0bbaf2269"
+            id: "0xe586b6abfde382b212d7bb0d78d45b70562bdb8f1883071f64fc577e716f7214"
           size: 0
       voting_power: 10000
-      operation_cap_id: "0xd6f39968901e8a440fe11b4fa7626052c331ee64c54a099b469d6d8250bd826e"
+      operation_cap_id: "0x139deaadf4e4bf4769d853331effb400aaec7e5b2818d976f7615226a2cc308d"
       gas_price: 1000
       staking_pool:
-        id: "0x5926424fffede15fe80ebfa20ed336c74c98aa9f2ce28f6662530a0c0fd9c02f"
+        id: "0xe79577e79af111ccdb76458829a10c0e0387f96dfc6c323782b9afb92eb20d1a"
         activation_epoch: 0
         deactivation_epoch: ~
         sui_balance: 20000000000000000
         rewards_pool:
           value: 0
         pool_token_balance: 20000000000000000
         exchange_rates:
-          id: "0x8e2de2713792615d0245ec30a7784eb0d271dab1a3eb8c0a92829c73fcf6e611"
+          id: "0x6da1faacc8677779acc23963231521e5f99045d67b4ee430f6539d99575f0870"
           size: 1
         pending_stake: 0
         pending_total_sui_withdraw: 0
         pending_pool_token_withdraw: 0
         extra_fields:
           id:
-            id: "0xf05055bdd05ab954963fababc162bfe50164423a3b09cb0b0ad85fcaed9920a2"
+            id: "0x0d2e2085eb00b1c59760cbe145dbca6cb8f11b227c3c515b1e1230e8823e633c"
           size: 0
       commission_rate: 200
       next_epoch_stake: 20000000000000000
       next_epoch_gas_price: 1000
       next_epoch_commission_rate: 200
       extra_fields:
         id:
-          id: "0x6ee5e1b2fd2fc0b9bc90f85df23b81247131efd1300c1ff31f7cddfe088c5c2d"
+          id: "0x9e054c847b1ddb131176bc330fb9b281e8f63dcbaa761ea5abcd95f1f1a239b0"
         size: 0
   pending_active_validators:
     contents:
-      id: "0xfc993d4f6b2c43a15c50d27265b3fbe102f98f3e880096fda2651249d7cfc28c"
+      id: "0x353861467da8403c047e00ae3ebbe1a5150915dfb053dc719bd2add26bd44037"
       size: 0
   pending_removals: []
   staking_pool_mappings:
-    id: "0x6b11d537051c1260bb91f25479ebbe52a57e30f2a4f9d17d77e76c9b96693cc9"
+    id: "0x3c358cd059540d76fe26eb1cfc029dfd18ef4999e38734ccf569c98bd057e9d5"
     size: 1
   inactive_validators:
-    id: "0xf672cf94515c0e99a207ccab019d5e7cd78310fe10a2bd6bca524c5fe69c5849"
+    id: "0x1607c6d0db9e1df642ad5dd79da6eda562569567f8a52dab4252908ae24dc9df"
     size: 0
   validator_candidates:
-    id: "0x87d2ae9a8cf6642d06d1b9943f6179c2dd06cc3b58da17a7d14c593edeb07f1d"
+    id: "0xf1f99fcb0baa4a75ebff512b15626af3aed3cbefd9af96e23246babd02987b41"
     size: 0
   at_risk_validators:
     contents: []
   extra_fields:
     id:
-      id: "0x8e7dfbedf7295c65affc16a595cf3d7c518f789e5b53f79d6114e4d17cf0ff7c"
+      id: "0xe1d775c17b894320dc362d0d7b0a944bce81b0b2a1e2101af60998296088c276"
     size: 0
 storage_fund:
   total_object_storage_rebates:
@@ -306,7 +306,7 @@ parameters:
   validator_low_stake_grace_period: 7
   extra_fields:
     id:
-      id: "0x293b3b5f09e713d5c5ee4b243cbd25e9a7e96010760ea54399f7a602684deacf"
+      id: "0xcb4dc2489fade60fe357ebcf45cd42fddb2c89f96d2ca2c7fbbd2f118e40ad8e"
     size: 0
 reference_gas_price: 1000
 validator_report_records:
@@ -320,7 +320,7 @@ stake_subsidy:
   stake_subsidy_decrease_rate: 1000
   extra_fields:
     id:
-      id: "0x536eae7cd37967730e534a0e3a14e24b4cab4e01d4739061c4dd1d72588e4c5d"
+      id: "0x57d6b0759dce2c8cd55dcad9409cde4b987eb74af99bbbf6a8286b1df5fad43c"
     size: 0
 safe_mode: false
 safe_mode_storage_rewards:
@@ -332,5 +332,5 @@ safe_mode_non_refundable_storage_fee: 0
 epoch_start_timestamp_ms: 10
 extra_fields:
   id:
-    id: "0x2bcf2f212c4f178fc6972629ebfdb650235a65581b362982faa159a27b07e4c3"
+    id: "0xc9dbad8a26614a903a8ae92f5fbb6c37d8e5d653c44edd2f8109e8b4afdc39cc"
   size: 0

crates/sui-swarm-config/tests/snapshots/snapshot_tests__populated_genesis_snapshot_matches-2.snap

@@ -82,6 +82,7 @@ pub mod event;
 mod funds_accumulator;
 mod object;
 pub mod object_runtime;
+mod protocol_config;
 mod random;
 pub mod test_scenario;
 mod test_utils;
@@ -1245,6 +1246,11 @@ pub fn all_natives(silent: bool, protocol_config: &ProtocolConfig) -> NativeFunc
             "poseidon_bn254_internal",
             make_native!(poseidon::poseidon_bn254_internal),
         ),
+        (
+            "protocol_config",
+            "is_feature_enabled",
+            make_native!(protocol_config::is_feature_enabled),
+        ),
         (
             "vdf",
             "vdf_verify_internal",

sui-execution/latest/sui-move-natives/src/lib.rs

@@ -0,0 +1,73 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+use crate::get_extension;
+use crate::object_runtime::ObjectRuntime;
+use move_binary_format::errors::PartialVMResult;
+use move_vm_runtime::native_functions::NativeContext;
+use move_vm_types::{
+    loaded_data::runtime_types::Type,
+    natives::function::NativeResult,
+    pop_arg,
+    values::{Value, VectorRef},
+};
+use smallvec::smallvec;
+use std::collections::VecDeque;
+
+pub const FEATURE_FLAG_NOT_FOUND_ERROR: u64 = 0;
+pub const INVALID_FEATURE_FLAG_NAME_ERROR: u64 = 1;
+
+/***************************************************************************************************
+ * native fun is_feature_enabled
+ *
+ * Implementation of the Move native function `protocol_config::is_feature_enabled(
+ *      feature_flag_name: vector<u8>): bool`
+ *
+ * Checks if a protocol feature flag is enabled in the current protocol version.
+ * Takes raw bytes for simplicity since this is internal framework use only.
+ *
+ * Gas cost: 0 (zero cost for framework-internal use)
+ **************************************************************************************************/
+pub fn is_feature_enabled(
+    context: &mut NativeContext,
+    ty_args: Vec<Type>,
+    mut args: VecDeque<Value>,
+) -> PartialVMResult<NativeResult> {
+    debug_assert!(ty_args.is_empty());
+    debug_assert!(args.len() == 1);
+
+    // Get the bytes directly - Move passes raw vector<u8>
+    let feature_flag_name_bytes = pop_arg!(args, VectorRef);
+    let bytes = feature_flag_name_bytes.as_bytes_ref();
+
+    // Validate that the feature flag name is valid UTF-8
+    let feature_flag_name = match String::from_utf8(bytes.to_vec()) {
+        Ok(s) => s,
+        Err(_) => {
+            // Invalid UTF-8 in feature flag name - abort with error
+            return Ok(NativeResult::err(
+                context.gas_used(),
+                INVALID_FEATURE_FLAG_NAME_ERROR,
+            ));
+        }
+    };
+
+    let protocol_config = &get_extension!(context, ObjectRuntime)?.protocol_config;
+
+    // Use the auto-generated lookup_feature method to find the feature flag
+    let is_enabled = match protocol_config.lookup_feature(feature_flag_name) {
+        Some(value) => value,
+        None => {
+            // Feature flag not found - abort with error
+            return Ok(NativeResult::err(
+                context.gas_used(),
+                FEATURE_FLAG_NOT_FOUND_ERROR,
+            ));
+        }
+    };
+
+    Ok(NativeResult::ok(
+        context.gas_used(),
+        smallvec![Value::bool(is_enabled)],
+    ))
+}