Copyright	2020 Input Output (Hong Kong) Ltd. 2021-2022 Input Output Global Inc. (IOG) 2023-2025 Intersect
License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

Cardano.Address.Script

Contents

Script
Script template
Validation
Hashing

Description

Synopsis

data Script elem
- = 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 ValidationLevel
- = RequiredValidation
- | RecommendedValidation
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
scriptHashToText :: ScriptHash -> KeyRole -> Maybe GovernanceType -> Text
scriptHashFromText :: Text -> Either ErrScriptHashFromText ScriptHash
prettyErrScriptHashFromText :: ErrScriptHashFromText -> String

Script

data Script elem #

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

FromJSON (Script KeyHash) #

Instance details

Defined in Cardano.Address.Script

Methods

parseJSON :: Value -> Parser (Script KeyHash) #

parseJSONList :: Value -> Parser [Script KeyHash] #

omittedField :: Maybe (Script KeyHash) #

FromJSON (Script Cosigner) #

Instance details

Defined in Cardano.Address.Script

Methods

parseJSON :: Value -> Parser (Script Cosigner) #

parseJSONList :: Value -> Parser [Script Cosigner] #

omittedField :: Maybe (Script Cosigner) #

ToJSON elem => ToJSON (Script elem) #

Instance details

Defined in Cardano.Address.Script

Methods

toJSON :: Script elem -> Value #

toEncoding :: Script elem -> Encoding #

toJSONList :: [Script elem] -> Value #

toEncodingList :: [Script elem] -> Encoding #

omitField :: Script elem -> Bool #

NFData elem => NFData (Script elem) #

Instance details

Defined in Cardano.Address.Script

Methods

rnf :: Script elem -> () #

Generic (Script elem) #

Instance details

Defined in Cardano.Address.Script

Associated Types

type Rep (Script elem)

Instance details

Defined in Cardano.Address.Script

type Rep (Script elem) = D1 ('MetaData "Script" "Cardano.Address.Script" "cardano-addresses-4.0.2-inplace" '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)))))

Methods

from :: Script elem -> Rep (Script elem) x #

to :: Rep (Script elem) x -> Script elem #

Show elem => Show (Script elem) #

Instance details

Defined in Cardano.Address.Script

Methods

showsPrec :: Int -> Script elem -> ShowS #

show :: Script elem -> String #

showList :: [Script elem] -> ShowS #

Eq elem => Eq (Script elem) #

Instance details

Defined in Cardano.Address.Script

Methods

(==) :: Script elem -> Script elem -> Bool #

(/=) :: Script elem -> Script elem -> Bool #

type Rep (Script elem) #

Instance details

Defined in Cardano.Address.Script

type Rep (Script elem) = D1 ('MetaData "Script" "Cardano.Address.Script" "cardano-addresses-4.0.2-inplace" '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 #

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 #

Script folding

Since: 3.2.0

Script template

data ScriptTemplate #

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

FromJSON ScriptTemplate #

Instance details

Defined in Cardano.Address.Script

Methods

parseJSON :: Value -> Parser ScriptTemplate #

parseJSONList :: Value -> Parser [ScriptTemplate] #

omittedField :: Maybe ScriptTemplate #

ToJSON ScriptTemplate #

Instance details

Defined in Cardano.Address.Script

Methods

toJSON :: ScriptTemplate -> Value #

toEncoding :: ScriptTemplate -> Encoding #

toJSONList :: [ScriptTemplate] -> Value #

toEncodingList :: [ScriptTemplate] -> Encoding #

omitField :: ScriptTemplate -> Bool #

NFData ScriptTemplate #

Instance details

Defined in Cardano.Address.Script

Methods

rnf :: ScriptTemplate -> () #

Generic ScriptTemplate #

Instance details

Defined in Cardano.Address.Script

Associated Types

type Rep ScriptTemplate

Instance details

Defined in Cardano.Address.Script

type Rep ScriptTemplate = D1 ('MetaData "ScriptTemplate" "Cardano.Address.Script" "cardano-addresses-4.0.2-inplace" '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))))

Methods

from :: ScriptTemplate -> Rep ScriptTemplate x #

to :: Rep ScriptTemplate x -> ScriptTemplate #

Show ScriptTemplate #

Instance details

Defined in Cardano.Address.Script

Methods

showsPrec :: Int -> ScriptTemplate -> ShowS #

show :: ScriptTemplate -> String #

showList :: [ScriptTemplate] -> ShowS #

Eq ScriptTemplate #

Instance details

