Introduce experimental ABI type aliases option.

Author: tritao

docs/book/src/reference/experimental_features.md

@@ -82,3 +82,9 @@ fn conditionally_compiled() {
     log("This is compiled only if both `some_feature` and `some_other_feature` are enabled.");
 }
 ```
+
+## Tracking Experimental Features
+
+- `abi_type_aliases` — keeps the JSON ABI emitter from expanding type aliases into their target type when serializing a contract's ABI, allowing the published JSON to preserve the original alias names.
+
+See the tracking issue for this feature at https://github.com/FuelLabs/sway/issues/7486.

forc-pkg/src/pkg.rs

@@ -1814,6 +1814,7 @@ pub fn compile(
                         metadata_declaration_cache: HashMap::new(),
                         concrete_declaration_cache: HashMap::new(),
                         type_cache_enabled: false,
+                        experimental,
                     },
                     engines,
                     if experimental.new_encoding {

sway-core/src/abi_generation/abi_str.rs

@@ -11,6 +11,7 @@ pub struct AbiStrContext {
     pub abi_with_callpaths: bool,
     pub abi_with_fully_specified_types: bool,
     pub abi_root_type_without_generic_type_parameters: bool,
+    pub abi_type_aliases: bool,
 }
 
 impl TypeId {
@@ -26,7 +27,7 @@ impl TypeId {
         let self_abi_str = type_engine
             .get(*self)
             .abi_str(handler, ctx, engines, true)?;
-        if self.is_generic_parameter(engines, resolved_type_id) {
+        if self.is_generic_parameter(engines, resolved_type_id, ctx.abi_type_aliases) {
             Ok(format!("generic {self_abi_str}"))
         } else {
             match (

sway-core/src/abi_generation/evm_abi.rs

@@ -25,7 +25,7 @@ pub fn generate_abi_program(program: &TyProgram, engines: &Engines) -> EvmAbiRes
 /// Gives back a string that represents the type, considering what it resolves to
 fn get_type_str(type_id: &TypeId, engines: &Engines, resolved_type_id: TypeId) -> String {
     let type_engine = engines.te();
-    if type_id.is_generic_parameter(engines, resolved_type_id) {
+    if type_id.is_generic_parameter(engines, resolved_type_id, false) {
         format!("generic {}", abi_str(&type_engine.get(*type_id), engines))
     } else {
         match (

sway-core/src/abi_generation/fuel_abi.rs

@@ -23,6 +23,7 @@ use crate::{
 };
 
 use super::abi_str::AbiStrContext;
+use sway_features::ExperimentalFeatures;
 
 #[derive(Clone, Debug)]
 pub enum AbiNameDiagnosticSpan {
@@ -48,6 +49,7 @@ pub struct AbiContext<'a> {
     pub metadata_declaration_cache: HashMap<TypeCacheKey, program_abi::TypeMetadataDeclaration>,
     pub concrete_declaration_cache: HashMap<TypeCacheKey, program_abi::TypeConcreteDeclaration>,
     pub type_cache_enabled: bool,
+    pub experimental: ExperimentalFeatures,
 }
 
 impl AbiContext<'_> {
@@ -57,6 +59,7 @@ impl AbiContext<'_> {
             abi_with_callpaths: self.abi_with_callpaths,
             abi_with_fully_specified_types: false,
             abi_root_type_without_generic_type_parameters: true,
+            abi_type_aliases: self.experimental.abi_type_aliases,
         }
     }
 }
@@ -163,6 +166,7 @@ impl TypeId {
             abi_with_callpaths: true,
             abi_with_fully_specified_types: true,
             abi_root_type_without_generic_type_parameters: false,
+            abi_type_aliases: ctx.experimental.abi_type_aliases,
         };
         let type_str = self.get_abi_type_str(handler, &display_ctx, engines, resolved_type_id)?;
 
@@ -908,7 +912,11 @@ impl TypeId {
         resolved_type_id: TypeId,
         metadata_types_to_add: &mut Vec<program_abi::TypeMetadataDeclaration>,
     ) -> Result<Option<Vec<MetadataTypeId>>, ErrorEmitted> {
-        match self.is_generic_parameter(engines, resolved_type_id) {
+        match self.is_generic_parameter(
+            engines,
+            resolved_type_id,
+            ctx.experimental.abi_type_aliases,
+        ) {
             true => Ok(None),
             false => resolved_type_id
                 .get_type_parameters(engines)
@@ -1247,7 +1255,11 @@ impl TypeId {
                 }
             }
             TypeInfo::Custom { type_arguments, .. } => {
-                if !self.is_generic_parameter(engines, resolved_type_id) {
+                if !self.is_generic_parameter(
+                    engines,
+                    resolved_type_id,
+                    ctx.experimental.abi_type_aliases,
+                ) {
                     for (v, p) in type_arguments.clone().unwrap_or_default().iter().zip(
                         resolved_type_id
                             .get_type_parameters(engines)

sway-core/src/language/ty/expression/expression.rs

@@ -384,6 +384,7 @@ impl CollectTypesMetadata for TyExpression {
                     ctx.engines,
                     logged_type_id,
                     ctx.program_name.clone(),
+                    ctx.experimental.abi_type_aliases,
                 )?);
 
                 // We still need to dive into the expression because it can have additional types to collect.

sway-core/src/language/ty/expression/intrinsic_function.rs

@@ -96,6 +96,7 @@ impl CollectTypesMetadata for TyIntrinsicFunctionKind {
                     ctx.engines,
                     logged_type_id,
                     ctx.program_name.clone(),
+                    ctx.experimental.abi_type_aliases,
                 )?;
                 types_metadata.push(logged_type);
             }

sway-core/src/type_system/id.rs

@@ -266,7 +266,12 @@ impl TypeId {
     /// Indicates of a given type is generic or not. Rely on whether the type is `Custom` and
     /// consider the special case where the resolved type is a struct or enum with a name that
     /// matches the name of the `Custom`.
-    pub(crate) fn is_generic_parameter(self, engines: &Engines, resolved_type_id: TypeId) -> bool {
+    pub(crate) fn is_generic_parameter(
+        self,
+        engines: &Engines,
+        resolved_type_id: TypeId,
+        abi_type_aliases_enabled: bool,
+    ) -> bool {
         let type_engine = engines.te();
         let decl_engine = engines.de();
         match (&*type_engine.get(self), &*type_engine.get(resolved_type_id)) {

sway-core/src/types/collect_types_metadata.rs

@@ -128,6 +128,7 @@ impl TypeMetadata {
         engines: &Engines,
         type_id: TypeId,
         program_name: String,
+        abi_type_aliases_enabled: bool,
     ) -> Result<Self, ErrorEmitted> {
         Ok(TypeMetadata::LoggedType(
             LogId::new(type_id.get_abi_type_str(
@@ -137,6 +138,7 @@ impl TypeMetadata {
                     abi_with_callpaths: true,
                     abi_with_fully_specified_types: true,
                     abi_root_type_without_generic_type_parameters: false,
+                    abi_type_aliases: abi_type_aliases_enabled,
                 },
                 engines,
                 type_id,

sway-features/src/lib.rs

@@ -173,6 +173,8 @@ features! {
     "https://github.com/FuelLabs/sway/issues/6860",
     new_hashing = true,
     "https://github.com/FuelLabs/sway/issues/7256",
+    abi_type_aliases = false,
+    "https://github.com/FuelLabs/sway/issues/7486",
 }
 
 #[derive(Clone, Debug, Default, Parser)]