Lorentz.Bytes

Type-safe operations with bytes-like data.

Documentation

class (KnownValue bs, ToT bs ~ ToT ByteString) => BytesLike bs where

Everything which is represented as bytes inside.

Methods

toBytes :: bs -> ByteString

Instances

BytesLike ByteString

Defined in Lorentz.Bytes

Methods

toBytes :: ByteString -> ByteString

Typeable a => BytesLike (Packed a)

Defined in Lorentz.Bytes

Methods

toBytes :: Packed a -> ByteString

(Typeable alg, Typeable a) => BytesLike (Hash alg a)

Defined in Lorentz.Bytes

Methods

toBytes :: Hash alg a -> ByteString

newtype Packed a

Represents a ByteString resulting from packing a value of type a.

This is not guaranteed to keep some packed value, and unpack can fail. We do so because often we need to accept values of such type from user, and also because there is no simple way to check validity of packed data without performing full unpack. So this wrapper is rather a hint for users.

Constructors

Packed

Fields

• unPacked :: ByteString

Instances

Eq (Packed a)

Defined in Lorentz.Bytes

Methods

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

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

Ord (Packed a)

Defined in Lorentz.Bytes

Methods

compare :: Packed a -> Packed a -> Ordering

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

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

(>) :: Packed a -> Packed a -> Bool

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

max :: Packed a -> Packed a -> Packed a

min :: Packed a -> Packed a -> Packed a

Show (Packed a)

Defined in Lorentz.Bytes

Methods

showsPrec :: Int -> Packed a -> ShowS

show :: Packed a -> String

showList :: [Packed a] -> ShowS

Generic (Packed a)

Defined in Lorentz.Bytes

Associated Types

type Rep (Packed a) :: Type -> Type

Methods

from :: Packed a -> Rep (Packed a) x

to :: Rep (Packed a) x -> Packed a

Buildable (Packed a)

Defined in Lorentz.Bytes

Methods

build :: Packed a -> Builder

TypeHasDoc a => TypeHasDoc (Packed a)

Defined in Lorentz.Bytes

Associated Types

type TypeDocFieldDescriptions (Packed a) :: FieldDescriptions

Methods

typeDocName :: Proxy (Packed a) -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy (Packed a) -> WithinParens -> Markdown

typeDocDependencies :: Proxy (Packed a) -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep (Packed a)

typeDocMichelsonRep :: TypeDocMichelsonRep (Packed a)

IsoValue (Packed a)

Defined in Lorentz.Bytes

Associated Types

type ToT (Packed a) :: T

Methods

toVal :: Packed a -> Value (ToT (Packed a))

fromVal :: Value (ToT (Packed a)) -> Packed a

HasAnnotation (Packed a)

Defined in Lorentz.Bytes

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (Packed a))

annOptions :: AnnOptions

Typeable a => BytesLike (Packed a)

Defined in Lorentz.Bytes

Methods

toBytes :: Packed a -> ByteString

CanCastTo (Packed a :: Type) ByteString

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy (Packed a) -> Proxy ByteString -> ()

CanCastTo a b => CanCastTo (Packed a :: Type) (Packed b :: Type)

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy (Packed a) -> Proxy (Packed b) -> ()

type Rep (Packed a)

Defined in Lorentz.Bytes

