Add #[abi_name() attribute to rename ABI items.

tritao · tritao · commit 04f5114a619e · 2025-04-02T20:07:01.000+01:00
Add `#[abi_name()` attribute to rename enum and struct ABI items. Here is example of how it can be used: ```sway contract; #[abi_name(name = "RenamedMyScript")] struct MyStruct {} #[abi_name(name = "RenamedMyEnum")] enum MyEnum { A: () } abi MyAbi { fn my_struct() -> MyStruct; fn my_enum() -> MyEnum; } impl MyAbi for Contract { fn my_struct() -> MyStruct { MyStruct{} } fn my_enum() -> MyEnum { MyEnum::A } } ``` Closes #5955.
diff --git a/sway-ast/src/attribute.rs b/sway-ast/src/attribute.rs
@@ -47,6 +47,10 @@ pub const CFG_PROGRAM_TYPE_ARG_NAME: &str = "program_type";
 pub const DEPRECATED_ATTRIBUTE_NAME: &str = "deprecated";
 pub const DEPRECATED_NOTE_ARG_NAME: &str = "note";
 
+// Abi names.
+pub const ABI_NAME_ATTRIBUTE_NAME: &str = "abi_name";
+pub const ABI_NAME_NAME_ARG_NAME: &str = "name";
+
 pub const KNOWN_ATTRIBUTE_NAMES: &[&str] = &[
     STORAGE_ATTRIBUTE_NAME,
     DOC_COMMENT_ATTRIBUTE_NAME,
@@ -57,6 +61,7 @@ pub const KNOWN_ATTRIBUTE_NAMES: &[&str] = &[
     CFG_ATTRIBUTE_NAME,
     DEPRECATED_ATTRIBUTE_NAME,
     FALLBACK_ATTRIBUTE_NAME,
+    ABI_NAME_ATTRIBUTE_NAME,
 ];
 
 /// An attribute declaration. Attribute declaration
diff --git a/sway-core/src/abi_generation/abi_str.rs b/sway-core/src/abi_generation/abi_str.rs
@@ -1,6 +1,7 @@
-use sway_types::{integer_bits::IntegerBits, Named};
+use sway_ast::Literal;
+use sway_types::{integer_bits::IntegerBits, BaseIdent, Named};
 
-use crate::{language::CallPath, Engines, GenericArgument, TypeId, TypeInfo};
+use crate::{language::CallPath, transform, Engines, GenericArgument, TypeId, TypeInfo};
 
 #[derive(Clone)]
 pub struct AbiStrContext {
@@ -143,9 +144,10 @@ impl TypeInfo {
                             .join(",")
                     )
                 };
+                let abi_call_path = handle_abi_name_attribute(&decl.call_path, &decl.attributes);
                 format!(
                     "enum {}{}",
-                    call_path_display(ctx, &decl.call_path),
+                    call_path_display(ctx, &abi_call_path),
                     type_params
                 )
             }
@@ -165,9 +167,10 @@ impl TypeInfo {
                             .join(",")
                     )
                 };
+                let abi_call_path = handle_abi_name_attribute(&decl.call_path, &decl.attributes);
                 format!(
                     "struct {}{}",
-                    call_path_display(ctx, &decl.call_path),
+                    call_path_display(ctx, &abi_call_path),
                     type_params
                 )
             }
@@ -208,6 +211,19 @@ impl TypeInfo {
     }
 }
 
