Skip to main content

PriceResult

Enum PriceResult 

Source
pub enum PriceResult {
    Ok(PriceData),
    Err(u32),
}
Expand description

Result type for lastprice() that allows auto-halt to commit even on guardrail violations.

§Why a custom enum instead of Result<PriceData, OracleSafetyViolation>?

Soroban contract methods that return Result::Err cause all storage writes in the same invocation to roll back, including writes inside open_circuit_breaker(). The original Phase 5.2 design hit this and was reverted (commit e98ed48). By returning Ok(PriceResult::Err(...)) from the contract method, the breaker write commits while still conveying the violation to the caller.

§Why Err(u32) and not Err(OracleSafetyViolation)?

OracleSafetyViolation is a #[contracterror] type. soroban-sdk 25.x has two distinct constraints that block embedding it inside the #[contracttype] enum below — both empirically verified, the second not surfaced until Hardening 6C’s PoC:

  1. SorobanArbitrary bound (Pre-5.4 finding). Under the test feature soroban-sdk derives an Arbitrary prototype for every #[contracttype]. The derive recursively requires every variant’s payload to implement SorobanArbitrary, which #[contracterror] types do not — build fails with “trait bound OracleSafetyViolation: SorobanArbitrary is not satisfied.” Manual SorobanArbitrary impl on the error type is conceptually possible (the trait is pub, three trait bounds to satisfy).

  2. ScVec: TryFrom<(ScSymbol, &OracleSafetyViolation)> bound (Hardening 6C finding, deferred). Independent of the Arbitrary derive, the #[contracttype] macro’s XDR encoding expects each variant payload to be convertible into the tuple shape (ScSymbol, &T)ScVec. #[contracterror] types implement IntoVal<Env, Val> but not this specific tuple-to-XDR path. A manual impl is blocked by Rust’s orphan rule — both ScVec and (ScSymbol, &T) are foreign, so neither side of the TryFrom can host the impl from this crate. Closing this would require either (a) a soroban-sdk change exposing the conversion or (b) reshaping OracleSafetyViolation away from #[contracterror] (which would lose the stable u32 discriminants that integrators consume).

Carrying the violation as its u32 discriminant sidesteps both constraints. The values here MUST stay aligned with OracleSafetyViolation = 1..=10. The into_result() shim re-hydrates the typed variant for callers that want it. Hardening Phase debt #17 remains deferred for future SDK releases that resolve constraint (2).

§Migration from the Phase 1-4 Result<PriceData, OracleSafetyViolation>

Callers that used ? continue to do so via the into_result() shim:

// Before (Phase 1-4):
let price = safe_oracle::lastprice(&env, &asset, ...)?;

// After (Phase 5.2 v2):
let price = safe_oracle::lastprice(&env, &asset, ...).into_result()?;

From<Result<PriceData, OracleSafetyViolation>> is also implemented so internal helpers that produce Result (e.g., lastprice_inner) convert at the API boundary without per-callsite match plumbing.

§Audit notes

  • PriceResult::Err(d) is semantically identical to a guardrail failure. A lending protocol MUST NOT proceed with PriceResult::Err the same way it would not proceed with Err in Phase 1-4.
  • The Ok wrapping at the Soroban boundary is a storage-commit mechanism only; the public-facing semantics (“violation = no price”) are unchanged.
  • Tuple variants (not named-field) match the soroban-sdk 25.x #[contracttype] enum constraint observed in Phase 5.1.

§Spec

See spec §4 — Function Signature and Stub Contract. PriceResult preserves the spec’s lastprice → Ok(price) | Err(violation) semantic at the public API level (via PriceResult::into_result) while letting auto-halt writes inside lastprice commit at the Soroban boundary.

Variants§

§

Ok(PriceData)

Validated price data, all guardrails passed.

§

Err(u32)

Guardrail violation; price MUST NOT be used. The u32 is the OracleSafetyViolation discriminant (1..=10); see into_result() for the typed re-hydration.

Implementations§

Source§

impl PriceResult

Source

pub const fn spec_xdr() -> [u8; 1320]

Source§

impl PriceResult

Source

pub fn is_ok(&self) -> bool

Returns true if the result is Ok.

Source

pub fn is_err(&self) -> bool

Returns true if the result is Err.

Source

