Compile panic expression to ABI error codes

Author: ironcev

Cargo.lock

@@ -82,13 +82,13 @@ sway-ir-macros = { path = "sway-ir/sway-ir-macros", version = "0.68.1" }
 #
 
 # Dependencies from the `fuel-abi-types` repository:
-fuel-abi-types = "0.8"
+fuel-abi-types = "0.10"
 
 # Dependencies from the `fuel-core` repository:
 #
-# Although ALL verions are "X.Y", we need the complete semver for
+# Although ALL versions are "X.Y", we need the complete semver for
 # fuel-core-client as the GitHub Actions workflow parses this value to pull down
-# the correct tarball
+# the correct tarball.
 fuel-core-client = { version = "0.43.1", default-features = false }
 fuel-core-types = { version = "0.43", default-features = false }
 
@@ -256,3 +256,9 @@ vte = "0.13"
 walkdir = "2.3"
 whoami = "1.5"
 wiremock = "0.6"
+
+[patch.crates-io]
+fuels = { git = "https://github.com/FuelLabs/fuels-rs", branch = "feat/abi-errors" }
+fuels-core = { git = "https://github.com/FuelLabs/fuels-rs", branch = "feat/abi-errors" }
+fuels-accounts = { git = "https://github.com/FuelLabs/fuels-rs", branch = "feat/abi-errors" }
+fuels-code-gen = { git = "https://github.com/FuelLabs/fuels-rs", branch = "feat/abi-errors" }

Cargo.toml

@@ -1768,9 +1768,15 @@ pub fn compile(
         metrics
     );
 
+    let mut asm = match asm_res {
+        Err(_) => return fail(handler),
+        Ok(asm) => asm,
+    };
+
     const ENCODING_V0: &str = "0";
     const ENCODING_V1: &str = "1";
     const SPEC_VERSION: &str = "1";
