Haskoin.Script.Standard

Standard scripts like pay-to-public-key, pay-to-public-key-hash, pay-to-script-hash, pay-to-multisig and corresponding SegWit variants.

Standard Script Outputs

data ScriptOutput

Data type describing standard transaction output scripts. Output scripts provide the conditions that must be fulfilled for someone to spend the funds in a transaction output.

Constructors

PayPK

pay to public key

Fields

• getOutputPubKey :: !PubKeyI

PayPKHash

pay to public key hash

Fields

• getOutputHash :: !Hash160

PayMulSig

multisig

Fields

• getOutputMulSigKeys :: ![PubKeyI]
• getOutputMulSigRequired :: !Int

PayScriptHash

pay to a script hash

Fields

• getOutputHash :: !Hash160

PayWitnessPKHash

pay to witness public key hash

Fields

• getOutputHash :: !Hash160

PayWitnessScriptHash

pay to witness script hash

Fields

• getScriptHash :: !Hash256

PayWitness

another pay to witness address

Fields

• getWitnessVersion :: !Word8
• getWitnessData :: !ByteString

DataCarrier

provably unspendable data carrier

Fields

• getOutputData :: !ByteString

Instances

Eq ScriptOutput

Defined in Haskoin.Script.Standard

Methods

(==) :: ScriptOutput -> ScriptOutput -> Bool

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

Read ScriptOutput

Defined in Haskoin.Script.Standard

Methods

readsPrec :: Int -> ReadS ScriptOutput

readList :: ReadS [ScriptOutput]

readPrec :: ReadPrec ScriptOutput

readListPrec :: ReadPrec [ScriptOutput]

Show ScriptOutput

Defined in Haskoin.Script.Standard

Methods

showsPrec :: Int -> ScriptOutput -> ShowS

show :: ScriptOutput -> String

showList :: [ScriptOutput] -> ShowS

Generic ScriptOutput

Defined in Haskoin.Script.Standard

Associated Types

type Rep ScriptOutput :: Type -> Type

Methods

from :: ScriptOutput -> Rep ScriptOutput x

to :: Rep ScriptOutput x -> ScriptOutput

Hashable ScriptOutput

Defined in Haskoin.Script.Standard

Methods

hashWithSalt :: Int -> ScriptOutput -> Int

hash :: ScriptOutput -> Int

ToJSON ScriptOutput

Defined in Haskoin.Script.Standard

Methods

toJSON :: ScriptOutput -> Value

toEncoding :: ScriptOutput -> Encoding

toJSONList :: [ScriptOutput] -> Value

toEncodingList :: [ScriptOutput] -> Encoding

FromJSON ScriptOutput

Defined in Haskoin.Script.Standard

Methods

parseJSON :: Value -> Parser ScriptOutput

parseJSONList :: Value -> Parser [ScriptOutput]

NFData ScriptOutput

Defined in Haskoin.Script.Standard

Methods

rnf :: ScriptOutput -> ()

type Rep ScriptOutput

Defined in Haskoin.Script.Standard

