sp1-sdk 6.0.0-beta.1

SP1 is a performant, 100% open-source, contributor-friendly zkVM.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! # Network Validation
//!
//! This module provides validation functions for the network sdk.

use super::{FulfillmentStrategy, NetworkMode};

/// Errors that can occur during network validation.
#[derive(Debug, thiserror::Error)]
pub enum ValidationError {
    /// The fulfillment strategy is not compatible with the specified network mode.
    #[error("FulfillmentStrategy::{strategy:?} is not compatible with NetworkMode::{mode:?}")]
    IncompatibleStrategy {
        /// The fulfillment strategy that was attempted.
        strategy: FulfillmentStrategy,
        /// The network mode that was specified.
        mode: NetworkMode,
    },
}

/// Validates that the given fulfillment strategy is compatible with the specified network mode.
///
/// # Arguments
///
/// * `mode` - The network mode (Mainnet or Reserved)
/// * `strategy` - The fulfillment strategy to validate
///
/// # Returns
///
/// Returns `Ok(())` if the strategy is compatible with the mode, otherwise returns
/// a `ValidationError::IncompatibleStrategy`.
///
/// # Examples
///
/// ```
/// use sp1_sdk::network::{
///     validation::validate_strategy_compatibility, FulfillmentStrategy, NetworkMode,
/// };
///
/// // Valid combination
/// assert!(
///     validate_strategy_compatibility(NetworkMode::Mainnet, FulfillmentStrategy::Auction).is_ok()
/// );
///
/// // Invalid combination
/// assert!(
///     validate_strategy_compatibility(NetworkMode::Mainnet, FulfillmentStrategy::Hosted).is_err()
/// );
/// ```
pub fn validate_strategy_compatibility(
    mode: NetworkMode,
    strategy: FulfillmentStrategy,
) -> Result<(), ValidationError> {
    match (mode, strategy) {
        // Valid combinations.
        (NetworkMode::Mainnet, FulfillmentStrategy::Auction)
        | (NetworkMode::Reserved, FulfillmentStrategy::Hosted | FulfillmentStrategy::Reserved) => {
            Ok(())
        }

        // Invalid combinations.
        (mode, strategy) => Err(ValidationError::IncompatibleStrategy { strategy, mode }),
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_valid_combinations() {
        assert!(validate_strategy_compatibility(
            NetworkMode::Mainnet,
            FulfillmentStrategy::Auction
        )
        .is_ok());
        assert!(validate_strategy_compatibility(
            NetworkMode::Reserved,
            FulfillmentStrategy::Hosted
        )
        .is_ok());
        assert!(validate_strategy_compatibility(
            NetworkMode::Reserved,
            FulfillmentStrategy::Reserved
        )
        .is_ok());
    }

    #[test]
    fn test_invalid_combinations() {
        assert!(validate_strategy_compatibility(
            NetworkMode::Reserved,
            FulfillmentStrategy::Auction
        )
        .is_err());
        assert!(validate_strategy_compatibility(NetworkMode::Mainnet, FulfillmentStrategy::Hosted)
            .is_err());
        assert!(validate_strategy_compatibility(
            NetworkMode::Mainnet,
            FulfillmentStrategy::Reserved
        )
        .is_err());
    }
}