Language.Bitcoin.Miniscript

Haskell embedding of miniscript. See http://bitcoin.sipa.be/miniscript/ for details. Much of the documentation below is taken from this site.

Syntax tree

data Value a

Constructors

Variable Text

Lit a

Instances

Eq a => Eq (Value a)

Defined in Language.Bitcoin.Miniscript.Syntax

Methods

(==) :: Value a -> Value a -> Bool

(/=) :: Value a -> Value a -> Bool

Ord a => Ord (Value a)

Defined in Language.Bitcoin.Miniscript.Syntax

Methods

compare :: Value a -> Value a -> Ordering

(<) :: Value a -> Value a -> Bool

(<=) :: Value a -> Value a -> Bool

(>) :: Value a -> Value a -> Bool

(>=) :: Value a -> Value a -> Bool

max :: Value a -> Value a -> Value a

min :: Value a -> Value a -> Value a

Show a => Show (Value a)

Defined in Language.Bitcoin.Miniscript.Syntax

Methods

showsPrec :: Int -> Value a -> ShowS

show :: Value a -> String

showList :: [Value a] -> ShowS

var :: Text -> Value a

literal :: a -> Value a

data Miniscript

The Miniscript AST with the addition of key descriptors and let bindings

Constructors

Var Text

Let Text Miniscript Miniscript

Boolean Bool

Number Int

Bytes ByteString

KeyDesc KeyDescriptor

Key (Value KeyDescriptor)

KeyH (Value KeyDescriptor)

Older (Value Int)

After (Value Int)

Sha256 (Value ByteString)

Ripemd160 (Value ByteString)

Hash256 (Value ByteString)

Hash160 (Value ByteString)

AndOr Miniscript Miniscript Miniscript

AndV Miniscript Miniscript

AndB Miniscript Miniscript

OrB Miniscript Miniscript

OrC Miniscript Miniscript

OrD Miniscript Miniscript

OrI Miniscript Miniscript

Thresh (Value Int) Miniscript [Miniscript]

Multi (Value Int) [Value KeyDescriptor]

AnnA Miniscript

AnnS Miniscript

AnnC Miniscript

AnnD Miniscript

AnnV Miniscript

AnnJ Miniscript

AnnN Miniscript

Instances

Eq Miniscript

Defined in Language.Bitcoin.Miniscript.Syntax

Methods

(==) :: Miniscript -> Miniscript -> Bool

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

Show Miniscript

Defined in Language.Bitcoin.Miniscript.Syntax

Methods

showsPrec :: Int -> Miniscript -> ShowS

show :: Miniscript -> String

showList :: [Miniscript] -> ShowS

let_ :: [(Text, Miniscript)] -> Miniscript -> Miniscript

key :: KeyDescriptor -> Miniscript

Check a key

keyH :: KeyDescriptor -> Miniscript

Check a key hash

older :: Int -> Miniscript

after :: Int -> Miniscript

sha256 :: ByteString -> Miniscript

ripemd160 :: ByteString -> Miniscript

hash256 :: ByteString -> Miniscript

hash160 :: ByteString -> Miniscript

thresh :: Int -> Miniscript -> [Miniscript] -> Miniscript

multi :: Int -> [KeyDescriptor] -> Miniscript

class MiniscriptAnnotation a where

Methods

(.:) :: a -> Miniscript -> Miniscript

Instances

MiniscriptAnnotation Annotation

Defined in Language.Bitcoin.Miniscript.Syntax

Methods

(.:) :: Annotation -> Miniscript -> Miniscript

MiniscriptAnnotation a => MiniscriptAnnotation [a]

Defined in Language.Bitcoin.Miniscript.Syntax

Methods

(.:) :: [a] -> Miniscript -> Miniscript

data Annotation

Constructors

A

S

C

D

V

J

N

T

L

U

Instances

Enum Annotation

Defined in Language.Bitcoin.Miniscript.Syntax

Methods

succ :: Annotation -> Annotation

pred :: Annotation -> Annotation

toEnum :: Int -> Annotation

fromEnum :: Annotation -> Int

enumFrom :: Annotation -> [Annotation]

enumFromThen :: Annotation -> Annotation -> [Annotation]

enumFromTo :: Annotation -> Annotation -> [Annotation]

enumFromThenTo :: Annotation -> Annotation -> Annotation -> [Annotation]

Eq Annotation

Defined in Language.Bitcoin.Miniscript.Syntax

Methods

(==) :: Annotation -> Annotation -> Bool

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

Ord Annotation

Defined in Language.Bitcoin.Miniscript.Syntax

Methods

compare :: Annotation -> Annotation -> Ordering

(<) :: Annotation -> Annotation -> Bool

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

(>) :: Annotation -> Annotation -> Bool

(>=) :: Annotation -> Annotation -> Bool

