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

GeniusYield.Transaction.CBOR

Description

The transaction CBOR as obtained by Cardano API library may not be in format as desired by some hardware/browser wallets. This module attempts to simplify this obtained CBOR to the manner more acceptable.

Review this file whenever a hardfork occurs.

Synopsis

data CborSimplificationError
simplifyGYTxBodyCbor ∷ GYTxBody → Either CborSimplificationError GYTxBody
simplifyTxCbor ∷ GYTx → Either CborSimplificationError GYTx

Documentation

data CborSimplificationError #

Constructors

TransactionDeserialisationError !DeserialiseFailure
TransactionHasLeftOver !Text
TransactionIsAbsurd !Text
ModifiedTransactionDoesntDeserialise !Text

Instances

Instances details

Show CborSimplificationError #
Instance details Defined in GeniusYield.Transaction.CBOR Methods showsPrec ∷ Int → CborSimplificationError → ShowS # show ∷ CborSimplificationError → String # showList ∷ [CborSimplificationError] → ShowS #
Eq CborSimplificationError #
Instance details Defined in GeniusYield.Transaction.CBOR Methods (==) ∷ CborSimplificationError → CborSimplificationError → Bool # (/=) ∷ CborSimplificationError → CborSimplificationError → Bool #

simplifyGYTxBodyCbor ∷ GYTxBody → Either CborSimplificationError GYTxBody #

This GYTxBody doesn't represent transaction_body as mentioned in CDDL specification, it's API's internal type to represent transaction without signing key witnesses. However GYTx does represent transaction as defined in specification. We therefore obtain GYTx and work with it. Here we need an invariant, which is if we receive our simplified GYTx transaction, then obtaining GYTxBody via getTxBody and obtaining GYTx back via unsignedTx should have the same serialisation for the modifications to CBOR encoding we do here.

simplifyTxCbor ∷ GYTx → Either CborSimplificationError GYTx #

Function to simplify transaction CBOR.

We as of now, only modify transaction_body (terms are as defined in CDDL) in it.

The modifications done is as follows:-

All indefinite-length items are made definite.
Wherever map occurs, it's keys are sorted as required by CIP 21.