Skip to main content

Module builder

Module builder 

Source

Structsยง

ClientInput
ClientInputBundle
A group of inputs and state machines responsible for driving their state
ClientInputSM
ClientOutput
ClientOutputBundle
ClientOutputSM
FeeQuote
Breakdown of the fee finalizing a transaction would incur, as computed by Client::fee_quote (a dry-run of the same balancing the real submission performs).
FeeQuoteRequest
The explicit (operation-supplied) side of a transaction, summarized for a fee quote via Client::fee_quote.
TransactionBuilder

Enumsยง

NeverClientContext
A fake sm::Context for NeverClientStateMachine
NeverClientStateMachine
A fake sm::State that can actually never happen.

Functionsยง

find_range_of_matching_items ๐Ÿ”’
Find the range of indexes in an monotonically increasing arr, that is equal to item
max_affordable_send_amount
Finds the largest send amount payable in full out of balance when the payment carries both an external per-amount fee (e.g. a Lightning gateway routing fee) and the on-federation transaction fee.
send_amount_affordable ๐Ÿ”’
Whether sending amount is payable in full out of balance: the funded value gross_up(amount) plus its federation fee_quote must fit within the balance. A quote error (the balance cannot fund a value this large) counts as unaffordable, making this safe as the monotone predicate for max_affordable_send_amount.
state_gen_to_dyn ๐Ÿ”’