1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
#ifndef LIGHTNING_PLUGINS_FUNDER_POLICY_H
#define LIGHTNING_PLUGINS_FUNDER_POLICY_H
#include "config.h"
#include <common/amount.h>
struct plugin;
struct lease_rates;
struct node_id;
/* Policy Options */
enum funder_opt {
/* Use their_funding/requested_amt as the starting
* point for your contribution */
MATCH,
/* Use the 'available_funds' as the starting
* point for your contribution */
AVAILABLE,
/* Use a static amount */
FIXED,
};
struct funder_policy {
/* How to interpret/apply the 'mod' field */
enum funder_opt opt;
/* for MATCH/AVAILABLE, is a percent of base;
* for FIXED is the satoshi amount */
u64 mod;
/* `their_funding` must be this much or greater to activate
* the policy. Defaults to 10,000 sats */
struct amount_sat min_their_funding;
/* `their_funding` must be this amount or less to activate
* the policy. Defaults to MAX_UNITsats */
struct amount_sat max_their_funding;
/* Upper limit on amount to add. Defaults to
* `available_funds` */
struct amount_sat per_channel_max;
/* Lower limit on amount to add. Defaults to
* 10,000sat */
struct amount_sat per_channel_min;
/* Percent to fuzz by. Default is 5% */
u32 fuzz_factor;
/* Minimum amount to leave unused in `available_funds`.
* Note that this is presently best-effort due to concurrency.
* Default is 0msat */
struct amount_sat reserve_tank;
/* Percent of open offers we'll consider funding. */
u32 fund_probability;
/* If we're advertising liquidity, only
* provide funds for lease requests */
bool leases_only;
/* Rates we're currently charging for channel leases */
struct lease_rates *rates;
};
/* Get a new funder_policy, set to the defaults */
struct funder_policy *
default_funder_policy(const tal_t *ctx,
enum funder_opt policy,
u64 policy_mod);
/* Defaults to use for the lease_rates */
struct lease_rates *
default_lease_rates(const tal_t *ctx);
/* Given the policy and this request's details, figure
* out how much we should contribute to this channel */
const char *
calculate_our_funding(struct funder_policy *policy,
struct node_id id,
struct amount_sat their_funding,
struct amount_sat *our_last_funding,
struct amount_sat available_funds,
struct amount_sat channel_max,
struct amount_sat lease_request,
struct amount_sat *our_funding);
/* Get the name of this policy option */
const char *funder_opt_name(enum funder_opt opt);
/* Get a (short, for now) description of the provided policy */
const char *funder_policy_desc(const tal_t *ctx,
const struct funder_policy *policy);
/* Convert a cmdline option to a funding_opt */
char *funding_option(struct plugin *plugin, const char *arg, bool check_only,
enum funder_opt *opt);
/* Convert to JSON field */
bool jsonfmt_funding_option(struct plugin *plugin,
struct json_stream *js,
const char *fieldname,
enum funder_opt *opt);
/* Check policy settings, return error if fails */
char *funder_check_policy(const struct funder_policy *policy);
#endif /* LIGHTNING_PLUGINS_FUNDER_POLICY_H */