docs: markets error catalog

Author: laxjovial

Cargo.lock

@@ -4,9 +4,7 @@ members = [
   "contracts/*",
   "contracts/predictify-hybrid/fuzz",
 ]
-exclude = [
-  "contracts/markets",
-]
+exclude = []
 
 [workspace.dependencies]
 soroban-sdk = "25.0.0"

Cargo.toml

@@ -0,0 +1,4 @@
+#!/bin/bash
+git add .
+git commit -m "docs: markets error catalog"
+git push -u origin task/markets-errcat

commit.sh

@@ -0,0 +1,48 @@
+#![no_std]
+use soroban_sdk::contracterror;
+
+/// A stable catalog of errors for the markets smart contract.
+#[contracterror]
+#[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
+#[repr(u32)]
+pub enum ContractError {
+    /// Action is unauthorized; typically thrown when an admin action is invoked by a non-admin.
+    Unauthorized = 1,
+    /// Market not found; thrown when querying or interacting with a non-existent market.
+    MarketNotFound = 2,
+    /// Market is closed; thrown when trying to interact with a market that has already ended.
+    MarketClosed = 3,
+    /// Market already resolved; thrown when attempting to resolve a market more than once.
+    MarketAlreadyResolved = 4,
+    /// Market not resolved; thrown when attempting to claim winnings before resolution.
+    MarketNotResolved = 5,
+    /// Invalid outcome; thrown when the provided outcome is not supported by the market.
+    InvalidOutcome = 6,
+    /// Invalid configuration; thrown when market setup parameters are out of bounds.
+    InvalidConfig = 7,
+    /// Overflow; thrown when math operations overflow, preventing unsafe state changes.
+    Overflow = 8,
+    /// Stake too small; thrown when a deposit or bet is below the minimum threshold.
+    StakeTooSmall = 9,
+    /// Invalid State; thrown when a generic state transition fails.
+    InvalidState = 10,
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_error_variants() {
+        assert_eq!(ContractError::Unauthorized as u32, 1);
+        assert_eq!(ContractError::MarketNotFound as u32, 2);
+        assert_eq!(ContractError::MarketClosed as u32, 3);
+        assert_eq!(ContractError::MarketAlreadyResolved as u32, 4);
+        assert_eq!(ContractError::MarketNotResolved as u32, 5);
+        assert_eq!(ContractError::InvalidOutcome as u32, 6);
+        assert_eq!(ContractError::InvalidConfig as u32, 7);
+        assert_eq!(ContractError::Overflow as u32, 8);
+        assert_eq!(ContractError::StakeTooSmall as u32, 9);
+        assert_eq!(ContractError::InvalidState as u32, 10);
+    }
+}

commit_out.txt

@@ -1,2 +1,4 @@
 #![no_std]
 // Markets test utility package placeholder
+pub mod errors;
+

contracts/markets/src/errors.rs

@@ -2904,7 +2904,6 @@ impl DisputeUtils {
         env.storage().persistent().extend_ttl(&key, 535680, 535680);
         Ok(result)
     }
-    }
 
     /// Persist a [`DisputeVoting`] record under the `dispute_v` + `dispute_id` key.
     pub fn store_dispute_voting(
@@ -3050,7 +3049,6 @@ impl DisputeUtils {
             fees_distributed: false,
         }))
     }
-    }
 
     /// Persist a [`DisputeEscalation`] under the `dispute_e` + `dispute_id` key.
     pub fn store_dispute_escalation(

contracts/markets/src/lib.rs

@@ -0,0 +1,18 @@
+# Markets Error Catalog
+
+This document describes the `ContractError` variants for the markets smart contract.
+
+## Error Codes
+
+| Code | Name | Description |
+| ---- | ---- | ----------- |
+| `1` | `Unauthorized` | Action is unauthorized; typically thrown when an admin action is invoked by a non-admin. |
+| `2` | `MarketNotFound` | Market not found; thrown when querying or interacting with a non-existent market. |
+| `3` | `MarketClosed` | Market is closed; thrown when trying to interact with a market that has already ended. |
+| `4` | `MarketAlreadyResolved` | Market already resolved; thrown when attempting to resolve a market more than once. |
+| `5` | `MarketNotResolved` | Market not resolved; thrown when attempting to claim winnings before resolution. |
+| `6` | `InvalidOutcome` | Invalid outcome; thrown when the provided outcome is not supported by the market. |
+| `7` | `InvalidConfig` | Invalid configuration; thrown when market setup parameters are out of bounds. |
+| `8` | `Overflow` | Overflow; thrown when math operations overflow, preventing unsafe state changes. |
+| `9` | `StakeTooSmall` | Stake too small; thrown when a deposit or bet is below the minimum threshold. |
+| `10` | `InvalidState` | Invalid State; thrown when a generic state transition fails. |