//! Error types live here.
-use std::str::FromStr;
-use std::ffi::c_void;
+use alloc::str::FromStr;
+use core::ffi::c_void;
use core::convert::Infallible;
use bitcoin::hashes::Hash;
use crate::c_types::*;
+#[cfg(feature="no-std")]
+use alloc::{vec::Vec, boxed::Box};
/// Indicates an error on the client's part (usually some variant of attempting to use too-low or
/// too-high values)
-#[must_use]
#[derive(Clone)]
+#[must_use]
#[repr(C)]
pub enum APIError {
/// Indicates the API was wholly misused (see err for more). Cases where these can be returned
/// A human-readable error message
err: crate::c_types::Str,
},
- /// An attempt to call watch/update_channel returned an Err (ie you did this!), causing the
- /// attempted action to fail.
- MonitorUpdateFailed,
+ /// An attempt to call [`chain::Watch::watch_channel`]/[`chain::Watch::update_channel`]
+ /// returned a [`ChannelMonitorUpdateStatus::InProgress`] indicating the persistence of a
+ /// monitor update is awaiting async resolution. Once it resolves the attempted action should
+ /// complete automatically.
+ ///
+ /// [`chain::Watch::watch_channel`]: crate::chain::Watch::watch_channel
+ /// [`chain::Watch::update_channel`]: crate::chain::Watch::update_channel
+ /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
+ MonitorUpdateInProgress,
/// [`KeysInterface::get_shutdown_scriptpubkey`] returned a shutdown scriptpubkey incompatible
/// with the channel counterparty as negotiated in [`InitFeatures`].
///
script: crate::lightning::ln::script::ShutdownScript,
},
}
-use lightning::util::errors::APIError as nativeAPIError;
+use lightning::util::errors::APIError as APIErrorImport;
+pub(crate) type nativeAPIError = APIErrorImport;
+
impl APIError {
#[allow(unused)]
pub(crate) fn to_native(&self) -> nativeAPIError {
err: err_nonref.into_string(),
}
},
- APIError::MonitorUpdateFailed => nativeAPIError::MonitorUpdateFailed,
+ APIError::MonitorUpdateInProgress => nativeAPIError::MonitorUpdateInProgress,
APIError::IncompatibleShutdownScript {ref script, } => {
let mut script_nonref = (*script).clone();
nativeAPIError::IncompatibleShutdownScript {
err: err.into_string(),
}
},
- APIError::MonitorUpdateFailed => nativeAPIError::MonitorUpdateFailed,
+ APIError::MonitorUpdateInProgress => nativeAPIError::MonitorUpdateInProgress,
APIError::IncompatibleShutdownScript {mut script, } => {
nativeAPIError::IncompatibleShutdownScript {
script: *unsafe { Box::from_raw(script.take_inner()) },
err: err_nonref.into(),
}
},
- nativeAPIError::MonitorUpdateFailed => APIError::MonitorUpdateFailed,
+ nativeAPIError::MonitorUpdateInProgress => APIError::MonitorUpdateInProgress,
nativeAPIError::IncompatibleShutdownScript {ref script, } => {
let mut script_nonref = (*script).clone();
APIError::IncompatibleShutdownScript {
err: err.into(),
}
},
- nativeAPIError::MonitorUpdateFailed => APIError::MonitorUpdateFailed,
+ nativeAPIError::MonitorUpdateInProgress => APIError::MonitorUpdateInProgress,
nativeAPIError::IncompatibleShutdownScript {mut script, } => {
APIError::IncompatibleShutdownScript {
script: crate::lightning::ln::script::ShutdownScript { inner: ObjOps::heap_alloc(script), is_owned: true },
}
}
#[no_mangle]
-/// Utility method to constructs a new MonitorUpdateFailed-variant APIError
-pub extern "C" fn APIError_monitor_update_failed() -> APIError {
- APIError::MonitorUpdateFailed}
+/// Utility method to constructs a new MonitorUpdateInProgress-variant APIError
+pub extern "C" fn APIError_monitor_update_in_progress() -> APIError {
+ APIError::MonitorUpdateInProgress}
#[no_mangle]
/// Utility method to constructs a new IncompatibleShutdownScript-variant APIError
pub extern "C" fn APIError_incompatible_shutdown_script(script: crate::lightning::ln::script::ShutdownScript) -> APIError {
script,
}
}
+/// Checks if two APIErrors contain equal inner contents.
+/// This ignores pointers and is_owned flags and looks at the values in fields.
+#[no_mangle]
+pub extern "C" fn APIError_eq(a: &APIError, b: &APIError) -> bool {
+ if &a.to_native() == &b.to_native() { true } else { false }
+}