Disable self parameters for ABI methods (FuelLabs#3662)

sway-core/src/transform/to_parsed_lang/convert_parse_tree.rs

@@ -163,14 +163,11 @@ fn item_to_ast_nodes(
         ItemKind::Fn(item_fn) => {
             let function_declaration =
                 item_fn_to_function_declaration(handler, engines, item_fn, attributes)?;
-            for param in &function_declaration.parameters {
-                if matches!(param.type_info, TypeInfo::SelfType) {
-                    let error = ConvertParseTreeError::SelfParameterNotAllowedForFreeFn {
-                        span: param.type_span.clone(),
-                    };
-                    return Err(handler.emit_err(error.into()));
-                }
-            }
+            error_if_self_param_is_not_allowed(
+                handler,
+                &function_declaration.parameters,
+                "a free function",
+            )?;
             decl(Declaration::FunctionDeclaration(function_declaration))
         }
         ItemKind::Trait(item_trait) => decl(Declaration::TraitDeclaration(
@@ -625,7 +622,14 @@ fn item_abi_to_abi_declaration(
                 .into_iter()
                 .map(|(fn_signature, _semicolon_token)| {
                     let attributes = item_attrs_to_map(handler, &fn_signature.attribute_list)?;
-                    fn_signature_to_trait_fn(handler, engines, fn_signature.value, attributes)
+                    let trait_fn =
+                        fn_signature_to_trait_fn(handler, engines, fn_signature.value, attributes)?;
+                    error_if_self_param_is_not_allowed(
+                        handler,
+                        &trait_fn.parameters,
+                        "an ABI method signature",
+                    )?;
+                    Ok(trait_fn)
                 })
                 .collect::<Result<_, _>>()?
         },
@@ -636,7 +640,18 @@ fn item_abi_to_abi_declaration(
                 .into_iter()
                 .map(|item_fn| {
                     let attributes = item_attrs_to_map(handler, &item_fn.attribute_list)?;
-                    item_fn_to_function_declaration(handler, engines, item_fn.value, attributes)
+                    let function_declaration = item_fn_to_function_declaration(
+                        handler,
+                        engines,
+                        item_fn.value,
+                        attributes,
+                    )?;
+                    error_if_self_param_is_not_allowed(
+                        handler,
+                        &function_declaration.parameters,
+                        "a method provided by ABI",
+                    )?;
+                    Ok(function_declaration)
                 })
                 .collect::<Result<_, _>>()?,
         },
@@ -3306,3 +3321,20 @@ fn item_attrs_to_map(
     }
     Ok(Arc::new(attrs_map))
 }
+
+fn error_if_self_param_is_not_allowed(
+    handler: &Handler,
+    parameters: &[FunctionParameter],
+    fn_kind: &str,
+) -> Result<(), ErrorEmitted> {
+    for param in parameters {
+        if matches!(param.type_info, TypeInfo::SelfType) {
+            let error = ConvertParseTreeError::SelfParameterNotAllowedForFn {
+                fn_kind: fn_kind.to_owned(),
+                span: param.type_span.clone(),
+            };
+            return Err(handler.emit_err(error.into()));
+        }
+    }
+    Ok(())
+}

sway-error/src/convert_parse_tree_error.rs

@@ -85,8 +85,8 @@ pub enum ConvertParseTreeError {
     DuplicateStructField { name: Ident, span: Span },
     #[error("identifier \"{name}\" bound more than once in this parameter list")]
     DuplicateParameterIdentifier { name: Ident, span: Span },
-    #[error("self parameter is not allowed for a free function")]
-    SelfParameterNotAllowedForFreeFn { span: Span },
+    #[error("self parameter is not allowed for {fn_kind}")]
+    SelfParameterNotAllowedForFn { fn_kind: String, span: Span },
     #[error("test functions are only allowed at module level")]
     TestFnOnlyAllowedAtModuleLevel { span: Span },
     #[error("`impl Self` for contracts is not supported")]
@@ -143,7 +143,7 @@ impl Spanned for ConvertParseTreeError {
             ConvertParseTreeError::DuplicateStorageField { span, .. } => span.clone(),
             ConvertParseTreeError::DuplicateStructField { span, .. } => span.clone(),
             ConvertParseTreeError::DuplicateParameterIdentifier { span, .. } => span.clone(),
-            ConvertParseTreeError::SelfParameterNotAllowedForFreeFn { span, .. } => span.clone(),
+            ConvertParseTreeError::SelfParameterNotAllowedForFn { span, .. } => span.clone(),
             ConvertParseTreeError::TestFnOnlyAllowedAtModuleLevel { span } => span.clone(),
             ConvertParseTreeError::SelfImplForContract { span, .. } => span.clone(),
             ConvertParseTreeError::CannotDocCommentDependency { span } => span.clone(),

test/src/e2e_vm_tests/test_programs/should_fail/no_self_in_abi_method_signature/Forc.lock

@@ -0,0 +1,3 @@
+[[package]]
+name = 'no_self_in_abi_method_signature'
+source = 'member'

test/src/e2e_vm_tests/test_programs/should_fail/no_self_in_abi_method_signature/Forc.toml

@@ -0,0 +1,6 @@
+[project]
+authors = ["Fuel Labs <[email protected]>"]
+entry = "main.sw"
+implicit-std = false
+license = "Apache-2.0"
+name = "no_self_in_abi_method_signature"

test/src/e2e_vm_tests/test_programs/should_fail/no_self_in_abi_method_signature/src/main.sw

@@ -0,0 +1,6 @@
+contract;
+
+abi MyContract {
+    fn foo(self);
+}
+

test/src/e2e_vm_tests/test_programs/should_fail/no_self_in_abi_method_signature/test.toml

@@ -0,0 +1,3 @@
+category = "fail"
+
+# check: $()self parameter is not allowed for an ABI method signature

test/src/e2e_vm_tests/test_programs/should_fail/no_self_in_method_provided_by_abi/Forc.lock

@@ -0,0 +1,3 @@
+[[package]]
+name = 'no_self_in_method_provided_by_abi'
+source = 'member'

test/src/e2e_vm_tests/test_programs/should_fail/no_self_in_method_provided_by_abi/Forc.toml

@@ -0,0 +1,6 @@
+[project]
+authors = ["Fuel Labs <[email protected]>"]
+entry = "main.sw"
+implicit-std = false
+license = "Apache-2.0"
+name = "no_self_in_method_provided_by_abi"

test/src/e2e_vm_tests/test_programs/should_fail/no_self_in_method_provided_by_abi/src/main.sw

@@ -0,0 +1,9 @@
+contract;
+
+abi MyContract {
+    fn foo();
+} {
+    fn bar(self) {
+    }
+}
+

test/src/e2e_vm_tests/test_programs/should_fail/no_self_in_method_provided_by_abi/test.toml

@@ -0,0 +1,3 @@
+category = "fail"
+
+# check: $()self parameter is not allowed for a method provided by ABI