type Rep (Packed a) = D1 ('MetaData "Packed" "Lorentz.Bytes" "lorentz-0.13.0-inplace" 'True) (C1 ('MetaCons "Packed" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPacked") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

type TypeDocFieldDescriptions (Packed a)

Defined in Lorentz.Bytes

type TypeDocFieldDescriptions (Packed a) = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

type ToT (Packed a)

Defined in Lorentz.Bytes

type ToT (Packed a) = ToT ByteString

newtype TSignature a

Represents a signature, where signed data has given type.

Since we usually sign a packed data, a common pattern for this type is TSignature (Packed signedData). If you don't want to use Packed, use plain TSignature ByteString instead.

Constructors

TSignature

Fields

• unTSignature :: Signature

Instances

Show (TSignature a)

Defined in Lorentz.Bytes

Methods

showsPrec :: Int -> TSignature a -> ShowS

show :: TSignature a -> String

showList :: [TSignature a] -> ShowS

Generic (TSignature a)

Defined in Lorentz.Bytes

Associated Types

type Rep (TSignature a) :: Type -> Type

Methods

from :: TSignature a -> Rep (TSignature a) x

to :: Rep (TSignature a) x -> TSignature a

Buildable (TSignature a)

Defined in Lorentz.Bytes

Methods

build :: TSignature a -> Builder

TypeHasDoc a => TypeHasDoc (TSignature a)

Defined in Lorentz.Bytes

Associated Types

type TypeDocFieldDescriptions (TSignature a) :: FieldDescriptions

Methods

typeDocName :: Proxy (TSignature a) -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy (TSignature a) -> WithinParens -> Markdown

typeDocDependencies :: Proxy (TSignature a) -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep (TSignature a)

typeDocMichelsonRep :: TypeDocMichelsonRep (TSignature a)

IsoValue (TSignature a)

Defined in Lorentz.Bytes

Associated Types

type ToT (TSignature a) :: T

Methods

toVal :: TSignature a -> Value (ToT (TSignature a))

fromVal :: Value (ToT (TSignature a)) -> TSignature a

HasAnnotation (TSignature a)

Defined in Lorentz.Bytes

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (TSignature a))

annOptions :: AnnOptions

CanCastTo (TSignature a :: Type) ByteString

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy (TSignature a) -> Proxy ByteString -> ()

CanCastTo a b => CanCastTo (TSignature a :: Type) (TSignature b :: Type)

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy (TSignature a) -> Proxy (TSignature b) -> ()

type Rep (TSignature a)

Defined in Lorentz.Bytes

type Rep (TSignature a) = D1 ('MetaData "TSignature" "Lorentz.Bytes" "lorentz-0.13.0-inplace" 'True) (C1 ('MetaCons "TSignature" 'PrefixI 'True) (S1 ('MetaSel ('Just "unTSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Signature)))

type TypeDocFieldDescriptions (TSignature a)

Defined in Lorentz.Bytes

type TypeDocFieldDescriptions (TSignature a) = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

type ToT (TSignature a)

Defined in Lorentz.Bytes

type ToT (TSignature a) = ToT Signature

lSign :: (MonadRandom m, BytesLike a) => SecretKey -> a -> m (TSignature a)

Sign data using SecretKey

newtype Hash (alg :: HashAlgorithmKind) a

Hash of type t evaluated from data of type a.

Constructors

UnsafeHash

Fields

• unHash :: ByteString

Instances

CanCastTo (Hash alg a :: Type) ByteString

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy (Hash alg a) -> Proxy ByteString -> ()

(CanCastTo alg1 alg2, CanCastTo a1 a2) => CanCastTo (Hash alg1 a1 :: Type) (Hash alg2 a2 :: Type)

Defined in Lorentz.Coercions

Methods

castDummy :: Proxy (Hash alg1 a1) -> Proxy (Hash alg2 a2) -> ()

Eq (Hash alg a)

Defined in Lorentz.Bytes

Methods

(==) :: Hash alg a -> Hash alg a -> Bool

(/=) :: Hash alg a -> Hash alg a -> Bool

Ord (Hash alg a)

Defined in Lorentz.Bytes

Methods

compare :: Hash alg a -> Hash alg a -> Ordering

(<) :: Hash alg a -> Hash alg a -> Bool

(<=) :: Hash alg a -> Hash alg a -> Bool

(>) :: Hash alg a -> Hash alg a -> Bool

(>=) :: Hash alg a -> Hash alg a -> Bool

max :: Hash alg a -> Hash alg a -> Hash alg a

min :: Hash alg a -> Hash alg a -> Hash alg a

Show (Hash alg a)

Defined in Lorentz.Bytes

Methods

showsPrec :: Int -> Hash alg a -> ShowS

show :: Hash alg a -> String

showList :: [Hash alg a] -> ShowS

Generic (Hash alg a)

Defined in Lorentz.Bytes

Associated Types

type Rep (Hash alg a) :: Type -> Type

Methods

from :: Hash alg a -> Rep (Hash alg a) x

to :: Rep (Hash alg a) x -> Hash alg a

Buildable (Hash alg a)

Defined in Lorentz.Bytes

Methods

build :: Hash alg a -> Builder

(KnownHashAlgorithm alg, TypeHasDoc a) => TypeHasDoc (Hash alg a)

Defined in Lorentz.Bytes

Associated Types

type TypeDocFieldDescriptions (Hash alg a) :: FieldDescriptions

Methods

typeDocName :: Proxy (Hash alg a) -> Text

typeDocMdDescription :: Markdown

typeDocMdReference :: Proxy (Hash alg a) -> WithinParens -> Markdown

typeDocDependencies :: Proxy (Hash alg a) -> [SomeDocDefinitionItem]

typeDocHaskellRep :: TypeDocHaskellRep (Hash alg a)

typeDocMichelsonRep :: TypeDocMichelsonRep (Hash alg a)

IsoValue (Hash alg a)

Defined in Lorentz.Bytes

Associated Types

type ToT (Hash alg a) :: T

Methods

toVal :: Hash alg a -> Value (ToT (Hash alg a))

fromVal :: Value (ToT (Hash alg a)) -> Hash alg a

HasAnnotation (Hash alg a)

Defined in Lorentz.Bytes

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (Hash alg a))

annOptions :: AnnOptions

(Typeable alg, Typeable a) => BytesLike (Hash alg a)

Defined in Lorentz.Bytes

Methods

toBytes :: Hash alg a -> ByteString

type Rep (Hash alg a)

Defined in Lorentz.Bytes

type Rep (Hash alg a) = D1 ('MetaData "Hash" "Lorentz.Bytes" "lorentz-0.13.0-inplace" 'True) (C1 ('MetaCons "UnsafeHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "unHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

type TypeDocFieldDescriptions (Hash alg a)

Defined in Lorentz.Bytes

type TypeDocFieldDescriptions (Hash alg a) = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))]

type ToT (Hash alg a)

Defined in Lorentz.Bytes

type ToT (Hash alg a) = ToT ByteString

data DHashAlgorithm

Documentation item for hash algorithms.

Instances

Eq DHashAlgorithm

Defined in Lorentz.Bytes

Methods

(==) :: DHashAlgorithm -> DHashAlgorithm -> Bool

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

Ord DHashAlgorithm

Defined in Lorentz.Bytes

Methods

compare :: DHashAlgorithm -> DHashAlgorithm -> Ordering

(<) :: DHashAlgorithm -> DHashAlgorithm -> Bool

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

(>) :: DHashAlgorithm -> DHashAlgorithm -> Bool

(>=) :: DHashAlgorithm -> DHashAlgorithm -> Bool

max :: DHashAlgorithm -> DHashAlgorithm -> DHashAlgorithm

min :: DHashAlgorithm -> DHashAlgorithm -> DHashAlgorithm

DocItem DHashAlgorithm

Defined in Lorentz.Bytes

Associated Types

type DocItemPlacement DHashAlgorithm :: DocItemPlacementKind

type DocItemReferenced DHashAlgorithm :: DocItemReferencedKind

Methods

docItemPos :: Natural

docItemSectionName :: Maybe Text

docItemSectionDescription :: Maybe Markdown

docItemSectionNameStyle :: DocSectionNameStyle

docItemRef :: DHashAlgorithm -> DocItemRef (DocItemPlacement DHashAlgorithm) (DocItemReferenced DHashAlgorithm)

docItemToMarkdown :: HeaderLevel -> DHashAlgorithm -> Markdown

docItemToToc :: HeaderLevel -> DHashAlgorithm -> Markdown

docItemDependencies :: DHashAlgorithm -> [SomeDocDefinitionItem]

docItemsOrder :: [DHashAlgorithm] -> [DHashAlgorithm]

type DocItemPlacement DHashAlgorithm

Defined in Lorentz.Bytes

type DocItemPlacement DHashAlgorithm = 'DocItemInDefinitions

type DocItemReferenced DHashAlgorithm

Defined in Lorentz.Bytes

type DocItemReferenced DHashAlgorithm = 'True

class Typeable alg => KnownHashAlgorithm (alg :: HashAlgorithmKind) where

Hash algorithm used in Tezos.

Minimal complete definition

computeHash, toHash

Methods

hashAlgorithmName :: Proxy alg -> Text

computeHash :: ByteString -> ByteString

toHash :: BytesLike bs => (bs ': s) :-> (Hash alg bs ': s)

Instances

KnownHashAlgorithm Keccak

Defined in Lorentz.Bytes

Methods

hashAlgorithmName :: Proxy Keccak -> Text

computeHash :: ByteString -> ByteString

toHash :: forall bs (s :: [Type]). BytesLike bs => (bs ': s) :-> (Hash Keccak bs ': s)

KnownHashAlgorithm Sha3

Defined in Lorentz.Bytes

Methods

hashAlgorithmName :: Proxy Sha3 -> Text

computeHash :: ByteString -> ByteString

toHash :: forall bs (s :: [Type]). BytesLike bs => (bs ': s) :-> (Hash Sha3 bs ': s)

KnownHashAlgorithm Blake2b

Defined in Lorentz.Bytes

Methods

hashAlgorithmName :: Proxy Blake2b -> Text

computeHash :: ByteString -> ByteString

toHash :: forall bs (s :: [Type]). BytesLike bs => (bs ': s) :-> (Hash Blake2b bs ': s)

KnownHashAlgorithm Sha512

Defined in Lorentz.Bytes

Methods

hashAlgorithmName :: Proxy Sha512 -> Text

computeHash :: ByteString -> ByteString

toHash :: forall bs (s :: [Type]). BytesLike bs => (bs ': s) :-> (Hash Sha512 bs ': s)

KnownHashAlgorithm Sha256

Defined in Lorentz.Bytes

Methods

hashAlgorithmName :: Proxy Sha256 -> Text

computeHash :: ByteString -> ByteString

toHash :: forall bs (s :: [Type]). BytesLike bs => (bs ': s) :-> (Hash Sha256 bs ': s)

toHashHs :: forall alg bs. (BytesLike bs, KnownHashAlgorithm alg) => bs -> Hash alg bs

Evaluate hash in Haskell world.

data Sha256 :: HashAlgorithmKind

Instances

KnownHashAlgorithm Sha256

Defined in Lorentz.Bytes

Methods

hashAlgorithmName :: Proxy Sha256 -> Text

computeHash :: ByteString -> ByteString

toHash :: forall bs (s :: [Type]). BytesLike bs => (bs ': s) :-> (Hash Sha256 bs ': s)

data Sha512 :: HashAlgorithmKind

Instances

KnownHashAlgorithm Sha512

Defined in Lorentz.Bytes

Methods

hashAlgorithmName :: Proxy Sha512 -> Text

computeHash :: ByteString -> ByteString

toHash :: forall bs (s :: [Type]). BytesLike bs => (bs ': s) :-> (Hash Sha512 bs ': s)

data Blake2b :: HashAlgorithmKind

Instances

KnownHashAlgorithm Blake2b

Defined in Lorentz.Bytes

Methods

hashAlgorithmName :: Proxy Blake2b -> Text

computeHash :: ByteString -> ByteString

toHash :: forall bs (s :: [Type]). BytesLike bs => (bs ': s) :-> (Hash Blake2b bs ': s)

data Sha3 :: HashAlgorithmKind

Instances

KnownHashAlgorithm Sha3

Defined in Lorentz.Bytes

Methods

hashAlgorithmName :: Proxy Sha3 -> Text

computeHash :: ByteString -> ByteString

toHash :: forall bs (s :: [Type]). BytesLike bs => (bs ': s) :-> (Hash Sha3 bs ': s)

data Keccak :: HashAlgorithmKind

Instances

KnownHashAlgorithm Keccak

Defined in Lorentz.Bytes

Methods

hashAlgorithmName :: Proxy Keccak -> Text

computeHash :: ByteString -> ByteString

toHash :: forall bs (s :: [Type]). BytesLike bs => (bs ': s) :-> (Hash Keccak bs ': s)