Remove UnwitnessedCliFormattedTxBody constructor

[smelc]

Changelog

- description: |
    Remove UnwitnessedCliFormattedTxBody constructor
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

Fixes #690

Checklist

• Commit sequence broadly makes sense and commits have useful messages
• New tests are added if needed and existing tests are updated. See Running tests for more details
• Self-reviewed the diff

[Jimbo4350]

What is the purpose of ReadTxBody?

[Jimbo4350]

So now its only possible to create CDDL formatted transactions. Therefore data IncompleteTx should be a newtype instead. We no longer need two constructors.

[smelc]

@Jimbo4350> changed 👍

Can you check this is what you had in mind?

[smelc]

@Jimbo4350> this is what you had in mind right? Treating two cases in the same manner?

[Jimbo4350]

You're almost there 👍

So we have:

acceptTxCDDLSerialisation
  :: FileOrPipe
  -> FileError TextEnvelopeError
  -> IO (Either CddlError CddlTx)
acceptTxCDDLSerialisation file err =
  case err of
   e@(FileError _ (TextEnvelopeDecodeError _)) ->
      first (CddlErrorTextEnv e) <$> readCddlTx file
   e@(FileError _ (TextEnvelopeAesonDecodeError _)) ->
      first (CddlErrorTextEnv e) <$> readCddlTx file
   e@(FileError _ (TextEnvelopeTypeError _ _)) ->
      first (CddlErrorTextEnv e) <$> readCddlTx file
   e@FileErrorTempFile{} -> return . Left $ CddlIOError e
   e@FileDoesNotExistError{} -> return . Left $ CddlIOError e
   e@FileIOError{} -> return . Left $ CddlIOError e

We cased on the TextEnvelope related errors because previously by default we used the deprecated "intermediate cli" format. Because it's no longer possible to create that format, and we will no longer support it, we can remove acceptTxCDDLSerialisation entirely and simply rely on the TextEnvelope encoding because we now default to the ledger's CDDL format.

[Jimbo4350]

See below:

instance IsShelleyBasedEra era => SerialiseAsCBOR (Tx era) where
    serialiseToCBOR (ShelleyTx sbe tx) =
      shelleyBasedEraConstraints sbe $ serialiseShelleyBasedTx tx

    deserialiseFromCBOR _ bs =
      shelleyBasedEraConstraints (shelleyBasedEra :: ShelleyBasedEra era)
        $ deserialiseShelleyBasedTx (ShelleyTx shelleyBasedEra) bs

-- | The serialisation format for the different Shelley-based eras are not the
-- same, but they can be handled generally with one overloaded implementation.
--
serialiseShelleyBasedTx :: forall ledgerera .
                           L.EraTx ledgerera
                        => L.Tx ledgerera
                        -> ByteString
serialiseShelleyBasedTx = Plain.serialize'

We call ledger's serialize' indirectly in our SerialiseAsCBOR (Tx era) instance and TextEnvelope is serialized as follows:

class SerialiseAsCBOR a => HasTextEnvelope a where
    textEnvelopeType :: AsType a -> TextEnvelopeType

    textEnvelopeDefaultDescr :: a -> TextEnvelopeDescr
    textEnvelopeDefaultDescr _ = ""

serialiseToTextEnvelope :: forall a. HasTextEnvelope a
                        => Maybe TextEnvelopeDescr -> a -> TextEnvelope
serialiseToTextEnvelope mbDescr a =
    TextEnvelope {
      teType    = textEnvelopeType ttoken
    , teDescription   = fromMaybe (textEnvelopeDefaultDescr a) mbDescr
    , teRawCBOR = serialiseToCBOR a
    }
  where
    ttoken :: AsType a
    ttoken = proxyToAsType Proxy

Note the SerialiseAsCBOR constraint and the call to serialiseToCBOR in serialiseToTextEnvelope. Hope this makes things clearer!

[Jimbo4350]

Looking good, see my comment below which hopefully clarifies things.

[Jimbo4350]

You're almost there 👍

So we have:

acceptTxCDDLSerialisation
  :: FileOrPipe
  -> FileError TextEnvelopeError
  -> IO (Either CddlError CddlTx)
acceptTxCDDLSerialisation file err =
  case err of
   e@(FileError _ (TextEnvelopeDecodeError _)) ->
      first (CddlErrorTextEnv e) <$> readCddlTx file
   e@(FileError _ (TextEnvelopeAesonDecodeError _)) ->
      first (CddlErrorTextEnv e) <$> readCddlTx file
   e@(FileError _ (TextEnvelopeTypeError _ _)) ->
      first (CddlErrorTextEnv e) <$> readCddlTx file
   e@FileErrorTempFile{} -> return . Left $ CddlIOError e
   e@FileDoesNotExistError{} -> return . Left $ CddlIOError e
   e@FileIOError{} -> return . Left $ CddlIOError e

We cased on the TextEnvelope related errors because previously by default we used the deprecated "intermediate cli" format. Because it's no longer possible to create that format, and we will no longer support it, we can remove acceptTxCDDLSerialisation entirely and simply rely on the TextEnvelope encoding because we now default to the ledger's CDDL format.

[Jimbo4350]

See below:

instance IsShelleyBasedEra era => SerialiseAsCBOR (Tx era) where
    serialiseToCBOR (ShelleyTx sbe tx) =
      shelleyBasedEraConstraints sbe $ serialiseShelleyBasedTx tx

    deserialiseFromCBOR _ bs =
      shelleyBasedEraConstraints (shelleyBasedEra :: ShelleyBasedEra era)
        $ deserialiseShelleyBasedTx (ShelleyTx shelleyBasedEra) bs

-- | The serialisation format for the different Shelley-based eras are not the
-- same, but they can be handled generally with one overloaded implementation.
--
serialiseShelleyBasedTx :: forall ledgerera .
                           L.EraTx ledgerera
                        => L.Tx ledgerera
                        -> ByteString
serialiseShelleyBasedTx = Plain.serialize'

We call ledger's serialize' indirectly in our SerialiseAsCBOR (Tx era) instance and TextEnvelope is serialized as follows:

class SerialiseAsCBOR a => HasTextEnvelope a where
    textEnvelopeType :: AsType a -> TextEnvelopeType

    textEnvelopeDefaultDescr :: a -> TextEnvelopeDescr
    textEnvelopeDefaultDescr _ = ""

serialiseToTextEnvelope :: forall a. HasTextEnvelope a
                        => Maybe TextEnvelopeDescr -> a -> TextEnvelope
serialiseToTextEnvelope mbDescr a =
    TextEnvelope {
      teType    = textEnvelopeType ttoken
    , teDescription   = fromMaybe (textEnvelopeDefaultDescr a) mbDescr
    , teRawCBOR = serialiseToCBOR a
    }
  where
    ttoken :: AsType a
    ttoken = proxyToAsType Proxy

Note the SerialiseAsCBOR constraint and the call to serialiseToCBOR in serialiseToTextEnvelope. Hope this makes things clearer!

[smelc]

This one conflicts with #758 and I want this one to go first.

[Jimbo4350]

"newExceptT" creeped into the comment.

[smelc]

Good catch, corrected 👍 and enqueueing for merge

[Jimbo4350]

Nice work 💪. We can get this merged but what we eventually want to do is remove all references to "CDDL". We default to the ledger's serialization so we don't need to be explicit about this. Previously we did because the "intermediate cli tx body" format was a thing.