Copyright	No rights reserved
License	MIT
Maintainer	jprupp@protonmail.ch
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	Haskell2010

Haskoin.Transaction.Segwit

Contents

Segwit

Description

Types to represent segregated witness data and auxilliary functions to manipulate it. See BIP 141 and BIP 143 for details.

Synopsis

data WitnessProgram
data WitnessProgramPKH = WitnessProgramPKH {
- witnessSignature :: !TxSignature
- witnessPubKey :: !PubKeyI
}
data WitnessProgramSH = WitnessProgramSH {
- witnessScriptHashStack :: ![ByteString]
- witnessScriptHashScript :: !Script
}
isSegwit :: ScriptOutput -> Bool
viewWitnessProgram :: Network -> ScriptOutput -> WitnessStack -> Either String WitnessProgram
decodeWitnessInput :: Network -> WitnessProgram -> Either String (Maybe ScriptOutput, SimpleInput)
calcWitnessProgram :: ScriptOutput -> ScriptInput -> Either String WitnessProgram
simpleInputStack :: SimpleInput -> [ByteString]
toWitnessStack :: WitnessProgram -> WitnessStack

Segwit

data WitnessProgram Source #

High level represenation of a (v0) witness program

Since: 0.11.0.0

Constructors

P2WPKH WitnessProgramPKH
P2WSH WitnessProgramSH
EmptyWitnessProgram

Instances

Instances details

Show WitnessProgram Source #
Instance details Defined in Haskoin.Transaction.Segwit Methods showsPrec :: Int -> WitnessProgram -> ShowS # show :: WitnessProgram -> String # showList :: [WitnessProgram] -> ShowS #
Eq WitnessProgram Source #
Instance details Defined in Haskoin.Transaction.Segwit Methods (==) :: WitnessProgram -> WitnessProgram -> Bool # (/=) :: WitnessProgram -> WitnessProgram -> Bool #

data WitnessProgramPKH Source #

High level representation of a P2WPKH witness

Since: 0.11.0.0

Constructors

WitnessProgramPKH
Fields witnessSignature :: !TxSignature witnessPubKey :: !PubKeyI

Instances

Instances details

Show WitnessProgramPKH Source #
Instance details Defined in Haskoin.Transaction.Segwit Methods showsPrec :: Int -> WitnessProgramPKH -> ShowS # show :: WitnessProgramPKH -> String # showList :: [WitnessProgramPKH] -> ShowS #
Eq WitnessProgramPKH Source #
Instance details Defined in Haskoin.Transaction.Segwit Methods (==) :: WitnessProgramPKH -> WitnessProgramPKH -> Bool # (/=) :: WitnessProgramPKH -> WitnessProgramPKH -> Bool #

data WitnessProgramSH Source #

High-level representation of a P2WSH witness

Since: 0.11.0.0

Constructors

WitnessProgramSH
Fields witnessScriptHashStack :: ![ByteString] witnessScriptHashScript :: !Script

Instances

Instances details

Show WitnessProgramSH Source #
Instance details Defined in Haskoin.Transaction.Segwit Methods showsPrec :: Int -> WitnessProgramSH -> ShowS # show :: WitnessProgramSH -> String # showList :: [WitnessProgramSH] -> ShowS #
Eq WitnessProgramSH Source #
Instance details Defined in Haskoin.Transaction.Segwit Methods (==) :: WitnessProgramSH -> WitnessProgramSH -> Bool # (/=) :: WitnessProgramSH -> WitnessProgramSH -> Bool #

isSegwit :: ScriptOutput -> Bool Source #

Test if a ScriptOutput is P2WPKH or P2WSH

Since: 0.11.0.0

viewWitnessProgram :: Network -> ScriptOutput -> WitnessStack -> Either String WitnessProgram Source #

Calculate the witness program from the transaction data

Since: 0.11.0.0

decodeWitnessInput :: Network -> WitnessProgram -> Either String (Maybe ScriptOutput, SimpleInput) Source #

Analyze the witness, trying to match it with standard input structures

Since: 0.11.0.0

calcWitnessProgram :: ScriptOutput -> ScriptInput -> Either String WitnessProgram Source #

Create the witness program for a standard input

Since: 0.11.0.0

simpleInputStack :: SimpleInput -> [ByteString] Source #

Create the witness stack required to spend a standard P2WSH input

Since: 0.11.0.0

toWitnessStack :: WitnessProgram -> WitnessStack Source #

Encode a witness program

Since: 0.11.0.0