Safe Haskell	None
Language	Haskell2010

Cardano.Address.Script

Contents

Script
Script template
Validation
Hashing

Synopsis

data Script (elem :: Type)
- = RequireSignatureOf !elem
- | RequireAllOf ![Script elem]
- | RequireAnyOf ![Script elem]
- | RequireSomeOf Word8 ![Script elem]
- | ActiveFromSlot Natural
- | ActiveUntilSlot Natural
serializeScript :: Script KeyHash -> ByteString
foldScript :: (a -> b -> b) -> b -> Script a -> b
data ScriptTemplate = ScriptTemplate {
- cosigners :: Map Cosigner XPub
- template :: Script Cosigner
}
newtype Cosigner = Cosigner Word8
data ErrValidateScript
- = LedgerIncompatible
- | WrongKeyHash
- | NotUniformKeyType
- | Malformed
- | NotRecommended ErrRecommendedValidateScript
data ErrRecommendedValidateScript
- = EmptyList
- | ListTooSmall
- | MZero
- | DuplicateSignatures
- | RedundantTimelocks
- | TimelockTrap
data ErrValidateScriptTemplate
- = WrongScript ErrValidateScript
- | DuplicateXPubs
- | UnknownCosigner
- | MissingCosignerXPub
- | NoCosignerInScript
- | NoCosignerXPub
validateScript :: ValidationLevel -> Script KeyHash -> Either ErrValidateScript ()
validateScriptTemplate :: ValidationLevel -> ScriptTemplate -> Either ErrValidateScriptTemplate ()
validateScriptOfTemplate :: ValidationLevel -> Script Cosigner -> Either ErrValidateScript ()
prettyErrValidateScript :: ErrValidateScript -> String
prettyErrValidateScriptTemplate :: ErrValidateScriptTemplate -> String
newtype ScriptHash = ScriptHash {
- unScriptHash :: ByteString
}
toScriptHash :: Script KeyHash -> ScriptHash
scriptHashFromBytes :: ByteString -> Maybe ScriptHash
data KeyHash = KeyHash {
- role :: KeyRole
- digest :: ByteString
}
keyHashFromBytes :: (KeyRole, ByteString) -> Maybe KeyHash
keyHashFromText :: Text -> Either ErrKeyHashFromText KeyHash
keyHashToText :: KeyHash -> Text

Script

data Script (elem :: Type) Source #

A Script type represents multi signature script. The script embodies conditions that need to be satisfied to make it valid.

Since: 3.0.0

Constructors

RequireSignatureOf !elem
RequireAllOf ![Script elem]
RequireAnyOf ![Script elem]
RequireSomeOf Word8 ![Script elem]
ActiveFromSlot Natural
ActiveUntilSlot Natural

Instances

Instances details

