plutus-ledger-api-1.45.0.0: Interface to the Plutus ledger for the Cardano ledger.
Safe HaskellSafe-Inferred
LanguageHaskell2010

PlutusLedgerApi.V1.Bytes

Synopsis

Documentation

newtype LedgerBytes Source #

Constructors

LedgerBytes 

Fields

Instances

Instances details
IsString LedgerBytes Source #

Read in arbitrary LedgerBytes as a "string" (of characters).

This is mostly used together with GHC's OverloadedStrings extension to specify at the source code any LedgerBytes constants, by utilizing Haskell's double-quoted string syntax.

IMPORTANT: the LedgerBytes are expected to be already hex-encoded (base16); otherwise, LedgerBytesError will be raised as an Exception.

Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

fromString :: String -> LedgerBytes Source #

Generic LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Associated Types

type Rep LedgerBytes :: Type -> Type Source #

Methods

from :: LedgerBytes -> Rep LedgerBytes x Source #

to :: Rep LedgerBytes x -> LedgerBytes Source #

Show LedgerBytes Source #

The Show instance of LedgerBytes is its Base16/Hex encoded bytestring, decoded with UTF-8, unpacked to String.

Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

showsPrec :: Int -> LedgerBytes -> ShowS Source #

show :: LedgerBytes -> String Source #

showList :: [LedgerBytes] -> ShowS Source #

NFData LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

rnf :: LedgerBytes -> () Source #

Eq LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

(==) :: LedgerBytes -> LedgerBytes -> Bool Source #

(/=) :: LedgerBytes -> LedgerBytes -> Bool Source #

Ord LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

compare :: LedgerBytes -> LedgerBytes -> Ordering Source #

(<) :: LedgerBytes -> LedgerBytes -> Bool Source #

(<=) :: LedgerBytes -> LedgerBytes -> Bool Source #

(>) :: LedgerBytes -> LedgerBytes -> Bool Source #

(>=) :: LedgerBytes -> LedgerBytes -> Bool Source #

max :: LedgerBytes -> LedgerBytes -> LedgerBytes Source #

min :: LedgerBytes -> LedgerBytes -> LedgerBytes Source #

HasBlueprintDefinition LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Associated Types

type Unroll LedgerBytes :: [Type]

Methods

definitionId :: DefinitionId

Eq LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

(==) :: LedgerBytes -> LedgerBytes -> Bool

FromData LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

fromBuiltinData :: BuiltinData -> Maybe LedgerBytes #

ToData LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

toBuiltinData :: LedgerBytes -> BuiltinData #

UnsafeFromData LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

unsafeFromBuiltinData :: BuiltinData -> LedgerBytes #

Ord LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

compare :: LedgerBytes -> LedgerBytes -> Ordering

(<) :: LedgerBytes -> LedgerBytes -> Bool

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

(>) :: LedgerBytes -> LedgerBytes -> Bool

(>=) :: LedgerBytes -> LedgerBytes -> Bool

max :: LedgerBytes -> LedgerBytes -> LedgerBytes

min :: LedgerBytes -> LedgerBytes -> LedgerBytes

Pretty LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

pretty :: LedgerBytes -> Doc ann

prettyList :: [LedgerBytes] -> Doc ann

HasBlueprintSchema LedgerBytes referencedTypes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

schema :: Schema referencedTypes

Lift DefaultUni LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

lift :: LedgerBytes -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ())

Typeable DefaultUni LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

typeRep :: Proxy LedgerBytes -> RTCompile DefaultUni fun (Type TyName DefaultUni ())

type Rep LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

type Rep LedgerBytes = D1 ('MetaData "LedgerBytes" "PlutusLedgerApi.V1.Bytes" "plutus-ledger-api-1.45.0.0-4sBiUM4DKlI2NgrKBx1zp5" 'True) (C1 ('MetaCons "LedgerBytes" 'PrefixI 'True) (S1 ('MetaSel ('Just "getLedgerBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuiltinByteString)))
type Unroll LedgerBytes Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

type Unroll LedgerBytes = Insert LedgerBytes (GUnroll (IfStuckRep (RepIsStuckError LedgerBytes :: Type -> Type) (Rep LedgerBytes)))

data LedgerBytesError Source #

An error that is encountered when converting a ByteString to a LedgerBytes.

Constructors

UnpairedDigit

Odd number of bytes in the original bytestring.

NotHexit !Char

A non-hex digit character ([^A-Fa-f0-9]) encountered during decoding.

Instances

Instances details
Exception LedgerBytesError Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

toException :: LedgerBytesError -> SomeException Source #

fromException :: SomeException -> Maybe LedgerBytesError Source #

displayException :: LedgerBytesError -> String Source #

Show LedgerBytesError Source # 
Instance details

Defined in PlutusLedgerApi.V1.Bytes

Methods

showsPrec :: Int -> LedgerBytesError -> ShowS Source #

show :: LedgerBytesError -> String Source #

showList :: [LedgerBytesError] -> ShowS Source #

fromHex :: ByteString -> Either LedgerBytesError LedgerBytes Source #

Convert a hex-encoded (Base16) ByteString to a LedgerBytes. May return an error (LedgerBytesError).

bytes :: LedgerBytes -> ByteString Source #

Extract the Haskell bytestring from inside the Plutus opaque LedgerBytes.

fromBytes :: ByteString -> LedgerBytes Source #

Lift a Haskell bytestring to the Plutus abstraction LedgerBytes

encodeByteString :: ByteString -> Text Source #

Encode a ByteString value to Base16 (i.e. hexadecimal), then decode with UTF-8 to a Text.