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

GeniusYield.Types.TxOutRef

Contents

Helpers
CBOR format

Description

Synopsis

data GYTxOutRef
txOutRefToPlutus :: GYTxOutRef -> TxOutRef
txOutRefFromPlutus :: TxOutRef -> Either PlutusToCardanoError GYTxOutRef
txOutRefFromApi :: TxIn -> GYTxOutRef
txOutRefFromApiTxIdIx :: TxId -> TxIx -> GYTxOutRef
wordToApiIx :: Word -> TxIx
txOutRefToApi :: GYTxOutRef -> TxIn
showTxOutRef :: GYTxOutRef -> Text
txOutRefToTuple :: GYTxOutRef -> (GYTxId, Word)
txOutRefToTuple' :: GYTxOutRef -> (Text, Word)
txOutRefFromTuple :: (GYTxId, Word) -> GYTxOutRef
newtype GYTxOutRefCbor = GYTxOutRefCbor {
- getTxOutRefHex :: GYTxOutRef
}

Documentation

data GYTxOutRef #

Type that represents a reference to a GYTxOut.

Instances

Instances details

FromJSON GYTxOutRef #
Instance details Defined in GeniusYield.Types.TxOutRef Methods parseJSON :: Value -> Parser GYTxOutRef # parseJSONList :: Value -> Parser [GYTxOutRef] # omittedField :: Maybe GYTxOutRef #
ToJSON GYTxOutRef #
Instance details Defined in GeniusYield.Types.TxOutRef Methods toJSON :: GYTxOutRef -> Value # toEncoding :: GYTxOutRef -> Encoding # toJSONList :: [GYTxOutRef] -> Value # toEncodingList :: [GYTxOutRef] -> Encoding # omitField :: GYTxOutRef -> Bool #
PrintfArg GYTxOutRef #
Instance details Defined in GeniusYield.Types.TxOutRef Methods formatArg :: GYTxOutRef -> FieldFormatter # parseFormat :: GYTxOutRef -> ModifierParser #
FromField GYTxOutRef #	`>>>` `Csv.runParser $ Csv.parseField @GYTxOutRef "4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189#1"`Right (GYTxOutRef (TxIn "4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189" (TxIx 1))) `>>>` `Csv.runParser $ Csv.parseField @GYTxOutRef "not a tx-out ref"`Left "GYTxOutRef: Failed reading: takeWhile1"
Instance details Defined in GeniusYield.Types.TxOutRef Methods parseField :: Field -> Parser GYTxOutRef #
ToField GYTxOutRef #	`>>>` `Csv.toField ("4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189#1" :: GYTxOutRef)`"4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189#1"
Instance details Defined in GeniusYield.Types.TxOutRef Methods toField :: GYTxOutRef -> Field #
IsString GYTxOutRef #	`>>>` `"4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189#1" :: GYTxOutRef`GYTxOutRef (TxIn "4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189" (TxIx 1)) `>>>` `"not-a-tx-out-ref" :: GYTxOutRef`*** Exception: invalid GYTxOutRef: not-a-tx-out-ref ...
Instance details Defined in GeniusYield.Types.TxOutRef Methods fromString :: String -> GYTxOutRef #
Show GYTxOutRef #
Instance details Defined in GeniusYield.Types.TxOutRef Methods showsPrec :: Int -> GYTxOutRef -> ShowS # show :: GYTxOutRef -> String # showList :: [GYTxOutRef] -> ShowS #
Eq GYTxOutRef #
Instance details Defined in GeniusYield.Types.TxOutRef Methods (==) :: GYTxOutRef -> GYTxOutRef -> Bool # (/=) :: GYTxOutRef -> GYTxOutRef -> Bool #
Ord GYTxOutRef #
Instance details Defined in GeniusYield.Types.TxOutRef Methods compare :: GYTxOutRef -> GYTxOutRef -> Ordering # (<) :: GYTxOutRef -> GYTxOutRef -> Bool # (<=) :: GYTxOutRef -> GYTxOutRef -> Bool # (>) :: GYTxOutRef -> GYTxOutRef -> Bool # (>=) :: GYTxOutRef -> GYTxOutRef -> Bool # max :: GYTxOutRef -> GYTxOutRef -> GYTxOutRef # min :: GYTxOutRef -> GYTxOutRef -> GYTxOutRef #
Hashable GYTxOutRef #
Instance details Defined in GeniusYield.Types.TxOutRef Methods hashWithSalt :: Int -> GYTxOutRef -> Int # hash :: GYTxOutRef -> Int #
FromHttpApiData GYTxOutRef #	`>>>` `Web.parseUrlPiece @GYTxOutRef "4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189#1"`Right (GYTxOutRef (TxIn "4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189" (TxIx 1)))
Instance details Defined in GeniusYield.Types.TxOutRef Methods parseUrlPiece :: Text -> Either Text GYTxOutRef # parseHeader :: ByteString -> Either Text GYTxOutRef # parseQueryParam :: Text -> Either Text GYTxOutRef #
ToHttpApiData GYTxOutRef #
Instance details Defined in GeniusYield.Types.TxOutRef Methods toUrlPiece :: GYTxOutRef -> Text # toEncodedUrlPiece :: GYTxOutRef -> Builder # toHeader :: GYTxOutRef -> ByteString # toQueryParam :: GYTxOutRef -> Text # toEncodedQueryParam :: GYTxOutRef -> Builder #
ToParamSchema GYTxOutRef #
Instance details Defined in GeniusYield.Types.TxOutRef Methods toParamSchema :: forall (t :: SwaggerKind Type). Proxy GYTxOutRef -> ParamSchema t #
ToSchema GYTxOutRef #
Instance details Defined in GeniusYield.Types.TxOutRef Methods declareNamedSchema :: Proxy GYTxOutRef -> Declare (Definitions Schema) NamedSchema #

