Use usize for transaction-position-in-block values

We use them largely as indexes into a Vec<Transaction> so there's
little reason for them to be u32s. Instead, use them as usize
everywhere.

We also take this opportunity to add range checks before
short_channel_id calculation, as we could otherwise end up with a
bogus short_channel_id due to an output index out of range.

Drop unused import in fuzz router.rs

Take &NetworkGraph as input in get_route, not a NetGraphMsgHandler

This was just an oversight when route calculation was split up into
parts - it makes no sense for get_route to require that we have a
full route message handler, only a network graph (which can always
be accessed from a NetGraphMsgHandler anyway).

Make ChainWatchInterface::filter_block return only idxes, not refs

Instead of making the filter_block fn in the ChainWatchInterface
trait return both a list of indexes of transaction positions within
the block and references to the transactions themselves, return
only the list of indexes and then build the reference list at the
callsite.

While this may be slightly less effecient from a memory locality
perspective, it shouldn't be materially different.

This should make it more practical to generate bindings for
filter_block as it no longer needs to reference Rust Transaction
objects that are contained in a Rust Block object (which we'd
otherwise just pass over the FFI in fully-serialized form).

Avoid references to primitives and add NetworkGraph::new()

non-mut references to primitives are only excess overhead, so
there's not much reason to ever have them. As a nice bonus, it also
is one less thing to worry about when generating C bindings

Avoid use std and use std::fmt and fmt:: instead in network_graph

This is more consistent with the way we use std::cmp over the
codebase and avoids `use std`, which is only actually needed to
support older rustcs, so feels a bit awkward.

Reduce RwLock usage in public interface of NetworkGraph

This isn't a big difference in the API, but it avoids needing to
wrap a given NetworkGraph in a RwLock before passing it, which
makes it much easier to generate C bindings for.

Drop a useless import of std::result::Result since its always there

Drop some unnecessary lifetime specifiers in return type definitions

In general, we don't need an explicit lifetime when doing something
like:
fn get_thing(&self) -> &Thing { &self.thing }.

This also makes it easier to reason about what's going on in the
bindings generation.

ChannelMonitor::get_funding_txo returns both the txid and scriptPK

... instead of only the txid.

This is another instance of it not being possible to fully
re-implement SimpleManyChannelMonitor using only public methods. In
this case you couldn't properly register outpoints for monitoring
so that the funding transaction would be matched.

Merge pull request #641 from jkczyz/2020-06-deterministic-test-logging

Make test output deterministic

Make test output deterministic

Tests use sources of randomness to produce seeds, preimages, secrets,
and ephemeral data. However, this makes comparing logs between different
test runs difficult. Remove uses of random number generators and the
current time in favor of fixed values in order to make the test output
deterministic.

Merge pull request #639 from valentinewallace/fix-feerate-new-channel

Use our actual feerate in open_channel messages, not a new one

Switch all feerate u64's to u32's.

