358 lines
12 KiB
C
358 lines
12 KiB
C
#ifndef LIGHTNING_STATE_H
|
|
#define LIGHTNING_STATE_H
|
|
#include "config.h"
|
|
|
|
#include <ccan/tal/tal.h>
|
|
#include <state_types.h>
|
|
#include <stdbool.h>
|
|
|
|
/*
|
|
* This is the core state machine.
|
|
*
|
|
* Calling the state machine updates updates peer->state, and may call
|
|
* various peer_ callbacks. It also returns the status of the current
|
|
* command.
|
|
*/
|
|
|
|
static inline bool state_is_error(enum state s)
|
|
{
|
|
return s >= STATE_ERR_ANCHOR_TIMEOUT && s <= STATE_ERR_INTERNAL;
|
|
}
|
|
|
|
struct peer;
|
|
struct bitcoin_tx;
|
|
|
|
static inline bool input_is_pkt(enum state_input input)
|
|
{
|
|
return input <= PKT_ERROR;
|
|
}
|
|
|
|
union input {
|
|
Pkt *pkt;
|
|
struct command *cmd;
|
|
struct bitcoin_event *btc;
|
|
struct htlc *htlc;
|
|
struct htlc_progress *htlc_prog;
|
|
};
|
|
|
|
enum command_status state(const tal_t *ctx,
|
|
struct peer *peer,
|
|
const enum state_input input,
|
|
const union input *idata,
|
|
Pkt **out,
|
|
struct bitcoin_tx **broadcast);
|
|
|
|
/* Any CMD_SEND_HTLC_* */
|
|
#define CMD_SEND_UPDATE_ANY INPUT_MAX
|
|
|
|
/* a == b? (or one of several for CMD_SEND_UPDATE_ANY) */
|
|
static inline bool input_is(enum state_input a, enum state_input b)
|
|
{
|
|
if (b == CMD_SEND_UPDATE_ANY) {
|
|
/* Single | here, we want to record all. */
|
|
return input_is(a, CMD_SEND_HTLC_UPDATE)
|
|
| input_is(a, CMD_SEND_HTLC_FULFILL)
|
|
| input_is(a, CMD_SEND_HTLC_TIMEDOUT)
|
|
| input_is(a, CMD_SEND_HTLC_ROUTEFAIL);
|
|
}
|
|
|
|
/* For test_state_coverate to make the states. */
|
|
#ifdef MAPPING_INPUTS
|
|
MAPPING_INPUTS(b);
|
|
#endif
|
|
return a == b;
|
|
}
|
|
|
|
struct signature;
|
|
|
|
/* Inform peer have an unexpected packet. */
|
|
void peer_unexpected_pkt(struct peer *peer, const Pkt *pkt);
|
|
|
|
/* Current HTLC management.
|
|
* The "current" htlc is set before sending CMD_SEND_HTLC_*, or by
|
|
* accept_pkt_htlc_*.
|
|
*
|
|
* After that the state machine manages the current htlc, eventually giving one
|
|
* of the following calls (which should reset the current HTLC):
|
|
*
|
|
* - peer_htlc_declined: sent PKT_UPDATE_DECLINE_HTLC.
|
|
* - peer_htlc_ours_deferred: their update was higher priority, retry later.
|
|
* - peer_htlc_added: a new HTLC was added successfully.
|
|
* - peer_htlc_fulfilled: an existing HTLC was fulfilled successfully.
|
|
* - peer_htlc_timedout: an existing HTLC was timed out successfully.
|
|
* - peer_htlc_routefail: an existing HTLC failed to route.
|
|
* - peer_htlc_aborted: eg. comms error
|
|
*/
|
|
|
|
/* Someone declined our HTLC: details in pkt (we will also get CMD_FAIL) */
|
|
void peer_htlc_declined(struct peer *peer, const Pkt *pkt);
|
|
/* Called when their update overrides our update cmd. */
|
|
void peer_htlc_ours_deferred(struct peer *peer);
|
|
/* Successfully added/fulfilled/timedout/routefail an HTLC. */
|
|
void peer_htlc_done(struct peer *peer);
|
|
/* Someone aborted an existing HTLC. */
|
|
void peer_htlc_aborted(struct peer *peer);
|
|
|
|
/* An on-chain transaction revealed an R value. */
|
|
const struct htlc *peer_tx_revealed_r_value(struct peer *peer,
|
|
const struct bitcoin_event *btc);
|
|
|
|
/* Create various kinds of packets, allocated off @ctx */
|
|
Pkt *pkt_open(const tal_t *ctx, const struct peer *peer,
|
|
OpenChannel__AnchorOffer anchor);
|
|
Pkt *pkt_anchor(const tal_t *ctx, const struct peer *peer);
|
|
Pkt *pkt_open_commit_sig(const tal_t *ctx, const struct peer *peer);
|
|
Pkt *pkt_open_complete(const tal_t *ctx, const struct peer *peer);
|
|
Pkt *pkt_htlc_update(const tal_t *ctx, const struct peer *peer,
|
|
const struct htlc_progress *htlc_prog);
|
|
Pkt *pkt_htlc_fulfill(const tal_t *ctx, const struct peer *peer,
|
|
const struct htlc_progress *htlc_prog);
|
|
Pkt *pkt_htlc_timedout(const tal_t *ctx, const struct peer *peer,
|
|
const struct htlc_progress *htlc_prog);
|
|
Pkt *pkt_htlc_routefail(const tal_t *ctx, const struct peer *peer,
|
|
const struct htlc_progress *htlc_prog);
|
|
Pkt *pkt_update_accept(const tal_t *ctx, const struct peer *peer);
|
|
Pkt *pkt_update_signature(const tal_t *ctx, const struct peer *peer);
|
|
Pkt *pkt_update_complete(const tal_t *ctx, const struct peer *peer);
|
|
Pkt *pkt_err(const tal_t *ctx, const char *msg);
|
|
Pkt *pkt_close(const tal_t *ctx, const struct peer *peer);
|
|
Pkt *pkt_close_complete(const tal_t *ctx, const struct peer *peer);
|
|
Pkt *pkt_close_ack(const tal_t *ctx, const struct peer *peer);
|
|
Pkt *pkt_err_unexpected(const tal_t *ctx, const Pkt *pkt);
|
|
|
|
/* Process various packets: return an error packet on failure. */
|
|
Pkt *accept_pkt_open(const tal_t *ctx,
|
|
struct peer *peer,
|
|
const Pkt *pkt);
|
|
|
|
Pkt *accept_pkt_anchor(const tal_t *ctx,
|
|
struct peer *peer,
|
|
const Pkt *pkt);
|
|
|
|
Pkt *accept_pkt_open_commit_sig(const tal_t *ctx,
|
|
struct peer *peer, const Pkt *pkt);
|
|
|
|
Pkt *accept_pkt_htlc_update(const tal_t *ctx,
|
|
struct peer *peer, const Pkt *pkt,
|
|
Pkt **decline);
|
|
|
|
Pkt *accept_pkt_htlc_routefail(const tal_t *ctx,
|
|
struct peer *peer, const Pkt *pkt);
|
|
|
|
Pkt *accept_pkt_htlc_timedout(const tal_t *ctx,
|
|
struct peer *peer, const Pkt *pkt);
|
|
|
|
Pkt *accept_pkt_htlc_fulfill(const tal_t *ctx,
|
|
struct peer *peer, const Pkt *pkt);
|
|
|
|
Pkt *accept_pkt_update_accept(const tal_t *ctx,
|
|
struct peer *peer, const Pkt *pkt);
|
|
|
|
Pkt *accept_pkt_update_complete(const tal_t *ctx,
|
|
struct peer *peer, const Pkt *pkt);
|
|
|
|
Pkt *accept_pkt_update_signature(const tal_t *ctx,
|
|
struct peer *peer,
|
|
const Pkt *pkt);
|
|
|
|
Pkt *accept_pkt_close(const tal_t *ctx, struct peer *peer, const Pkt *pkt);
|
|
|
|
Pkt *accept_pkt_close_complete(const tal_t *ctx,
|
|
struct peer *peer, const Pkt *pkt);
|
|
|
|
Pkt *accept_pkt_simultaneous_close(const tal_t *ctx,
|
|
struct peer *peer,
|
|
const Pkt *pkt);
|
|
|
|
Pkt *accept_pkt_close_ack(const tal_t *ctx, struct peer *peer, const Pkt *pkt);
|
|
|
|
/**
|
|
* committed_to_htlcs: do we have any locked-in HTLCs?
|
|
* @peer: the state data for this peer.
|
|
*
|
|
* If we were to generate a commit tx now, would it have HTLCs in it?
|
|
*/
|
|
bool committed_to_htlcs(const struct peer *peer);
|
|
|
|
/**
|
|
* peer_watch_anchor: create a watch for the anchor transaction.
|
|
* @peer: the state data for this peer.
|
|
* @depthok: the input to give when anchor reaches expected depth.
|
|
* @timeout: the input to give if anchor doesn't reach depth in time.
|
|
* @unspent: the input to give if anchor is unspent after @depthok.
|
|
* @theyspent: the input to give if they spend anchor with their commit tx.
|
|
* @otherspent: the input to give if they spend anchor otherwise.
|
|
*
|
|
* @depthok can be INPUT_NONE if it's our anchor (we don't time
|
|
* ourselves out).
|
|
*/
|
|
void peer_watch_anchor(struct peer *peer,
|
|
enum state_input depthok,
|
|
enum state_input timeout,
|
|
enum state_input unspent,
|
|
enum state_input theyspent,
|
|
enum state_input otherspent);
|
|
|
|
/**
|
|
* peer_unwatch_anchor_depth: remove depth watch for the anchor.
|
|
* @peer: the state data for this peer.
|
|
* @depthok: the input to give when anchor reaches expected depth.
|
|
* @timeout: the input to give if anchor doesn't reach depth in time.
|
|
*
|
|
* @depthok and @timeout must match bitcoin_watch_anchor() call.
|
|
*/
|
|
void peer_unwatch_anchor_depth(struct peer *peer,
|
|
enum state_input depthok,
|
|
enum state_input timeout);
|
|
|
|
/**
|
|
* peer_watch_delayed: watch this (commit) tx, tell me when I can spend it
|
|
* @peer: the state data for this peer.
|
|
* @tx: the tx we're watching.
|
|
* @canspend: the input to give when commit reaches spendable depth.
|
|
*
|
|
* Note that this tx may be malleated, as it's dual-signed.
|
|
*/
|
|
void peer_watch_delayed(struct peer *peer,
|
|
const struct bitcoin_tx *tx,
|
|
enum state_input canspend);
|
|
|
|
/**
|
|
* peer_watch_tx: watch this tx until it's "irreversible"
|
|
* @peer: the state data for this peer.
|
|
* @tx: the tx we're watching.
|
|
* @done: the input to give when tx is completely buried.
|
|
*
|
|
* Once this fires we consider the channel completely closed and stop
|
|
* watching (eg 100 txs down).
|
|
*
|
|
* This is used for watching a transaction we sent (such as a steal,
|
|
* or spend of their close, etc).
|
|
*/
|
|
void peer_watch_tx(struct peer *peer,
|
|
const struct bitcoin_tx *tx,
|
|
enum state_input done);
|
|
|
|
/**
|
|
* peer_watch_close: watch for close tx until it's "irreversible" (or timedout)
|
|
* @peer: the state data for this peer.
|
|
* @done: the input to give when tx is completely buried.
|
|
* @timedout: the input to give if we time out.
|
|
*
|
|
* Once this fires we consider the channel completely closed and stop
|
|
* watching (eg 100 txs down).
|
|
*
|
|
* This is used for watching a mutual close, or for a transaction we sent
|
|
* (such as a steal, or spend of their close, etc).
|
|
*/
|
|
void peer_watch_close(struct peer *peer,
|
|
enum state_input done, enum state_input timedout);
|
|
|
|
/**
|
|
* peer_watch_our_htlc_outputs: HTLC outputs from our commit tx to watch.
|
|
* @peer: the state data for this peer.
|
|
* @tx: the commitment tx
|
|
* @tous_timeout: input to give when a HTLC output to us times out.
|
|
* @tothem_spent: input to give when a HTLC output to them is spent.
|
|
* @tothem_timeout: input to give when a HTLC output to them times out.
|
|
*
|
|
* Returns true if there were any htlc outputs to watch.
|
|
*/
|
|
bool peer_watch_our_htlc_outputs(struct peer *peer,
|
|
const struct bitcoin_tx *tx,
|
|
enum state_input tous_timeout,
|
|
enum state_input tothem_spent,
|
|
enum state_input tothem_timeout);
|
|
|
|
/**
|
|
* peer_watch_their_htlc_outputs: HTLC outputs from their commit tx to watch.
|
|
* @peer: the state data for this peer.
|
|
* @tx: the commitment tx
|
|
* @tous_timeout: input to give when a HTLC output to us times out.
|
|
* @tothem_spent: input to give when a HTLC output to them is spent.
|
|
* @tothem_timeout: input to give when a HTLC output to them times out.
|
|
*
|
|
* Returns true if there were any htlc outputs to watch.
|
|
*/
|
|
bool peer_watch_their_htlc_outputs(struct peer *peer,
|
|
const struct bitcoin_event *tx,
|
|
enum state_input tous_timeout,
|
|
enum state_input tothem_spent,
|
|
enum state_input tothem_timeout);
|
|
|
|
/**
|
|
* peer_unwatch_htlc_output: stop watching an HTLC
|
|
* @peer: the state data for this peer.
|
|
* @htlc: the htlc to stop watching
|
|
* @all_done: input to give if we're not watching any outputs anymore.
|
|
*/
|
|
void peer_unwatch_htlc_output(struct peer *peer,
|
|
const struct htlc *htlc,
|
|
enum state_input all_done);
|
|
|
|
/**
|
|
* peer_unwatch_all_htlc_outputs: stop watching all HTLCs
|
|
* @peer: the state data for this peer.
|
|
*/
|
|
void peer_unwatch_all_htlc_outputs(struct peer *peer);
|
|
|
|
/**
|
|
* peer_watch_htlc_spend: watch our spend of an HTLC output
|
|
* @peer: the state data for this peer.
|
|
* @tx: the commitment tx
|
|
* @htlc: the htlc the tx is spending an output of
|
|
* @done: input to give when it's completely buried.
|
|
*/
|
|
void peer_watch_htlc_spend(struct peer *peer,
|
|
const struct bitcoin_tx *tx,
|
|
const struct htlc *htlc,
|
|
enum state_input done);
|
|
|
|
/**
|
|
* peer_unwatch_htlc_spend: stop watching our HTLC spend
|
|
* @peer: the state data for this peer.
|
|
* @htlc: the htlc to stop watching the spend for.
|
|
* @all_done: input to give if we're not watching anything anymore.
|
|
*/
|
|
void peer_unwatch_htlc_spend(struct peer *peer,
|
|
const struct htlc *htlc,
|
|
enum state_input all_done);
|
|
|
|
/* Create a bitcoin anchor tx. */
|
|
struct bitcoin_tx *bitcoin_anchor(const tal_t *ctx,
|
|
const struct peer *peer);
|
|
|
|
/* Create a bitcoin close tx. */
|
|
struct bitcoin_tx *bitcoin_close(const tal_t *ctx,
|
|
const struct peer *peer);
|
|
|
|
/* Create a bitcoin spend tx (to spend our commit's outputs) */
|
|
struct bitcoin_tx *bitcoin_spend_ours(const tal_t *ctx,
|
|
const struct peer *peer);
|
|
|
|
/* Create a bitcoin spend tx (to spend their commit's outputs) */
|
|
struct bitcoin_tx *bitcoin_spend_theirs(const tal_t *ctx,
|
|
const struct peer *peer,
|
|
const struct bitcoin_event *btc);
|
|
|
|
/* Create a bitcoin steal tx (to steal all their commit's outputs) */
|
|
struct bitcoin_tx *bitcoin_steal(const tal_t *ctx,
|
|
const struct peer *peer,
|
|
struct bitcoin_event *btc);
|
|
|
|
/* Create our commit tx */
|
|
struct bitcoin_tx *bitcoin_commit(const tal_t *ctx,
|
|
const struct peer *peer);
|
|
|
|
/* Create a HTLC refund collection */
|
|
struct bitcoin_tx *bitcoin_htlc_timeout(const tal_t *ctx,
|
|
const struct peer *peer,
|
|
const struct htlc *htlc);
|
|
|
|
/* Create a HTLC collection */
|
|
struct bitcoin_tx *bitcoin_htlc_spend(const tal_t *ctx,
|
|
const struct peer *peer,
|
|
const struct htlc *htlc);
|
|
|
|
#endif /* LIGHTNING_STATE_H */
|