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

[tritao]

Description

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

Here is example of how it can be used:

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

Closes #5955.

Checklist

• I have linked to any relevant issues.
• I have commented my code, particularly in hard-to-understand areas.
• I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • If my change requires substantial documentation changes, I have requested support from the DevRel team
• I have added tests that prove my fix is effective or that my feature works.
• I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
• I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
• I have requested a review from the relevant team or maintainers.

[codspeed-hq]

CodSpeed Performance Report

Merging #7057 will not alter performance

_{Comparing tritao:annotation-abi-name (b993940) with master (2501c76)}

Summary

✅ 22 untouched benchmarks

[ironcev]

A general question to renaming ABI elements. What if we rename it to something that already exist and is also serialized into ABI? Shouldn't we provide any checks here?

[ironcev]

I gave this a bit of a thought. Giving names is a serious business. Aside from renaming that can clash with an existing item what about invalid names? E.g.

• name = ""
• name = "this !s n0t an identif1er"
• name = "__this_also_not"
• name = "this::looks::like::a::path"
• name = "will this \" break ABI generation or be encoded?"

What will SDKs do in these cases? How do they handle invalid names, if at all? I wouldn't be surprised if expecting a valid name is a part of an unwritten contract for ABI consistency.

I expect strong checks here for consistency. Honestly, I would go that far and give warnings for non-idiomatic names.

[tritao]

Thanks for thinking about these in more detail, indeed I agree with you, it's worth it to spend a bit more time on this and add some better checks.

[ironcev]

The attribute should be added to the Attributes chapter in the documentation.

I've changed that documentation page fully in #7058 because it was seriously outdated. So, whoever gets the PR merged later will have some slight merge conflicts to solve on that page 😄