+fn handle_abi_name_attribute(call_path: &CallPath, attributes: &transform::Attributes) -> CallPath {
+    let mut abi_call_path = call_path.clone();
+    if let Some(abi_name_attr) = attributes.abi_name() {
+        let name = abi_name_attr.args.first().unwrap();
+        let literal = match name.value.as_ref().unwrap() {
+            Literal::String(lit_string) => lit_string,
+            _ => unreachable!()
+        };
+        abi_call_path.suffix = BaseIdent::new(literal.span.clone());
+    }
+    abi_call_path
+}
+
 /// `call_path_display`  returns the provided `call_path` without the first prefix in case it is equal to the program name.
 /// If the program name is `my_program` and the `call_path` is `my_program::MyStruct` then this function returns only `MyStruct`.
 fn call_path_display(ctx: &AbiStrContext, call_path: &CallPath) -> String {
diff --git a/sway-core/src/transform/attribute.rs b/sway-core/src/transform/attribute.rs
@@ -317,7 +317,7 @@ pub enum ArgsExpectValues {
     ///
     /// E.g.: `#[cfg(target = "fuel", experimental_new_encoding = false)]`.
     Yes,
-    /// None of the arguments can never have values specified, or the
+    /// None of the arguments can have values specified, or the
     /// [Attribute] does not expect any arguments.
     ///
     /// E.g.: `#[storage(read, write)]`, `#[fallback]`.
@@ -348,6 +348,7 @@ pub enum AttributeKind {
     Cfg,
     Deprecated,
     Fallback,
+    AbiName,
 }
 
 /// Denotes if an [ItemTraitItem] belongs to an ABI or to a trait.
@@ -376,6 +377,7 @@ impl AttributeKind {
             CFG_ATTRIBUTE_NAME => AttributeKind::Cfg,
             DEPRECATED_ATTRIBUTE_NAME => AttributeKind::Deprecated,
             FALLBACK_ATTRIBUTE_NAME => AttributeKind::Fallback,
+            ABI_NAME_ATTRIBUTE_NAME => AttributeKind::AbiName,
             _ => AttributeKind::Unknown,
         }
     }
@@ -402,6 +404,7 @@ impl AttributeKind {
             Cfg => true,
             Deprecated => false,
             Fallback => false,
+            AbiName => false,
         }
     }
 }
@@ -440,6 +443,7 @@ impl Attribute {
             // `deprecated`, `deprecated(note = "note")`.
             Deprecated => Multiplicity::at_most(1),
             Fallback => Multiplicity::zero(),
+            AbiName => Multiplicity::exactly(1),
         }
     }
 
@@ -493,6 +497,7 @@ impl Attribute {
             }
             Deprecated => MustBeIn(vec![DEPRECATED_NOTE_ARG_NAME]),
             Fallback => None,
+            AbiName => MustBeIn(vec![ABI_NAME_NAME_ARG_NAME]),
         }
     }
 
@@ -513,6 +518,7 @@ impl Attribute {
             // `deprecated(note = "note")`.
             Deprecated => Yes,
             Fallback => No,
+            AbiName => Yes,
         }
     }
 
@@ -531,6 +537,7 @@ impl Attribute {
             //       Deprecating the module kind will mean deprecating all its items.
             Deprecated => false,
             Fallback => false,
+            AbiName => false,
         }
     }
 
@@ -582,6 +589,11 @@ impl Attribute {
                 ItemKind::Error(_, _) => true,
             },
             Fallback => matches!(item_kind, ItemKind::Fn(_)),
+            AbiName => match item_kind {
+                ItemKind::Struct(_) => true,
+                ItemKind::Enum(_) => true,
+                _ => true,
+            }
         }
     }
 
@@ -605,6 +617,7 @@ impl Attribute {
             Cfg => true,
             Deprecated => true,
             Fallback => false,
+            AbiName => true,
         }
     }
 
@@ -628,6 +641,7 @@ impl Attribute {
             // TODO: Change to true once https://github.com/FuelLabs/sway/issues/6942 is implemented.
             Deprecated => false,
             Fallback => false,
+            AbiName => false,
         }
     }
 
@@ -648,6 +662,7 @@ impl Attribute {
             Cfg => true,
             Deprecated => !matches!(item, ItemImplItem::Type(_)),
             Fallback => false,
+            AbiName => false,
         }
     }
 
@@ -667,6 +682,7 @@ impl Attribute {
             Cfg => true,
             Deprecated => true,
             Fallback => false,
+            AbiName => false,
         }
     }
 
@@ -684,6 +700,7 @@ impl Attribute {
             // TODO: Change to true once https://github.com/FuelLabs/sway/issues/6942 is implemented.
             Deprecated => false,
             Fallback => false,
+            AbiName => false,
         }
     }
 
@@ -700,6 +717,7 @@ impl Attribute {
             Cfg => true,
             Deprecated => true,
             Fallback => false,
+            AbiName => false,
         }
     }
 
@@ -749,6 +767,9 @@ impl Attribute {
                 "\"deprecated\" attribute is currently not implemented for all elements that could be deprecated.",
             ],
             Fallback => vec!["\"fallback\" attribute can only annotate module functions in a contract module."],
