cln-plugin 0.6.0

A CLN plugin library. Write your plugin in Rust.
Documentation 
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

#ifndef LIGHTNING_PLUGINS_OFFERS_H
#define LIGHTNING_PLUGINS_OFFERS_H
#include "config.h"

struct command_result;
struct command;
struct onion_message;
struct plugin;

/* plugin_data for this plugin */
struct offers_data {
	/* This is me. */
	struct pubkey id;
	/* --fetchinvoice-noconnect */
	bool disable_connect;
	/* --cltv-final */
	u16 cltv_final;
	/* Current header_count */
	u32 blockheight;
	/* Basis for invoice path_secrets */
	struct secret invoicesecret_base;
	/* Base for offers path_secrets */
	struct secret offerblinding_base;
	/* Base for node aliases for invoice requests */
	struct secret nodealias_base;
	/* Any --payment-fronting-node specified */
	struct pubkey *fronting_nodes;
	/* --dev-invoice-bpath-scid */
	bool dev_invoice_bpath_scid;
	/* --dev-invoice-internal-scid */
	struct short_channel_id *dev_invoice_internal_scid;
	/* Use get_gossmap() to access this! */
	struct gossmap *global_gossmap_;
};

struct offers_data *get_offers_data(struct plugin *plugin);

/* Helper to send a reply (connecting if required), and discard result */
struct command_result *WARN_UNUSED_RESULT
send_onion_reply(struct command *cmd,
		 struct blinded_path *reply_path,
		 struct tlv_onionmsg_tlv *payload);

/* Helper to send an onion message */
#define inject_onionmessage(cmd, omsg, success, fail, arg)		\
	inject_onionmessage_((cmd), (omsg),				\
			     typesafe_cb_preargs(struct command_result *, void *, \
						 (success), (arg),	\
						 struct command *,	\
						 const char *,		\
						 const char *,		\
						 const jsmntok_t *),	\
			     typesafe_cb_preargs(struct command_result *, void *, \
						 (fail), (arg),		\
						 struct command *,	\
						 const char *,		\
						 const char *,		\
						 const jsmntok_t *),	\
			     (arg))

struct command_result *
inject_onionmessage_(struct command *cmd,
		     const struct onion_message *omsg,
		     struct command_result *(*cb)(struct command *command,
						  const char *method,
						  const char *buf,
						  const jsmntok_t *result,
						  void *arg),
		     struct command_result *(*errcb)(struct command *command,
						     const char *method,
						     const char *buf,
						     const jsmntok_t *result,
						     void *arg),
		     void *arg);

/* Get the (latest) gossmap */
struct gossmap *get_gossmap(struct plugin *plugin);

/* Get the best (private) channel */
struct chaninfo {
	struct pubkey id;
	struct amount_msat capacity, htlc_min, htlc_max;
	u32 feebase, feeppm, cltv;
};

/* Calls listpeerchannels, then cb with best peer (if any!) which has needed_feature */
struct command_result *find_best_peer_(struct command *cmd,
				       u64 needed_features,
				       const struct pubkey *fronting_nodes,
				       struct command_result *(*cb)(struct command *,
								    const struct chaninfo *,
								    void *),
				       void *arg);

#define find_best_peer(cmd, needed_features, fronting_nodes, cb, arg)	\
	find_best_peer_((cmd), (needed_features), (fronting_nodes),	\
			typesafe_cb_preargs(struct command_result *, void *, \
					    (cb), (arg),		\
					    struct command *,		\
					    const struct chaninfo *),	\
			(arg))

/* Do we want a blinded path from a peer? */
bool we_want_blinded_path(struct plugin *plugin,
			  const struct pubkey *fronting_nodes,
			  bool for_payment);
#endif /* LIGHTNING_PLUGINS_OFFERS_H */