Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Shelley.Scripts

Contents

Orphan instances

Synopsis

data MultiSig era
class EraScript era ⇒ ShelleyEraScript era where
- mkRequireSignature ∷ KeyHash 'Witness (EraCrypto era) → NativeScript era
- getRequireSignature ∷ NativeScript era → Maybe (KeyHash 'Witness (EraCrypto era))
- mkRequireAllOf ∷ StrictSeq (NativeScript era) → NativeScript era
- getRequireAllOf ∷ NativeScript era → Maybe (StrictSeq (NativeScript era))
- mkRequireAnyOf ∷ StrictSeq (NativeScript era) → NativeScript era
- getRequireAnyOf ∷ NativeScript era → Maybe (StrictSeq (NativeScript era))
- mkRequireMOf ∷ Int → StrictSeq (NativeScript era) → NativeScript era
- getRequireMOf ∷ NativeScript era → Maybe (Int, StrictSeq (NativeScript era))
pattern RequireSignature ∷ ShelleyEraScript era ⇒ KeyHash 'Witness (EraCrypto era) → NativeScript era
pattern RequireAllOf ∷ ShelleyEraScript era ⇒ StrictSeq (NativeScript era) → NativeScript era
pattern RequireAnyOf ∷ ShelleyEraScript era ⇒ StrictSeq (NativeScript era) → NativeScript era
pattern RequireMOf ∷ ShelleyEraScript era ⇒ Int → StrictSeq (NativeScript era) → NativeScript era
evalMultiSig ∷ (ShelleyEraScript era, NativeScript era ~ MultiSig era) ⇒ Set (KeyHash 'Witness (EraCrypto era)) → NativeScript era → Bool
validateMultiSig ∷ (ShelleyEraScript era, EraTx era, NativeScript era ~ MultiSig era) ⇒ Tx era → NativeScript era → Bool
newtype ScriptHash c = ScriptHash (Hash (ADDRHASH c) EraIndependentScript)
nativeMultiSigTag ∷ ByteString
eqMultiSigRaw ∷ MultiSig era → MultiSig era → Bool
data MultiSigRaw era

Documentation

data MultiSig era Source #

Instances

Instances details

Memoized MultiSig Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Associated Types type RawType MultiSig = (r ∷ Type → Type) Source # Methods getMemoBytes ∷ MultiSig era → MemoBytes (RawType MultiSig) era wrapMemoBytes ∷ MemoBytes (RawType MultiSig) era → MultiSig era
Generic (MultiSig era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Associated Types type Rep (MultiSig era) ∷ Type → Type Source # Methods from ∷ MultiSig era → Rep (MultiSig era) x Source # to ∷ Rep (MultiSig era) x → MultiSig era Source #
HashAlgorithm (HASH (EraCrypto era)) ⇒ Show (MultiSig era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods showsPrec ∷ Int → MultiSig era → ShowS Source # show ∷ MultiSig era → String Source # showList ∷ [MultiSig era] → ShowS Source #
Typeable era ⇒ ToCBOR (MultiSig era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods toCBOR ∷ MultiSig era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (MultiSig era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [MultiSig era] → Size Source #
Era era ⇒ DecCBOR (Annotator (MultiSig era)) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods decCBOR ∷ Decoder s (Annotator (MultiSig era)) Source # dropCBOR ∷ Proxy (Annotator (MultiSig era)) → Decoder s () Source # label ∷ Proxy (Annotator (MultiSig era)) → Text Source #
Era era ⇒ EncCBOR (MultiSig era) Source #	Encodes memoized bytes created upon construction.
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods encCBOR ∷ MultiSig era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (MultiSig era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [MultiSig era] → Size Source #
EqRaw (MultiSig era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods eqRaw ∷ MultiSig era → MultiSig era → Bool Source #
SafeToHash (MultiSig era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods originalBytes ∷ MultiSig era → ByteString Source # originalBytesSize ∷ MultiSig era → Int Source # makeHashWithExplicitProxys ∷ HashAlgorithm (HASH c) ⇒ Proxy c → Proxy index → MultiSig era → SafeHash c index Source #
NFData (MultiSig era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods rnf ∷ MultiSig era → () Source #
Eq (MultiSig era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods (==) ∷ MultiSig era → MultiSig era → Bool Source # (/=) ∷ MultiSig era → MultiSig era → Bool Source #
Typeable era ⇒ NoThunks (MultiSig era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods noThunks ∷ Context → MultiSig era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → MultiSig era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (MultiSig era) → String Source #
type RawType MultiSig Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts type RawType MultiSig = MultiSigRaw
type Rep (MultiSig era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts type Rep (MultiSig era) = D1 ('MetaData "MultiSig" "Cardano.Ledger.Shelley.Scripts" "cardano-ledger-shelley-1.15.0.0-inplace" 'True) (C1 ('MetaCons "MultiSigConstr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MemoBytes MultiSigRaw era))))

class EraScript era ⇒ ShelleyEraScript era where Source #

Methods

mkRequireSignature ∷ KeyHash 'Witness (EraCrypto era) → NativeScript era Source #

getRequireSignature ∷ NativeScript era → Maybe (KeyHash 'Witness (EraCrypto era)) Source #

mkRequireAllOf ∷ StrictSeq (NativeScript era) → NativeScript era Source #

getRequireAllOf ∷ NativeScript era → Maybe (StrictSeq (NativeScript era)) Source #

mkRequireAnyOf ∷ StrictSeq (NativeScript era) → NativeScript era Source #

getRequireAnyOf ∷ NativeScript era → Maybe (StrictSeq (NativeScript era)) Source #

mkRequireMOf ∷ Int → StrictSeq (NativeScript era) → NativeScript era Source #

getRequireMOf ∷ NativeScript era → Maybe (Int, StrictSeq (NativeScript era)) Source #

Instances

Instances details

Crypto c ⇒ ShelleyEraScript (ShelleyEra c) Source #

Instance details

Defined in Cardano.Ledger.Shelley.Scripts

Methods

mkRequireSignature ∷ KeyHash 'Witness (EraCrypto (ShelleyEra c)) → NativeScript (ShelleyEra c) Source #

getRequireSignature ∷ NativeScript (ShelleyEra c) → Maybe (KeyHash 'Witness (EraCrypto (ShelleyEra c))) Source #

mkRequireAllOf ∷ StrictSeq (NativeScript (ShelleyEra c)) → NativeScript (ShelleyEra c) Source #

getRequireAllOf ∷ NativeScript (ShelleyEra c) → Maybe (StrictSeq (NativeScript (ShelleyEra c))) Source #

mkRequireAnyOf ∷ StrictSeq (NativeScript (ShelleyEra c)) → NativeScript (ShelleyEra c) Source #

getRequireAnyOf ∷ NativeScript (ShelleyEra c) → Maybe (StrictSeq (NativeScript (ShelleyEra c))) Source #

mkRequireMOf ∷ Int → StrictSeq (NativeScript (ShelleyEra c)) → NativeScript (ShelleyEra c) Source #

getRequireMOf ∷ NativeScript (ShelleyEra c) → Maybe (Int, StrictSeq (NativeScript (ShelleyEra c))) Source #

pattern RequireSignature ∷ ShelleyEraScript era ⇒ KeyHash 'Witness (EraCrypto era) → NativeScript era Source #

pattern RequireAllOf ∷ ShelleyEraScript era ⇒ StrictSeq (NativeScript era) → NativeScript era Source #

pattern RequireAnyOf ∷ ShelleyEraScript era ⇒ StrictSeq (NativeScript era) → NativeScript era Source #

pattern RequireMOf ∷ ShelleyEraScript era ⇒ Int → StrictSeq (NativeScript era) → NativeScript era Source #

evalMultiSig ∷ (ShelleyEraScript era, NativeScript era ~ MultiSig era) ⇒ Set (KeyHash 'Witness (EraCrypto era)) → NativeScript era → Bool Source #

Script evaluator for native multi-signature scheme. vhks is the set of key hashes that signed the transaction to be validated.

validateMultiSig ∷ (ShelleyEraScript era, EraTx era, NativeScript era ~ MultiSig era) ⇒ Tx era → NativeScript era → Bool Source #

Script validator for native multi-signature scheme.

newtype ScriptHash c Source #

Constructors

ScriptHash (Hash (ADDRHASH c) EraIndependentScript)

Instances

Instances details

Crypto c ⇒ FromJSON (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods parseJSON ∷ Value → Parser (ScriptHash c) Source # parseJSONList ∷ Value → Parser [ScriptHash c] Source # omittedField ∷ Maybe (ScriptHash c) Source #
Crypto c ⇒ FromJSONKey (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods fromJSONKey ∷ FromJSONKeyFunction (ScriptHash c) Source # fromJSONKeyList ∷ FromJSONKeyFunction [ScriptHash c] Source #
Crypto c ⇒ ToJSON (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods toJSON ∷ ScriptHash c → Value Source # toEncoding ∷ ScriptHash c → Encoding Source # toJSONList ∷ [ScriptHash c] → Value Source # toEncodingList ∷ [ScriptHash c] → Encoding Source # omitField ∷ ScriptHash c → Bool Source #
Crypto c ⇒ ToJSONKey (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods toJSONKey ∷ ToJSONKeyFunction (ScriptHash c) Source # toJSONKeyList ∷ ToJSONKeyFunction [ScriptHash c] Source #
Generic (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Associated Types type Rep (ScriptHash c) ∷ Type → Type Source # Methods from ∷ ScriptHash c → Rep (ScriptHash c) x Source # to ∷ Rep (ScriptHash c) x → ScriptHash c Source #
Show (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods showsPrec ∷ Int → ScriptHash c → ShowS Source # show ∷ ScriptHash c → String Source # showList ∷ [ScriptHash c] → ShowS Source #
Crypto c ⇒ FromCBOR (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods fromCBOR ∷ Decoder s (ScriptHash c) Source # label ∷ Proxy (ScriptHash c) → Text Source #
Crypto c ⇒ ToCBOR (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods toCBOR ∷ ScriptHash c → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (ScriptHash c) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ScriptHash c] → Size Source #
Crypto c ⇒ DecCBOR (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods decCBOR ∷ Decoder s (ScriptHash c) Source # dropCBOR ∷ Proxy (ScriptHash c) → Decoder s () Source # label ∷ Proxy (ScriptHash c) → Text Source #
Crypto c ⇒ EncCBOR (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods encCBOR ∷ ScriptHash c → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (ScriptHash c) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [ScriptHash c] → Size Source #
NFData (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods rnf ∷ ScriptHash c → () Source #
Eq (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods (==) ∷ ScriptHash c → ScriptHash c → Bool Source # (/=) ∷ ScriptHash c → ScriptHash c → Bool Source #
Ord (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods compare ∷ ScriptHash c → ScriptHash c → Ordering Source # (<) ∷ ScriptHash c → ScriptHash c → Bool Source # (<=) ∷ ScriptHash c → ScriptHash c → Bool Source # (>) ∷ ScriptHash c → ScriptHash c → Bool Source # (>=) ∷ ScriptHash c → ScriptHash c → Bool Source # max ∷ ScriptHash c → ScriptHash c → ScriptHash c Source # min ∷ ScriptHash c → ScriptHash c → ScriptHash c Source #
NoThunks (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes Methods noThunks ∷ Context → ScriptHash c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ScriptHash c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (ScriptHash c) → String Source #
type Rep (ScriptHash c)
Instance details Defined in Cardano.Ledger.Hashes type Rep (ScriptHash c) = D1 ('MetaData "ScriptHash" "Cardano.Ledger.Hashes" "cardano-ledger-core-1.16.0.0-inplace" 'True) (C1 ('MetaCons "ScriptHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Hash (ADDRHASH c) EraIndependentScript))))

nativeMultiSigTag ∷ ByteString Source #

Magic number "memorialized" in the ValidateScript class under the method: scriptPrefixTag:: Core.Script era -> Bs.ByteString, for the Shelley Era.

eqMultiSigRaw ∷ MultiSig era → MultiSig era → Bool Source #

Check the equality of two underlying types, while ignoring their binary representation, which Eq instance normally does. This is used for testing.

data MultiSigRaw era Source #

A simple language for expressing conditions under which it is valid to withdraw from a normal UTxO payment address or to use a stake address.

The use case is for expressing multi-signature payment addresses and multi-signature stake addresses. These can be combined arbitrarily using logical operations:

multi-way "and";
multi-way "or";
multi-way "N of M".

This makes it easy to express multi-signature addresses, and provides an extension point to express other validity conditions, e.g., as needed for locking funds used with lightning.

Instances

Instances details

Generic (MultiSigRaw era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Associated Types type Rep (MultiSigRaw era) ∷ Type → Type Source # Methods from ∷ MultiSigRaw era → Rep (MultiSigRaw era) x Source # to ∷ Rep (MultiSigRaw era) x → MultiSigRaw era Source #
HashAlgorithm (HASH (EraCrypto era)) ⇒ Show (MultiSigRaw era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods showsPrec ∷ Int → MultiSigRaw era → ShowS Source # show ∷ MultiSigRaw era → String Source # showList ∷ [MultiSigRaw era] → ShowS Source #
Era era ⇒ DecCBOR (Annotator (MultiSigRaw era)) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods decCBOR ∷ Decoder s (Annotator (MultiSigRaw era)) Source # dropCBOR ∷ Proxy (Annotator (MultiSigRaw era)) → Decoder s () Source # label ∷ Proxy (Annotator (MultiSigRaw era)) → Text Source #
NFData (MultiSigRaw era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods rnf ∷ MultiSigRaw era → () Source #
Eq (MultiSigRaw era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods (==) ∷ MultiSigRaw era → MultiSigRaw era → Bool Source # (/=) ∷ MultiSigRaw era → MultiSigRaw era → Bool Source #
Typeable era ⇒ NoThunks (MultiSigRaw era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts Methods noThunks ∷ Context → MultiSigRaw era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → MultiSigRaw era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (MultiSigRaw era) → String Source #
type Rep (MultiSigRaw era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Scripts type Rep (MultiSigRaw era) = D1 ('MetaData "MultiSigRaw" "Cardano.Ledger.Shelley.Scripts" "cardano-ledger-shelley-1.15.0.0-inplace" 'False) ((C1 ('MetaCons "RequireSignature'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'Witness (EraCrypto era)))) :+: C1 ('MetaCons "RequireAllOf'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictSeq (MultiSig era))))) :+: (C1 ('MetaCons "RequireAnyOf'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictSeq (MultiSig era)))) :+: C1 ('MetaCons "RequireMOf'" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictSeq (MultiSig era))))))

Orphan instances

Crypto c ⇒ EraScript (ShelleyEra c) Source #

Instance details

Associated Types

type Script (ShelleyEra c) = (r ∷ Type) Source #

type NativeScript (ShelleyEra c) = (r ∷ Type) Source #

Methods

upgradeScript ∷ Script (PreviousEra (ShelleyEra c)) → Script (ShelleyEra c) Source #

scriptPrefixTag ∷ Script (ShelleyEra c) → ByteString Source #

getNativeScript ∷ Script (ShelleyEra c) → Maybe (NativeScript (ShelleyEra c)) Source #

fromNativeScript ∷ NativeScript (ShelleyEra c) → Script (ShelleyEra c) Source #