mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-03-12 02:08:15 +01:00
79ceb59d7a
In general, we should be using tmpctx unless there's a specific reason not to. It's clear, and simplifies the code somewhat. If tmpctx is not cleaned often enough, we can look at a per-MCF context, but this seems like premature optimization. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
94 lines
2.9 KiB
C
94 lines
2.9 KiB
C
#ifndef LIGHTNING_PLUGINS_ASKRENE_FLOW_H
|
|
#define LIGHTNING_PLUGINS_ASKRENE_FLOW_H
|
|
#include "config.h"
|
|
#include <bitcoin/short_channel_id.h>
|
|
#include <common/amount.h>
|
|
#include <common/gossmap.h>
|
|
|
|
struct plugin;
|
|
struct route_query;
|
|
|
|
/* An actual partial flow. */
|
|
struct flow {
|
|
const struct gossmap_chan **path;
|
|
/* The directions to traverse. */
|
|
int *dirs;
|
|
/* Amounts for this flow (fees mean this shrinks across path). */
|
|
double success_prob;
|
|
struct amount_msat amount;
|
|
};
|
|
|
|
const char *fmt_flows(const tal_t *ctx,
|
|
const struct route_query *rq,
|
|
struct flow **flows);
|
|
|
|
/* Helper to access the half chan at flow index idx */
|
|
const struct half_chan *flow_edge(const struct flow *flow, size_t idx);
|
|
|
|
/* A big number, meaning "don't bother" (not infinite, since you may add) */
|
|
#define FLOW_INF_COST 100000000.0
|
|
|
|
/* Cost function to send @f msat through @c in direction @dir,
|
|
* given we already have a flow of prev_flow. */
|
|
double flow_edge_cost(const struct gossmap *gossmap,
|
|
const struct gossmap_chan *c, int dir,
|
|
const struct amount_msat known_min,
|
|
const struct amount_msat known_max,
|
|
struct amount_msat prev_flow,
|
|
struct amount_msat f,
|
|
double mu,
|
|
double basefee_penalty,
|
|
double delay_riskfactor);
|
|
|
|
/* Compute the prob. of success of a set of concurrent set of flows. */
|
|
double flowset_probability(struct flow **flows,
|
|
const struct route_query *rq);
|
|
|
|
/* How much do we need to send to make this flow arrive. */
|
|
struct amount_msat flow_spend(struct plugin *plugin, const struct flow *flow);
|
|
|
|
/* How much do we pay in fees to make this flow arrive. */
|
|
struct amount_msat flow_fee(struct plugin *plugin, const struct flow *flow);
|
|
|
|
struct amount_msat flowset_fee(struct plugin *plugin, struct flow **flows);
|
|
|
|
struct amount_msat flowset_delivers(struct plugin *plugin,
|
|
struct flow **flows);
|
|
|
|
static inline struct amount_msat flow_delivers(const struct flow *flow)
|
|
{
|
|
return flow->amount;
|
|
}
|
|
|
|
/* FIXME: remove */
|
|
enum askrene_errorcode {
|
|
ASKRENE_NOERROR = 0,
|
|
|
|
ASKRENE_AMOUNT_OVERFLOW,
|
|
ASKRENE_CHANNEL_NOT_FOUND,
|
|
ASKRENE_BAD_CHANNEL,
|
|
ASKRENE_BAD_ALLOCATION,
|
|
ASKRENE_PRECONDITION_ERROR,
|
|
ASKRENE_UNEXPECTED,
|
|
};
|
|
|
|
/* Returns problematic channel, OR sets max_deliverable to non-zero amount */
|
|
const struct gossmap_chan *
|
|
flow_maximum_deliverable(struct amount_msat *max_deliverable,
|
|
const struct flow *flow,
|
|
const struct route_query *rq);
|
|
|
|
/* Assign the delivered amount to the flow if it fits
|
|
the path maximum capacity. Returns bad channel if max would be zero. */
|
|
const struct gossmap_chan *
|
|
flow_assign_delivery(struct flow *flow,
|
|
const struct route_query *rq,
|
|
struct amount_msat requested_amount);
|
|
|
|
double flow_probability(const struct flow *flow,
|
|
const struct route_query *rq);
|
|
|
|
u64 flow_delay(const struct flow *flow);
|
|
u64 flows_worst_delay(struct flow **flows);
|
|
|
|
#endif /* LIGHTNING_PLUGINS_ASKRENE_FLOW_H */
|