txOutRefToPlutus :: GYTxOutRef -> TxOutRef #

>>> txOutRefToPlutus "4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189#1"
TxOutRef {txOutRefId = 4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189, txOutRefIdx = 1}

txOutRefFromPlutus :: TxOutRef -> Either PlutusToCardanoError GYTxOutRef #

>>> txOutRefFromPlutus $ Plutus.TxOutRef "4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189" 12
Right (GYTxOutRef (TxIn "4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189" (TxIx 12)))

>>> txOutRefFromPlutus $ Plutus.TxOutRef "ae" 12
Left (UnknownPlutusToCardanoError {ptceTag = "txOutRefFromPlutus: invalid txOutRefId ae, error: SerialiseAsRawBytesError {unSerialiseAsRawBytesError = \"Unable to deserialise TxId\"}"})

>>> txOutRefFromPlutus $ Plutus.TxOutRef "4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189" (-2)
Left (UnknownPlutusToCardanoError {ptceTag = "txOutRefFromPlutus: negative txOutRefIdx -2"})

>>> txOutRefFromPlutus $ Plutus.TxOutRef "4293386fef391299c9886dc0ef3e8676cbdbc2c9f2773507f1f838e00043a189" 123456789012345678901
Left (UnknownPlutusToCardanoError {ptceTag = "txOutRefFromPlutus: txOutRefIdx 123456789012345678901 too large"})

txOutRefFromApi :: TxIn -> GYTxOutRef #

txOutRefFromApiTxIdIx :: TxId -> TxIx -> GYTxOutRef #

wordToApiIx :: Word -> TxIx #

txOutRefToApi :: GYTxOutRef -> TxIn #

Helpers

showTxOutRef :: GYTxOutRef -> Text #

txOutRefToTuple :: GYTxOutRef -> (GYTxId, Word) #

txOutRefToTuple' :: GYTxOutRef -> (Text, Word) #

txOutRefFromTuple :: (GYTxId, Word) -> GYTxOutRef #

CBOR format

newtype GYTxOutRefCbor #

Constructors

GYTxOutRefCbor
Fields getTxOutRefHex :: GYTxOutRef

Instances

Instances details

FromJSON GYTxOutRefCbor #
Instance details Defined in GeniusYield.Types.TxOutRef Methods parseJSON :: Value -> Parser GYTxOutRefCbor # parseJSONList :: Value -> Parser [GYTxOutRefCbor] # omittedField :: Maybe GYTxOutRefCbor #
ToJSON GYTxOutRefCbor #	Warning: this JSON instance does not satisfy `JSON --> GYTxOutRefCbor --> JSON === id` since some information in the hex encoded CBOR string is lost when going from `GYTxOutRefCbor` to `JSON`. In practise, this shouldn't be an issue -- see https://github.com/geniusyield/atlas/issues/399#issuecomment-2618617724 for details.
Instance details Defined in GeniusYield.Types.TxOutRef Methods toJSON :: GYTxOutRefCbor -> Value # toEncoding :: GYTxOutRefCbor -> Encoding # toJSONList :: [GYTxOutRefCbor] -> Value # toEncodingList :: [GYTxOutRefCbor] -> Encoding # omitField :: GYTxOutRefCbor -> Bool #
PrintfArg GYTxOutRefCbor #
Instance details Defined in GeniusYield.Types.TxOutRef Methods formatArg :: GYTxOutRefCbor -> FieldFormatter # parseFormat :: GYTxOutRefCbor -> ModifierParser #
Show GYTxOutRefCbor #
Instance details Defined in GeniusYield.Types.TxOutRef Methods showsPrec :: Int -> GYTxOutRefCbor -> ShowS # show :: GYTxOutRefCbor -> String # showList :: [GYTxOutRefCbor] -> ShowS #
FromHttpApiData GYTxOutRefCbor #	`>>>` `Web.parseUrlPiece @GYTxOutRefCbor "8282582004ffecdf5f3ced5c5c788833415bcbef26e3e21290fcebcf8216327e21569e420082583900e1cbb80db89e292269aeb93ec15eb963dda5176b66949fe1c2a6a38d1b930e9f7add78a174a21000e989ff551366dcd127028cb2aa39f6161a004c4b40"`Right GYTxOutRef (TxIn "04ffecdf5f3ced5c5c788833415bcbef26e3e21290fcebcf8216327e21569e42" (TxIx 0)) `>>>` `Web.parseUrlPiece @GYTxOutRefCbor "00"`Left "Invalid TxIn CBOR structure"
Instance details Defined in GeniusYield.Types.TxOutRef Methods parseUrlPiece :: Text -> Either Text GYTxOutRefCbor # parseHeader :: ByteString -> Either Text GYTxOutRefCbor # parseQueryParam :: Text -> Either Text GYTxOutRefCbor #
ToParamSchema GYTxOutRefCbor #
Instance details Defined in GeniusYield.Types.TxOutRef Methods toParamSchema :: forall (t :: SwaggerKind Type). Proxy GYTxOutRefCbor -> ParamSchema t #
ToSchema GYTxOutRefCbor #
Instance details Defined in GeniusYield.Types.TxOutRef Methods declareNamedSchema :: Proxy GYTxOutRefCbor -> Declare (Definitions Schema) NamedSchema #