+    const SPEC_VERSION_ERROR_TYPE: &str = "1.1";
 
     let mut program_abi = match pkg.target {
         BuildTarget::Fuel => {
@@ -1782,6 +1788,7 @@ pub fn compile(
                     &handler,
                     &mut AbiContext {
                         program: typed_program,
+                        panic_locations: &asm.panic_locations,
                         abi_with_callpaths: true,
                         type_ids_to_full_type_str: HashMap::<String, String>::new(),
                     },
@@ -1791,7 +1798,11 @@ pub fn compile(
                     } else {
                         ENCODING_V0.into()
                     },
-                    SPEC_VERSION.into(),
+                    if experimental.error_type {
+                        SPEC_VERSION_ERROR_TYPE.into()
+                    } else {
+                        SPEC_VERSION.into()
+                    }
                 ),
                 Some(sway_build_config.clone()),
                 metrics
@@ -1805,11 +1816,8 @@ pub fn compile(
         BuildTarget::EVM => {
             // Merge the ABI output of ASM gen with ABI gen to handle internal constructors
             // generated by the ASM backend.
-            let mut ops = match &asm_res {
-                Ok(ref asm) => match &asm.0.abi {
-                    Some(ProgramABI::Evm(ops)) => ops.clone(),
-                    _ => vec![],
-                },
+            let mut ops = match &asm.finalized_asm.abi {
+                Some(ProgramABI::Evm(ops)) => ops.clone(),
                 _ => vec![],
             };
 
@@ -1828,20 +1836,13 @@ pub fn compile(
         }
     };
 
-    let entries = asm_res
-        .as_ref()
-        .map(|asm| asm.0.entries.clone())
-        .unwrap_or_default();
-    let entries = entries
+    let entries = asm
+        .finalized_asm
+        .entries
         .iter()
         .map(|finalized_entry| PkgEntry::from_finalized_entry(finalized_entry, engines))
         .collect::<anyhow::Result<_>>()?;
 
-    let mut asm = match asm_res {
-        Err(_) => return fail(handler),
-        Ok(asm) => asm,
-    };
-
     let bc_res = time_expr!(
         pkg.name,
         "compile asm to bytecode",
@@ -1976,12 +1977,16 @@ fn report_assembly_information(
         data_section: sway_core::asm_generation::DataSectionInformation {
             size: data_section_size,
             used: compiled_asm
-                .0
+                .finalized_asm
                 .data_section
                 .iter_all_entries()
                 .map(|entry| calculate_entry_size(&entry))
                 .sum(),
-            value_pairs: compiled_asm.0.data_section.iter_all_entries().collect(),
+            value_pairs: compiled_asm
+                .finalized_asm
+                .data_section
+                .iter_all_entries()
+                .collect(),
         },
     };
 

forc-pkg/src/pkg.rs

@@ -1,22 +1,24 @@
 use fuel_abi_types::abi::program::{
-    self as program_abi, ConcreteTypeId, MetadataTypeId, TypeConcreteDeclaration,
+    self as program_abi, ConcreteTypeId, ErrorDetails, ErrorPosition, MetadataTypeId,
+    TypeConcreteDeclaration,
 };
 use sha2::{Digest, Sha256};
-use std::collections::{HashMap, HashSet};
+use std::collections::{BTreeMap, HashMap, HashSet};
 use sway_error::handler::{ErrorEmitted, Handler};
 use sway_types::Span;
 
 use crate::{
     ast_elements::type_parameter::GenericTypeParameter,
     language::ty::{TyFunctionDecl, TyProgram, TyProgramKind},
     transform::Attributes,
-    Engines, TypeId, TypeInfo,
+    Engines, PanicLocation, TypeId, TypeInfo,
 };
 
 use super::abi_str::AbiStrContext;
 
 pub struct AbiContext<'a> {
     pub program: &'a TyProgram,
+    pub panic_locations: &'a Vec<PanicLocation>,
     pub abi_with_callpaths: bool,
     pub type_ids_to_full_type_str: HashMap<String, String>,
 }
@@ -106,6 +108,7 @@ pub fn generate_program_abi(
                 generate_messages_types(handler, ctx, engines, metadata_types, concrete_types)?;
             let configurables =
                 generate_configurables(handler, ctx, engines, metadata_types, concrete_types)?;
+            let error_codes = generate_error_codes(ctx.panic_locations)?;
             program_abi::ProgramABI {
                 program_type: "contract".to_string(),
                 spec_version,
@@ -116,6 +119,7 @@ pub fn generate_program_abi(
                 logged_types: Some(logged_types),
                 messages_types: Some(messages_types),
                 configurables: Some(configurables),
+                error_codes: Some(error_codes),
             }
         }
         TyProgramKind::Script { main_function, .. } => {
@@ -133,6 +137,7 @@ pub fn generate_program_abi(
                 generate_messages_types(handler, ctx, engines, metadata_types, concrete_types)?;
             let configurables =
                 generate_configurables(handler, ctx, engines, metadata_types, concrete_types)?;
+            let error_codes = generate_error_codes(ctx.panic_locations)?;
             program_abi::ProgramABI {
                 program_type: "script".to_string(),
                 spec_version,
@@ -143,6 +148,7 @@ pub fn generate_program_abi(
                 logged_types: Some(logged_types),
                 messages_types: Some(messages_types),
                 configurables: Some(configurables),
+                error_codes: Some(error_codes),
             }
         }
         TyProgramKind::Predicate { main_function, .. } => {
@@ -160,6 +166,7 @@ pub fn generate_program_abi(
                 generate_messages_types(handler, ctx, engines, metadata_types, concrete_types)?;
             let configurables =
                 generate_configurables(handler, ctx, engines, metadata_types, concrete_types)?;
+            let error_codes = generate_error_codes(ctx.panic_locations)?;
             program_abi::ProgramABI {
                 program_type: "predicate".to_string(),
                 spec_version,
@@ -170,14 +177,15 @@ pub fn generate_program_abi(
                 logged_types: Some(logged_types),
                 messages_types: Some(messages_types),
                 configurables: Some(configurables),
+                error_codes: Some(error_codes),
             }
         }
         TyProgramKind::Library { .. } => {
             let logged_types =
                 generate_logged_types(handler, ctx, engines, metadata_types, concrete_types)?;
             let messages_types =
                 generate_messages_types(handler, ctx, engines, metadata_types, concrete_types)?;
-
+            let error_codes = generate_error_codes(ctx.panic_locations)?;
             program_abi::ProgramABI {
                 program_type: "library".to_string(),
                 spec_version,
@@ -188,6 +196,7 @@ pub fn generate_program_abi(
                 logged_types: Some(logged_types),
                 messages_types: Some(messages_types),
                 configurables: None,
+                error_codes: Some(error_codes),
             }
         }
     };
@@ -564,11 +573,36 @@ fn generate_configurables(
                     decl.type_ascription.type_id(),
                 )?,
                 offset: 0,
+                indirect: false,
             })
         })
         .collect::<Result<Vec<_>, _>>()
 }
 
+fn generate_error_codes(
+    panic_locations: &[PanicLocation],
+) -> Result<BTreeMap<u64, ErrorDetails>, ErrorEmitted> {
+    let mut res = BTreeMap::new();
+    for panic_location in panic_locations.iter() {
+        res.insert(
+            panic_location.revert_code,
+            ErrorDetails {
+                pos: ErrorPosition {
+                    pkg: panic_location.loc.pkg.clone(),
+                    file: panic_location.loc.file.clone(),
+                    line: panic_location.loc.loc.line as u64,
+                    column: panic_location.loc.loc.col as u64,
+                },
+                log_id: panic_location
+                    .log_id
+                    .map(|log_id| log_id.hash_id.to_string()),
+                msg: panic_location.msg.clone(),
+            },
+        );
+    }
+    Ok(res)
+}
+
 impl TypeId {
     /// Return the type parameters of a given (potentially generic) type while considering what it
     /// actually resolves to. These parameters are essentially of type of `usize` which are