Struct fedimint_core::api::WsFederationApi
source · pub struct WsFederationApi<C = WsClient> { /* private fields */ }Expand description
Mint API client that will try to run queries against all peers expecting
equal results from at least min_eq_results of them. Peers that return
differing results are returned as a peer faults list.
Implementations§
source§impl WsFederationApi<WsClient>
impl WsFederationApi<WsClient>
sourcepub fn from_config(config: &ClientConfig) -> Self
pub fn from_config(config: &ClientConfig) -> Self
Creates a new API client from a client config
sourcepub fn from_invite_code(info: &[InviteCode]) -> Self
pub fn from_invite_code(info: &[InviteCode]) -> Self
Creates a new API client from a invite code, assumes they are in peer id order
Trait Implementations§
source§impl<C: Clone> Clone for WsFederationApi<C>
impl<C: Clone> Clone for WsFederationApi<C>
source§fn clone(&self) -> WsFederationApi<C>
fn clone(&self) -> WsFederationApi<C>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl<C: Debug> Debug for WsFederationApi<C>
impl<C: Debug> Debug for WsFederationApi<C>
source§impl<C: JsonRpcClient + Debug + 'static> IFederationApi for WsFederationApi<C>
impl<C: JsonRpcClient + Debug + 'static> IFederationApi for WsFederationApi<C>
Implementation of API calls over websockets
Can function as either the global or module API
source§fn all_peers(&self) -> &BTreeSet<PeerId>
fn all_peers(&self) -> &BTreeSet<PeerId>
List of all federation peers for the purpose of iterating each peer
in the federation. Read more
fn with_module(&self, id: ModuleInstanceId) -> DynModuleApi
source§fn request_raw<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
peer_id: PeerId,
method: &'life1 str,
params: &'life2 [Value]
) -> Pin<Box<dyn Future<Output = JsonRpcResult<Value>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
fn request_raw<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, peer_id: PeerId, method: &'life1 str, params: &'life2 [Value] ) -> Pin<Box<dyn Future<Output = JsonRpcResult<Value>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,
Make request to a specific federation peer by
peer_idimpl<C: JsonRpcClient + Debug + 'static> IGlobalFederationApi for WsFederationApi<C>
impl<C: JsonRpcClient + Debug + 'static> IModuleFederationApi for WsFederationApi<C>
Auto Trait Implementations§
impl<C = Client> !RefUnwindSafe for WsFederationApi<C>
impl<C> Send for WsFederationApi<C>where C: Send + Sync,
impl<C> Sync for WsFederationApi<C>where C: Send + Sync,
impl<C> Unpin for WsFederationApi<C>
impl<C = Client> !UnwindSafe for WsFederationApi<C>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Conv for T
impl<T> Conv for T
source§impl<T> FederationApiExt for Twhere
T: IFederationApi + ?Sized,
impl<T> FederationApiExt for Twhere T: IFederationApi + ?Sized,
source§fn request_with_strategy<'life0, 'async_trait, PeerRet, FedRet>(
&'life0 self,
strategy: impl 'async_trait + QueryStrategy<PeerRet, FedRet> + MaybeSend,
method: String,
params: ApiRequestErased
) -> Pin<Box<dyn Future<Output = FederationResult<FedRet>> + Send + 'async_trait>>where
PeerRet: 'async_trait + DeserializeOwned,
FedRet: 'async_trait + Debug,
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn request_with_strategy<'life0, 'async_trait, PeerRet, FedRet>( &'life0 self, strategy: impl 'async_trait + QueryStrategy<PeerRet, FedRet> + MaybeSend, method: String, params: ApiRequestErased ) -> Pin<Box<dyn Future<Output = FederationResult<FedRet>> + Send + 'async_trait>>where PeerRet: 'async_trait + DeserializeOwned, FedRet: 'async_trait + Debug, Self: Sync + 'async_trait, 'life0: 'async_trait,
Make an aggregate request to federation, using
strategy to logically
merge the responses.fn request_current_consensus<'life0, 'async_trait, Ret>( &'life0 self, method: String, params: ApiRequestErased ) -> Pin<Box<dyn Future<Output = FederationResult<Ret>> + Send + 'async_trait>>where Ret: DeserializeOwned + Eq + Debug + Clone + MaybeSend + 'async_trait, Self: Sync + 'async_trait, 'life0: 'async_trait,
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
source§impl<T> GlobalFederationApi for Twhere
T: IGlobalFederationApi + MaybeSend + MaybeSync + 'static + ?Sized,
impl<T> GlobalFederationApi for Twhere T: IGlobalFederationApi + MaybeSend + MaybeSync + 'static + ?Sized,
source§fn submit_transaction<'life0, 'async_trait>(
&'life0 self,
tx: Transaction
) -> Pin<Box<dyn Future<Output = Result<SerdeModuleEncoding<Result<TransactionId, TransactionError>>, FederationError>> + Send + 'async_trait>>where
'life0: 'async_trait,
T: 'async_trait,
fn submit_transaction<'life0, 'async_trait>( &'life0 self, tx: Transaction ) -> Pin<Box<dyn Future<Output = Result<SerdeModuleEncoding<Result<TransactionId, TransactionError>>, FederationError>> + Send + 'async_trait>>where 'life0: 'async_trait, T: 'async_trait,
Submit a transaction for inclusion
fn await_block<'life0, 'life1, 'async_trait>( &'life0 self, block_index: u64, decoders: &'life1 ModuleRegistry<Decoder, DecodingMode> ) -> Pin<Box<dyn Future<Output = Result<SessionOutcome, Error>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, T: 'async_trait,
fn session_count<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<u64, FederationError>> + Send + 'async_trait>>where 'life0: 'async_trait, T: 'async_trait,
fn await_transaction<'life0, 'async_trait>( &'life0 self, txid: TransactionId ) -> Pin<Box<dyn Future<Output = Result<TransactionId, FederationError>> + Send + 'async_trait>>where 'life0: 'async_trait, T: 'async_trait,
fn await_output_outcome<'life0, 'life1, 'async_trait, R>( &'life0 self, outpoint: OutPoint, timeout: Duration, module_decoder: &'life1 Decoder ) -> Pin<Box<dyn Future<Output = Result<R, OutputOutcomeError>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, R: OutputOutcome + 'async_trait, T: 'async_trait,
source§fn download_client_config<'life0, 'life1, 'async_trait>(
&'life0 self,
invite_code: &'life1 InviteCode
) -> Pin<Box<dyn Future<Output = Result<ClientConfig, FederationError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
T: 'async_trait,
fn download_client_config<'life0, 'life1, 'async_trait>( &'life0 self, invite_code: &'life1 InviteCode ) -> Pin<Box<dyn Future<Output = Result<ClientConfig, FederationError>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, T: 'async_trait,
Fetch client configuration info only if verified against a federation id
source§fn server_config_consensus_hash<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Hash, FederationError>> + Send + 'async_trait>>where
'life0: 'async_trait,
T: 'async_trait,
fn server_config_consensus_hash<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<Hash, FederationError>> + Send + 'async_trait>>where 'life0: 'async_trait, T: 'async_trait,
Fetches the server consensus hash if enough peers agree on it
fn upload_backup<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 SignedBackupRequest ) -> Pin<Box<dyn Future<Output = Result<(), FederationError>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, T: 'async_trait,
fn download_backup<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 PublicKey ) -> Pin<Box<dyn Future<Output = Result<Vec<ClientBackupSnapshot>, FederationError>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, T: 'async_trait,
source§fn discover_api_version_set<'life0, 'life1, 'async_trait>(
&'life0 self,
client_versions: &'life1 SupportedApiVersionsSummary
) -> Pin<Box<dyn Future<Output = Result<ApiVersionSet, FederationError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
T: 'async_trait,
fn discover_api_version_set<'life0, 'life1, 'async_trait>( &'life0 self, client_versions: &'life1 SupportedApiVersionsSummary ) -> Pin<Box<dyn Future<Output = Result<ApiVersionSet, FederationError>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, T: 'async_trait,
Query peers and calculate optimal common api versions to use.
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
Borrows
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
Borrows
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
Mutably borrows
self, then passes self.as_mut() into the pipe
function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Immutable access to the
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
Mutable access to the
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
Immutable access to the
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
Mutable access to the
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Immutable access to the
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Mutable access to the
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
Calls
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.