Add #[abi_name(name = "foo") attribute to rename ABI items.

Add `#[abi_name(name = "foo")` 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.

Author: tritao

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

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().trim_quotes());
+    }
+    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 {

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> {

sway-types/src/span.rs

@@ -188,6 +188,27 @@ impl Span {
         }
     }
 
+    pub fn trim_quotes(self) -> Span {
+        let s = self.as_str();
+        let mut start_delta = 0;
+        let mut end_delta = 0;
+
+        if s.starts_with('"') {
+            start_delta += 1;
+        }
+
+        if s.ends_with('"') && s.len() > start_delta {
+            end_delta += 1;
+        }
+
+        Span {
+            src: self.src,
+            start: self.start + start_delta,
+            end: self.end - end_delta,
+            source_id: self.source_id,
+        }
+    }
+
     /// Creates a new span that points to very next char of the current span.
     ///
     /// ```ignore

test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/.gitignore

@@ -0,0 +1,2 @@
+out
+target

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"

test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/Forc.toml

@@ -0,0 +1,9 @@
+[project]
+authors = ["Fuel Labs <[email protected]>"]
+entry = "lib.sw"
+license = "Apache-2.0"
+name = "abi_name_attribute"
+
+[dependencies]
+std = { path = "../../../../../../../sway-lib-std" }
+

test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/json_abi_oracle.json

@@ -0,0 +1,49 @@
+{
+  "concreteTypes": [
+    {
+      "concreteTypeId": "215af2bca9e1aa8fec647dab22a0cd36c63ce5ed051a132d51323807e28c0d67",
+      "metadataTypeId": 1,
+      "type": "enum RenamedMyEnum"
+    },
+    {
+      "concreteTypeId": "d31db280ac133d726851d8003bd2f06ec2d3fc76a46f1007d13914088fbd0791",
+      "type": "struct RenamedMyStruct"
+    }
+  ],
+  "configurables": [],
+  "encodingVersion": "1",
+  "functions": [
+    {
+      "attributes": null,
+      "inputs": [],
+      "name": "my_enum",
+      "output": "215af2bca9e1aa8fec647dab22a0cd36c63ce5ed051a132d51323807e28c0d67"
+    },
+    {
+      "attributes": null,
+      "inputs": [],
+      "name": "my_struct",
+      "output": "d31db280ac133d726851d8003bd2f06ec2d3fc76a46f1007d13914088fbd0791"
+    }
+  ],
+  "loggedTypes": [],
+  "messagesTypes": [],
+  "metadataTypes": [
+    {
+      "metadataTypeId": 0,
+      "type": "()"
+    },
+    {
+      "components": [
+        {
+          "name": "A",
+          "typeId": 0
+        }
+      ],
+      "metadataTypeId": 1,
+      "type": "enum RenamedMyEnum"
+    }
+  ],
+  "programType": "contract",
+  "specVersion": "1"
+}

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": "215af2bca9e1aa8fec647dab22a0cd36c63ce5ed051a132d51323807e28c0d67",
+      "metadataTypeId": 1,
+      "type": "enum RenamedMyEnum"
+    },
+    {
+      "concreteTypeId": "d31db280ac133d726851d8003bd2f06ec2d3fc76a46f1007d13914088fbd0791",
+      "type": "struct RenamedMyStruct"
+    }
+  ],
+  "configurables": [],
+  "encodingVersion": "1",
+  "functions": [
+    {
+      "attributes": null,
+      "inputs": [],
+      "name": "my_enum",
+      "output": "215af2bca9e1aa8fec647dab22a0cd36c63ce5ed051a132d51323807e28c0d67"
+    },
+    {
+      "attributes": null,
+      "inputs": [],
+      "name": "my_struct",
+      "output": "d31db280ac133d726851d8003bd2f06ec2d3fc76a46f1007d13914088fbd0791"
+    }
+  ],
+  "loggedTypes": [],
+  "messagesTypes": [],
+  "metadataTypes": [
+    {
+      "metadataTypeId": 0,
+      "type": "()"
+    },
+    {
+      "components": [
+        {
+          "name": "A",
+          "typeId": 0
+        }
+      ],
+      "metadataTypeId": 1,
+      "type": "enum RenamedMyEnum"
+    }
+  ],
+  "programType": "contract",
+  "specVersion": "1"
+}

test/src/e2e_vm_tests/test_programs/should_pass/language/abi_name_attribute/src/lib.sw

@@ -0,0 +1,19 @@
+contract;
+
+#[abi_name(name = "RenamedMyStruct")]
+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 }
+}

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