lightning/common/psbt_open.h

#ifndef LIGHTNING_COMMON_PSBT_OPEN_H
#define LIGHTNING_COMMON_PSBT_OPEN_H
#include "config.h"
#include <ccan/short_types/short_types.h>
#include <ccan/tal/tal.h>
#include <stdbool.h>
#include <wally_psbt.h>
#include <wally_transaction.h>

struct wally_tx_input;
struct wally_tx_output;
struct wally_psbt;
struct wally_psbt_input;
struct wally_psbt_output;
struct wally_map;

struct input_set {
	struct wally_tx_input tx_input;
	struct wally_psbt_input input;
};

struct output_set {
	struct wally_tx_output tx_output;
	struct wally_psbt_output output;
};

#define PSBT_TYPE_SERIAL_ID 0x01
#define PSBT_TYPE_MAX_WITNESS_LEN 0x02

/* psbt_get_serial_id - Returns the serial_id from an unknowns map
 *
 * @map - the map to find the serial id entry within
 * @serial_id - found serial_id
 *
 * Returns false if serial_id is not present
 */
WARN_UNUSED_RESULT bool psbt_get_serial_id(const struct wally_map *map,
					   u16 *serial_id);

/* psbt_sort_by_serial_id - Sort PSBT by serial_ids
 *
 * MUST have a serial_id on every input/output.
 *
 * @psbt - psbt to sort
 */
void psbt_sort_by_serial_id(struct wally_psbt *psbt);

/* psbt_has_diff - Returns set of diffs btw orig + new psbt
 *
 * All inputs+outputs MUST have a serial_id field present before
 * calling this.
 *
 * @ctx - allocation context for returned diffsets
 * @orig - original psbt
 * @new - updated psbt
 * @added_ins - inputs added {new}
 * @rm_ins - inputs removed {orig}
 * @added_outs - outputs added {new}
 * @rm_outs - outputs removed {orig}
 *
 * Note that the input + output data returned in the diff sets
 * contain references to the originating PSBT; they are not copies.
 *
 * Returns true if changes are found.
 */
bool psbt_has_diff(const tal_t *ctx,
		   struct wally_psbt *orig,
		   struct wally_psbt *new,
		   struct input_set **added_ins,
		   struct input_set **rm_ins,
		   struct output_set **added_outs,
		   struct output_set **rm_outs);

/* psbt_input_add_serial_id - Adds a serial id to given input
 *
 * @input - to add serial_id to
 * @serial_id - to add
 */
void psbt_input_add_serial_id(struct wally_psbt_input *input,
			       u16 serial_id);
/* psbt_output_add_serial_id - Adds a serial id to given output
 *
 * @output - to add serial_id to
 * @serial_id - to add
 */
void psbt_output_add_serial_id(struct wally_psbt_output *output,
			       u16 serial_id);

/* psbt_sort_by_serial_id - Sorts the inputs + outputs by serial_id
 *
 * Requires every input/output to have a serial_id entry.
 *
 * @psbt - psbt to sort inputs/outputs
 */
void psbt_sort_by_serial_id(struct wally_psbt *psbt);

/* psbt_has_serial_input - Checks inputs for provided serial_id
 *
 * @psbt - psbt's inputs to check
 * @serial_id - id to look for
 * Returns true if serial_id found.
 */
WARN_UNUSED_RESULT bool
psbt_has_serial_input(struct wally_psbt *psbt, u16 serial_id);

/* psbt_has_serial_output - Checks outputs for provided serial_id
 *
 * @psbt - psbt's outputs to check
 * @serial_id - id to look for
 * Returns true if serial_id found.
 */
WARN_UNUSED_RESULT bool
psbt_has_serial_output(struct wally_psbt *psbt, u16 serial_id);

/* psbt_input_add_max_witness_len - Put a max witness len on a thing
 *
 * @input - input to add max-witness-len to
 * @max_witness_len - value
 */
void psbt_input_add_max_witness_len(struct wally_psbt_input *input,
				    u16 max_witness_len);

/* psbt_input_get_max_witness_len - Get the max_witness_len
 *
 * @input - psbt input to look for max witness len on
 * @max_witness_len - found length
 *
 * Returns false if key not present */
WARN_UNUSED_RESULT bool
psbt_input_get_max_witness_len(struct wally_psbt_input *input,
			       u16 *max_witness_len);

/* psbt_has_required_fields - Validates psbt field completion
 *
 * Required fields are:
 * - a serial_id; input+output
 * - a prev_tx; input,non_witness_utxo
 * - redeemscript; input,iff is P2SH-P2W*
 * @psbt - psbt to validate
 *
 * Returns true if all required fields are present
 */
bool psbt_has_required_fields(struct wally_psbt *psbt);

#endif /* LIGHTNING_COMMON_PSBT_OPEN_H */