lnwallet: add Tree() method, fix formatting

lightningnetwork · May 1, 2024 · 0b991e2 · 0b991e2
1 parent df0e9f7
commit 0b991e2
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 48 deletions.
diff --git a/input/script_desc.go b/input/script_desc.go
@@ -33,17 +33,17 @@ const (
  ScriptPathDelay
 )
 
-// ScriptDesciptor is an interface that abstracts over the various ways a
+// ScriptDescriptor is an interface that abstracts over the various ways a
 // pkScript can be spent from an output. This supports both normal p2wsh
-// (witness script, etc), and also tapscript paths which have distinct
+// (witness script, etc.), and also tapscript paths which have distinct
 // tapscript leaves.
 type ScriptDescriptor interface {
  // PkScript is the public key script that commits to the final
  // contract.
  PkScript() []byte
 
- // WitnessScript returns the witness script that we'll use when signing
- // for the remote party, and also verifying signatures on our
+ // WitnessScriptToSign returns the witness script that we'll use when
+ // signing for the remote party, and also verifying signatures on our
  // transactions. As an example, when we create an outgoing HTLC for the
  // remote party, we want to sign their success path.
  //
@@ -73,6 +73,9 @@ type TapscriptDescriptor interface {
 
  // TapScriptTree returns the underlying tapscript tree.
  TapScriptTree() *txscript.IndexedTapScriptTree
+
+ // Tree returns the underlying ScriptTree.
+ Tree() ScriptTree
 }
 
 // ScriptTree holds the contents needed to spend a script within a tapscript

diff --git a/input/script_utils.go b/input/script_utils.go
@@ -733,8 +733,8 @@ func (h *HtlcScriptTree) WitnessScriptForPath(path ScriptPath) ([]byte, error) {
 
 // CtrlBlockForPath returns the control block for the given spending path. For
 // script types that don't have a control block, nil is returned.
-func (h *HtlcScriptTree) CtrlBlockForPath(path ScriptPath,
-) (*txscript.ControlBlock, error) {
+func (h *HtlcScriptTree) CtrlBlockForPath(
+ path ScriptPath) (*txscript.ControlBlock, error) {
 
  switch path {
  case ScriptPathSuccess:
@@ -752,6 +752,11 @@ func (h *HtlcScriptTree) CtrlBlockForPath(path ScriptPath,
  }
 }
 
+// Tree returns the underlying ScriptTree of the HtlcScriptTree.
+func (h *HtlcScriptTree) Tree() ScriptTree {
+ return h.ScriptTree
+}
+
 // A compile time check to ensure HtlcScriptTree implements the
 // TapscriptMultiplexer interface.
 var _ TapscriptDescriptor = (*HtlcScriptTree)(nil)
@@ -1752,18 +1757,18 @@ func TaprootSecondLevelScriptTree(revokeKey, delayKey *btcec.PublicKey,
  }, nil
 }
 
-// WitnessScript returns the witness script that we'll use when signing for the
-// remote party, and also verifying signatures on our transactions. As an
-// example, when we create an outgoing HTLC for the remote party, we want to
+// WitnessScriptToSign returns the witness script that we'll use when signing
+// for the remote party, and also verifying signatures on our transactions. As
+// an example, when we create an outgoing HTLC for the remote party, we want to
 // sign their success path.
 func (s *SecondLevelScriptTree) WitnessScriptToSign() []byte {
  return s.SuccessTapLeaf.Script
 }
 
 // WitnessScriptForPath returns the witness script for the given spending path.
 // An error is returned if the path is unknown.
-func (s *SecondLevelScriptTree) WitnessScriptForPath(path ScriptPath,
-) ([]byte, error) {
+func (s *SecondLevelScriptTree) WitnessScriptForPath(
+ path ScriptPath) ([]byte, error) {
 
  switch path {
  case ScriptPathDelay:
@@ -1778,8 +1783,8 @@ func (s *SecondLevelScriptTree) WitnessScriptForPath(path ScriptPath,
 
 // CtrlBlockForPath returns the control block for the given spending path. For
 // script types that don't have a control block, nil is returned.
-func (s *SecondLevelScriptTree) CtrlBlockForPath(path ScriptPath,
-) (*txscript.ControlBlock, error) {
+func (s *SecondLevelScriptTree) CtrlBlockForPath(
+ path ScriptPath) (*txscript.ControlBlock, error) {
 
  switch path {
  case ScriptPathDelay:
@@ -1795,6 +1800,11 @@ func (s *SecondLevelScriptTree) CtrlBlockForPath(path ScriptPath,
  }
 }
 
+// Tree returns the underlying ScriptTree of the SecondLevelScriptTree.
+func (s *SecondLevelScriptTree) Tree() ScriptTree {
+ return s.ScriptTree
+}
+
 // A compile time check to ensure SecondLevelScriptTree implements the
 // TapscriptDescriptor interface.
 var _ TapscriptDescriptor = (*SecondLevelScriptTree)(nil)
@@ -2137,9 +2147,9 @@ type CommitScriptTree struct {
 // TapscriptDescriptor interface.
 var _ TapscriptDescriptor = (*CommitScriptTree)(nil)
 
-// WitnessScript returns the witness script that we'll use when signing for the
-// remote party, and also verifying signatures on our transactions. As an
-// example, when we create an outgoing HTLC for the remote party, we want to
+// WitnessScriptToSign returns the witness script that we'll use when signing
+// for the remote party, and also verifying signatures on our transactions. As
+// an example, when we create an outgoing HTLC for the remote party, we want to
 // sign their success path.
 func (c *CommitScriptTree) WitnessScriptToSign() []byte {
  // TODO(roasbeef): abstraction leak here? always dependent
@@ -2148,8 +2158,8 @@ func (c *CommitScriptTree) WitnessScriptToSign() []byte {
 
 // WitnessScriptForPath returns the witness script for the given spending path.
 // An error is returned if the path is unknown.
-func (c *CommitScriptTree) WitnessScriptForPath(path ScriptPath,
-) ([]byte, error) {
+func (c *CommitScriptTree) WitnessScriptForPath(
+ path ScriptPath) ([]byte, error) {
 
  switch path {
  // For the commitment output, the delay and success path are the same,
@@ -2167,8 +2177,8 @@ func (c *CommitScriptTree) WitnessScriptForPath(path ScriptPath,
 
 // CtrlBlockForPath returns the control block for the given spending path. For
 // script types that don't have a control block, nil is returned.
-func (c *CommitScriptTree) CtrlBlockForPath(path ScriptPath,
-) (*txscript.ControlBlock, error) {
+func (c *CommitScriptTree) CtrlBlockForPath(
+ path ScriptPath) (*txscript.ControlBlock, error) {
 
  switch path {
  case ScriptPathDelay:
@@ -2188,6 +2198,11 @@ func (c *CommitScriptTree) CtrlBlockForPath(path ScriptPath,
  }
 }
 
+// Tree returns the underlying ScriptTree of the CommitScriptTree.
+func (c *CommitScriptTree) Tree() ScriptTree {
+ return c.ScriptTree
+}
+
 // NewLocalCommitScriptTree returns a new CommitScript tree that can be used to
 // create and spend the commitment output for the local party.
 func NewLocalCommitScriptTree(csvTimeout uint32, selfKey,
@@ -2315,7 +2330,7 @@ func TaprootCommitScriptToSelf(csvTimeout uint32,
  return commitScriptTree.TaprootKey, nil
 }
 
-// MakeTaprootSCtrlBlock takes a leaf script, the internal key (usually the
+// MakeTaprootCtrlBlock takes a leaf script, the internal key (usually the
 // revoke key), and a script tree and creates a valid control block for a spend
 // of the leaf.
 func MakeTaprootCtrlBlock(leafScript []byte, internalKey *btcec.PublicKey,
@@ -2370,9 +2385,6 @@ func TaprootCommitSpendSuccess(signer Signer, signDesc *SignDescriptor,
  witnessStack[0] = maybeAppendSighash(sweepSig, signDesc.HashType)
  witnessStack[1] = signDesc.WitnessScript
  witnessStack[2] = ctrlBlockBytes
- if err != nil {
- return nil, err
- }
 
  return witnessStack, nil
 }
@@ -2854,8 +2866,8 @@ type AnchorScriptTree struct {
 
 // NewAnchorScriptTree makes a new script tree for an anchor output with the
 // passed anchor key.
-func NewAnchorScriptTree(anchorKey *btcec.PublicKey,
-) (*AnchorScriptTree, error) {
+func NewAnchorScriptTree(
+ anchorKey *btcec.PublicKey) (*AnchorScriptTree, error) {
 
  // The main script used is just a OP_16 CSV (anyone can sweep after 16
  // blocks).
@@ -2891,18 +2903,18 @@ func NewAnchorScriptTree(anchorKey *btcec.PublicKey,
  }, nil
 }
 
-// WitnessScript returns the witness script that we'll use when signing for the
-// remote party, and also verifying signatures on our transactions. As an
-// example, when we create an outgoing HTLC for the remote party, we want to
+// WitnessScriptToSign returns the witness script that we'll use when signing
+// for the remote party, and also verifying signatures on our transactions. As
+// an example, when we create an outgoing HTLC for the remote party, we want to
 // sign their success path.
 func (a *AnchorScriptTree) WitnessScriptToSign() []byte {
  return a.SweepLeaf.Script
 }
 
 // WitnessScriptForPath returns the witness script for the given spending path.
 // An error is returned if the path is unknown.
-func (a *AnchorScriptTree) WitnessScriptForPath(path ScriptPath,
-) ([]byte, error) {
+func (a *AnchorScriptTree) WitnessScriptForPath(
+ path ScriptPath) ([]byte, error) {
 
  switch path {
  case ScriptPathDelay:
@@ -2917,8 +2929,8 @@ func (a *AnchorScriptTree) WitnessScriptForPath(path ScriptPath,
 
 // CtrlBlockForPath returns the control block for the given spending path. For
 // script types that don't have a control block, nil is returned.
-func (a *AnchorScriptTree) CtrlBlockForPath(path ScriptPath,
-) (*txscript.ControlBlock, error) {
+func (a *AnchorScriptTree) CtrlBlockForPath(
+ path ScriptPath) (*txscript.ControlBlock, error) {
 
  switch path {
  case ScriptPathDelay:
@@ -2934,6 +2946,11 @@ func (a *AnchorScriptTree) CtrlBlockForPath(path ScriptPath,
  }
 }
 
+// Tree returns the underlying ScriptTree of the AnchorScriptTree.
+func (a *AnchorScriptTree) Tree() ScriptTree {
+ return a.ScriptTree
+}
+
 // A compile time check to ensure AnchorScriptTree implements the
 // TapscriptDescriptor interface.
 var _ TapscriptDescriptor = (*AnchorScriptTree)(nil)

diff --git a/lnwallet/commitment.go b/lnwallet/commitment.go
@@ -201,20 +201,20 @@ func (w *WitnessScriptDesc) PkScript() []byte {
  return w.OutputScript
 }
 
-// WitnessScript returns the witness script that we'll use when signing for the
-// remote party, and also verifying signatures on our transactions. As an
-// example, when we create an outgoing HTLC for the remote party, we want to
+// WitnessScriptToSign returns the witness script that we'll use when signing
+// for the remote party, and also verifying signatures on our transactions. As
+// an example, when we create an outgoing HTLC for the remote party, we want to
 // sign their success path.
 func (w *WitnessScriptDesc) WitnessScriptToSign() []byte {
  return w.WitnessScript
 }
 
 // WitnessScriptForPath returns the witness script for the given spending path.
 // An error is returned if the path is unknown. This is useful as when
-// constructing a contrl block for a given path, one also needs witness script
+// constructing a control block for a given path, one also needs witness script
 // being signed.
-func (w *WitnessScriptDesc) WitnessScriptForPath(_ input.ScriptPath,
-) ([]byte, error) {
+func (w *WitnessScriptDesc) WitnessScriptForPath(
+ _ input.ScriptPath) ([]byte, error) {
 
  return w.WitnessScript, nil
 }
@@ -532,8 +532,8 @@ func CommitScriptAnchors(chanType channeldb.ChannelType,
  input.ScriptDescriptor, input.ScriptDescriptor, error) {
 
  var (
- anchorScript func(key *btcec.PublicKey) (
- input.ScriptDescriptor, error)
+ anchorScript func(
+ key *btcec.PublicKey) (input.ScriptDescriptor, error)
 
  keySelector func(*channeldb.ChannelConfig,
  bool) *btcec.PublicKey
@@ -544,12 +544,10 @@ func CommitScriptAnchors(chanType channeldb.ChannelType,
  // level key is now the (relative) local delay and remote public key,
  // since these are fully revealed once the commitment hits the chain.
  case chanType.IsTaproot():
- anchorScript = func(key *btcec.PublicKey,
- ) (input.ScriptDescriptor, error) {
+ anchorScript = func(
+  key *btcec.PublicKey) (input.ScriptDescriptor, error) {
 
- return input.NewAnchorScriptTree(
- key,
- )
+ return input.NewAnchorScriptTree(key)
  }
 
  keySelector = func(cfg *channeldb.ChannelConfig,
@@ -567,8 +565,8 @@ func CommitScriptAnchors(chanType channeldb.ChannelType,
  default:
  // For normal channels, we'll create a p2wsh script based on
  // the target key.
- anchorScript = func(key *btcec.PublicKey,
- ) (input.ScriptDescriptor, error) {
+ anchorScript = func(
+  key *btcec.PublicKey) (input.ScriptDescriptor, error) {
 
  script, err := input.CommitScriptAnchor(key)
  if err != nil {