type Rep ScriptOutput = D1 ('MetaData "ScriptOutput" "Haskoin.Script.Standard" "haskoin-core-0.21.2-inplace" 'False) (((C1 ('MetaCons "PayPK" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOutputPubKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PubKeyI)) :+: C1 ('MetaCons "PayPKHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOutputHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Hash160))) :+: (C1 ('MetaCons "PayMulSig" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOutputMulSigKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [PubKeyI]) :*: S1 ('MetaSel ('Just "getOutputMulSigRequired") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :+: C1 ('MetaCons "PayScriptHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOutputHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Hash160)))) :+: ((C1 ('MetaCons "PayWitnessPKHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOutputHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Hash160)) :+: C1 ('MetaCons "PayWitnessScriptHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "getScriptHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Hash256))) :+: (C1 ('MetaCons "PayWitness" 'PrefixI 'True) (S1 ('MetaSel ('Just "getWitnessVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8) :*: S1 ('MetaSel ('Just "getWitnessData") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString)) :+: C1 ('MetaCons "DataCarrier" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOutputData") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString)))))

type RedeemScript = ScriptOutput

A redeem script is the output script serialized into the spending input script. It must be included in inputs that spend pay-to-script-hash outputs.

isPayPK :: ScriptOutput -> Bool

Is script a pay-to-public-key output?

isPayPKHash :: ScriptOutput -> Bool

Is script a pay-to-pub-key-hash output?

isPayMulSig :: ScriptOutput -> Bool

Is script a pay-to-multi-sig output?

isPayScriptHash :: ScriptOutput -> Bool

Is script a pay-to-script-hash output?

isPayWitness :: ScriptOutput -> Bool

Is script paying to a different type of witness address?

isPayWitnessPKHash :: ScriptOutput -> Bool

Is script a pay-to-witness-pub-key-hash output?

isPayWitnessScriptHash :: ScriptOutput -> Bool

Is script a pay-to-witness-script-hash output?

isDataCarrier :: ScriptOutput -> Bool

Is script a data carrier output?

encodeOutput :: ScriptOutput -> Script

Computes a Script from a standard ScriptOutput.

encodeOutputBS :: ScriptOutput -> ByteString

Similar to encodeOutput but encodes to a ByteString

decodeOutput :: Script -> Either String ScriptOutput

Tries to decode a ScriptOutput from a Script. This can fail if the script is not recognized as any of the standard output types.

decodeOutputBS :: ByteString -> Either String ScriptOutput

Similar to decodeOutput but decodes from a ByteString.

toP2SH :: Script -> ScriptOutput

Encode script as pay-to-script-hash script

toP2WSH :: Script -> ScriptOutput

Encode script as a pay-to-witness-script-hash script

sortMulSig :: ScriptOutput -> ScriptOutput

Sort the public keys of a multisig output in ascending order by comparing their compressed serialized representations. Refer to BIP-67.

Standard Script Inputs

data ScriptInput

Standard input script high-level representation.

Constructors

RegularInput

Fields

• getRegularInput :: !SimpleInput

  get wrapped simple input

ScriptHashInput

Fields

• getScriptHashInput :: !SimpleInput

  get simple input associated with redeem script

• getScriptHashRedeem :: !RedeemScript

  redeem script

Instances

Eq ScriptInput

Defined in Haskoin.Script.Standard

Methods

(==) :: ScriptInput -> ScriptInput -> Bool

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

Show ScriptInput

Defined in Haskoin.Script.Standard

Methods

showsPrec :: Int -> ScriptInput -> ShowS

show :: ScriptInput -> String

showList :: [ScriptInput] -> ShowS

Generic ScriptInput

Defined in Haskoin.Script.Standard

Associated Types

type Rep ScriptInput :: Type -> Type

Methods

from :: ScriptInput -> Rep ScriptInput x

to :: Rep ScriptInput x -> ScriptInput

NFData ScriptInput

Defined in Haskoin.Script.Standard

Methods

rnf :: ScriptInput -> ()

type Rep ScriptInput

Defined in Haskoin.Script.Standard

type Rep ScriptInput = D1 ('MetaData "ScriptInput" "Haskoin.Script.Standard" "haskoin-core-0.21.2-inplace" 'False) (C1 ('MetaCons "RegularInput" 'PrefixI 'True) (S1 ('MetaSel ('Just "getRegularInput") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SimpleInput)) :+: C1 ('MetaCons "ScriptHashInput" 'PrefixI 'True) (S1 ('MetaSel ('Just "getScriptHashInput") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SimpleInput) :*: S1 ('MetaSel ('Just "getScriptHashRedeem") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RedeemScript)))

data SimpleInput

Data type describing standard transaction input scripts. Input scripts provide the signing data required to unlock the coins of the output they are trying to spend, except in pay-to-witness-public-key-hash and pay-to-script-hash transactions.

Constructors

SpendPK

Fields

• getInputSig :: !TxSignature

  transaction signature

SpendPKHash

Fields

• getInputSig :: !TxSignature

  transaction signature

• getInputKey :: !PubKeyI

  public key

SpendMulSig

Fields

• getInputMulSigKeys :: ![TxSignature]

  list of signatures

Instances

Eq SimpleInput

Defined in Haskoin.Script.Standard

Methods

(==) :: SimpleInput -> SimpleInput -> Bool

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

Show SimpleInput

Defined in Haskoin.Script.Standard

Methods

showsPrec :: Int -> SimpleInput -> ShowS

show :: SimpleInput -> String

showList :: [SimpleInput] -> ShowS

Generic SimpleInput

Defined in Haskoin.Script.Standard

Associated Types

type Rep SimpleInput :: Type -> Type

Methods

from :: SimpleInput -> Rep SimpleInput x

to :: Rep SimpleInput x -> SimpleInput

NFData SimpleInput

Defined in Haskoin.Script.Standard

Methods

rnf :: SimpleInput -> ()

type Rep SimpleInput

Defined in Haskoin.Script.Standard

type Rep SimpleInput = D1 ('MetaData "SimpleInput" "Haskoin.Script.Standard" "haskoin-core-0.21.2-inplace" 'False) (C1 ('MetaCons "SpendPK" 'PrefixI 'True) (S1 ('MetaSel ('Just "getInputSig") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TxSignature)) :+: (C1 ('MetaCons "SpendPKHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "getInputSig") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TxSignature) :*: S1 ('MetaSel ('Just "getInputKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PubKeyI)) :+: C1 ('MetaCons "SpendMulSig" 'PrefixI 'True) (S1 ('MetaSel ('Just "getInputMulSigKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [TxSignature]))))

encodeInput :: ScriptInput -> Script

Encode a standard input into a script.

encodeInputBS :: ScriptInput -> ByteString

Similar to encodeInput but encodes directly to a serialized script ByteString.

decodeInput :: Network -> Script -> Either String ScriptInput

Heuristic to decode a ScriptInput from a Script. This function fails if the script can not be parsed as a standard script input.

decodeInputBS :: Network -> ByteString -> Either String ScriptInput

Like decodeInput but decodes directly from a serialized script ByteString.

isSpendPK :: ScriptInput -> Bool

Returns true if the input script is spending from a pay-to-public-key output.

isSpendPKHash :: ScriptInput -> Bool

Returns true if the input script is spending from a pay-to-public-key-hash output.

isSpendMulSig :: ScriptInput -> Bool

Returns true if the input script is spending a multisig output.

isScriptHashInput :: ScriptInput -> Bool

Returns true if the input script is spending a pay-to-script-hash output.