Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Dual funding, PSBT work #3902

Merged
merged 14 commits into from
Aug 18, 2020
Merged

Dual funding, PSBT work #3902

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
c31f7f1
psbt: add helpers for creating + adding input/outputs
niftynei Jul 23, 2020
4f449d0
psbt: utilities for adding unknown info / proprietary c-lightning key…
niftynei Jul 23, 2020
764e512
pubkey: update comment to reflect location
niftynei Jul 23, 2020
6971ad4
psbt-common: shared psbt utilities
niftynei Jul 23, 2020
67662d2
psbt: re-use init function for create_psbt
niftynei Jul 31, 2020
1a4038d
psbt: rename append_out -> append_output
niftynei Aug 4, 2020
abc2e28
psbt-common: unit test for diff/sort/add serial etc
niftynei Aug 4, 2020
4c370ef
psbt-utils: ignore the 'unknown' map for input + output comparison
niftynei Aug 7, 2020
3e7f3e1
psbt: use elements input init alloc
niftynei Aug 13, 2020
7ca23a5
tx: use elements_input_init_alloc
niftynei Aug 13, 2020
17f6dd3
psbt: assertion for index in bounds
niftynei Aug 13, 2020
9090f78
psbt: use platform-independent serialization for psbt fields
niftynei Aug 13, 2020
ba040cd
libwally: update to latest master, includes map sort
niftynei Aug 13, 2020
f99dbfa
psbt: sort maps before serializing, to stabilize comparison
niftynei Aug 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 192 additions & 4 deletions bitcoin/psbt.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#include <bitcoin/signature.h>
#include <ccan/cast/cast.h>
#include <ccan/ccan/array_size/array_size.h>
#include <ccan/ccan/mem/mem.h>
#include <ccan/tal/str/str.h>
#include <common/amount.h>
#include <common/type_to_string.h>
Expand All @@ -21,17 +22,42 @@ void psbt_destroy(struct wally_psbt *psbt)
wally_psbt_free(psbt);
}

struct wally_psbt *new_psbt(const tal_t *ctx, const struct wally_tx *wtx)
static struct wally_psbt *init_psbt(const tal_t *ctx, size_t num_inputs, size_t num_outputs)
{
struct wally_psbt *psbt;
int wally_err;
struct wally_psbt *psbt;

if (is_elements(chainparams))
wally_err = wally_psbt_elements_init_alloc(0, wtx->num_inputs, wtx->num_outputs, 0, &psbt);
wally_err = wally_psbt_elements_init_alloc(0, num_inputs, num_outputs, 0, &psbt);
else
wally_err = wally_psbt_init_alloc(0, wtx->num_inputs, wtx->num_outputs, 0, &psbt);
wally_err = wally_psbt_init_alloc(0, num_inputs, num_outputs, 0, &psbt);
assert(wally_err == WALLY_OK);
tal_add_destructor(psbt, psbt_destroy);
return tal_steal(ctx, psbt);
}

struct wally_psbt *create_psbt(const tal_t *ctx, size_t num_inputs, size_t num_outputs)
{
int wally_err;
struct wally_tx *wtx;
struct wally_psbt *psbt;

if (wally_tx_init_alloc(WALLY_TX_VERSION_2, 0, num_inputs, num_outputs, &wtx) != WALLY_OK)
abort();

psbt = init_psbt(ctx, num_inputs, num_outputs);

wally_err = wally_psbt_set_global_tx(psbt, wtx);
assert(wally_err == WALLY_OK);
return psbt;
}

