Language.Bitcoin.Script.Descriptors

A library for working with bitcoin script descriptors. Documentation taken from https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md.

Documentation

data ScriptDescriptor

Constructors

Sh ScriptDescriptor

P2SH embed the argument.

Wsh ScriptDescriptor

P2WSH embed the argument.

Pk KeyDescriptor

P2PK output for the given public key.

Pkh KeyDescriptor

P2PKH output for the given public key (use Addr if you only know the pubkey hash).

Wpkh KeyDescriptor

P2WPKH output for the given compressed pubkey.

Combo KeyDescriptor

An alias for the collection of pk(KEY) and pkh(KEY). If the key is compressed, it also includes wpkh(KEY) and sh(wpkh(KEY)).

Multi Int [KeyDescriptor]

k-of-n multisig script.

SortedMulti Int [KeyDescriptor]

k-of-n multisig script with keys sorted lexicographically in the resulting script.

Addr Address

the script which ADDR expands to.

Raw ByteString

the script whose hex encoding is HEX.

Instances

Eq ScriptDescriptor

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

(==) :: ScriptDescriptor -> ScriptDescriptor -> Bool

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

Show ScriptDescriptor

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

showsPrec :: Int -> ScriptDescriptor -> ShowS

show :: ScriptDescriptor -> String

showList :: [ScriptDescriptor] -> ShowS

data KeyDescriptor

Constructors

KeyDescriptor

Fields

• origin :: Maybe Origin
• keyDef :: Key

Instances

Eq KeyDescriptor

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

(==) :: KeyDescriptor -> KeyDescriptor -> Bool

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

Show KeyDescriptor

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

showsPrec :: Int -> KeyDescriptor -> ShowS

show :: KeyDescriptor -> String

showList :: [KeyDescriptor] -> ShowS

data Origin

Constructors

Origin

Fields

• fingerprint :: Fingerprint
• derivation :: DerivPath

Instances

Eq Origin

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

(==) :: Origin -> Origin -> Bool

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

Ord Origin

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

compare :: Origin -> Origin -> Ordering

(<) :: Origin -> Origin -> Bool

(<=) :: Origin -> Origin -> Bool

(>) :: Origin -> Origin -> Bool

(>=) :: Origin -> Origin -> Bool

max :: Origin -> Origin -> Origin

min :: Origin -> Origin -> Origin

Show Origin

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

showsPrec :: Int -> Origin -> ShowS

show :: Origin -> String

showList :: [Origin] -> ShowS

data Key

Constructors

Pubkey PubKeyI

DER-hex encoded secp256k1 public key

SecretKey SecKeyI

(de)serialized as WIF

XPub XPubKey DerivPath KeyCollection

Instances

Eq Key

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

(==) :: Key -> Key -> Bool

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

Show Key

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

data KeyCollection

Represent whether the key corresponds to a collection (and how) or a single key.

Constructors

Single

HardKeys

immediate hardened children

SoftKeys

immediate non-hardened children

Instances

Eq KeyCollection

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

(==) :: KeyCollection -> KeyCollection -> Bool

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

Ord KeyCollection

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

compare :: KeyCollection -> KeyCollection -> Ordering

(<) :: KeyCollection -> KeyCollection -> Bool

(<=) :: KeyCollection -> KeyCollection -> Bool

(>) :: KeyCollection -> KeyCollection -> Bool

(>=) :: KeyCollection -> KeyCollection -> Bool

max :: KeyCollection -> KeyCollection -> KeyCollection

min :: KeyCollection -> KeyCollection -> KeyCollection

Show KeyCollection

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

showsPrec :: Int -> KeyCollection -> ShowS

show :: KeyCollection -> String

showList :: [KeyCollection] -> ShowS

pubKey :: PubKeyI -> KeyDescriptor

Simple explicit public key with no origin information

secKey :: SecKeyI -> KeyDescriptor

Simple explicit secret key with no origin information

keyDescPubKey :: KeyDescriptor -> Maybe PubKeyI

Produce a pubkey if possible

keyBytes :: KeyDescriptor -> Maybe ByteString

Produce a key literal if possible

Text representation

descriptorToText :: Network -> ScriptDescriptor -> Text

keyDescriptorToText :: Network -> KeyDescriptor -> Text

Parsing

parseDescriptor :: Network -> Text -> Either String ScriptDescriptor

descriptorParser :: Network -> Parser ScriptDescriptor

parseKeyDescriptor :: Network -> Text -> Either String KeyDescriptor

keyDescriptorParser :: Network -> Parser KeyDescriptor