#include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include void psbt_destroy(struct wally_psbt *psbt) { wally_psbt_free(psbt); } static struct wally_psbt *init_psbt(const tal_t *ctx, size_t num_inputs, size_t num_outputs) { int wally_err; struct wally_psbt *psbt; tal_wally_start(); if (is_elements(chainparams)) wally_err = wally_psbt_elements_init_alloc(0, num_inputs, num_outputs, 0, &psbt); else wally_err = wally_psbt_init_alloc(0, num_inputs, num_outputs, 0, &psbt); assert(wally_err == WALLY_OK); tal_add_destructor(psbt, psbt_destroy); tal_wally_end(tal_steal(ctx, psbt)); return psbt; } struct wally_psbt *create_psbt(const tal_t *ctx, size_t num_inputs, size_t num_outputs, u32 locktime) { int wally_err; struct wally_tx *wtx; struct wally_psbt *psbt; tal_wally_start(); if (wally_tx_init_alloc(WALLY_TX_VERSION_2, locktime, num_inputs, num_outputs, &wtx) != WALLY_OK) abort(); /* wtx is freed below */ tal_wally_end(NULL); psbt = init_psbt(ctx, num_inputs, num_outputs); tal_wally_start(); wally_err = wally_psbt_set_global_tx(psbt, wtx); assert(wally_err == WALLY_OK); tal_wally_end(psbt); wally_tx_free(wtx); 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); tal_wally_start(); /* Set directly: avoids psbt checks for non-NULL scripts/witnesses */ wally_err = wally_tx_clone_alloc(wtx, 0, &psbt->tx); assert(wally_err == WALLY_OK); /* Inputs/outs are pre-allocated above, 'add' them as empty dummies */ psbt->num_inputs = wtx->num_inputs; psbt->num_outputs = wtx->num_outputs; for (size_t i = 0; i < wtx->num_inputs; i++) { /* add these scripts + witnesses to the psbt */ if (wtx->inputs[i].script) { wally_err = wally_psbt_input_set_final_scriptsig(&psbt->inputs[i], wtx->inputs[i].script, wtx->inputs[i].script_len); assert(wally_err == WALLY_OK); } if (wtx->inputs[i].witness) { wally_err = wally_psbt_input_set_final_witness(&psbt->inputs[i], wtx->inputs[i].witness); assert(wally_err == WALLY_OK); } } tal_wally_end(psbt); return psbt; } bool psbt_is_finalized(const struct wally_psbt *psbt) { size_t is_finalized; int wally_err = wally_psbt_is_finalized(psbt, &is_finalized); assert(wally_err == WALLY_OK); return is_finalized ? true : false; } struct wally_psbt_input *psbt_add_input(struct wally_psbt *psbt, struct wally_tx_input *input, size_t insert_at) { const u32 flags = WALLY_PSBT_FLAG_NON_FINAL; /* Skip script/witness */ int wally_err; tal_wally_start(); wally_err = wally_psbt_add_input_at(psbt, insert_at, flags, input); assert(wally_err == WALLY_OK); tal_wally_end(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, const u8 *scriptSig, const u8 *input_wscript, const u8 *redeemscript) { struct wally_tx_input *tx_in; size_t input_num = psbt->num_inputs; const u32 flags = WALLY_PSBT_FLAG_NON_FINAL; /* Skip script/witness */ int wally_err; tal_wally_start(); if (chainparams->is_elements) { if (wally_tx_elements_input_init_alloc(txid->shad.sha.u.u8, sizeof(txid->shad.sha.u.u8), outnum, sequence, NULL, 0, NULL, NULL, 0, NULL, 0, NULL, 0, NULL, 0, NULL, 0, NULL, 0, NULL, &tx_in) != WALLY_OK) abort(); } else { if (wally_tx_input_init_alloc(txid->shad.sha.u.u8, sizeof(txid->shad.sha.u.u8), outnum, sequence, NULL, 0, NULL, &tx_in) != WALLY_OK) abort(); } wally_err = wally_psbt_add_input_at(psbt, input_num, flags, tx_in); assert(wally_err == WALLY_OK); wally_tx_input_free(tx_in); tal_wally_end(psbt); if (input_wscript) { /* Add the prev output's data into the PSBT struct */ psbt_input_set_witscript(psbt, input_num, input_wscript); } if (redeemscript) { tal_wally_start(); wally_err = wally_psbt_input_set_redeem_script(&psbt->inputs[input_num], redeemscript, tal_bytelen(redeemscript)); assert(wally_err == WALLY_OK); tal_wally_end(psbt); } return &psbt->inputs[input_num]; } void psbt_rm_input(struct wally_psbt *psbt, size_t remove_at) { int wally_err = wally_psbt_remove_input(psbt, remove_at); assert(wally_err == WALLY_OK); } struct wally_psbt_output *psbt_add_output(struct wally_psbt *psbt, struct wally_tx_output *output, size_t insert_at) { int wally_err; tal_wally_start(); wally_err = wally_psbt_add_output_at(psbt, insert_at, 0, output); assert(wally_err == WALLY_OK); tal_wally_end(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(NULL, script, amount); out = psbt_add_output(psbt, tx_out, psbt->tx->num_outputs); wally_tx_output_free(tx_out); return out; } struct wally_psbt_output *psbt_insert_output(struct wally_psbt *psbt, const u8 *script, struct amount_sat amount, size_t insert_at) { struct wally_psbt_output *out; struct wally_tx_output *tx_out = wally_tx_output(NULL, script, amount); out = psbt_add_output(psbt, tx_out, insert_at); wally_tx_output_free(tx_out); return out; } void psbt_rm_output(struct wally_psbt *psbt, size_t remove_at) { int wally_err = wally_psbt_remove_output(psbt, remove_at); assert(wally_err == WALLY_OK); } void psbt_input_add_pubkey(struct wally_psbt *psbt, size_t in, const struct pubkey *pubkey) { int wally_err; u32 empty_path[1] = {0}; unsigned char fingerprint[4]; struct ripemd160 hash; u8 pk_der[PUBKEY_CMPR_LEN]; assert(in < psbt->num_inputs); /* Find the key identifier fingerprint: * the first 32 bits of the identifier, where the identifier * is the hash160 of the ECDSA serialized public key * https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#key-identifiers * */ pubkey_to_hash160(pubkey, &hash); memcpy(fingerprint, hash.u.u8, sizeof(fingerprint)); /* we serialize the compressed version of the key, wally likes this */ pubkey_to_der(pk_der, pubkey); tal_wally_start(); wally_err = wally_psbt_input_add_keypath_item(&psbt->inputs[in], pk_der, sizeof(pk_der), fingerprint, sizeof(fingerprint), empty_path, ARRAY_SIZE(empty_path)); assert(wally_err == WALLY_OK); tal_wally_end(psbt); } bool psbt_input_set_signature(struct wally_psbt *psbt, size_t in, const struct pubkey *pubkey, const struct bitcoin_signature *sig) { u8 pk_der[PUBKEY_CMPR_LEN]; bool ok; assert(in < psbt->num_inputs); /* we serialize the compressed version of the key, wally likes this */ pubkey_to_der(pk_der, pubkey); tal_wally_start(); wally_psbt_input_set_sighash(&psbt->inputs[in], sig->sighash_type); ok = wally_psbt_input_add_signature(&psbt->inputs[in], pk_der, sizeof(pk_der), sig->s.data, sizeof(sig->s.data)) == WALLY_OK; tal_wally_end(psbt); return ok; } void psbt_input_set_wit_utxo(struct wally_psbt *psbt, size_t in, const u8 *scriptPubkey, struct amount_sat amt) { struct wally_tx_output *tx_out; int wally_err; assert(in < psbt->num_inputs); assert(tal_bytelen(scriptPubkey) > 0); tal_wally_start(); if (is_elements(chainparams)) { u8 value[9]; wally_err = wally_tx_confidential_value_from_satoshi(amt.satoshis, /* Raw: wally API */ value, sizeof(value)); assert(wally_err == WALLY_OK); wally_err = wally_tx_elements_output_init_alloc(scriptPubkey, tal_bytelen(scriptPubkey), chainparams->fee_asset_tag, ELEMENTS_ASSET_LEN, value, sizeof(value), NULL, 0, NULL, 0, NULL, 0, &tx_out); } else wally_err = wally_tx_output_init_alloc(amt.satoshis, /* Raw: type conv */ scriptPubkey, tal_bytelen(scriptPubkey), &tx_out); assert(wally_err == WALLY_OK); wally_err = wally_psbt_input_set_witness_utxo(&psbt->inputs[in], tx_out); wally_tx_output_free(tx_out); assert(wally_err == WALLY_OK); tal_wally_end(psbt); } void psbt_input_set_utxo(struct wally_psbt *psbt, size_t in, const struct wally_tx *prev_tx) { int wally_err; tal_wally_start(); wally_err = wally_psbt_input_set_utxo(&psbt->inputs[in], prev_tx); tal_wally_end(psbt); assert(wally_err == WALLY_OK); } void psbt_input_set_witscript(struct wally_psbt *psbt, size_t in, const u8 *wscript) { int wally_err; tal_wally_start(); wally_err = wally_psbt_input_set_witness_script(&psbt->inputs[in], wscript, tal_bytelen(wscript)); assert(wally_err == WALLY_OK); tal_wally_end(psbt); } void psbt_elements_input_set_asset(struct wally_psbt *psbt, size_t in, struct amount_asset *asset) { tal_wally_start(); if (asset->value > 0) if (wally_psbt_input_set_value(&psbt->inputs[in], asset->value) != WALLY_OK) abort(); /* PSET expects an asset tag without the prefix */ if (wally_psbt_input_set_asset(&psbt->inputs[in], asset->asset + 1, ELEMENTS_ASSET_LEN - 1) != WALLY_OK) abort(); tal_wally_end(psbt); } void psbt_elements_normalize_fees(struct wally_psbt *psbt) { struct amount_asset asset; size_t fee_output_idx = psbt->num_outputs; if (!is_elements(chainparams)) return; /* Elements requires that every input value is accounted for, * including the fees */ struct amount_sat total_in = AMOUNT_SAT(0), val; for (size_t i = 0; i < psbt->num_inputs; i++) { val = psbt_input_get_amount(psbt, i); if (!amount_sat_add(&total_in, total_in, val)) return; } for (size_t i = 0; i < psbt->num_outputs; i++) { asset = wally_tx_output_get_amount(&psbt->tx->outputs[i]); if (elements_wtx_output_is_fee(psbt->tx, i)) { if (fee_output_idx == psbt->num_outputs) { fee_output_idx = i; continue; } /* We already have at least one fee output, * remove this one */ psbt_rm_output(psbt, i--); continue; } if (!amount_asset_is_main(&asset)) continue; if (!amount_sat_sub(&total_in, total_in, amount_asset_to_sat(&asset))) return; } if (amount_sat_eq(total_in, AMOUNT_SAT(0))) return; /* We need to add a fee output */ if (fee_output_idx == psbt->num_outputs) { psbt_append_output(psbt, NULL, total_in); } else { u64 sats = total_in.satoshis; /* Raw: wally API */ struct wally_tx_output *out = &psbt->tx->outputs[fee_output_idx]; if (wally_tx_confidential_value_from_satoshi( sats, out->value, out->value_len) != WALLY_OK) return; } } bool psbt_has_input(const struct wally_psbt *psbt, const 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) { int wally_err; assert(psbt->num_inputs > in); wally_err = wally_psbt_input_set_redeem_script(&psbt->inputs[in], redeemscript, tal_bytelen(redeemscript)); return wally_err == WALLY_OK; } struct amount_sat psbt_input_get_amount(const struct wally_psbt *psbt, size_t in) { struct amount_sat val; assert(in < psbt->num_inputs); if (psbt->inputs[in].witness_utxo) { struct amount_asset amt_asset = wally_tx_output_get_amount(psbt->inputs[in].witness_utxo); assert(amount_asset_is_main(&amt_asset)); val = amount_asset_to_sat(&amt_asset); } else if (psbt->inputs[in].utxo) { int idx = psbt->tx->inputs[in].index; struct wally_tx *prev_tx = psbt->inputs[in].utxo; val = amount_sat(prev_tx->outputs[idx].satoshi); } else abort(); return val; } struct amount_sat psbt_output_get_amount(const 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 PSBT_GLOBAL_PROPRIETARY = 0xFC ** Key: Variable length identifier prefix, followed * by a subtype, followed by the key data itself. *** {0xFC}||{subtype}|{key data} ** Value: Any value data as defined by the proprietary type user. *** */ 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; } static bool wally_map_set_unknown(const tal_t *ctx, struct wally_map *map, const u8 *key, const void *value, size_t value_len) { size_t exists_at; struct wally_map_item *item; assert(value_len != 0); if (wally_map_find(map, cast_const(unsigned char *, key), tal_bytelen(key), &exists_at) != WALLY_OK) return false; /* If not exists, add */ if (exists_at == 0) { bool ok; tal_wally_start(); ok = wally_map_add(map, cast_const(unsigned char *, key), tal_bytelen(key), (unsigned char *) memcheck(value, value_len), value_len) == WALLY_OK; tal_wally_end(ctx); return ok; } /* Already in map, update entry */ item = &map->items[exists_at - 1]; tal_resize(&item->value, value_len); memcpy(item->value, memcheck(value, value_len), value_len); item->value_len = value_len; return true; } void psbt_input_set_unknown(const tal_t *ctx, struct wally_psbt_input *in, const u8 *key, const void *value, size_t value_len) { if (!wally_map_set_unknown(ctx, &in->unknowns, key, value, value_len)) 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_set_unknown(const tal_t *ctx, struct wally_psbt_output *out, const u8 *key, const void *value, size_t value_len) { if (!wally_map_set_unknown(ctx, &out->unknowns, key, value, value_len)) abort(); } /* Use the destructor to free the wally_tx */ static void wally_tx_destroy(struct wally_tx *wtx) { wally_tx_free(wtx); } bool psbt_finalize(struct wally_psbt *psbt) { bool ok; tal_wally_start(); /* Wally doesn't know how to finalize P2WSH; this happens with * option_anchor_outputs, and finalizing is trivial. */ /* FIXME: miniscript! miniscript! miniscript! */ for (size_t i = 0; i < psbt->num_inputs; i++) { struct wally_psbt_input *input = &psbt->inputs[i]; struct wally_tx_witness_stack *stack; if (!is_anchor_witness_script(input->witness_script, input->witness_script_len)) continue; if (input->signatures.num_items != 1) continue; /* BOLT #3: * #### `to_remote` Output * * If `option_anchor_outputs` applies to the commitment * transaction, the `to_remote` output is encumbered by a one * block csv lock. * * OP_CHECKSIGVERIFY 1 OP_CHECKSEQUENCEVERIFY * * The output is spent by an input with `nSequence` * field set to `1` and witness: * * */ wally_tx_witness_stack_init_alloc(2, &stack); wally_tx_witness_stack_add(stack, input->signatures.items[0].value, input->signatures.items[0].value_len); wally_tx_witness_stack_add(stack, input->witness_script, input->witness_script_len); input->final_witness = stack; } ok = (wally_psbt_finalize(psbt) == WALLY_OK); tal_wally_end(psbt); return ok && psbt_is_finalized(psbt); } struct wally_tx *psbt_final_tx(const tal_t *ctx, const struct wally_psbt *psbt) { struct wally_tx *wtx; if (!psbt_is_finalized(psbt)) return NULL; tal_wally_start(); if (wally_psbt_extract(psbt, &wtx) == WALLY_OK) tal_add_destructor(wtx, wally_tx_destroy); else wtx = NULL; tal_wally_end(tal_steal(ctx, wtx)); return wtx; } struct wally_psbt *psbt_from_b64(const tal_t *ctx, const char *b64, size_t b64len) { struct wally_psbt *psbt; char *str = tal_strndup(tmpctx, b64, b64len); tal_wally_start(); if (wally_psbt_from_base64(str, &psbt) == WALLY_OK) tal_add_destructor(psbt, psbt_destroy); else psbt = NULL; tal_wally_end(tal_steal(ctx, psbt)); return psbt; } char *psbt_to_b64(const tal_t *ctx, const struct wally_psbt *psbt) { char *serialized_psbt; int ret; tal_wally_start(); ret = wally_psbt_to_base64(psbt, 0, &serialized_psbt); assert(ret == WALLY_OK); tal_wally_end(tal_steal(ctx, serialized_psbt)); return serialized_psbt; } REGISTER_TYPE_TO_STRING(wally_psbt, psbt_to_b64); const u8 *psbt_get_bytes(const tal_t *ctx, const struct wally_psbt *psbt, size_t *bytes_written) { size_t len = 0; u8 *bytes; if (!psbt) { *bytes_written = 0; return NULL; } wally_psbt_get_length(psbt, 0, &len); bytes = tal_arr(ctx, u8, len); if (wally_psbt_to_bytes(psbt, 0, bytes, len, bytes_written) != WALLY_OK || *bytes_written != len) { /* something went wrong. bad libwally ?? */ abort(); } return bytes; } struct wally_psbt *psbt_from_bytes(const tal_t *ctx, const u8 *bytes, size_t byte_len) { struct wally_psbt *psbt; tal_wally_start(); if (wally_psbt_from_bytes(bytes, byte_len, &psbt) == WALLY_OK) tal_add_destructor(psbt, psbt_destroy); else psbt = NULL; tal_wally_end(tal_steal(ctx, psbt)); return psbt; } void towire_wally_psbt(u8 **pptr, const struct wally_psbt *psbt) { /* Let's include the PSBT bytes */ size_t bytes_written; const u8 *pbt_bytes = psbt_get_bytes(NULL, psbt, &bytes_written); towire_u32(pptr, bytes_written); towire_u8_array(pptr, pbt_bytes, bytes_written); tal_free(pbt_bytes); } struct wally_psbt *fromwire_wally_psbt(const tal_t *ctx, const u8 **cursor, size_t *max) { struct wally_psbt *psbt; u32 psbt_byte_len; const u8 *psbt_buf; psbt_byte_len = fromwire_u32(cursor, max); psbt_buf = fromwire(cursor, max, NULL, psbt_byte_len); if (!psbt_buf || psbt_byte_len == 0) return NULL; psbt = psbt_from_bytes(ctx, psbt_buf, psbt_byte_len); if (!psbt) return fromwire_fail(cursor, max); #if DEVELOPER /* Re-marshall for sanity check! */ u8 *tmpbuf = tal_arr(NULL, u8, psbt_byte_len); size_t written; if (wally_psbt_to_bytes(psbt, 0, tmpbuf, psbt_byte_len, &written) != WALLY_OK) { tal_free(tmpbuf); tal_free(psbt); return fromwire_fail(cursor, max); } tal_free(tmpbuf); #endif return psbt; } /* This only works on a non-final psbt because we're ALL SEGWIT! */ void psbt_txid(const tal_t *ctx, const struct wally_psbt *psbt, struct bitcoin_txid *txid, struct wally_tx **wtx) { struct wally_tx *tx; /* You can *almost* take txid of global tx. But @niftynei thought * about this far more than me and pointed out that P2SH * inputs would not be represented, so here we go. */ tal_wally_start(); wally_tx_clone_alloc(psbt->tx, 0, &tx); for (size_t i = 0; i < tx->num_inputs; i++) { if (psbt->inputs[i].final_scriptsig) { wally_tx_set_input_script(tx, i, psbt->inputs[i].final_scriptsig, psbt->inputs[i].final_scriptsig_len); } else if (psbt->inputs[i].redeem_script) { u8 *script; /* P2SH requires push of the redeemscript, from libwally src */ script = tal_arr(tmpctx, u8, 0); script_push_bytes(&script, psbt->inputs[i].redeem_script, psbt->inputs[i].redeem_script_len); wally_tx_set_input_script(tx, i, script, tal_bytelen(script)); } } tal_wally_end(tal_steal(ctx, tx)); wally_txid(tx, txid); if (wtx) *wtx = tx; else wally_tx_free(tx); }