max :: Annotation -> Annotation -> Annotation

min :: Annotation -> Annotation -> Annotation

Show Annotation

Defined in Language.Bitcoin.Miniscript.Syntax

Methods

showsPrec :: Int -> Annotation -> ShowS

show :: Annotation -> String

showList :: [Annotation] -> ShowS

MiniscriptAnnotation Annotation

Defined in Language.Bitcoin.Miniscript.Syntax

Methods

(.:) :: Annotation -> Miniscript -> Miniscript

Type system

data BaseType

Constructors

TypeB

Base expression

TypeV

Verify expression

TypeK

Key expression

TypeW

Wrapped expression

TypeNumber

Number expression

TypeBytes

Bytes expression

TypeKeyDesc

Key descriptor type

Instances

Eq BaseType

Defined in Language.Bitcoin.Miniscript.Types

Methods

(==) :: BaseType -> BaseType -> Bool

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

Show BaseType

Defined in Language.Bitcoin.Miniscript.Types

Methods

showsPrec :: Int -> BaseType -> ShowS

show :: BaseType -> String

showList :: [BaseType] -> ShowS

data ModField

Type modifications that imply additional properties of the expression

Constructors

ModField

Fields

• modZ :: Bool

  Consumes exactly 0 stack elements

• modO :: Bool

  One-arg: this expression always consumes exactly 1 stack element.

• modN :: Bool

  Nonzero: this expression always consumes at least 1 stack element, no satisfaction for this expression requires the top input stack element to be zero.

• modD :: Bool

  Dissatisfiable: a dissatisfaction for this expression can unconditionally be constructed.

• modU :: Bool

  Unit: when satisfied put exactly 1 on the stack

Instances

Eq ModField

Defined in Language.Bitcoin.Miniscript.Types

Methods

(==) :: ModField -> ModField -> Bool

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

Show ModField

Defined in Language.Bitcoin.Miniscript.Types

Methods

showsPrec :: Int -> ModField -> ShowS

show :: ModField -> String

showList :: [ModField] -> ShowS

data MiniscriptType

Constructors

MiniscriptType

Fields

• baseType :: BaseType
• modifiers :: ModField

Instances

Eq MiniscriptType

Defined in Language.Bitcoin.Miniscript.Types

Methods

(==) :: MiniscriptType -> MiniscriptType -> Bool

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

Show MiniscriptType

Defined in Language.Bitcoin.Miniscript.Types

Methods

showsPrec :: Int -> MiniscriptType -> ShowS

show :: MiniscriptType -> String

showList :: [MiniscriptType] -> ShowS

boolType :: Bool -> MiniscriptType

numberType :: MiniscriptType

bytesType :: MiniscriptType

keyDescriptorType :: MiniscriptType

typeCheckMiniscript

Arguments

:: Map Text MiniscriptType

type hints for free variables in the miniscript expression

-> Miniscript

-> Either MiniscriptTypeError MiniscriptType

Check that a miniscript expression is well-typed.

data MiniscriptTypeError

Constructors

MiniscriptTypeError Miniscript

UntypedVariable Text

WrongVariableType Text BaseType MiniscriptType

fields: name expectedBaseType typeAnnotation

Instances

Eq MiniscriptTypeError

Defined in Language.Bitcoin.Miniscript.Types

Methods

(==) :: MiniscriptTypeError -> MiniscriptTypeError -> Bool

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

Show MiniscriptTypeError

Defined in Language.Bitcoin.Miniscript.Types

Methods

showsPrec :: Int -> MiniscriptTypeError -> ShowS

show :: MiniscriptTypeError -> String

showList :: [MiniscriptTypeError] -> ShowS

Compilation

compile :: Miniscript -> Either CompilerError Script

Type check and compile a miniscript

compileOnly :: Miniscript -> Either CompilerError Script

Compile a miniscript without type checking

data CompilerError

Constructors

FreeVariable Text

CompilerError Miniscript

TypeError MiniscriptTypeError

NotImplemented Miniscript

AbstractKey KeyDescriptor

Instances

Eq CompilerError

Defined in Language.Bitcoin.Miniscript.Compiler

Methods

(==) :: CompilerError -> CompilerError -> Bool

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

Show CompilerError

Defined in Language.Bitcoin.Miniscript.Compiler

Methods

showsPrec :: Int -> CompilerError -> ShowS

show :: CompilerError -> String

showList :: [CompilerError] -> ShowS

Exception CompilerError

Defined in Language.Bitcoin.Miniscript.Compiler

Methods

toException :: CompilerError -> SomeException

fromException :: SomeException -> Maybe CompilerError

displayException :: CompilerError -> String

Printing and parsing

miniscriptToText :: Network -> Miniscript -> Text

miniscriptParser :: Network -> Parser Miniscript

parseMiniscript :: Network -> Text -> Either String Miniscript