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

• point :: PubKey

Instances

Read XOnlyPubKey

Defined in Haskoin.Transaction.Taproot

Methods

readsPrec :: Int -> ReadS XOnlyPubKey

readList :: ReadS [XOnlyPubKey]

readPrec :: ReadPrec XOnlyPubKey

readListPrec :: ReadPrec [XOnlyPubKey]

Show XOnlyPubKey

Defined in Haskoin.Transaction.Taproot

Methods

showsPrec :: Int -> XOnlyPubKey -> ShowS

show :: XOnlyPubKey -> String

showList :: [XOnlyPubKey] -> ShowS

Eq XOnlyPubKey

Defined in Haskoin.Transaction.Taproot

Methods

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

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

Marshal Ctx XOnlyPubKey

Defined in Haskoin.Transaction.Taproot

Methods

marshalPut :: MonadPut m => Ctx -> XOnlyPubKey -> m ()

marshalGet :: MonadGet m => Ctx -> m XOnlyPubKey

MarshalJSON Ctx XOnlyPubKey

Defined in Haskoin.Transaction.Taproot

Methods

marshalValue :: Ctx -> XOnlyPubKey -> Value

marshalEncoding :: Ctx -> XOnlyPubKey -> Encoding

unmarshalValue :: Ctx -> Value -> Parser 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

• internalKey :: PubKey
• mast :: Maybe MAST

taprootOutputKey :: Ctx -> TaprootOutput -> PubKey

Since: 0.21.0

taprootScriptOutput :: Ctx -> 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

data ScriptPathData

Since: 0.21.0

Constructors

ScriptPathData

Fields

• annex :: Maybe ByteString
• stack :: [ByteString]
• script :: Script
• extIsOdd :: Bool
• leafVersion :: Word8

  This value is masked by 0xFE

• internalKey :: PubKey
• control :: [ByteString]

Instances

Eq ScriptPathData

Defined in Haskoin.Transaction.Taproot

Methods

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

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

viewTaprootWitness :: Ctx -> WitnessStack -> Maybe TaprootWitness

Try to interpret a WitnessStack as taproot witness data.

Since: 0.21.0

encodeTaprootWitness :: Ctx -> TaprootWitness -> WitnessStack

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

Since: 0.21.0

verifyScriptPathData

Arguments

:: Ctx

-> PubKey

Output key

-> ScriptPathData

-> Bool

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

Since: 0.21.0