mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 02:27:51 +01:00
f1e4cad9d4
The wire protocol uses this, in the assumption that we'll never see feerates in excess of 4294967 satoshi per kiloweight. So let's use that consistently internally as well. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
293 lines
8.2 KiB
C
293 lines
8.2 KiB
C
#include <bitcoin/script.h>
|
|
#include <bitcoin/tx.h>
|
|
#include <ccan/endian/endian.h>
|
|
#include <channeld/commit_tx.h>
|
|
#include <common/htlc_tx.h>
|
|
#include <common/keyset.h>
|
|
#include <common/permute_tx.h>
|
|
#include <common/utils.h>
|
|
|
|
#ifndef SUPERVERBOSE
|
|
#define SUPERVERBOSE(...)
|
|
#endif
|
|
|
|
static bool trim(const struct htlc *htlc,
|
|
u32 feerate_per_kw, u64 dust_limit_satoshis,
|
|
enum side side)
|
|
{
|
|
u64 htlc_fee;
|
|
|
|
/* BOLT #3:
|
|
*
|
|
* For every offered HTLC, if the HTLC amount minus the HTLC-timeout
|
|
* fee would be less than `dust_limit_satoshis` set by the transaction
|
|
* owner, the commitment transaction MUST NOT contain that output,
|
|
* otherwise it MUST be generated as specified in [Offered HTLC
|
|
* Outputs](#offered-htlc-outputs).
|
|
*/
|
|
if (htlc_owner(htlc) == side)
|
|
htlc_fee = htlc_timeout_fee(feerate_per_kw);
|
|
/* BOLT #3:
|
|
*
|
|
* For every received HTLC, if the HTLC amount minus the HTLC-success
|
|
* fee would be less than `dust_limit_satoshis` set by the transaction
|
|
* owner, the commitment transaction MUST NOT contain that output,
|
|
* otherwise it MUST be generated as specified in [Received HTLC
|
|
* Outputs](#received-htlc-outputs).
|
|
*/
|
|
else
|
|
htlc_fee = htlc_success_fee(feerate_per_kw);
|
|
|
|
return htlc->msatoshi / 1000 < dust_limit_satoshis + htlc_fee;
|
|
}
|
|
|
|
size_t commit_tx_num_untrimmed(const struct htlc **htlcs,
|
|
u32 feerate_per_kw, u64 dust_limit_satoshis,
|
|
enum side side)
|
|
{
|
|
size_t i, n;
|
|
|
|
for (i = n = 0; i < tal_count(htlcs); i++)
|
|
n += !trim(htlcs[i], feerate_per_kw, dust_limit_satoshis, side);
|
|
|
|
return n;
|
|
}
|
|
|
|
static void add_offered_htlc_out(struct bitcoin_tx *tx, size_t n,
|
|
const struct htlc *htlc,
|
|
const struct keyset *keyset)
|
|
{
|
|
struct ripemd160 ripemd;
|
|
u8 *wscript;
|
|
|
|
ripemd160(&ripemd, htlc->rhash.u.u8, sizeof(htlc->rhash.u.u8));
|
|
wscript = htlc_offered_wscript(tx->output, &ripemd, keyset);
|
|
tx->output[n].amount = htlc->msatoshi / 1000;
|
|
tx->output[n].script = scriptpubkey_p2wsh(tx, wscript);
|
|
SUPERVERBOSE("# HTLC %"PRIu64" offered amount %"PRIu64" wscript %s\n",
|
|
htlc->id, tx->output[n].amount, tal_hex(wscript, wscript));
|
|
tal_free(wscript);
|
|
}
|
|
|
|
static void add_received_htlc_out(struct bitcoin_tx *tx, size_t n,
|
|
const struct htlc *htlc,
|
|
const struct keyset *keyset)
|
|
{
|
|
struct ripemd160 ripemd;
|
|
u8 *wscript;
|
|
|
|
ripemd160(&ripemd, htlc->rhash.u.u8, sizeof(htlc->rhash.u.u8));
|
|
wscript = htlc_received_wscript(tx, &ripemd, &htlc->expiry, keyset);
|
|
tx->output[n].amount = htlc->msatoshi / 1000;
|
|
tx->output[n].script = scriptpubkey_p2wsh(tx->output, wscript);
|
|
SUPERVERBOSE("# HTLC %"PRIu64" received amount %"PRIu64" wscript %s\n",
|
|
htlc->id, tx->output[n].amount, tal_hex(wscript, wscript));
|
|
tal_free(wscript);
|
|
}
|
|
|
|
struct bitcoin_tx *commit_tx(const tal_t *ctx,
|
|
const struct sha256_double *funding_txid,
|
|
unsigned int funding_txout,
|
|
u64 funding_satoshis,
|
|
enum side funder,
|
|
u16 to_self_delay,
|
|
const struct keyset *keyset,
|
|
u32 feerate_per_kw,
|
|
u64 dust_limit_satoshis,
|
|
u64 self_pay_msat,
|
|
u64 other_pay_msat,
|
|
const struct htlc **htlcs,
|
|
const struct htlc ***htlcmap,
|
|
u64 obscured_commitment_number,
|
|
enum side side)
|
|
{
|
|
const tal_t *tmpctx = tal_tmpctx(ctx);
|
|
u64 base_fee_msat;
|
|
struct bitcoin_tx *tx;
|
|
size_t i, n, untrimmed;
|
|
|
|
assert(self_pay_msat + other_pay_msat <= funding_satoshis * 1000);
|
|
|
|
/* BOLT #3:
|
|
*
|
|
* 1. Calculate which committed HTLCs need to be trimmed (see
|
|
* [Trimmed Outputs](#trimmed-outputs)).
|
|
*/
|
|
untrimmed = commit_tx_num_untrimmed(htlcs,
|
|
feerate_per_kw,
|
|
dust_limit_satoshis, side);
|
|
|
|
/* BOLT #3:
|
|
*
|
|
* 2. Calculate the base [commitment transaction
|
|
* fee](#fee-calculation).
|
|
*/
|
|
base_fee_msat = commit_tx_base_fee(feerate_per_kw, untrimmed) * 1000;
|
|
|
|
SUPERVERBOSE("# base commitment transaction fee = %"PRIu64"\n",
|
|
base_fee_msat / 1000);
|
|
|
|
/* BOLT #3:
|
|
*
|
|
* 3. Subtract this base fee from the funder (either `to_local` or
|
|
* `to_remote`), with a floor of zero (see [Fee Payment](#fee-payment)).
|
|
*/
|
|
try_subtract_fee(funder, side, base_fee_msat,
|
|
&self_pay_msat, &other_pay_msat);
|
|
|
|
#ifdef PRINT_ACTUAL_FEE
|
|
{
|
|
u64 satoshis_out = 0;
|
|
for (i = n = 0; i < tal_count(htlcs); i++) {
|
|
if (!trim(htlcs[i], feerate_per_kw, dust_limit_satoshis,
|
|
side))
|
|
satoshis_out += htlcs[i]->msatoshi / 1000;
|
|
}
|
|
if (self_pay_msat / 1000 >= dust_limit_satoshis)
|
|
satoshis_out += self_pay_msat / 1000;
|
|
if (other_pay_msat / 1000 >= dust_limit_satoshis)
|
|
satoshis_out += other_pay_msat / 1000;
|
|
SUPERVERBOSE("# actual commitment transaction fee = %"PRIu64"\n",
|
|
funding_satoshis - satoshis_out);
|
|
}
|
|
#endif
|
|
|
|
/* Worst-case sizing: both to-local and to-remote outputs. */
|
|
tx = bitcoin_tx(ctx, 1, untrimmed + 2);
|
|
|
|
/* We keep track of which outputs have which HTLCs */
|
|
if (htlcmap)
|
|
*htlcmap = tal_arr(tx, const struct htlc *,
|
|
tal_count(tx->output));
|
|
|
|
/* This could be done in a single loop, but we follow the BOLT
|
|
* literally to make comments in test vectors clearer. */
|
|
|
|
n = 0;
|
|
/* BOLT #3:
|
|
*
|
|
* 3. For every offered HTLC, if it is not trimmed, add an
|
|
* [offered HTLC output](#offered-htlc-outputs).
|
|
*/
|
|
for (i = 0; i < tal_count(htlcs); i++) {
|
|
if (htlc_owner(htlcs[i]) != side)
|
|
continue;
|
|
if (trim(htlcs[i], feerate_per_kw, dust_limit_satoshis, side))
|
|
continue;
|
|
add_offered_htlc_out(tx, n, htlcs[i], keyset);
|
|
if (htlcmap)
|
|
(*htlcmap)[n++] = htlcs[i];
|
|
}
|
|
|
|
/* BOLT #3:
|
|
*
|
|
* 4. For every received HTLC, if it is not trimmed, add an
|
|
* [received HTLC output](#received-htlc-outputs).
|
|
*/
|
|
for (i = 0; i < tal_count(htlcs); i++) {
|
|
if (htlc_owner(htlcs[i]) == side)
|
|
continue;
|
|
if (trim(htlcs[i], feerate_per_kw, dust_limit_satoshis, side))
|
|
continue;
|
|
add_received_htlc_out(tx, n, htlcs[i], keyset);
|
|
if (htlcmap)
|
|
(*htlcmap)[n++] = htlcs[i];
|
|
}
|
|
|
|
/* BOLT #3:
|
|
*
|
|
* 5. If the `to_local` amount is greater or equal to
|
|
* `dust_limit_satoshis`, add a [`to_local`
|
|
* Output](#to-local-output).
|
|
*/
|
|
if (self_pay_msat / 1000 >= dust_limit_satoshis) {
|
|
u8 *wscript = to_self_wscript(tmpctx, to_self_delay,keyset);
|
|
tx->output[n].amount = self_pay_msat / 1000;
|
|
tx->output[n].script = scriptpubkey_p2wsh(tx, wscript);
|
|
if (htlcmap)
|
|
(*htlcmap)[n] = NULL;
|
|
SUPERVERBOSE("# to-local amount %"PRIu64" wscript %s\n",
|
|
tx->output[n].amount,
|
|
tal_hex(tmpctx, wscript));
|
|
n++;
|
|
}
|
|
|
|
/* BOLT #3:
|
|
*
|
|
* 6. If the `to_remote` amount is greater or equal to
|
|
* `dust_limit_satoshis`, add a [`to_remote`
|
|
* Output](#to-remote-output).
|
|
*/
|
|
if (other_pay_msat / 1000 >= dust_limit_satoshis) {
|
|
/* BOLT #3:
|
|
*
|
|
* #### `to_remote` Output
|
|
*
|
|
* This output sends funds to the other peer, thus is a simple
|
|
* P2WPKH to `remotekey`.
|
|
*/
|
|
tx->output[n].amount = other_pay_msat / 1000;
|
|
tx->output[n].script = scriptpubkey_p2wpkh(tx,
|
|
&keyset->other_payment_key);
|
|
if (htlcmap)
|
|
(*htlcmap)[n] = NULL;
|
|
SUPERVERBOSE("# to-remote amount %"PRIu64" P2WPKH(%s)\n",
|
|
tx->output[n].amount,
|
|
type_to_string(tmpctx, struct pubkey,
|
|
&keyset->other_payment_key));
|
|
n++;
|
|
}
|
|
|
|
assert(n <= tal_count(tx->output));
|
|
tal_resize(&tx->output, n);
|
|
if (htlcmap)
|
|
tal_resize(htlcmap, n);
|
|
|
|
/* BOLT #3:
|
|
*
|
|
* 7. Sort the outputs into [BIP 69
|
|
* order](#transaction-input-and-output-ordering)
|
|
*/
|
|
permute_outputs(tx->output, tal_count(tx->output),
|
|
htlcmap ? (const void **)*htlcmap : NULL);
|
|
|
|
/* BOLT #3:
|
|
*
|
|
* ## Commitment Transaction
|
|
*
|
|
* * version: 2
|
|
*/
|
|
assert(tx->version == 2);
|
|
|
|
/* BOLT #3:
|
|
*
|
|
* * locktime: upper 8 bits are 0x20, lower 24 bits are the lower
|
|
* 24 bits of the obscured commitment transaction number.
|
|
*/
|
|
tx->lock_time
|
|
= (0x20000000 | (obscured_commitment_number & 0xFFFFFF));
|
|
|
|
/* BOLT #3:
|
|
*
|
|
* * txin count: 1
|
|
* * `txin[0]` outpoint: `txid` and `output_index` from
|
|
* `funding_created` message
|
|
*/
|
|
tx->input[0].txid = *funding_txid;
|
|
tx->input[0].index = funding_txout;
|
|
|
|
/* BOLT #3:
|
|
*
|
|
* * `txin[0]` sequence: upper 8 bits are 0x80, lower 24 bits are
|
|
* upper 24 bits of the obscured commitment transaction number.
|
|
*/
|
|
tx->input[0].sequence_number
|
|
= (0x80000000 | ((obscured_commitment_number>>24) & 0xFFFFFF));
|
|
|
|
/* Input amount needed for signature code. */
|
|
tx->input[0].amount = tal_dup(tx->input, u64, &funding_satoshis);
|
|
|
|
tal_free(tmpctx);
|
|
return tx;
|
|
}
|