Haskoin.Transaction.Taproot

This module provides support for reperesenting full taproot outputs and parsing taproot witnesses. For reference see BIPS 340, 341, and 342.

Documentation

newtype XOnlyPubKey

An x-only pubkey corresponds to the keys (x,y) and (x, -y). The equality test only checks the x-coordinate. An x-only pubkey serializes to 32 bytes.

Since: 0.21.0

Constructors

XOnlyPubKey

Fields

• xOnlyPubKey :: PubKey

Instances

Eq XOnlyPubKey

Defined in Haskoin.Transaction.Taproot

Methods

(==) :: XOnlyPubKey -> XOnlyPubKey -> Bool

(/=) :: XOnlyPubKey -> XOnlyPubKey -> Bool

Show XOnlyPubKey

Defined in Haskoin.Transaction.Taproot

Methods

showsPrec :: Int -> XOnlyPubKey -> ShowS

show :: XOnlyPubKey -> String

showList :: [XOnlyPubKey] -> ShowS

ToJSON XOnlyPubKey

Hex encoding

Defined in Haskoin.Transaction.Taproot

Methods

toJSON :: XOnlyPubKey -> Value

toEncoding :: XOnlyPubKey -> Encoding

toJSONList :: [XOnlyPubKey] -> Value

toEncodingList :: [XOnlyPubKey] -> Encoding

FromJSON XOnlyPubKey

Hex encoding

Defined in Haskoin.Transaction.Taproot

Methods

parseJSON :: Value -> Parser XOnlyPubKey

parseJSONList :: Value -> Parser [XOnlyPubKey]

Binary XOnlyPubKey

Defined in Haskoin.Transaction.Taproot

Methods

put :: XOnlyPubKey -> Put

get :: Get XOnlyPubKey

putList :: [XOnlyPubKey] -> Put

Serial XOnlyPubKey

Defined in Haskoin.Transaction.Taproot

Methods

serialize :: MonadPut m => XOnlyPubKey -> m ()

deserialize :: MonadGet m => m XOnlyPubKey

Serialize XOnlyPubKey

Defined in Haskoin.Transaction.Taproot

Methods

put :: Putter XOnlyPubKey

get :: Get XOnlyPubKey

type TapLeafVersion = Word8

Since: 0.21.0

data MAST

Merklized Abstract Syntax Tree. This type can represent trees where only a subset of the leaves are known. Note that the tree is invariant under swapping branches at an internal node.

Since: 0.21.0

Constructors

MASTBranch MAST MAST

MASTLeaf TapLeafVersion Script

MASTCommitment (Digest SHA256)

Instances

Show MAST

Defined in Haskoin.Transaction.Taproot

Methods

showsPrec :: Int -> MAST -> ShowS

show :: MAST -> String

showList :: [MAST] -> ShowS

mastCommitment :: MAST -> Digest SHA256

Calculate the root hash for this tree.

Since: 0.21.0

getMerkleProofs :: MAST -> [(TapLeafVersion, Script, [Digest SHA256])]

Get the inclusion proofs for the leaves in the tree. The proof is ordered leaf-to-root.

Since: 0.21.0

data TaprootOutput

Representation of a full taproot output.

Since: 0.21.0

Constructors

TaprootOutput

Fields

• taprootInternalKey :: PubKey
• taprootMAST :: Maybe MAST

Instances

Show TaprootOutput

Defined in Haskoin.Transaction.Taproot

Methods

showsPrec :: Int -> TaprootOutput -> ShowS

show :: TaprootOutput -> String

showList :: [TaprootOutput] -> ShowS

taprootOutputKey :: TaprootOutput -> PubKey

Since: 0.21.0

taprootScriptOutput :: TaprootOutput -> ScriptOutput

Generate the output script for a taproot output

Since: 0.21.0

data TaprootWitness

Comprehension of taproot witness data

Since: 0.21.0

Constructors

KeyPathSpend ByteString

Signature

ScriptPathSpend ScriptPathData

Instances

Eq TaprootWitness

Defined in Haskoin.Transaction.Taproot

Methods

(==) :: TaprootWitness -> TaprootWitness -> Bool

(/=) :: TaprootWitness -> TaprootWitness -> Bool

Show TaprootWitness

Defined in Haskoin.Transaction.Taproot

Methods

showsPrec :: Int -> TaprootWitness -> ShowS

show :: TaprootWitness -> String

showList :: [TaprootWitness] -> ShowS

data ScriptPathData

Since: 0.21.0

Constructors

ScriptPathData

Fields

• scriptPathAnnex :: Maybe ByteString
• scriptPathStack :: [ByteString]
• scriptPathScript :: Script
• scriptPathExternalIsOdd :: Bool
• scriptPathLeafVersion :: Word8

  This value is masked by 0xFE

• scriptPathInternalKey :: PubKey
• scriptPathControl :: [ByteString]

Instances

Eq ScriptPathData

Defined in Haskoin.Transaction.Taproot

Methods

(==) :: ScriptPathData -> ScriptPathData -> Bool

(/=) :: ScriptPathData -> ScriptPathData -> Bool

Show ScriptPathData

Defined in Haskoin.Transaction.Taproot

Methods

showsPrec :: Int -> ScriptPathData -> ShowS

show :: ScriptPathData -> String

showList :: [ScriptPathData] -> ShowS

viewTaprootWitness :: WitnessStack -> Maybe TaprootWitness

Try to interpret a WitnessStack as taproot witness data.

Since: 0.21.0

encodeTaprootWitness :: TaprootWitness -> WitnessStack

Transform the high-level representation of taproot witness data into a witness stack

Since: 0.21.0

verifyScriptPathData

Arguments

:: PubKey

Output key

-> ScriptPathData

-> Bool

Verify that the script path spend is valid, except for script execution.

Since: 0.21.0