input: update SignDescriptor doc to note only segwit is supported
Also update the WitnessScript doc to note it should be set also for p2wkh.
This commit is contained in:
parent
f92c7a3af0
commit
9b5809a884
@ -17,9 +17,9 @@ var (
|
|||||||
ErrTweakOverdose = errors.New("sign descriptor should only have one tweak")
|
ErrTweakOverdose = errors.New("sign descriptor should only have one tweak")
|
||||||
)
|
)
|
||||||
|
|
||||||
// SignDescriptor houses the necessary information required to successfully sign
|
// SignDescriptor houses the necessary information required to successfully
|
||||||
// a given output. This struct is used by the Signer interface in order to gain
|
// sign a given segwit output. This struct is used by the Signer interface in
|
||||||
// access to critical data needed to generate a valid signature.
|
// order to gain access to critical data needed to generate a valid signature.
|
||||||
type SignDescriptor struct {
|
type SignDescriptor struct {
|
||||||
// KeyDesc is a descriptor that precisely describes *which* key to use
|
// KeyDesc is a descriptor that precisely describes *which* key to use
|
||||||
// for signing. This may provide the raw public key directly, or
|
// for signing. This may provide the raw public key directly, or
|
||||||
@ -56,8 +56,9 @@ type SignDescriptor struct {
|
|||||||
DoubleTweak *btcec.PrivateKey
|
DoubleTweak *btcec.PrivateKey
|
||||||
|
|
||||||
// WitnessScript is the full script required to properly redeem the
|
// WitnessScript is the full script required to properly redeem the
|
||||||
// output. This field will only be populated if a p2wsh or a p2sh
|
// output. This field should be set to the full script if a p2wsh
|
||||||
// output is being signed.
|
// output is being signed. For p2wkh it should be set to the hashed
|
||||||
|
// script (PkScript).
|
||||||
WitnessScript []byte
|
WitnessScript []byte
|
||||||
|
|
||||||
// Output is the target output which should be signed. The PkScript and
|
// Output is the target output which should be signed. The PkScript and
|
||||||
|
Loading…
Reference in New Issue
Block a user