Add error messages to miden-objects errors and implement `core::err…

…or::Error` (#974) * feat: Remove `Clone`, `PartialEq`, `Eq` from errors * feat: Refactor `AssetError` and `AssetVaultError` * feat: Use `thiserror` for `BlockError` * chore: Make `NoteExecutionHint` tags associated constants * feat: Use `thiserror` for `NoteError` * feat: Include printed Report in error * feat: Add error messages for `TransactionInputError` * feat: Add error messages for `TransactionOutputError` * feat: Use `thiserror` for `ProvenTransactionError` * feat: Update `winter-utils` to `0.10.2` * feat: Add error messages for `AccountDeltaError` * fix: Build no-std * feat: Add error messages for `AccountError` * chore: Add Changelog entry * chore: Fix formatting * feat: Replace `std` with `core::error::Error` * chore: Alphabetize dependency order * chore: Include only minor version in version string
0xPolygonMiden · Nov 21, 2024 · e31db53 · e31db53
1 parent 7098c66
commit e31db53
Show file tree

Hide file tree

Showing 44 changed files with 625 additions and 626 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@
 
 - [BREAKING] Better error display when queues are full in the prover service (#967).
 - [BREAKING] Remove `AccountBuilder::build_testing` and make `Account::initialize_from_components` private (#969).
+- [BREAKING] Add error messages to errors and implement `core::error::Error` (#974).
 
 ## 0.6.1 (2024-11-08)
 

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -33,6 +33,7 @@ lto = true
 
 [workspace.dependencies]
 assembly = { package = "miden-assembly", version = "0.11", default-features = false }
+assert_matches = { version = "1.5", default-features = false }
 miden-crypto = { version = "0.12", default-features = false }
 miden-lib = { path = "miden-lib", version = "0.7", default-features = false }
 miden-objects = { path = "objects", version = "0.7", default-features = false }
@@ -41,5 +42,6 @@ miden-stdlib = { version = "0.11", default-features = false }
 miden-tx = { path = "miden-tx", version = "0.7", default-features = false }
 miden-verifier = { version = "0.11", default-features = false }
 rand = { version = "0.8", default-features = false }
+thiserror = { version = "2.0", default-features = false }
 vm-core = { package = "miden-core", version = "0.11", default-features = false }
 vm-processor = { package = "miden-processor", version = "0.11", default-features = false }
diff --git a/bin/tx-prover/src/lib.rs b/bin/tx-prover/src/lib.rs
@@ -39,3 +39,5 @@ impl std::fmt::Display for RemoteTransactionProverError {
         }
     }
 }
+
+impl core::error::Error for RemoteTransactionProverError {}
diff --git a/miden-lib/src/accounts/faucets/mod.rs b/miden-lib/src/accounts/faucets/mod.rs
@@ -1,5 +1,3 @@
-use alloc::string::ToString;
-
 use miden_objects::{
     accounts::{
         Account, AccountBuilder, AccountComponent, AccountStorageMode, AccountType, StorageSlot,
@@ -32,17 +30,27 @@ pub struct BasicFungibleFaucet {
 }
 
 impl BasicFungibleFaucet {
+    // CONSTANTS
+    // --------------------------------------------------------------------------------------------
+    const MAX_MAX_SUPPLY: u64 = (1 << 63) - 1;
+    const MAX_DECIMALS: u8 = 12;
+
+    // CONSTRUCTORS
+    // --------------------------------------------------------------------------------------------
+
     /// Creates a new [`BasicFungibleFaucet`] component from the given pieces of metadata.
     pub fn new(symbol: TokenSymbol, decimals: u8, max_supply: Felt) -> Result<Self, AccountError> {
         // First check that the metadata is valid.
-        if decimals > MAX_DECIMALS {
-            return Err(AccountError::FungibleFaucetInvalidMetadata(
-                "Decimals must be less than 13".to_string(),
-            ));
-        } else if max_supply.as_int() > MAX_MAX_SUPPLY {
-            return Err(AccountError::FungibleFaucetInvalidMetadata(
-                "Max supply must be < 2^63".to_string(),
-            ));
+        if decimals > Self::MAX_DECIMALS {
+            return Err(AccountError::FungibleFaucetTooManyDecimals {
+                actual: decimals,
+                max: Self::MAX_DECIMALS,
+            });
+        } else if max_supply.as_int() > Self::MAX_MAX_SUPPLY {
+            return Err(AccountError::FungibleFaucetMaxSupplyTooLarge {
+                actual: max_supply.as_int(),
+                max: Self::MAX_MAX_SUPPLY,
+            });
         }
 
         Ok(Self { symbol, decimals, max_supply })
@@ -65,9 +73,6 @@ impl From<BasicFungibleFaucet> for AccountComponent {
 // FUNGIBLE FAUCET
 // ================================================================================================
 
-const MAX_MAX_SUPPLY: u64 = (1 << 63) - 1;
-const MAX_DECIMALS: u8 = 12;
-
 /// Creates a new faucet account with basic fungible faucet interface,
 /// account storage type, specified authentication scheme, and provided meta data (token symbol,
 /// decimals, max supply).

diff --git a/miden-lib/src/accounts/wallets/mod.rs b/miden-lib/src/accounts/wallets/mod.rs
@@ -51,8 +51,8 @@ pub fn create_basic_wallet(
     account_storage_mode: AccountStorageMode,
 ) -> Result<(Account, Word), AccountError> {
     if matches!(account_type, AccountType::FungibleFaucet | AccountType::NonFungibleFaucet) {
-        return Err(AccountError::AccountIdInvalidFieldElement(
-            "Basic wallet accounts cannot have a faucet account type".to_string(),
+        return Err(AccountError::AssumptionViolated(
+            "basic wallet accounts cannot have a faucet account type".to_string(),
         ));
     }
 

diff --git a/miden-lib/src/transaction/errors.rs b/miden-lib/src/transaction/errors.rs
@@ -8,7 +8,7 @@ use miden_objects::{
 // TRANSACTION KERNEL ERROR
 // ================================================================================================
 
-#[derive(Debug, Clone, Eq, PartialEq)]
+#[derive(Debug)]
 pub enum TransactionKernelError {
     AccountDeltaError(AccountDeltaError),
     FailedToAddAssetToNote(NoteError),
@@ -117,13 +117,12 @@ impl fmt::Display for TransactionKernelError {
     }
 }
 
-#[cfg(feature = "std")]
-impl std::error::Error for TransactionKernelError {}
+impl core::error::Error for TransactionKernelError {}
 
 // TRANSACTION EVENT PARSING ERROR
 // ================================================================================================
 
-#[derive(Debug, Clone, Eq, PartialEq)]
+#[derive(Debug)]
 pub enum TransactionEventParsingError {
     InvalidTransactionEvent(u32),
     NotTransactionEvent(u32),
@@ -142,13 +141,12 @@ impl fmt::Display for TransactionEventParsingError {
     }
 }
 
-#[cfg(feature = "std")]
-impl std::error::Error for TransactionEventParsingError {}
+impl core::error::Error for TransactionEventParsingError {}
 
 // TRANSACTION TRACE PARSING ERROR
 // ================================================================================================
 
-#[derive(Debug, Clone, Eq, PartialEq)]
+#[derive(Debug)]
 pub enum TransactionTraceParsingError {
     InvalidTransactionTrace(u32),
     NotTransactionTrace(u32),
@@ -167,5 +165,4 @@ impl fmt::Display for TransactionTraceParsingError {
     }
 }
 
-#[cfg(feature = "std")]
-impl std::error::Error for TransactionTraceParsingError {}
+impl core::error::Error for TransactionTraceParsingError {}
diff --git a/miden-lib/src/transaction/mod.rs b/miden-lib/src/transaction/mod.rs
@@ -272,18 +272,18 @@ impl TransactionKernel {
         let final_account_data: &[Word] = group_slice_elements(
             adv_map
                 .get(&final_acct_hash)
-                .ok_or(TransactionOutputError::FinalAccountDataNotFound)?,
+                .ok_or(TransactionOutputError::FinalAccountHashMissingInAdviceMap)?,
         );
         let account = parse_final_account_header(final_account_data)
-            .map_err(TransactionOutputError::FinalAccountHeaderDataInvalid)?;
+            .map_err(TransactionOutputError::FinalAccountHeaderParseFailure)?;
 
         // validate output notes
         let output_notes = OutputNotes::new(output_notes)?;
         if output_notes_hash != output_notes.commitment() {
-            return Err(TransactionOutputError::OutputNotesCommitmentInconsistent(
-                output_notes_hash,
-                output_notes.commitment(),
-            ));
+            return Err(TransactionOutputError::OutputNotesCommitmentInconsistent {
+                actual: output_notes.commitment(),
+                expected: output_notes_hash,
+            });
         }
 
         Ok(TransactionOutputs {

diff --git a/miden-lib/src/transaction/outputs.rs b/miden-lib/src/transaction/outputs.rs
@@ -27,7 +27,10 @@ pub const EXPIRATION_BLOCK_ELEMENT_IDX: usize = 8;
 /// Returns a tuple of account ID, vault root, storage commitment, code commitment, and nonce.
 pub fn parse_final_account_header(elements: &[Word]) -> Result<AccountHeader, AccountError> {
     if elements.len() != ACCT_DATA_MEM_SIZE {
-        return Err(AccountError::HeaderDataIncorrectLength(elements.len(), ACCT_DATA_MEM_SIZE));
+        return Err(AccountError::HeaderDataIncorrectLength {
+            actual: elements.len(),
+            expected: ACCT_DATA_MEM_SIZE,
+        });
     }
 
     let id = AccountId::try_from(elements[ACCT_ID_AND_NONCE_OFFSET as usize][ACCT_ID_IDX])?;

diff --git a/miden-tx/Cargo.toml b/miden-tx/Cargo.toml
@@ -36,5 +36,6 @@ winter-maybe-async = { version = "0.10" }
 
 [dev-dependencies]
 assembly = { workspace = true }
+assert_matches = { workspace = true }
 miden-tx = { path = ".", features = ["testing"] }
 rand_chacha = { version = "0.3", default-features = false }
-Original file line number
+Diff line change
@@ Expand Up / @@ -39,3 +39,5 @@ impl std::fmt::Display for RemoteTransactionProverError { @@
             }
         }
     }
+    impl core::error::Error for RemoteTransactionProverError {}