Defined in Cardano.Address.Script

Methods

(==) :: ScriptTemplate -> ScriptTemplate -> Bool #

(/=) :: ScriptTemplate -> ScriptTemplate -> Bool #

type Rep ScriptTemplate #

Instance details

Defined in Cardano.Address.Script

type Rep ScriptTemplate = D1 ('MetaData "ScriptTemplate" "Cardano.Address.Script" "cardano-addresses-4.0.2-inplace" '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 #

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

Since: 3.2.0

Constructors

Cosigner Word8

Instances

Instances details

FromJSON Cosigner #

Instance details

Defined in Cardano.Address.Script

Methods

parseJSON :: Value -> Parser Cosigner #

parseJSONList :: Value -> Parser [Cosigner] #

omittedField :: Maybe Cosigner #

ToJSON Cosigner #

Instance details

Defined in Cardano.Address.Script

Methods

toJSON :: Cosigner -> Value #

toEncoding :: Cosigner -> Encoding #

toJSONList :: [Cosigner] -> Value #

toEncodingList :: [Cosigner] -> Encoding #

omitField :: Cosigner -> Bool #

NFData Cosigner #

Instance details

Defined in Cardano.Address.Script

Methods

rnf :: Cosigner -> () #

Generic Cosigner #

Instance details

Defined in Cardano.Address.Script

Associated Types

type Rep Cosigner
Instance details Defined in Cardano.Address.Script type Rep Cosigner = D1 ('MetaData "Cosigner" "Cardano.Address.Script" "cardano-addresses-4.0.2-inplace" 'True) (C1 ('MetaCons "Cosigner" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

Methods

from :: Cosigner -> Rep Cosigner x #

to :: Rep Cosigner x -> Cosigner #

Show Cosigner #

Instance details

Defined in Cardano.Address.Script

Methods

showsPrec :: Int -> Cosigner -> ShowS #

show :: Cosigner -> String #

showList :: [Cosigner] -> ShowS #

Eq Cosigner #

Instance details

Defined in Cardano.Address.Script

Methods

(==) :: Cosigner -> Cosigner -> Bool #

(/=) :: Cosigner -> Cosigner -> Bool #

Ord Cosigner #

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 #

Hashable Cosigner #

Instance details

Defined in Cardano.Address.Script

Methods

hashWithSalt :: Int -> Cosigner -> Int #

hash :: Cosigner -> Int #

FromJSON (Script Cosigner) #

Instance details

Defined in Cardano.Address.Script

Methods

parseJSON :: Value -> Parser (Script Cosigner) #

parseJSONList :: Value -> Parser [Script Cosigner] #

omittedField :: Maybe (Script Cosigner) #

type Rep Cosigner #

Instance details

Defined in Cardano.Address.Script

type Rep Cosigner = D1 ('MetaData "Cosigner" "Cardano.Address.Script" "cardano-addresses-4.0.2-inplace" 'True) (C1 ('MetaCons "Cosigner" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

Validation

data ValidationLevel #

Validation level. Required level does basic check that will make sure the script is accepted in ledger. Recommended level collects a number of checks that will warn about dangerous, unwise and redundant things present in the script.

Since: 3.2.0

Constructors

RequiredValidation
RecommendedValidation

Instances

Instances details

NFData ValidationLevel #

Instance details

Defined in Cardano.Address.Script

Methods

rnf :: ValidationLevel -> () #

Generic ValidationLevel #

Instance details

Defined in Cardano.Address.Script

Associated Types

type Rep ValidationLevel
Instance details Defined in Cardano.Address.Script type Rep ValidationLevel = D1 ('MetaData "ValidationLevel" "Cardano.Address.Script" "cardano-addresses-4.0.2-inplace" 'False) (C1 ('MetaCons "RequiredValidation" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RecommendedValidation" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: ValidationLevel -> Rep ValidationLevel x #

to :: Rep ValidationLevel x -> ValidationLevel #

Show ValidationLevel #

Instance details

Defined in Cardano.Address.Script

Methods

showsPrec :: Int -> ValidationLevel -> ShowS #

show :: ValidationLevel -> String #

showList :: [ValidationLevel] -> ShowS #

Eq ValidationLevel #

Instance details

Defined in Cardano.Address.Script

Methods

(==) :: ValidationLevel -> ValidationLevel -> Bool #

(/=) :: ValidationLevel -> ValidationLevel -> Bool #

type Rep ValidationLevel #

Instance details

Defined in Cardano.Address.Script

type Rep ValidationLevel = D1 ('MetaData "ValidationLevel" "Cardano.Address.Script" "cardano-addresses-4.0.2-inplace" 'False) (C1 ('MetaCons "RequiredValidation" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RecommendedValidation" 'PrefixI 'False) (U1 :: Type -> Type))

data ErrValidateScript #

Possible validation errors when validating a script

Since: 3.0.0

Constructors

LedgerIncompatible
WrongKeyHash
NotUniformKeyType
Malformed
NotRecommended ErrRecommendedValidateScript

Instances

Instances details

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

data ErrRecommendedValidateScript #

Possible recommended validation errors when validating a script

Since: 3.2.0

Constructors

EmptyList
ListTooSmall
MZero
DuplicateSignatures
RedundantTimelocks
TimelockTrap

Instances

Instances details

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

data ErrValidateScriptTemplate #

Possible validation errors when validating a script template

Since: 3.2.0

Constructors

WrongScript ErrValidateScript
DuplicateXPubs
UnknownCosigner
MissingCosignerXPub
NoCosignerInScript
NoCosignerXPub

Instances

Instances details

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

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

Validate a Script, semantically

Since: 3.0.0

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

Validate a ScriptTemplate, semantically

Since: 3.2.0

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

Validate a script in ScriptTemplate

Since: 3.5.0

prettyErrValidateScript :: ErrValidateScript -> String #

Pretty-print a script validation error.

Since: 3.0.0

prettyErrValidateScriptTemplate :: ErrValidateScriptTemplate -> String #

Pretty-print a script template validation error.

Since: 3.2.0

Hashing

newtype ScriptHash #

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

NFData ScriptHash #

Instance details

Defined in Cardano.Address.Script

Methods

rnf :: ScriptHash -> () #

Generic ScriptHash #

Instance details

Defined in Cardano.Address.Script

Associated Types

type Rep ScriptHash
Instance details Defined in Cardano.Address.Script type Rep ScriptHash = D1 ('MetaData "ScriptHash" "Cardano.Address.Script" "cardano-addresses-4.0.2-inplace" 'True) (C1 ('MetaCons "ScriptHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "unScriptHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: ScriptHash -> Rep ScriptHash x #

to :: Rep ScriptHash x -> ScriptHash #

Show ScriptHash #

Instance details

Defined in Cardano.Address.Script

Methods

showsPrec :: Int -> ScriptHash -> ShowS #

show :: ScriptHash -> String #

showList :: [ScriptHash] -> ShowS #

Eq ScriptHash #

Instance details

Defined in Cardano.Address.Script

Methods

(==) :: ScriptHash -> ScriptHash -> Bool #

(/=) :: ScriptHash -> ScriptHash -> Bool #

Ord ScriptHash #

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 #

type Rep ScriptHash #

Instance details

Defined in Cardano.Address.Script

type Rep ScriptHash = D1 ('MetaData "ScriptHash" "Cardano.Address.Script" "cardano-addresses-4.0.2-inplace" 'True) (C1 ('MetaCons "ScriptHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "unScriptHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

toScriptHash :: Script KeyHash -> ScriptHash #

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

Since: 3.0.0

scriptHashFromBytes :: ByteString -> Maybe ScriptHash #

Construct an ScriptHash from raw ByteString (28 bytes).

Since: 3.0.0

scriptHashToText :: ScriptHash -> KeyRole -> Maybe GovernanceType -> Text #

Encode a ScriptHash to bech32 Text or hex if key role is unknown. In the case of governance role, if one wants to include additional byte as specified in CIP-0129 unless the function is called with CIP0105.

One byte is prepended to script hash only in governance context. The rules how to contruct it are summarized below

  drep       0010....
  hot        0000....    key type
  cold       0001....

  scripthash ....0011    credential type

This is on top of X_script, where X={drep, cc_hot, cc_hot}, which lacks the additional byte. In scriptHashFromText we additionally support reading legacy X which also lacks the additional byte, and has the same payload as as the corresponding X_script.

Since: 4.0.0

scriptHashFromText :: Text -> Either ErrScriptHashFromText ScriptHash #

Construct a ScriptHash from Text. It should be

Bech32 encoded text with one of following hrp:

script
drep
cc_cold
cc_hot
drep_script
cc_cold_script
cc_hot_script

If if hex is encountered it is converted in rawly fashion

Since: 4.0.0

prettyErrScriptHashFromText :: ErrScriptHashFromText -> String #

Possible errors when deserializing a script hash from text.

Since: 4.0.0