struct wally_psbt *new_psbt(const tal_t *ctx, const struct wally_tx *wtx)
{
struct wally_psbt *psbt;
int wally_err;

psbt = init_psbt(ctx, wtx->num_inputs, wtx->num_outputs);

/* Set directly: avoids psbt checks for non-NULL scripts/witnesses */
wally_err = wally_tx_clone_alloc(wtx, 0, &psbt->tx);
Expand Down Expand Up @@ -80,6 +106,28 @@ struct wally_psbt_input *psbt_add_input(struct wally_psbt *psbt,
return &psbt->inputs[insert_at];
}

struct wally_psbt_input *psbt_append_input(struct wally_psbt *psbt,
const struct bitcoin_txid *txid,
u32 outnum, u32 sequence)
{
struct wally_tx_input *tx_in;
struct wally_psbt_input *input;
size_t insert_at;

insert_at = psbt->num_inputs;

if (wally_tx_input_init_alloc(txid->shad.sha.u.u8,
sizeof(struct bitcoin_txid),
outnum, sequence, NULL, 0, NULL,
&tx_in) != WALLY_OK)
abort();

tx_in->features = chainparams->is_elements ? WALLY_TX_IS_ELEMENTS : 0;
input = psbt_add_input(psbt, tx_in, insert_at);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

features is an internal impl detail and we may end up using it for more than just elements. please use wally_tx_elements_input_init_alloc for elements instead.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ack, updated

wally_tx_input_free(tx_in);
return input;
}

void psbt_rm_input(struct wally_psbt *psbt,
size_t remove_at)
{
Expand All @@ -96,6 +144,18 @@ struct wally_psbt_output *psbt_add_output(struct wally_psbt *psbt,
return &psbt->outputs[insert_at];
}

struct wally_psbt_output *psbt_append_output(struct wally_psbt *psbt,
const u8 *script,
struct amount_sat amount)
{
struct wally_psbt_output *out;
struct wally_tx_output *tx_out = wally_tx_output(script, amount);

out = psbt_add_output(psbt, tx_out, psbt->tx->num_outputs);
wally_tx_output_free(tx_out);
return out;
}

void psbt_rm_output(struct wally_psbt *psbt,
size_t remove_at)
{
Expand Down Expand Up @@ -298,6 +358,24 @@ void psbt_elements_input_init(struct wally_psbt *psbt, size_t in,
abort();
}

bool psbt_has_input(struct wally_psbt *psbt,
struct bitcoin_txid *txid,
u32 outnum)
{
for (size_t i = 0; i < psbt->num_inputs; i++) {
struct bitcoin_txid in_txid;
struct wally_tx_input *in = &psbt->tx->inputs[i];

if (outnum != in->index)
continue;

wally_tx_input_get_txid(in, &in_txid);
if (bitcoin_txid_eq(txid, &in_txid))
return true;
}
return false;
}

bool psbt_input_set_redeemscript(struct wally_psbt *psbt, size_t in,
const u8 *redeemscript)
{
Expand Down Expand Up @@ -329,6 +407,114 @@ struct amount_sat psbt_input_get_amount(struct wally_psbt *psbt,
return val;
}

struct amount_sat psbt_output_get_amount(struct wally_psbt *psbt,
size_t out)
{
struct amount_asset asset;
assert(out < psbt->num_outputs);
asset = wally_tx_output_get_amount(&psbt->tx->outputs[out]);
assert(amount_asset_is_main(&asset));
return amount_asset_to_sat(&asset);
}

static void add(u8 **key, const void *mem, size_t len)
{
size_t oldlen = tal_count(*key);
tal_resize(key, oldlen + len);
memcpy(*key + oldlen, memcheck(mem, len), len);
}

static void add_type(u8 **key, const u8 num)
{
add(key, &num, 1);
}

static void add_varint(u8 **key, size_t val)
{
u8 vt[VARINT_MAX_LEN];
size_t vtlen;
vtlen = varint_put(vt, val);
add(key, vt, vtlen);
}

#define LIGHTNING_PROPRIETARY_PREFIX "lightning"

u8 *psbt_make_key(const tal_t *ctx, u8 key_subtype, const u8 *key_data)
{
/**
* BIP174:
* Type: Proprietary Use Type <tt>PSBT_GLOBAL_PROPRIETARY = 0xFC</tt>
** Key: Variable length identifier prefix, followed
* by a subtype, followed by the key data itself.
*** <tt>{0xFC}|<prefix>|{subtype}|{key data}</tt>
** Value: Any value data as defined by the proprietary type user.
*** <tt><data></tt>
*/
u8 *key = tal_arr(ctx, u8, 0);
add_type(&key, PSBT_PROPRIETARY_TYPE);
add_varint(&key, strlen(LIGHTNING_PROPRIETARY_PREFIX));
add(&key, LIGHTNING_PROPRIETARY_PREFIX,
strlen(LIGHTNING_PROPRIETARY_PREFIX));
add_type(&key, key_subtype);
if (key_data)
add(&key, key_data, tal_bytelen(key_data));
return key;
}

void psbt_input_add_unknown(struct wally_psbt_input *in,
const u8 *key,
const void *value,
size_t value_len)
{
if (wally_map_add(&in->unknowns,
cast_const(unsigned char *, key), tal_bytelen(key),
(unsigned char *) memcheck(value, value_len), value_len)
!= WALLY_OK)
abort();
}

void *psbt_get_unknown(const struct wally_map *map,
const u8 *key,
size_t *val_len)
{
size_t index;

if (wally_map_find(map, key, tal_bytelen(key), &index) != WALLY_OK)
return NULL;

/* Zero: item not found. */
if (index == 0)
return NULL;

/* ++: item is at this index minus 1 */
*val_len = map->items[index - 1].value_len;
return map->items[index - 1].value;
}

void *psbt_get_lightning(const struct wally_map *map,
const u8 proprietary_type,
size_t *val_len)
{
void *res;
u8 *key = psbt_make_key(NULL, proprietary_type, NULL);
res = psbt_get_unknown(map, key, val_len);
tal_free(key);
return res;
}


void psbt_output_add_unknown(struct wally_psbt_output *out,
const u8 *key,
const void *value,
size_t value_len)
{
if (wally_map_add(&out->unknowns,
cast_const(unsigned char *, key), tal_bytelen(key),
(unsigned char *) memcheck(value, value_len), value_len)
!= WALLY_OK)
abort();
}

struct wally_tx *psbt_finalize(struct wally_psbt *psbt, bool finalize_in_place)
{
struct wally_psbt *tmppsbt;
Expand Down Expand Up @@ -389,6 +575,8 @@ char *psbt_to_b64(const tal_t *ctx, const struct wally_psbt *psbt)
wally_free_string(serialized_psbt);
return ret_val;
}

/* Do not remove this line, it is magic */
REGISTER_TYPE_TO_STRING(wally_psbt, psbt_to_b64);

const u8 *psbt_get_bytes(const tal_t *ctx, const struct wally_psbt *psbt,
Expand Down
Loading