Copyright	(c) 2024 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	Safe-Inferred
Language	GHC2021

GeniusYield.Types.Anchor

Description

Synopsis

data GYUrl
textToUrl ∷ MonadFail m ⇒ Text → m GYUrl
unsafeTextToUrl ∷ Text → GYUrl
urlToText ∷ GYUrl → Text
type GYAnchorData = ByteString
data GYAnchorDataHash
hashAnchorData ∷ GYAnchorData → GYAnchorDataHash
data GYAnchor = GYAnchor {
- anchorUrl ∷ !GYUrl
- anchorDataHash ∷ !GYAnchorDataHash
}
anchorToLedger ∷ GYAnchor → Anchor StandardCrypto
anchorFromLedger ∷ Anchor StandardCrypto → GYAnchor

Documentation

data GYUrl #

URL to a JSON payload of metadata. Note that we require URL to be at most 128 bytes. >>> textToUrl "https://geniusyield.co" GYUrl (Url {urlToText = "https://geniusyield.co"})

Instances

Instances details

Show GYUrl #
Instance details Defined in GeniusYield.Types.Anchor Methods showsPrec ∷ Int → GYUrl → ShowS # show ∷ GYUrl → String # showList ∷ [GYUrl] → ShowS #
Eq GYUrl #
Instance details Defined in GeniusYield.Types.Anchor Methods (==) ∷ GYUrl → GYUrl → Bool # (/=) ∷ GYUrl → GYUrl → Bool #
Ord GYUrl #
Instance details Defined in GeniusYield.Types.Anchor Methods compare ∷ GYUrl → GYUrl → Ordering # (<) ∷ GYUrl → GYUrl → Bool # (<=) ∷ GYUrl → GYUrl → Bool # (>) ∷ GYUrl → GYUrl → Bool # (>=) ∷ GYUrl → GYUrl → Bool # max ∷ GYUrl → GYUrl → GYUrl # min ∷ GYUrl → GYUrl → GYUrl #

textToUrl ∷ MonadFail m ⇒ Text → m GYUrl #

Convert a Text to a GYUrl checking that it is at most 128 bytes in the process.

unsafeTextToUrl ∷ Text → GYUrl #

urlToText ∷ GYUrl → Text #

Convert a GYUrl to a Text.

type GYAnchorData = ByteString #

Anchor data.

data GYAnchorDataHash #

Hash of anchor data. >>> hashAnchorData "Hello, World!" GYAnchorDataHash (SafeHash "511bc81dde11180838c562c82bb35f3223f46061ebde4a955c27b3f489cf1e03")

Instances

Instances details

Show GYAnchorDataHash #
Instance details Defined in GeniusYield.Types.Anchor Methods showsPrec ∷ Int → GYAnchorDataHash → ShowS # show ∷ GYAnchorDataHash → String # showList ∷ [GYAnchorDataHash] → ShowS #
Eq GYAnchorDataHash #
Instance details Defined in GeniusYield.Types.Anchor Methods (==) ∷ GYAnchorDataHash → GYAnchorDataHash → Bool # (/=) ∷ GYAnchorDataHash → GYAnchorDataHash → Bool #
Ord GYAnchorDataHash #
Instance details Defined in GeniusYield.Types.Anchor Methods compare ∷ GYAnchorDataHash → GYAnchorDataHash → Ordering # (<) ∷ GYAnchorDataHash → GYAnchorDataHash → Bool # (<=) ∷ GYAnchorDataHash → GYAnchorDataHash → Bool # (>) ∷ GYAnchorDataHash → GYAnchorDataHash → Bool # (>=) ∷ GYAnchorDataHash → GYAnchorDataHash → Bool # max ∷ GYAnchorDataHash → GYAnchorDataHash → GYAnchorDataHash # min ∷ GYAnchorDataHash → GYAnchorDataHash → GYAnchorDataHash #

hashAnchorData ∷ GYAnchorData → GYAnchorDataHash #

Hash anchor data.

data GYAnchor #

Anchor.

Constructors

GYAnchor
Fields anchorUrl ∷ !GYUrl anchorDataHash ∷ !GYAnchorDataHash

Instances

Instances details

Show GYAnchor #
Instance details Defined in GeniusYield.Types.Anchor Methods showsPrec ∷ Int → GYAnchor → ShowS # show ∷ GYAnchor → String # showList ∷ [GYAnchor] → ShowS #
Eq GYAnchor #
Instance details Defined in GeniusYield.Types.Anchor Methods (==) ∷ GYAnchor → GYAnchor → Bool # (/=) ∷ GYAnchor → GYAnchor → Bool #
Ord GYAnchor #
Instance details Defined in GeniusYield.Types.Anchor Methods compare ∷ GYAnchor → GYAnchor → Ordering # (<) ∷ GYAnchor → GYAnchor → Bool # (<=) ∷ GYAnchor → GYAnchor → Bool # (>) ∷ GYAnchor → GYAnchor → Bool # (>=) ∷ GYAnchor → GYAnchor → Bool # max ∷ GYAnchor → GYAnchor → GYAnchor # min ∷ GYAnchor → GYAnchor → GYAnchor #

anchorToLedger ∷ GYAnchor → Anchor StandardCrypto #

anchorFromLedger ∷ Anchor StandardCrypto → GYAnchor #