The protocol only allows a u32, so if we received or sent something
larger it would be an issue (though it's unlikely).

Use our actual feerate in open_channel messages, not a new one

When we were sending an open_channel messages we were asking the
feerate estimator for a new value instead of using the one we had.
If the feerate estimator gave a different value than the one it did
when we created the Channel struct, we'd start out-of-sync with our
counterparty and blow up on funding_signed. Even worse, the
ConfirmationTarget used was different, so its highly likely they
would disagree.

Also remove newly unused fee estimator parameter from get_open-channel
API.

Co-authored-by: Matt Corallo <git@bluematt.me>
Co-authored-by: Valentine Wallace <vwallace@protonmail.com>

Merge pull request #577 from valentinewallace/fix-onchain-fee-check-htlcs

Incl tx fee when calcing inbound+outbound HTLC limits on channels

Update chanmon fuzzer to include small payment actions.

This change should allow the fuzzer to catch more edge cases, such as
channel reserve checks that cut it close when sending payments.

Add fee spike buffer + incl commit tx fee in chan reserve calculation

When we receive an inbound HTLC from a peer on an inbound channel,
make sure the funder can still cover the additional on-chain cost
of the HTLC while maintaining their channel reserve.

When we're sending an outbound HTLC, make sure the funder can still
cover the additional on-chain cost of the HTLC while maintaining
their channel reserve.

+ implement fee spike buffer for channel initiators sending payments.
Also add an additional spec-deviating fee spike buffer on the
receiving side (but don't close the channel if this reserve is
violated, just fail the HTLC).
From lightning-rfc PR #740.

Co-authored-by: Matt Corallo <git@bluematt.me>
Co-authored-by: Valentine Wallace <vwallace@protonmail.com>

Merge pull request #634 from valentinewallace/improve-inbound-htlc-docs

Improve documentation for InboundHTLCState enum states.

Improve documentation for InboundHTLCState enum states.

Refactor: move channel checks for HTLC adds into Channel

This also includes adding a closure that creates a new pending HTLC status
as a parameter for Channel's update_add_htlc. This will later be useful
when we add the check for fee spike buffer violations, which will also result
in changing an HTLC's pending status to failing.

Co-authored-by: Jeffrey Czyz <jkczyz@gmail.com>
Co-authored-by: Valentine Wallace <vwallace@protonmail.com>

Merge pull request #629 from arik-so/message_handling_extraction

Extract wire message handling into a method.

Extract wire message handling into a method.

This is a response to splitting #585 into smaller components. This extraction should allow the subsequent creation of a trait for all message handling, thereby enabling more flexibility in the state machine, particularly for bindings.

Merge pull request #632 from TheBlueMatt/2020-05-drop-chankeys-privs

Drop ChannelKeys Private Key Methods

Drop requirement that all ChannelKeys expose htlc_basepoint

Drop requirement that ChannelKeys expose delayed_payment_basepoint

Drop requirement that all ChannelKeys expose revocaion_basepoint

Drop requirement that all ChannelKeys expose the payment_point

Drop requirement that all ChannelKeys expose the funding privkey

Expose private keys from InMemoryChannelKeys publicly

As we drop the requirement that all ChannelKeys expose the private
keys used, we should have a way to access the private keys in use
when using InMemoryChannelKeys.

Merge pull request #620 from TheBlueMatt/2020-05-pre-bindings-cleanups

Pre-C Bindings Cleanup

Merge pull request #610 from ariard/2020-04-cache-in-monitor

Move back to ChannelMonitor RemoteTxCache

Add test_key_derivation_params

`to_local` output or remote output on remote commitment transaction
needs a channel keys to be spent. As per-channel keys are derived from
KeysManager seed and per-channel secrets those must be backed up by
any descriptor bookmarking for latter spend. We test that generating
a new KeysManager loaded with such backed-up seed/per-channel secrets
return the correct keys for spending a `to_local` output.

Significantly clarify key derivation and expose methods referenced

Document better DynamicOutputP2WSH

Remove useless build warnings

Make get_revokable_redeemscript

Make derive_private_key public

Dry-up witnessScript in sign_remote_htlc_transaction

Instead of blindly signing provided witnessScript, signer must derive
channel keys corresponding to the provided per-commitment-point and
regenerate templated witnessScript to ensure its syntax correctness.

Dry-up witnessScript in sign_justice_transaction

Instead of blindly signing provided witnessScript, signer must derive
channel keys corresponding to the provided per-commitment-point and
regenerate templated witnessScript to ensure its syntax correctness.

Imp Writer/Reader for RemoteCommitmentTransaction

Rename RemoteTxCache as RemoteCommitmentTransaction and document better

We also remove an unecessary build warning.

Rename their_to_self_delay as on_local_tx_csv

on_remote_tx_csv is the CSV delay encumbering remote transactions
revokable outputs as required by local.

on_local_tx_csv is the CSV delay encumbering local transactions
revokable outputs as required by remote.

Local/remote is here defined from a code processing viewpoint,
process running this code is "local".

Drop remote_csv from OnchainTxHandler, cache it in Monitor's cache

Dedup RemoteTxCache by removing OnchainTxHandler copy

RemoteTxCache was providing all data needed at transaction
signature for any remote HTLC transaction or justice transaction.
This move was making the API between OnchainTxHandle akward and
scope of responsibilites with ChannelMonitor unclear.

Instead scope OnchainTxHandler to transaction-finalization, fee-bumping
and broadcast only.

Duplicate RemoteTxCache in ChannelMonitor

Dry-up remote pubkeys tracking in one struct.

This introduce a duplicate of RemoteTxCache, which is going
to be removed in next commit when OnchainTxHandler version is
removed.

Remove SecretKey from DynamicOuputP2WPKH descriptor

Add sign_payment_transaction in ChanSigner to be able to spend
SpendableOutputDescriptor in test framework

Extend ChannelKeys with remote_pubkeys to access remote revocation
basepoint for witnessScript construction.

Remove SecretKey from DynamicOutputP2WSH descriptor

Add sign_delayed_transaction in ChanSigner to be able to spend
SpendableOutputDescriptor in test framework.

Extend KeysInterface with derive_channel_keys

A dynamic-p2wsh-output like `to_local` on local commitment/HTLC txn
require a signature from delayed_payment_key to be spend. Instead of
sending private key in descriptor, we ask for spender to derive again
the corresponding ChannelKeys based on key state, uniquely identifying
a channel and encompassing its unique start data.

Descriptor modification is done in next commit.

Merge pull request #624 from arik-so/encode_and_send_msg_method_refactor

Extract encode_and_send_msg into a method.

Expose PeerHandleError::no_connection_possible

Its just a trivial bool and already has docs on it, so seems like
an oversight

Three small fixes to work around our bindings generator limitations

 * Return Self instead of the fully-written types for constructors,
 * Place definitions before use (in this case for KeysInterface),
 * Don't import foo::bar::self, but import foo::bar

 + a spelling fix in the KeysInterface docs for get_onion_rand.

Return a ChannelManager instead of result from ChannelManager::new()

We never actually fail, so we can just drop the Result type.

Make RoutingMessageHandler a generic Deref instead of an Arc

We also update to use single idents when referencing the Deref=*
types since the automated code generator is pretty braindead.

This also moves some test utils out of peer_handler.rs and into
util::test_utils to standardize things a little bit, which we need
to concretize the PeerHandler types used in testing.

Make ManyChannelMonitor Keys an associated type

Instead of using a raw generic type, an associted type allows us
to have explicit docs on the type, which is nice. More importantly,
however, our automated bindings generator knows how to read
associated types but not raw generics.

Also, our bindings generator expects things which are referenced to
have already been defined, so we move ManyChannelMonitor below the
ChannelMonitor definition.

Extract encode_and_send_msg into a method.

This is a response to splitting #585 into smaller components. This extraction will permit a future extraction of all message handling into a separate method, and then later even into a separate trait that will be accessible through language bindings.

Add KeysManager::derive_unique_start

In next commit, we add derive_channel_keys, a helper to rederive
keys from a SpendableOuptutDescriptor. We still need to ensure
that user rederive same set of keys even if KeyManager is started
at a later time. For doing so we need to pass starting time as
part of the re-derived sha_state, therefore we need to make it
accessible and part of channel state key material.

Seed is already required to be conserved between KeysManager
serializations.

Move remote htlc transaction signature behind ChanSigner

Build witness_script for remote htlc transactions inside
OnchainTxHandler

By moving script generation inside OnchainTxHandler, we may dry-up
further ChannelMonitor in next commits

Comment MINIMALIF rule

Move justice transaction signature behind ChanSigner

Build witness_script for justice tx inside OnchainTxHandler

By moving script generation inside OnchainTxHandler, we may dry-up
further ChannelMonitor in next commits.

Replace is_htlc in InputMaterial by InputDescriptor

As we cache more and more transaction elements in OnchainTxHandler
we should dry up completly InputMaterial until them being replaced
directly by InputDescriptor

Cache remote HTLC inside OnchainTxHandler::RemoteTxCache

As we can't predict if any and which revoked commitment tx is
going to appear onchain we have by design to cache all htlc information
to regenerate htlc script if needed.

Cache remote basepoint and remote_csv in new OnchainTxHandler::RemoteTxCache

Used in next commits to avoid passing script between ChannelMonitor
and OnchainTxHandler. ChannelMonitor duplicata will be removed
in future commits.

Drop OutPoint::new since the struct is all pub

This makes it easier for our automated bindings generator to
function as it tries to automatically create a ::new if the struct
contains only pub elements who's type is convertible.

Merge pull request #622 from valentinewallace/chanmgr-logger-arc-to-deref

ChannelManager+Router++ Logger Arc --> Deref

PeerManager Logger Arc --> Deref

ChannelManager+Router++ Logger Arc --> Deref

This caused a bunch of cascading changes, including
passing loggers down to Channels in function calls
rather than having each Channel have a pointer to the
ChannelManager's Logger (which was a circular reference).
Other structs that the Channel had passed its Logger to also
had their loggers removed. Other newly unused Loggers were
also removed, especially when keeping them would've caused
a bunch of extra test changes to be necessary, e.g. with
the ChainWatchInterfaceUtil's Logger.

Merge pull request #617 from sourabhmarathe/serialize-channelmanager-events

Serialize ChannelManager events

Serialize ChannelManager events

Also adds a test for de/serializing events

Merge pull request #621 from TheBlueMatt/2020-05-592-nits

592+a few fixes

Fix some new indentation nits

Fix a few new (and one old) issues in the new channel_update

We need to always set lowest_inbound_channel_fees to None if there
are no channels (and we should ignore the channels which are
disabled for the purpose of lowest-fee calculations). Further, we
cannot unwrap the channel lookups as they may be for channels which
are not related to the channel we are processing an update for.
Finally, we can satisfy borrowck much easier since things are on
self instead of on a MutexGuard.

Add assertion since we now have a pub field that is PartialEq

We previously were only able to assert that the route graph
serialization roundtrips were good by comparing the network
messages returned from them, but we can now do better as the graph
is exposed publicly via a simple datastructure that implements
PartialEq.

Add missing comment on why last_update_message is None

Move get_addresses to network_graph and drop now-useless log_trace

Because we expose the internals we don't need a method to log
their contents anymore, and get_addresses can now avoid copying as
we expose the RwLock directly

Drop new test Node field introduced in 8ce2223b6952567b28adfcc11c2

8ce2223b6952567b28adfcc11c23c9f19c4c0324 introduced a new field in
the "Node" objects used in our functional tests - the node_id. Its
not a bad idea to cache it, but unless we want to commit and use it
everywhere, we should avoid duplicating data, especially in tests
where we'd rather exercise the underlying code than bypass it.

Improve routing-related documentation

Remove NetGraphMsgHandler serialization

Make DirectionalChannelInfo optional

Move node announcement fields into a separate struct

Expose some network graph methods

Split routing from getting network messages

Remove non-bitcoin chain helpers

Move router to a separate module

Merge pull request #539 from TheBlueMatt/2020-03-static-remotekey

Require static_remotekey

Merge pull request #613 from valentinewallace/less-confusing-chan-reserve-names

Make channel reserve variable names less confusing.

Rename payment_basepoint/key to simply payment_point/key.

We no longer derive any keys from the payment point, so they aren't
a "base" but simply a point/key.

Require option_static_remotekey in channel/channelmonitor.

This simplifies channelmonitor quite nicely (as expected) as we
never have to be concerned with learning data in a DataLossProtect
which is require for us to claim our funds from the latest remote
commitment transaction.

Add detection of feature_static_remotekey support and print

This adds the ability to check for static_remotekey in appropriate
feature contexts and prints it at connect time. It is still
considered unknown for the purposes of requires_unknown_bits() as
we don't yet implement it.

Make channel reserve variable names less confusing.

Previous to this commit, variables such as their_channel_reserve
referred to the channel reserve that _we_ are required to keep,
(the value is initially set by the remote). Similarly,
variables such as our_channel_reserve referred to the channel
reserve that we require the remote to keep.

Change this to use local_channel_reserve / remote_channel_reserve
to refer to the the channel reserve that the local is required to keep
and the channel reserve that the remote is required to keep, respectively.

Check local signtures explicitly in channel tx-generation tests

It appears the local signatures which are specified in the channel
transaction-generation tests were never checked directly (though
they were checked as a part of the overall fully-signed-transaction
tests).

Check them explicitly so that they can be updated for static remote
key.

Add additional trace logging in channel signature validation

This makes it easier to amend the full_stack_target
test_no_existing_test_breakage test by always providing the
neccessary data in the log.

Merge pull request #590 from jkczyz/2020-04-feature-flags

Features module improvements

Sanity check that known features are not required

Expand testing of unknown feature bits

Include tests for requires_unknown_bits and supports_unknown_bits when
an unknown even bit, odd bit, or neither is set. Refactor bit clearing
such that tests and production code share the same code path. Fix a
potential spec incompatibility (currently only exposed in testing code)
where trailing zero bytes are not removed after a bit is cleared.

Generalize with_known_relevant_init_flags

Converting from InitFeatures to other Features is accomplished using
Features::with_known_relevant_init_flags. Define a more general
to_context method which converts from Features of one Context to
another.

Additionally, ensure the source context only has known flags before
selecting flags for the target context.

Generalize feature methods to work in any context

Refactoring the features module allowed for making code specific to
certain contexts generalizable. Specifically, KNOWN_FEATURE_MASK
is defined on Context instead of hardcoded in each method
specialization. Thus, such methods are no longer required.

Remove duplicate specification of features

Features for a given context are duplicated throughout the features
module. Use a macro for defining a Context and the applicable features
such that features only need to be defined for a Context in one place.
The Context provides bitmasks for selecting known and unknown feature
flags.

BOLT 1 and BOLT 9 refer to features as "known" if a peer understands
them. They also use the term "supported" to mean either optional or
required.

Update the features module to use similar terminology.
- Define contexts in terms of required and optional features rather than
  just supported features
- Define known features as those that are optional or required
- Rename supported() constructor to known()

For completeness, clear_optional_bit for each feature is now called
clear_bits and clears both optional and required bits.

Improve features module documentation