Eq elem => Eq (Script elem) Source #
Instance details Defined in Cardano.Address.Script Methods (==) :: Script elem -> Script elem -> Bool # (/=) :: Script elem -> Script elem -> Bool #
Show elem => Show (Script elem) Source #
Instance details Defined in Cardano.Address.Script Methods showsPrec :: Int -> Script elem -> ShowS # show :: Script elem -> String # showList :: [Script elem] -> ShowS #
Generic (Script elem) Source #
Instance details Defined in Cardano.Address.Script Associated Types type Rep (Script elem) :: Type -> Type # Methods from :: Script elem -> Rep (Script elem) x # to :: Rep (Script elem) x -> Script elem #
NFData elem => NFData (Script elem) Source #
Instance details Defined in Cardano.Address.Script Methods rnf :: Script elem -> () #
FromJSON (Script KeyHash) Source #
Instance details Defined in Cardano.Address.Script Methods parseJSON :: Value -> Parser (Script KeyHash) parseJSONList :: Value -> Parser [Script KeyHash]
FromJSON (Script Cosigner) Source #
Instance details Defined in Cardano.Address.Script Methods parseJSON :: Value -> Parser (Script Cosigner) parseJSONList :: Value -> Parser [Script Cosigner]
ToJSON elem => ToJSON (Script elem) Source #
Instance details Defined in Cardano.Address.Script Methods toJSON :: Script elem -> Value toEncoding :: Script elem -> Encoding toJSONList :: [Script elem] -> Value toEncodingList :: [Script elem] -> Encoding
type Rep (Script elem) Source #
Instance details Defined in Cardano.Address.Script type Rep (Script elem) = D1 ('MetaData "Script" "Cardano.Address.Script" "cardano-addresses-3.12.0-CXdZXYlvM2IBJZenPvTIY5" 'False) ((C1 ('MetaCons "RequireSignatureOf" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 elem)) :+: (C1 ('MetaCons "RequireAllOf" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Script elem])) :+: C1 ('MetaCons "RequireAnyOf" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Script elem])))) :+: (C1 ('MetaCons "RequireSomeOf" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Script elem])) :+: (C1 ('MetaCons "ActiveFromSlot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)) :+: C1 ('MetaCons "ActiveUntilSlot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))))

serializeScript :: Script KeyHash -> ByteString Source #

This function realizes what cardano-node's `Api.serialiseToCBOR script` realizes This is basically doing the symbolically following: toCBOR [0,multisigScript]

Since: 3.0.0

foldScript :: (a -> b -> b) -> b -> Script a -> b Source #

Script folding

Since: 3.2.0

Script template

data ScriptTemplate Source #

Represents the script template that show the structure of the script and determines the expected place of verification keys corresponding to given cosigners.

Since: 3.2.0

Constructors

ScriptTemplate
Fields cosigners :: Map Cosigner XPub template :: Script Cosigner

Instances

Instances details

Eq ScriptTemplate Source #
Instance details Defined in Cardano.Address.Script Methods (==) :: ScriptTemplate -> ScriptTemplate -> Bool # (/=) :: ScriptTemplate -> ScriptTemplate -> Bool #
Show ScriptTemplate Source #
Instance details Defined in Cardano.Address.Script Methods showsPrec :: Int -> ScriptTemplate -> ShowS # show :: ScriptTemplate -> String # showList :: [ScriptTemplate] -> ShowS #
Generic ScriptTemplate Source #
Instance details Defined in Cardano.Address.Script Associated Types type Rep ScriptTemplate :: Type -> Type # Methods from :: ScriptTemplate -> Rep ScriptTemplate x # to :: Rep ScriptTemplate x -> ScriptTemplate #
NFData ScriptTemplate Source #
Instance details Defined in Cardano.Address.Script Methods rnf :: ScriptTemplate -> () #
FromJSON ScriptTemplate Source #
Instance details Defined in Cardano.Address.Script Methods parseJSON :: Value -> Parser ScriptTemplate parseJSONList :: Value -> Parser [ScriptTemplate]
ToJSON ScriptTemplate Source #
Instance details Defined in Cardano.Address.Script Methods toJSON :: ScriptTemplate -> Value toEncoding :: ScriptTemplate -> Encoding toJSONList :: [ScriptTemplate] -> Value toEncodingList :: [ScriptTemplate] -> Encoding
type Rep ScriptTemplate Source #
Instance details Defined in Cardano.Address.Script type Rep ScriptTemplate = D1 ('MetaData "ScriptTemplate" "Cardano.Address.Script" "cardano-addresses-3.12.0-CXdZXYlvM2IBJZenPvTIY5" 'False) (C1 ('MetaCons "ScriptTemplate" 'PrefixI 'True) (S1 ('MetaSel ('Just "cosigners") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Cosigner XPub)) :*: S1 ('MetaSel ('Just "template") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Script Cosigner))))

newtype Cosigner Source #

Represents the cosigner of the script, ie., party that co-shares the script.

Since: 3.2.0

Constructors

Cosigner Word8

Instances

Instances details

Eq Cosigner Source #
Instance details Defined in Cardano.Address.Script Methods (==) :: Cosigner -> Cosigner -> Bool # (/=) :: Cosigner -> Cosigner -> Bool #
Ord Cosigner Source #
Instance details Defined in Cardano.Address.Script Methods compare :: Cosigner -> Cosigner -> Ordering # (<) :: Cosigner -> Cosigner -> Bool # (<=) :: Cosigner -> Cosigner -> Bool # (>) :: Cosigner -> Cosigner -> Bool # (>=) :: Cosigner -> Cosigner -> Bool # max :: Cosigner -> Cosigner -> Cosigner # min :: Cosigner -> Cosigner -> Cosigner #
Show Cosigner Source #
Instance details Defined in Cardano.Address.Script Methods showsPrec :: Int -> Cosigner -> ShowS # show :: Cosigner -> String # showList :: [Cosigner] -> ShowS #
Generic Cosigner Source #
Instance details Defined in Cardano.Address.Script Associated Types type Rep Cosigner :: Type -> Type # Methods from :: Cosigner -> Rep Cosigner x # to :: Rep Cosigner x -> Cosigner #
NFData Cosigner Source #
Instance details Defined in Cardano.Address.Script Methods rnf :: Cosigner -> () #
FromJSON Cosigner Source #
Instance details Defined in Cardano.Address.Script Methods parseJSON :: Value -> Parser Cosigner parseJSONList :: Value -> Parser [Cosigner]
ToJSON Cosigner Source #
Instance details Defined in Cardano.Address.Script Methods toJSON :: Cosigner -> Value toEncoding :: Cosigner -> Encoding toJSONList :: [Cosigner] -> Value toEncodingList :: [Cosigner] -> Encoding
Hashable Cosigner Source #
Instance details Defined in Cardano.Address.Script Methods hashWithSalt :: Int -> Cosigner -> Int hash :: Cosigner -> Int
FromJSON (Script Cosigner) Source #
Instance details Defined in Cardano.Address.Script Methods parseJSON :: Value -> Parser (Script Cosigner) parseJSONList :: Value -> Parser [Script Cosigner]
type Rep Cosigner Source #
Instance details Defined in Cardano.Address.Script type Rep Cosigner = D1 ('MetaData "Cosigner" "Cardano.Address.Script" "cardano-addresses-3.12.0-CXdZXYlvM2IBJZenPvTIY5" 'True) (C1 ('MetaCons "Cosigner" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

Validation

data ErrValidateScript Source #

Possible validation errors when validating a script

Since: 3.0.0

Constructors

LedgerIncompatible
WrongKeyHash
NotUniformKeyType
Malformed
NotRecommended ErrRecommendedValidateScript

Instances

Instances details

Eq ErrValidateScript Source #
Instance details Defined in Cardano.Address.Script Methods (==) :: ErrValidateScript -> ErrValidateScript -> Bool # (/=) :: ErrValidateScript -> ErrValidateScript -> Bool #
Show ErrValidateScript Source #
Instance details Defined in Cardano.Address.Script Methods showsPrec :: Int -> ErrValidateScript -> ShowS # show :: ErrValidateScript -> String # showList :: [ErrValidateScript] -> ShowS #

Possible recommended validation errors when validating a script

Since: 3.2.0

Constructors

EmptyList
ListTooSmall
MZero
DuplicateSignatures
RedundantTimelocks
TimelockTrap

Instances

Instances details

Eq ErrRecommendedValidateScript Source #
Instance details Defined in Cardano.Address.Script Methods (==) :: ErrRecommendedValidateScript -> ErrRecommendedValidateScript -> Bool # (/=) :: ErrRecommendedValidateScript -> ErrRecommendedValidateScript -> Bool #
Show ErrRecommendedValidateScript Source #
Instance details Defined in Cardano.Address.Script Methods showsPrec :: Int -> ErrRecommendedValidateScript -> ShowS # show :: ErrRecommendedValidateScript -> String # showList :: [ErrRecommendedValidateScript] -> ShowS #

data ErrValidateScriptTemplate Source #

Possible validation errors when validating a script template

Since: 3.2.0

Constructors

WrongScript ErrValidateScript
DuplicateXPubs
UnknownCosigner
MissingCosignerXPub
NoCosignerInScript
NoCosignerXPub

Instances

Instances details

Eq ErrValidateScriptTemplate Source #
Instance details Defined in Cardano.Address.Script Methods (==) :: ErrValidateScriptTemplate -> ErrValidateScriptTemplate -> Bool # (/=) :: ErrValidateScriptTemplate -> ErrValidateScriptTemplate -> Bool #
Show ErrValidateScriptTemplate Source #
Instance details Defined in Cardano.Address.Script Methods showsPrec :: Int -> ErrValidateScriptTemplate -> ShowS # show :: ErrValidateScriptTemplate -> String # showList :: [ErrValidateScriptTemplate] -> ShowS #

validateScript :: ValidationLevel -> Script KeyHash -> Either ErrValidateScript () Source #

Validate a Script, semantically

Since: 3.0.0

validateScriptTemplate :: ValidationLevel -> ScriptTemplate -> Either ErrValidateScriptTemplate () Source #

Validate a ScriptTemplate, semantically

Since: 3.2.0

validateScriptOfTemplate :: ValidationLevel -> Script Cosigner -> Either ErrValidateScript () Source #

Validate a script in ScriptTemplate

Since: 3.5.0

prettyErrValidateScript :: ErrValidateScript -> String Source #

Pretty-print a script validation error.

Since: 3.0.0

prettyErrValidateScriptTemplate :: ErrValidateScriptTemplate -> String Source #

Pretty-print a script template validation error.

Since: 3.2.0

Hashing

newtype ScriptHash Source #

A ScriptHash type represents script hash. The hash is expected to have size of 28-byte.

Since: 3.0.0

Constructors

ScriptHash
Fields unScriptHash :: ByteString

Instances

Instances details

Eq ScriptHash Source #
Instance details Defined in Cardano.Address.Script Methods (==) :: ScriptHash -> ScriptHash -> Bool # (/=) :: ScriptHash -> ScriptHash -> Bool #
Ord ScriptHash Source #
Instance details Defined in Cardano.Address.Script Methods compare :: ScriptHash -> ScriptHash -> Ordering # (<) :: ScriptHash -> ScriptHash -> Bool # (<=) :: ScriptHash -> ScriptHash -> Bool # (>) :: ScriptHash -> ScriptHash -> Bool # (>=) :: ScriptHash -> ScriptHash -> Bool # max :: ScriptHash -> ScriptHash -> ScriptHash # min :: ScriptHash -> ScriptHash -> ScriptHash #
Show ScriptHash Source #
Instance details Defined in Cardano.Address.Script Methods showsPrec :: Int -> ScriptHash -> ShowS # show :: ScriptHash -> String # showList :: [ScriptHash] -> ShowS #
Generic ScriptHash Source #
Instance details Defined in Cardano.Address.Script Associated Types type Rep ScriptHash :: Type -> Type # Methods from :: ScriptHash -> Rep ScriptHash x # to :: Rep ScriptHash x -> ScriptHash #
NFData ScriptHash Source #
Instance details Defined in Cardano.Address.Script Methods rnf :: ScriptHash -> () #
type Rep ScriptHash Source #
Instance details Defined in Cardano.Address.Script type Rep ScriptHash = D1 ('MetaData "ScriptHash" "Cardano.Address.Script" "cardano-addresses-3.12.0-CXdZXYlvM2IBJZenPvTIY5" 'True) (C1 ('MetaCons "ScriptHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "unScriptHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

toScriptHash :: Script KeyHash -> ScriptHash Source #

Computes the hash of a given script, by first serializing it to CBOR.

Since: 3.0.0

scriptHashFromBytes :: ByteString -> Maybe ScriptHash Source #

Construct an ScriptHash from raw ByteString (28 bytes).

Since: 3.0.0

data KeyHash Source #

A KeyHash type represents verification key hash that participate in building multi-signature script. The hash is expected to have size of 28-byte.

Since: 3.0.0

Constructors

KeyHash
Fields role :: KeyRole digest :: ByteString

Instances

Instances details

Eq KeyHash Source #
Instance details Defined in Cardano.Address.Script Methods (==) :: KeyHash -> KeyHash -> Bool # (/=) :: KeyHash -> KeyHash -> Bool #
Ord KeyHash Source #
Instance details Defined in Cardano.Address.Script Methods compare :: KeyHash -> KeyHash -> Ordering # (<) :: KeyHash -> KeyHash -> Bool # (<=) :: KeyHash -> KeyHash -> Bool # (>) :: KeyHash -> KeyHash -> Bool # (>=) :: KeyHash -> KeyHash -> Bool # max :: KeyHash -> KeyHash -> KeyHash # min :: KeyHash -> KeyHash -> KeyHash #
Show KeyHash Source #
Instance details Defined in Cardano.Address.Script Methods showsPrec :: Int -> KeyHash -> ShowS # show :: KeyHash -> String # showList :: [KeyHash] -> ShowS #
Generic KeyHash Source #
Instance details Defined in Cardano.Address.Script Associated Types type Rep KeyHash :: Type -> Type # Methods from :: KeyHash -> Rep KeyHash x # to :: Rep KeyHash x -> KeyHash #
NFData KeyHash Source #
Instance details Defined in Cardano.Address.Script Methods rnf :: KeyHash -> () #
ToJSON KeyHash Source #
Instance details Defined in Cardano.Address.Script Methods toJSON :: KeyHash -> Value toEncoding :: KeyHash -> Encoding toJSONList :: [KeyHash] -> Value toEncodingList :: [KeyHash] -> Encoding
FromJSON (Script KeyHash) Source #
Instance details Defined in Cardano.Address.Script Methods parseJSON :: Value -> Parser (Script KeyHash) parseJSONList :: Value -> Parser [Script KeyHash]
type Rep KeyHash Source #
Instance details Defined in Cardano.Address.Script type Rep KeyHash = D1 ('MetaData "KeyHash" "Cardano.Address.Script" "cardano-addresses-3.12.0-CXdZXYlvM2IBJZenPvTIY5" 'False) (C1 ('MetaCons "KeyHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 KeyRole) :*: S1 ('MetaSel ('Just "digest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

keyHashFromBytes :: (KeyRole, ByteString) -> Maybe KeyHash Source #

Construct an KeyHash from raw ByteString (28 bytes).

Since: 3.0.0

keyHashFromText :: Text -> Either ErrKeyHashFromText KeyHash Source #

Construct a KeyHash from Text. It should be Bech32 encoded text with one of following hrp: - addr_shared_vkh - stake_shared_vkh - addr_vkh - stake_vkh - policy_vkh - addr_shared_vk - stake_shared_vk - addr_vk - stake_vk - addr_shared_xvk - stake_shared_xvk - addr_xvk - stake_xvk - policy_vk - policy_xvk Raw keys will be hashed on the fly, whereas hash that are directly provided will remain as such. If if hex is encountered Unknown policy key is assumed

Since: 3.1.0

keyHashToText :: KeyHash -> Text Source #

Encode a KeyHash to bech32 Text or hex is key role unknown.

Since: 3.0.0