pub fn into_result(self) -> Result<PriceData, OracleSafetyViolation>

Convert to standard Rust Result for ergonomic ? operator usage.

Recommended migration path for Phase 1-4 callers: replace lastprice(...)? with lastprice(...).into_result()?.

Re-hydrates the u32 discriminant into the typed OracleSafetyViolation. Unknown discriminants panic — they cannot occur on a result produced by lastprice(), which only emits values from the canonical 1..=10 range, but the explicit panic guards against forged values reaching the shim.

Trait Implementations§

Source§

impl Clone for PriceResult

Source§

fn clone(&self) -> PriceResult

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PriceResult

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl From<Result<PriceData, OracleSafetyViolation>> for PriceResult

Source§

fn from(r: Result<PriceData, OracleSafetyViolation>) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for PriceResult

Source§

fn eq(&self, other: &PriceResult) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl TryFromVal<Env, &PriceResult> for Val

Source§

impl TryFromVal<Env, PriceResult> for Val

Source§

impl TryFromVal<Env, Val> for PriceResult

Source§

impl Eq for PriceResult

Source§

impl StructuralPartialEq for PriceResult

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, C> Compare<&T> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare(&self, a: &&T, b: &&T) -> Result<Ordering, <C as Compare<&T>>::Error>

Source§

impl<T, U, E, C> Compare<(T, U)> for C
where C: Compare<T, Error = E, Error = E> + Compare<U>,

Source§

type Error = E

Source§

fn compare( &self, a: &(T, U), b: &(T, U), ) -> Result<Ordering, <C as Compare<(T, U)>>::Error>

Source§

impl<T, U, V, E, C> Compare<(T, U, V)> for C
where C: Compare<T, Error = E, Error = E, Error = E> + Compare<U> + Compare<V>,

Source§

impl<T, U, V, W, E, C> Compare<(T, U, V, W)> for C
where C: Compare<T, Error = E, Error = E, Error = E, Error = E> + Compare<U> + Compare<V> + Compare<W>,

Source§

impl<T, U, V, W, X, E, C> Compare<(T, U, V, W, X)> for C
where C: Compare<T, Error = E, Error = E, Error = E, Error = E, Error = E> + Compare<U> + Compare<V> + Compare<W> + Compare<X>,

Source§

impl<T, C> Compare<Box<T>> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare( &self, a: &Box<T>, b: &Box<T>, ) -> Result<Ordering, <C as Compare<Box<T>>>::Error>

Source§

impl<T, C> Compare<Option<T>> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare( &self, a: &Option<T>, b: &Option<T>, ) -> Result<Ordering, <C as Compare<Option<T>>>::Error>

Source§

impl<T, C> Compare<Rc<T>> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare( &self, a: &Rc<T>, b: &Rc<T>, ) -> Result<Ordering, <C as Compare<Rc<T>>>::Error>

Source§

impl<T, C> Compare<Vec<T>> for C
where C: Compare<T>,

Source§

type Error = <C as Compare<T>>::Error

Source§

fn compare( &self, a: &Vec<T>, b: &Vec<T>, ) -> Result<Ordering, <C as Compare<Vec<T>>>::Error>

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<E, T, U> FromVal<E, T> for U
where E: Env, U: TryFromVal<E, T>,

Source§

fn from_val(e: &E, v: &T) -> U

Source§

impl<T> FromXdr for T
where T: TryFromVal<Env, Val>,

Source§

type Error = <T as TryFromVal<Env, Val>>::Error

The error type returned if the Val cannot be converted into the target type.
Source§

fn from_xdr(env: &Env, b: &Bytes) -> Result<T, <T as FromXdr>::Error>

Deserializes the value from XDR Bytes. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<E, T, U> IntoVal<E, T> for U
where E: Env, T: FromVal<E, U>,

Source§

fn into_val(&self, e: &E) -> T

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToXdr for T
where T: IntoVal<Env, Val>,

Source§

fn to_xdr(self, env: &Env) -> Bytes

Serializes the value to XDR as Bytes.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<E, T, U> TryIntoVal<E, T> for U
where E: Env, T: TryFromVal<E, U>,

Source§

type Error = <T as TryFromVal<E, U>>::Error

Source§

fn try_into_val(&self, env: &E) -> Result<T, <U as TryIntoVal<E, T>>::Error>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V