Struct SendStateMachine

pub struct SendStateMachine {
    pub common: SendSMCommon,
    pub state: SendSMState,
}

Fields

common: SendSMCommon

state: SendSMState

Implementations

impl SendStateMachine

pub fn update(&self, state: SendSMState) -> Self

impl SendStateMachine

async fn await_funding( global_context: DynGlobalClientContext, txid: TransactionId, ) -> Result<(), String>

fn transition_funding( result: Result<(), String>, old_state: &SendStateMachine, ) -> SendStateMachine

async fn gateway_send_payment( gateway_api: SafeUrl, federation_id: FederationId, contract: OutgoingContract, invoice: LightningInvoice, refund_keypair: KeyPair, context: LightningClientContext, ) -> Result<[u8; 32], Signature>

async fn transition_gateway_send_payment( global_context: DynGlobalClientContext, dbtx: &mut ClientSMDatabaseTransaction<'_, '_>, gateway_response: Result<[u8; 32], Signature>, old_state: SendStateMachine, ) -> SendStateMachine

async fn await_preimage( global_context: DynGlobalClientContext, contract: OutgoingContract, ) -> Option<[u8; 32]>

async fn transition_preimage( dbtx: &mut ClientSMDatabaseTransaction<'_, '_>, global_context: DynGlobalClientContext, old_state: SendStateMachine, preimage: Option<[u8; 32]>, ) -> SendStateMachine

Trait Implementations

impl Clone for SendStateMachine

fn clone(&self) -> SendStateMachine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SendStateMachine

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

Formats the value using the given formatter.

impl Decodable for SendStateMachine

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode<R>( r: &mut R, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

where R: Read,

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

impl Encodable for SendStateMachine

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

fn consensus_encode_to_vec(&self) -> Vec<u8>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

impl Hash for SendStateMachine

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SendStateMachine

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl State for SendStateMachine

State machine that requests the lightning gateway to pay an invoice on behalf of a federation client.

graph LR classDef virtual fill:#fff,stroke-dasharray: 5 5 Funding -- funding tx is rejected --> Rejected Funding -- funding tx is accepted --> Funded Funded -- post invoice returns preimage --> Success Funded -- post invoice returns forfeit tx --> Refunding Funded -- await_preimage returns preimage --> Success Funded -- await_preimage expires --> Refunding

type ModuleContext = LightningClientContext

Additional resources made available in this module’s state transitions

fn transitions( &self, context: &Self::ModuleContext, global_context: &DynGlobalClientContext, ) -> Vec<StateTransition<Self>>

All possible transitions from the current state to other states. See StateTransition for details.

fn operation_id(&self) -> OperationId

Operation this state machine belongs to. See OperationId for details.

impl Eq for SendStateMachine

impl StructuralPartialEq for SendStateMachine