lnwallet/commitment: clarify keyring key ownership

This commit is contained in:
Johan T. Halseth 2020-01-06 11:42:03 +01:00
parent 76ce51301e
commit 7b9c54996b
No known key found for this signature in database
GPG Key ID: 15BAADA29DA20D26

@ -20,7 +20,7 @@ import (
// is referred to in the field comments, regardless of which is local and which // is referred to in the field comments, regardless of which is local and which
// is remote. // is remote.
type CommitmentKeyRing struct { type CommitmentKeyRing struct {
// commitPoint is the "per commitment point" used to derive the tweak // CommitPoint is the "per commitment point" used to derive the tweak
// for each base point. // for each base point.
CommitPoint *btcec.PublicKey CommitPoint *btcec.PublicKey
@ -28,23 +28,35 @@ type CommitmentKeyRing struct {
// from the local payment base point or the local private key from the // from the local payment base point or the local private key from the
// base point secret. This may be included in a SignDescriptor to // base point secret. This may be included in a SignDescriptor to
// generate signatures for the local payment key. // generate signatures for the local payment key.
//
// NOTE: This will always refer to "our" local key, regardless of
// whether this is our commit or not.
LocalCommitKeyTweak []byte LocalCommitKeyTweak []byte
// TODO(roasbeef): need delay tweak as well? // TODO(roasbeef): need delay tweak as well?
// LocalHtlcKeyTweak is the teak used to derive the local HTLC key from // LocalHtlcKeyTweak is the tweak used to derive the local HTLC key
// the local HTLC base point. This value is needed in order to // from the local HTLC base point. This value is needed in order to
// derive the final key used within the HTLC scripts in the commitment // derive the final key used within the HTLC scripts in the commitment
// transaction. // transaction.
//
// NOTE: This will always refer to "our" local HTLC key, regardless of
// whether this is our commit or not.
LocalHtlcKeyTweak []byte LocalHtlcKeyTweak []byte
// LocalHtlcKey is the key that will be used in the "to self" clause of // LocalHtlcKey is the key that will be used in any clause paying to
// any HTLC scripts within the commitment transaction for this key ring // our node of any HTLC scripts within the commitment transaction for
// set. // this key ring set.
//
// NOTE: This will always refer to "our" local HTLC key, regardless of
// whether this is our commit or not.
LocalHtlcKey *btcec.PublicKey LocalHtlcKey *btcec.PublicKey
// RemoteHtlcKey is the key that will be used in clauses within the // RemoteHtlcKey is the key that will be used in clauses within the
// HTLC script that send money to the remote party. // HTLC script that send money to the remote party.
//
// NOTE: This will always refer to "their" remote HTLC key, regardless
// of whether this is our commit or not.
RemoteHtlcKey *btcec.PublicKey RemoteHtlcKey *btcec.PublicKey
// DelayKey is the commitment transaction owner's key which is included // DelayKey is the commitment transaction owner's key which is included