Struct DynGlobalClientContext

pub struct DynGlobalClientContext {
    pub(crate) inner: Arc<dyn IGlobalClientContext + Send + Sync + 'static>,
}

Global state and functionality provided to all state machines running in the client

Fields

inner: Arc<dyn IGlobalClientContext + Send + Sync + 'static>

Implementations

impl DynGlobalClientContext

pub fn get_mut(&mut self) -> Option<&mut <Self as Deref>::Target>

impl DynGlobalClientContext

pub fn new_fake() -> Self

pub async fn await_tx_accepted( &self, query_txid: TransactionId, ) -> Result<(), String>

pub async fn claim_input<I, S>( &self, dbtx: &mut ClientSMDatabaseTransaction<'_, '_>, input: ClientInput<I, S>, ) -> Result<(TransactionId, Vec<OutPoint>)>

where I: IInput + MaybeSend + MaybeSync + 'static, S: IState + MaybeSend + MaybeSync + 'static,

Creates a transaction that with an output of the primary module, claiming the given input and transferring its value into the client’s wallet.

The transactions submission state machine as well as the state machines responsible for the generated output are generated automatically. The caller is responsible for the input’s state machines, should there be any required.

pub async fn fund_output<O, S>( &self, dbtx: &mut ClientSMDatabaseTransaction<'_, '_>, output: ClientOutput<O, S>, ) -> Result<(TransactionId, Vec<OutPoint>)>

where O: IOutput + MaybeSend + MaybeSync + 'static, S: IState + MaybeSend + MaybeSync + 'static,

Creates a transaction with the supplied output and funding added by the primary module if possible. If the primary module does not have the required funds this function fails.

The transactions submission state machine as well as the state machines for the funding inputs are generated automatically. The caller is responsible for the output’s state machines, should there be any required.

pub async fn add_state_machine<S>( &self, dbtx: &mut ClientSMDatabaseTransaction<'_, '_>, sm: S, ) -> AddStateMachinesResult

where S: State + MaybeSend + MaybeSync + 'static,

Allows adding state machines from inside a transition to the executor. The added state machine belongs to the same module instance as the state machine from inside which it was spawned.

pub(crate) async fn log_event<E>( &self, dbtx: &mut ClientSMDatabaseTransaction<'_, '_>, event: E, )

where E: Event + Send,

Trait Implementations

impl Clone for DynGlobalClientContext

fn clone(&self) -> DynGlobalClientContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DynGlobalClientContext

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

Formats the value using the given formatter.

impl Deref for DynGlobalClientContext

type Target = dyn IGlobalClientContext + Sync + Send

The resulting type after dereferencing.

fn deref(&self) -> &<Self as Deref>::Target

Dereferences the value.

impl<T> From<Arc<T>> for DynGlobalClientContext

where T: IGlobalClientContext,

fn from(inner: Arc<T>) -> Self

Converts to this type from the input type.

impl<I> From<I> for DynGlobalClientContext

where I: IGlobalClientContext + MaybeSend + MaybeSync + 'static,

fn from(i: I) -> Self

Converts to this type from the input type.