[Builtins] Remove 'Emitter' and 'MonadEmitter' (#6224)

plutus-core/changelog.d/20240620_025344_effectfully_remove_Emitter_and_MonadEmitter.md

@@ -0,0 +1,7 @@
+### Removed
+
+- Removed `Emitter` and `MonadEmitter` in #6224.
+
+### Changed
+
+- Changed the type of `emit` to `Text -> BuiltinResult ()` in #6224.

plutus-core/plutus-core.cabal

@@ -96,7 +96,6 @@ library
     PlutusCore.Builtin
     PlutusCore.Builtin.Debug
     PlutusCore.Builtin.Elaborate
-    PlutusCore.Builtin.Emitter
     PlutusCore.Check.Normal
     PlutusCore.Check.Scoping
     PlutusCore.Check.Uniques

plutus-core/plutus-core/src/PlutusCore/Builtin.hs

@@ -4,7 +4,6 @@ module PlutusCore.Builtin
     ( module Export
     ) where
 
-import PlutusCore.Builtin.Emitter as Export
 import PlutusCore.Builtin.HasConstant as Export
 import PlutusCore.Builtin.KnownKind as Export
 import PlutusCore.Builtin.KnownType as Export

plutus-core/plutus-core/src/PlutusCore/Builtin/KnownType.hs

@@ -33,7 +33,6 @@ module PlutusCore.Builtin.KnownType
 
 import PlutusPrelude
 
-import PlutusCore.Builtin.Emitter
 import PlutusCore.Builtin.HasConstant
 import PlutusCore.Builtin.Polymorphism
 import PlutusCore.Builtin.Result
@@ -352,20 +351,6 @@ instance
     readKnown _ = throwUnderTypeError
     {-# INLINE readKnown #-}
 
-instance
-        ( TypeError ('Text "Use ‘BuiltinResult’ instead of ‘Emitter’")
-        , uni ~ UniOf val
-        ) => MakeKnownIn uni val (Emitter a) where
-    makeKnown _ = throwUnderTypeError
-    {-# INLINE makeKnown #-}
-
-instance
-        ( TypeError ('Text "Use ‘BuiltinResult’ instead of ‘Emitter’")
-        , uni ~ UniOf val
-        ) => ReadKnownIn uni val (Emitter a) where
-    readKnown _ = throwUnderTypeError
-    {-# INLINE readKnown #-}
-
 instance HasConstantIn uni val => MakeKnownIn uni val (SomeConstant uni rep) where
     makeKnown = coerceArg $ pure . fromConstant
     {-# INLINE makeKnown #-}

plutus-core/plutus-core/src/PlutusCore/Builtin/KnownTypeAst.hs

@@ -31,7 +31,6 @@ module PlutusCore.Builtin.KnownTypeAst
     , Delete
     ) where
 
-import PlutusCore.Builtin.Emitter
 import PlutusCore.Builtin.KnownKind
 import PlutusCore.Builtin.Polymorphism
 import PlutusCore.Builtin.Result
@@ -232,13 +231,6 @@ instance KnownTypeAst tyname uni a => KnownTypeAst tyname uni (BuiltinResult a)
     typeAst = toTypeAst $ Proxy @a
     {-# INLINE typeAst #-}
 
-instance KnownTypeAst tyname uni a => KnownTypeAst tyname uni (Emitter a) where
-    type IsBuiltin _ (Emitter a) = 'False
-    type ToHoles _ (Emitter a) = '[TypeHole a]
-    type ToBinds uni acc (Emitter a) = ToBinds uni acc a
-    typeAst = toTypeAst $ Proxy @a
-    {-# INLINE typeAst #-}
-
 instance KnownTypeAst tyname uni rep => KnownTypeAst tyname uni (SomeConstant uni rep) where
     type IsBuiltin _ (SomeConstant uni rep) = 'False
     type ToHoles _ (SomeConstant _ rep) = '[RepHole rep]

plutus-core/plutus-core/src/PlutusCore/Builtin/Result.hs

@@ -24,14 +24,14 @@ module PlutusCore.Builtin.Result
     , _OperationalUnliftingError
     , throwNotAConstant
     , throwUnderTypeError
+    , emit
     , withLogs
     , throwing
     , throwing_
     ) where
 
 import PlutusPrelude
 
-import PlutusCore.Builtin.Emitter
 import PlutusCore.Evaluation.Error
 import PlutusCore.Evaluation.Result
 
@@ -64,15 +64,15 @@ data BuiltinError
     deriving stock (Show, Eq)
 
 -- | The monad that 'makeKnown' runs in.
--- Equivalent to @ExceptT BuiltinError Emitter@, except optimized in two ways:
+-- Equivalent to @ExceptT BuiltinError (Writer (DList Text))@, except optimized in two ways:
 --
 -- 1. everything is strict
 -- 2. has the 'BuiltinSuccess' constructor that is used for returning a value with no logs
 --    attached, which is the most common case for us, so it helps a lot not to construct and
 --    deconstruct a redundant tuple
 --
--- Moving from @ExceptT BuiltinError Emitter@ to this data type gave us a speedup of 8% of total
--- evaluation time.
+-- Moving from @ExceptT BuiltinError (Writer (DList Text))@ to this data type gave us a speedup of
+-- 8% of total evaluation time.
 --
 -- Logs are represented as a 'DList', because we don't particularly care about the efficiency of
 -- logging, since there's no logging on the chain and builtins don't emit much anyway. Otherwise
@@ -143,10 +143,6 @@ instance AsEvaluationFailure (BuiltinResult a) where
     _EvaluationFailure = _BuiltinFailure . iso (\_ -> ()) (\_ -> pure evaluationFailure)
     {-# INLINE _EvaluationFailure #-}
 
-instance MonadEmitter BuiltinResult where
-    emit txt = BuiltinSuccessWithLogs (pure txt) ()
-    {-# INLINE emit #-}
-
 instance MonadFail BuiltinResult where
     fail err = BuiltinFailure (pure $ Text.pack err) BuiltinEvaluationFailure
     {-# INLINE fail #-}
@@ -208,6 +204,11 @@ throwUnderTypeError :: MonadError BuiltinError m => m void
 throwUnderTypeError = throwing _StructuralUnliftingError "Panic: 'TypeError' was bypassed"
 {-# INLINE throwUnderTypeError #-}
 
+-- | Add a log line to the logs.
+emit :: Text -> BuiltinResult ()
+emit txt = BuiltinSuccessWithLogs (pure txt) ()
+{-# INLINE emit #-}
+
 -- | Prepend logs to a 'BuiltinResult' computation.
 withLogs :: DList Text -> BuiltinResult a -> BuiltinResult a
 withLogs logs1 = \case

plutus-core/plutus-core/src/PlutusCore/Crypto/Utils.hs

@@ -3,8 +3,7 @@
 
 module PlutusCore.Crypto.Utils (failWithMessage, byteStringAsHex) where
 
-import PlutusCore.Builtin.Emitter (emit)
-import PlutusCore.Builtin.Result (BuiltinResult)
+import PlutusCore.Builtin.Result (BuiltinResult, emit)
 import PlutusCore.Evaluation.Result (evaluationFailure)
 
 import Data.ByteString (ByteString, foldr')