chore: remove script tech debt (#22333)

Author: bmwill

crates/sui-open-rpc/spec/openrpc.json

@@ -1321,6 +1321,7 @@
                 "disallow_adding_abilities_on_upgrade": false,
                 "disallow_change_struct_type_params_on_upgrade": false,
                 "disallow_new_modules_in_deps_only_packages": false,
+                "disallow_self_identifier": false,
                 "enable_coin_deny_list": false,
                 "enable_coin_deny_list_v2": false,
                 "enable_effects_v2": false,

crates/sui-protocol-config/src/lib.rs

@@ -612,6 +612,10 @@ struct FeatureFlags {
     #[serde(skip_serializing_if = "is_false")]
     validate_identifier_inputs: bool,
 
+    // Disallow self identifier
+    #[serde(skip_serializing_if = "is_false")]
+    disallow_self_identifier: bool,
+
     // Enables Mysticeti fastpath.
     #[serde(skip_serializing_if = "is_false")]
     mysticeti_fastpath: bool,
@@ -3679,6 +3683,7 @@ impl ProtocolConfig {
 
                     cfg.feature_flags
                         .record_consensus_determined_version_assignments_in_prologue_v2 = true;
+                    cfg.feature_flags.disallow_self_identifier = true;
                 }
                 // Use this template when making changes:
                 //
@@ -3729,6 +3734,7 @@ impl ProtocolConfig {
             max_back_edges_per_module,
             max_basic_blocks_in_script: None,
             max_idenfitier_len: self.max_move_identifier_len_as_option(), // Before protocol version 9, there was no limit
+            disallow_self_identifier: self.feature_flags.disallow_self_identifier,
             allow_receiving_object_id: self.allow_receiving_object_id(),
             reject_mutable_random_on_entry_functions: self
                 .reject_mutable_random_on_entry_functions(),

crates/sui-protocol-config/src/snapshots/sui_protocol_config__test__Mainnet_version_85.snap

@@ -73,6 +73,7 @@ feature_flags:
   consensus_distributed_vote_scoring_strategy: true
   consensus_round_prober: true
   validate_identifier_inputs: true
+  disallow_self_identifier: true
   relocate_event_module: true
   uncompressed_g1_group_elements: true
   disallow_new_modules_in_deps_only_packages: true

crates/sui-protocol-config/src/snapshots/sui_protocol_config__test__Testnet_version_85.snap

@@ -75,6 +75,7 @@ feature_flags:
   consensus_distributed_vote_scoring_strategy: true
   consensus_round_prober: true
   validate_identifier_inputs: true
+  disallow_self_identifier: true
   relocate_event_module: true
   uncompressed_g1_group_elements: true
   disallow_new_modules_in_deps_only_packages: true

crates/sui-protocol-config/src/snapshots/sui_protocol_config__test__version_85.snap

@@ -79,6 +79,7 @@ feature_flags:
   consensus_distributed_vote_scoring_strategy: true
   consensus_round_prober: true
   validate_identifier_inputs: true
+  disallow_self_identifier: true
   mysticeti_fastpath: true
   relocate_event_module: true
   uncompressed_g1_group_elements: true

crates/sui-types/src/transaction.rs

@@ -152,13 +152,13 @@ fn type_input_validity_check(
                 let next_depth = depth + 1;
                 if config.validate_identifier_inputs() {
                     fp_ensure!(
-                        identifier::is_valid(&s.module),
+                        identifier::is_valid(&s.module) && s.module != "<SELF>",
                         UserInputError::InvalidIdentifier {
                             error: s.module.clone()
                         }
                     );
                     fp_ensure!(
-                        identifier::is_valid(&s.name),
+                        identifier::is_valid(&s.name) && s.name != "<SELF>",
                         UserInputError::InvalidIdentifier {
                             error: s.name.clone()
                         }

external-crates/move/crates/bytecode-verifier-tests/src/unit_tests/mod.rs

@@ -48,6 +48,7 @@ pub(crate) fn production_config() -> (VerifierConfig, MeterConfig) {
 
             max_constant_vector_len: Some(DEFAULT_MAX_CONSTANT_VECTOR_LEN),
             max_idenfitier_len: Some(DEFAULT_MAX_IDENTIFIER_LENGTH),
+            disallow_self_identifier: true,
             allow_receiving_object_id: true,
             reject_mutable_random_on_entry_functions: true,
             bytecode_version: VERSION_MAX,

external-crates/move/crates/move-binary-format/src/file_format.rs

@@ -42,7 +42,6 @@ use move_core_types::{
 };
 #[cfg(any(test, feature = "fuzzing"))]
 use proptest::{collection::vec, prelude::*, strategy::BoxedStrategy};
-use ref_cast::RefCast;
 use serde::{Deserialize, Serialize};
 use std::fmt::{Display, Formatter};
 use std::ops::BitOr;
@@ -246,12 +245,6 @@ pub type TypeSignaturePool = Vec<TypeSignature>;
 /// locals used and their types.
 pub type SignaturePool = Vec<Signature>;
 
-// TODO: "<SELF>" only passes the validator for identifiers because it is special cased. Whenever
-// "<SELF>" is removed, so should the special case in identifier.rs.
-pub fn self_module_name() -> &'static IdentStr {
-    IdentStr::ref_cast("<SELF>")
-}
-
 /// Index 0 into the LocalsSignaturePool, which is guaranteed to be an empty list.
 /// Used to represent function/struct instantiation with no type arguments -- effectively
 /// non-generic functions and structs.
@@ -2835,7 +2828,7 @@ pub fn empty_module() -> CompiledModule {
             name: IdentifierIndex(0),
         }],
         self_module_handle_idx: ModuleHandleIndex(0),
-        identifiers: vec![self_module_name().to_owned()],
+        identifiers: vec![move_core_types::ident_str!("DUMMY").to_owned()],
         address_identifiers: vec![AccountAddress::ZERO],
         constant_pool: vec![],
         metadata: vec![],

external-crates/move/crates/move-bytecode-verifier/src/limits.rs

@@ -207,17 +207,27 @@ impl<'a> LimitsVerifier<'a> {
 
     /// Verifies the lengths of all identifers are valid
     fn verify_identifiers(&self, config: &VerifierConfig) -> PartialVMResult<()> {
-        if let Some(max_idenfitier_len) = config.max_idenfitier_len {
-            for (idx, identifier) in self.module.identifiers().iter().enumerate() {
-                if identifier.len() > (max_idenfitier_len as usize) {
-                    return Err(verification_error(
-                        StatusCode::IDENTIFIER_TOO_LONG,
-                        IndexKind::Identifier,
-                        idx as TableIndex,
-                    ));
-                }
+        for (idx, identifier) in self.module.identifiers().iter().enumerate() {
+            if config
+                .max_idenfitier_len
+                .is_some_and(|max_identifier_len| identifier.len() > (max_identifier_len as usize))
+            {
+                return Err(verification_error(
+                    StatusCode::IDENTIFIER_TOO_LONG,
+                    IndexKind::Identifier,
+                    idx as TableIndex,
+                ));
+            }
+
+            if config.disallow_self_identifier && identifier.as_str() == "<SELF>" {
+                return Err(verification_error(
+                    StatusCode::INVALID_IDENTIFIER,
+                    IndexKind::Identifier,
+                    idx as TableIndex,
+                ));
             }
         }
+
         Ok(())
     }
 }

external-crates/move/crates/move-core-types/src/vm_status.rs

@@ -314,6 +314,8 @@ pub enum StatusCode {
     ZERO_SIZED_ENUM = 1134,
     MAX_VARIANTS_REACHED = 1135,
 
+    INVALID_IDENTIFIER = 1136,
+
     // These are errors that the VM might raise if a violation of internal
     // invariants takes place.
     // Invariant Violation Errors: 2000-2999

external-crates/move/crates/move-model/src/builder/module_builder.rs

@@ -22,7 +22,7 @@ use crate::{
     },
     model::{
         DatatypeId, EnumData, FunId, FunctionData, Loc, ModuleId, NamedConstantData,
-        NamedConstantId, SCRIPT_BYTECODE_FUN_NAME, StructData,
+        NamedConstantId, StructData,
     },
     project_1st,
     symbol::{Symbol, SymbolPool},
@@ -485,16 +485,7 @@ impl ModuleBuilder<'_, '_> {
                 let handle_idx = module.function_def_at(def_idx).function;
                 let handle = module.function_handle_at(handle_idx);
                 let name_str = module.identifier_at(handle.name).as_str();
-                let name = if name_str == SCRIPT_BYTECODE_FUN_NAME {
-                    // This is a pseudo script module, which has exactly one function. Determine
-                    // the name of this function.
-                    self.parent.fun_table.iter().find_map(|(k, _)| {
-                        if k.module_name == self.module_name
-                        { Some(k.symbol) } else { None }
-                    }).expect("unexpected script with multiple or no functions")
-                } else {
-                    self.symbol_pool().make(name_str)
-                };
+                let name = self.symbol_pool().make(name_str);
                 if let Some(entry) = self.parent.fun_table.get(&self.qualified_by_module(name)) {
                     let arg_names = project_1st(&entry.params);
                     let type_arg_names = project_1st(&entry.type_params);

external-crates/move/crates/move-model/src/model.rs

@@ -65,12 +65,6 @@ use crate::{
 // =================================================================================================
 // # Constants
 
-/// A name we use to represent a script as a module.
-pub const SCRIPT_MODULE_NAME: &str = "<SELF>";
-
-/// Names used in the bytecode/AST to represent the main function of a script
-pub const SCRIPT_BYTECODE_FUN_NAME: &str = "<SELF>";
-
 /// A prefix used for structs which are backing specification ("ghost") memory.
 pub const GHOST_MEMORY_PREFIX: &str = "Ghost$";
 
@@ -865,17 +859,7 @@ impl GlobalEnv {
         function_data: BTreeMap<FunId, FunctionData>,
     ) {
         let idx = self.module_data.len();
-        let effective_name = if module.self_id().name().as_str() == SCRIPT_MODULE_NAME {
-            // Use the name of the first function in this module.
-            function_data
-                .iter()
-                .next()
-                .expect("functions in script")
-                .1
-                .name
-        } else {
-            self.symbol_pool.make(module.self_id().name().as_str())
-        };
+        let effective_name = self.symbol_pool.make(module.self_id().name().as_str());
         let name = ModuleName::from_str(&module.self_id().address().to_string(), effective_name);
         let struct_idx_to_id: BTreeMap<StructDefinitionIndex, DatatypeId> = struct_data
             .iter()

external-crates/move/crates/move-vm-config/src/verifier.rs

@@ -25,6 +25,7 @@ pub struct VerifierConfig {
     pub max_back_edges_per_module: Option<usize>,
     pub max_basic_blocks_in_script: Option<usize>,
     pub max_idenfitier_len: Option<u64>,
+    pub disallow_self_identifier: bool,
     pub allow_receiving_object_id: bool,
     pub reject_mutable_random_on_entry_functions: bool,
     pub bytecode_version: u32,
@@ -69,6 +70,7 @@ impl Default for VerifierConfig {
             max_basic_blocks_in_script: None,
             max_constant_vector_len: Some(DEFAULT_MAX_CONSTANT_VECTOR_LEN),
             max_idenfitier_len: Some(DEFAULT_MAX_IDENTIFIER_LENGTH),
+            disallow_self_identifier: false,
             allow_receiving_object_id: true,
             reject_mutable_random_on_entry_functions: true,
             bytecode_version: VERSION_MAX,

external-crates/move/move-execution/v0/crates/bytecode-verifier-tests/src/unit_tests/mod.rs

@@ -48,6 +48,7 @@ pub(crate) fn production_config() -> (VerifierConfig, MeterConfig) {
 
             max_constant_vector_len: Some(DEFAULT_MAX_CONSTANT_VECTOR_LEN),
             max_idenfitier_len: Some(DEFAULT_MAX_IDENTIFIER_LENGTH),
+            disallow_self_identifier: true,
             allow_receiving_object_id: true,
             reject_mutable_random_on_entry_functions: true,
             bytecode_version: VERSION_6,

external-crates/move/move-execution/v1/crates/bytecode-verifier-tests/src/unit_tests/mod.rs

@@ -48,6 +48,7 @@ pub(crate) fn production_config() -> (VerifierConfig, MeterConfig) {
 
             max_constant_vector_len: Some(DEFAULT_MAX_CONSTANT_VECTOR_LEN),
             max_idenfitier_len: Some(DEFAULT_MAX_IDENTIFIER_LENGTH),
+            disallow_self_identifier: true,
             allow_receiving_object_id: true,
             reject_mutable_random_on_entry_functions: true,
             bytecode_version: VERSION_6,

external-crates/move/move-execution/v2/crates/bytecode-verifier-tests/src/unit_tests/mod.rs

@@ -48,6 +48,7 @@ pub(crate) fn production_config() -> (VerifierConfig, MeterConfig) {
 
             max_constant_vector_len: Some(DEFAULT_MAX_CONSTANT_VECTOR_LEN),
             max_idenfitier_len: Some(DEFAULT_MAX_IDENTIFIER_LENGTH),
+            disallow_self_identifier: true,
             allow_receiving_object_id: true,
             reject_mutable_random_on_entry_functions: true,
             bytecode_version: VERSION_6,