+            AbiName => vec![
+                "\"abi_name\" attribute is currently not implemented for all elements that could renamed in ABIs.",
+            ],
         };
 
         if help.is_empty() && target_friendly_name.starts_with("module kind") {
@@ -949,6 +970,12 @@ impl Attributes {
             .map(|index| &self.attributes[index])
     }
 
+    /// Returns the `#[abi_name]` [Attribute], or `None` if the
+    /// [Attributes] does not contain any `#[abi_name]` attributes.
+    pub fn abi_name(&self) -> Option<&Attribute> {
+        self.of_kind(AttributeKind::AbiName).last()
+    }
+
     /// Returns the `#[test]` [Attribute], or `None` if the
     /// [Attributes] does not contain any `#[test]` attributes.
     pub fn test(&self) -> Option<&Attribute> {
diff --git a/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/.gitignore b/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/.gitignore
@@ -0,0 +1,2 @@
+out
+target
diff --git a/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/Forc.lock b/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/Forc.lock
@@ -0,0 +1,8 @@
+[[package]]
+name = "abi_name_attribute"
+source = "member"
+dependencies = ["std"]
+
+[[package]]
+name = "std"
+source = "path+from-root-ADA3C90E7ED94315"
diff --git a/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/Forc.toml b/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/Forc.toml
@@ -0,0 +1,9 @@
+[project]
+authors = ["Fuel Labs <contact@fuel.sh>"]
+entry = "lib.sw"
+license = "Apache-2.0"
+name = "abi_name_attribute"
+
+[dependencies]
+std = { path = "../../../../../../../sway-lib-std" }
+
diff --git a/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/json_abi_oracle.json b/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/json_abi_oracle.json
@@ -0,0 +1,49 @@
+{
+  "concreteTypes": [
+    {
+      "concreteTypeId": "ae12f4febfb972911e17d7d6cef8cb1d27073b2909d02360bd10827626bfae2b",
+      "metadataTypeId": 1,
+      "type": "enum \"RenamedMyEnum\""
+    },
+    {
+      "concreteTypeId": "b4d23182b68c23897a0f62a99d0fbea374f31183cc4072740c90c76d27582032",
+      "type": "struct \"RenamedMyScript\""
+    }
+  ],
+  "configurables": [],
+  "encodingVersion": "1",
+  "functions": [
+    {
+      "attributes": null,
+      "inputs": [],
+      "name": "my_enum",
+      "output": "ae12f4febfb972911e17d7d6cef8cb1d27073b2909d02360bd10827626bfae2b"
+    },
+    {
+      "attributes": null,
+      "inputs": [],
+      "name": "my_struct",
+      "output": "b4d23182b68c23897a0f62a99d0fbea374f31183cc4072740c90c76d27582032"
+    }
+  ],
+  "loggedTypes": [],
+  "messagesTypes": [],
+  "metadataTypes": [
+    {
+      "metadataTypeId": 0,
+      "type": "()"
+    },
+    {
+      "components": [
+        {
+          "name": "A",
+          "typeId": 0
+        }
+      ],
+      "metadataTypeId": 1,
+      "type": "enum \"RenamedMyEnum\""
+    }
+  ],
+  "programType": "contract",
+  "specVersion": "1"
+}
diff --git a/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/json_abi_oracle_new_encoding.json b/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/json_abi_oracle_new_encoding.json
@@ -0,0 +1,49 @@
+{
+  "concreteTypes": [
+    {
+      "concreteTypeId": "ae12f4febfb972911e17d7d6cef8cb1d27073b2909d02360bd10827626bfae2b",
+      "metadataTypeId": 1,
+      "type": "enum \"RenamedMyEnum\""
+    },
+    {
+      "concreteTypeId": "b4d23182b68c23897a0f62a99d0fbea374f31183cc4072740c90c76d27582032",
+      "type": "struct \"RenamedMyScript\""
+    }
+  ],
+  "configurables": [],
+  "encodingVersion": "1",
+  "functions": [
+    {
+      "attributes": null,
+      "inputs": [],
+      "name": "my_enum",
+      "output": "ae12f4febfb972911e17d7d6cef8cb1d27073b2909d02360bd10827626bfae2b"
+    },
+    {
+      "attributes": null,
+      "inputs": [],
+      "name": "my_struct",
+      "output": "b4d23182b68c23897a0f62a99d0fbea374f31183cc4072740c90c76d27582032"
+    }
+  ],
+  "loggedTypes": [],
+  "messagesTypes": [],
+  "metadataTypes": [
+    {
+      "metadataTypeId": 0,
+      "type": "()"
+    },
+    {
+      "components": [
+        {
+          "name": "A",
+          "typeId": 0
+        }
+      ],
+      "metadataTypeId": 1,
+      "type": "enum \"RenamedMyEnum\""
+    }
+  ],
+  "programType": "contract",
+  "specVersion": "1"
+}
diff --git a/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/src/lib.sw b/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/src/lib.sw
@@ -0,0 +1,19 @@
+contract;
+
+#[abi_name(name = "RenamedMyScript")]
+struct MyStruct {}
+
+#[abi_name(name = "RenamedMyEnum")]
+enum MyEnum {
+  A: ()
+}
+
+abi MyAbi {
+    fn my_struct() -> MyStruct;
+    fn my_enum() -> MyEnum;
+}
+
+impl MyAbi for Contract {
+  fn my_struct() -> MyStruct { MyStruct{} }
+  fn my_enum() -> MyEnum { MyEnum::A }
+}
diff --git a/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/test.toml b/test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/test.toml
@@ -0,0 +1,3 @@
+category = "compile"
+expected_warnings = 0
+validate_abi = true

Original file line number	Diff line number	Diff line change
`@@ -317,7 +317,7 @@ pub enum ArgsExpectValues {`
`317`	`317`	`///`
`318`	`318`	/// E.g.: `#[cfg(target = "fuel", experimental_new_encoding = false)]`.
`319`	`319`	`Yes,`
`320`		`- /// None of the arguments can never have values specified, or the`
	`320`	`+ /// None of the arguments can have values specified, or the`
`321`	`321`	`/// [Attribute] does not expect any arguments.`
`322`	`322`	`///`
`323`	`323`	/// E.g.: `#[storage(read, write)]`, `#[fallback]`.
`@@ -348,6 +348,7 @@ pub enum AttributeKind {`
`348`	`348`	`Cfg,`
`349`	`349`	`Deprecated,`
`350`	`350`	`Fallback,`
	`351`	`+ AbiName,`
`351`	`352`	`}`
`352`	`353`
`353`	`354`	`/// Denotes if an [ItemTraitItem] belongs to an ABI or to a trait.`
`@@ -376,6 +377,7 @@ impl AttributeKind {`
`376`	`377`	`CFG_ATTRIBUTE_NAME => AttributeKind::Cfg,`
`377`	`378`	`DEPRECATED_ATTRIBUTE_NAME => AttributeKind::Deprecated,`
`378`	`379`	`FALLBACK_ATTRIBUTE_NAME => AttributeKind::Fallback,`
	`380`	`+ ABI_NAME_ATTRIBUTE_NAME => AttributeKind::AbiName,`
`379`	`381`	`_ => AttributeKind::Unknown,`
`380`	`382`	`}`
`381`	`383`	`}`
`@@ -402,6 +404,7 @@ impl AttributeKind {`
`402`	`404`	`Cfg => true,`
`403`	`405`	`Deprecated => false,`
`404`	`406`	`Fallback => false,`
	`407`	`+ AbiName => false,`
`405`	`408`	`}`
`406`	`409`	`}`
`407`	`410`	`}`
`@@ -440,6 +443,7 @@ impl Attribute {`
`440`	`443`	// `deprecated`, `deprecated(note = "note")`.
`441`	`444`	`Deprecated => Multiplicity::at_most(1),`
`442`	`445`	`Fallback => Multiplicity::zero(),`
	`446`	`+ AbiName => Multiplicity::exactly(1),`
`443`	`447`	`}`
`444`	`448`	`}`
`445`	`449`
`@@ -493,6 +497,7 @@ impl Attribute {`
`493`	`497`	`}`
`494`	`498`	`Deprecated => MustBeIn(vec![DEPRECATED_NOTE_ARG_NAME]),`
`495`	`499`	`Fallback => None,`
	`500`	`+ AbiName => MustBeIn(vec![ABI_NAME_NAME_ARG_NAME]),`
`496`	`501`	`}`
`497`	`502`	`}`
`498`	`503`
`@@ -513,6 +518,7 @@ impl Attribute {`
`513`	`518`	// `deprecated(note = "note")`.
`514`	`519`	`Deprecated => Yes,`
`515`	`520`	`Fallback => No,`
	`521`	`+ AbiName => Yes,`
`516`	`522`	`}`
`517`	`523`	`}`
`518`	`524`
`@@ -531,6 +537,7 @@ impl Attribute {`
`531`	`537`	`// Deprecating the module kind will mean deprecating all its items.`
`532`	`538`	`Deprecated => false,`
`533`	`539`	`Fallback => false,`
	`540`	`+ AbiName => false,`
`534`	`541`	`}`
`535`	`542`	`}`
`536`	`543`
`@@ -582,6 +589,11 @@ impl Attribute {`
`582`	`589`	`ItemKind::Error(_, _) => true,`
`583`	`590`	`},`
`584`	`591`	`Fallback => matches!(item_kind, ItemKind::Fn(_)),`
	`592`	`+ AbiName => match item_kind {`
	`593`	`+ ItemKind::Struct(_) => true,`
	`594`	`+ ItemKind::Enum(_) => true,`
	`595`	`+ _ => true,`
	`596`	`+ }`
`585`	`597`	`}`
`586`	`598`	`}`
`587`	`599`
`@@ -605,6 +617,7 @@ impl Attribute {`
`605`	`617`	`Cfg => true,`
`606`	`618`	`Deprecated => true,`
`607`	`619`	`Fallback => false,`
	`620`	`+ AbiName => true,`
`608`	`621`	`}`
`609`	`622`	`}`
`610`	`623`
`@@ -628,6 +641,7 @@ impl Attribute {`
`628`	`641`	`// TODO: Change to true once https://github.com/FuelLabs/sway/issues/6942 is implemented.`
`629`	`642`	`Deprecated => false,`
`630`	`643`	`Fallback => false,`
	`644`	`+ AbiName => false,`
`631`	`645`	`}`
`632`	`646`	`}`
`633`	`647`
`@@ -648,6 +662,7 @@ impl Attribute {`
`648`	`662`	`Cfg => true,`
`649`	`663`	`Deprecated => !matches!(item, ItemImplItem::Type(_)),`
`650`	`664`	`Fallback => false,`
	`665`	`+ AbiName => false,`
`651`	`666`	`}`
`652`	`667`	`}`
`653`	`668`
`@@ -667,6 +682,7 @@ impl Attribute {`
`667`	`682`	`Cfg => true,`
`668`	`683`	`Deprecated => true,`
`669`	`684`	`Fallback => false,`
	`685`	`+ AbiName => false,`
`670`	`686`	`}`
`671`	`687`	`}`
`672`	`688`
`@@ -684,6 +700,7 @@ impl Attribute {`
`684`	`700`	`// TODO: Change to true once https://github.com/FuelLabs/sway/issues/6942 is implemented.`
`685`	`701`	`Deprecated => false,`
`686`	`702`	`Fallback => false,`
	`703`	`+ AbiName => false,`
`687`	`704`	`}`
`688`	`705`	`}`
`689`	`706`
`@@ -700,6 +717,7 @@ impl Attribute {`
`700`	`717`	`Cfg => true,`
`701`	`718`	`Deprecated => true,`
`702`	`719`	`Fallback => false,`
	`720`	`+ AbiName => false,`
`703`	`721`	`}`
`704`	`722`	`}`
`705`	`723`
`@@ -749,6 +767,9 @@ impl Attribute {`
`749`	`767`	`"\"deprecated\" attribute is currently not implemented for all elements that could be deprecated.",`
`750`	`768`	`],`
`751`	`769`	`Fallback => vec!["\"fallback\" attribute can only annotate module functions in a contract module."],`
	`770`	`+ AbiName => vec![`
	`771`	`+ "\"abi_name\" attribute is currently not implemented for all elements that could renamed in ABIs.",`
	`772`	`+ ],`
`752`	`773`	`};`
`753`	`774`
`754`	`775`	`if help.is_empty() && target_friendly_name.starts_with("module kind") {`
`@@ -949,6 +970,12 @@ impl Attributes {`
`949`	`970`	`.map(\|index\| &self.attributes[index])`
`950`	`971`	`}`
`951`	`972`
	`973`	+ /// Returns the `#[abi_name]` [Attribute], or `None` if the
	`974`	+ /// [Attributes] does not contain any `#[abi_name]` attributes.
	`975`	`+ pub fn abi_name(&self) -> Option<&Attribute> {`
	`976`	`+ self.of_kind(AttributeKind::AbiName).last()`
	`977`	`+ }`
	`978`	`+`
`952`	`979`	/// Returns the `#[test]` [Attribute], or `None` if the
`953`	`980`	/// [Attributes] does not contain any `#[test]` attributes.
`954`	`981`	`pub fn test(&self) -> Option<&Attribute> {`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+category = "compile"`
	`2`	`+expected_warnings = 0`
	`3`	`+validate_abi = true`