mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-01-07 14:29:33 +01:00
54c57e7495
When we support bolt12, this won't exist. We only need min_final_cltv_expiry, routes and features, so put them into struct payment explicitly. We move the default final ctlv out to the caller, too, which is clearer. e.g. keysend was using this value, but it was hard to tell. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
119 lines
3.2 KiB
C
119 lines
3.2 KiB
C
#ifndef LIGHTNING_COMMON_BOLT11_H
|
|
#define LIGHTNING_COMMON_BOLT11_H
|
|
#include "config.h"
|
|
|
|
#include <bitcoin/pubkey.h>
|
|
#include <bitcoin/short_channel_id.h>
|
|
#include <ccan/list/list.h>
|
|
#include <ccan/short_types/short_types.h>
|
|
#include <ccan/take/take.h>
|
|
#include <common/hash_u5.h>
|
|
#include <common/node_id.h>
|
|
#include <secp256k1_recovery.h>
|
|
|
|
/* We only have 10 bits for the field length, meaning < 640 bytes */
|
|
#define BOLT11_FIELD_BYTE_LIMIT ((1 << 10) * 5 / 8)
|
|
|
|
/* BOLT #11:
|
|
* * `c` (24): `data_length` variable.
|
|
* `min_final_cltv_expiry` to use for the last HTLC in the route.
|
|
* Default is 18 if not specified.
|
|
*/
|
|
#define DEFAULT_FINAL_CLTV_DELTA 18
|
|
|
|
struct feature_set;
|
|
|
|
struct bolt11_field {
|
|
struct list_node list;
|
|
|
|
char tag;
|
|
u5 *data;
|
|
};
|
|
|
|
/* BOLT #11:
|
|
* * `pubkey` (264 bits)
|
|
* * `short_channel_id` (64 bits)
|
|
* * `fee_base_msat` (32 bits, big-endian)
|
|
* * `fee_proportional_millionths` (32 bits, big-endian)
|
|
* * `cltv_expiry_delta` (16 bits, big-endian)
|
|
*/
|
|
|
|
struct route_info {
|
|
/* This is 33 bytes, so we pack cltv_expiry_delta next to it */
|
|
struct node_id pubkey;
|
|
u16 cltv_expiry_delta;
|
|
struct short_channel_id short_channel_id;
|
|
u32 fee_base_msat, fee_proportional_millionths;
|
|
};
|
|
|
|
struct bolt11 {
|
|
const struct chainparams *chain;
|
|
u64 timestamp;
|
|
struct amount_msat *msat; /* NULL if not specified. */
|
|
|
|
struct sha256 payment_hash;
|
|
struct node_id receiver_id;
|
|
|
|
/* description_hash valid if and only if description is NULL. */
|
|
const char *description;
|
|
struct sha256 *description_hash;
|
|
|
|
/* How many seconds to pay from @timestamp above. */
|
|
u64 expiry;
|
|
|
|
/* How many blocks final hop requires. */
|
|
u32 min_final_cltv_expiry;
|
|
|
|
/* If non-NULL, indicates fallback addresses to pay to. */
|
|
const u8 **fallbacks;
|
|
|
|
/* If non-NULL: array of route arrays */
|
|
struct route_info **routes;
|
|
|
|
/* signature of sha256 of entire thing. */
|
|
secp256k1_ecdsa_signature sig;
|
|
|
|
/* payment secret, if any. */
|
|
struct secret *payment_secret;
|
|
|
|
/* Features bitmap, if any. */
|
|
u8 *features;
|
|
|
|
struct list_head extra_fields;
|
|
};
|
|
|
|
/* Decodes and checks signature; returns NULL on error; description is
|
|
* (optional) out-of-band description of payment, for `h` field.
|
|
* fset is NULL to accept any features (usually not desirable!).
|
|
*
|
|
* if @must_be_chain is not NULL, fails unless it's this chain.
|
|
*/
|
|
struct bolt11 *bolt11_decode(const tal_t *ctx, const char *str,
|
|
const struct feature_set *our_features,
|
|
const char *description,
|
|
const struct chainparams *must_be_chain,
|
|
char **fail);
|
|
|
|
/* Initialize an empty bolt11 struct with optional amount */
|
|
struct bolt11 *new_bolt11(const tal_t *ctx,
|
|
const struct amount_msat *msat TAKES);
|
|
|
|
/* Encodes and signs, even if it's nonsense. */
|
|
char *bolt11_encode_(const tal_t *ctx,
|
|
const struct bolt11 *b11, bool n_field,
|
|
bool (*sign)(const u5 *u5bytes,
|
|
const u8 *hrpu8,
|
|
secp256k1_ecdsa_recoverable_signature *rsig,
|
|
void *arg),
|
|
void *arg);
|
|
|
|
#define bolt11_encode(ctx, b11, n_field, sign, arg) \
|
|
bolt11_encode_((ctx), (b11), (n_field), \
|
|
typesafe_cb_preargs(bool, void *, (sign), (arg), \
|
|
const u5 *, \
|
|
const u8 *, \
|
|
secp256k1_ecdsa_recoverable_signature *rsig), \
|
|
(arg))
|
|
|
|
#endif /* LIGHTNING_COMMON_BOLT11_H */
|