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.

Descriptors

data OutputDescriptor

High level description for a bitcoin output

Constructors

ScriptPubKey ScriptDescriptor

The output is secured by the given script.

P2SH ScriptDescriptor

P2SH embed the argument.

P2WPKH KeyDescriptor

P2WPKH output for the given compressed pubkey.

P2WSH ScriptDescriptor

P2WSH embed the argument.

WrappedWPkh KeyDescriptor

P2SH-P2WPKH the given compressed pubkey.

WrappedWSh ScriptDescriptor

P2SH-P2WSH the given script

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)).

Addr Address

The script which ADDR expands to.

Instances

Eq OutputDescriptor

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

(==) :: OutputDescriptor -> OutputDescriptor -> Bool

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

Show OutputDescriptor

Defined in Language.Bitcoin.Script.Descriptors.Syntax

Methods

showsPrec :: Int -> OutputDescriptor -> ShowS

show :: OutputDescriptor -> String

showList :: [OutputDescriptor] -> ShowS

data ScriptDescriptor

High level description of a bitcoin script

Constructors

Pk KeyDescriptor

Require a signature for this key

Pkh KeyDescriptor

Require a key matching this hash and a signature for that 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.

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

Keys

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

isDefinite :: KeyDescriptor -> Bool

Test whether the key descriptor corresponds to a single key

keyAtIndex :: Word32 -> Key -> Key

For key families, get the key at the given index. Otherwise, return the input key.

keyDescPubKey :: KeyDescriptor -> Maybe PubKeyI

Produce a pubkey if possible

pubKey :: PubKeyI -> KeyDescriptor

Simple explicit public key with no origin information

secKey :: SecKeyI -> KeyDescriptor

Simple explicit secret key with no origin information

keyBytes :: KeyDescriptor -> Maybe ByteString

Produce a key literal if possible

Text representation

descriptorToText :: Network -> OutputDescriptor -> Text

keyDescriptorToText :: Network -> KeyDescriptor -> Text

Parsing

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

outputDescriptorParser :: Network -> Parser OutputDescriptor

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

keyDescriptorParser :: Network -> Parser KeyDescriptor

Conversions

descriptorAddresses :: OutputDescriptor -> [Address]

Get the set of addresses associated with an output descriptor. The list will be empty if:

• any keys are indefinite
• the output is p2pk
• the output has a non-standard script

The list can contain more than one address in the case of the "combo" construct.

compile :: ScriptDescriptor -> Maybe Script

Produce the script described by the descriptor. Fails when any keys in the descriptor are indeterminate.