Create CLI for plutus-debug

[Lucsanszky]

Description

Checklist

• Commit sequence broadly makes sense and commits have useful messages
• New tests are added if needed and existing tests are updated
• All visible changes are prepended to the latest section of a CHANGELOG.md for the affected packages.
  New section is never added with the code changes. (See RELEASING.md)
• When applicable, versions are updated in .cabal and CHANGELOG.md files according to the
  versioning process.
• The version bounds in .cabal files for all affected packages are updated.
  If you change the bounds in a cabal file, that package itself must have a version increase. (See RELEASING.md)
• Code is formatted with fourmolu (use scripts/fourmolize.sh)
• Cabal files are formatted (use scripts/cabal-format.sh)
• hie.yaml has been updated (use scripts/gen-hie.sh)
• Self-reviewed the diff

[lehins]

Looks great. A suggested a few improvements

[lehins]

This module should go into the executable itself.
First of all we do not want to depend on the optparse-applicative in the library. Secondly cli options aren't useful to any downstream user of this library

[Lucsanszky]

Good point! I'll move it.

[lehins]

This should also be Maybe [Int64], because empty cost model is also a legal value that would turn off all plutus primitives, so it could be a sensible option that can be used for debugging

[lehins]

It is ok to move that into the executable section. That being said, alternitivley we could move Opts definition into this module, while only moving the associated CLI parser into executable section. If we go with the latter approach then Opts needs a better name, eg. OverridesForPlutusWithContext

[lehins]

Unfortunately, we cannot remove this function from the library, because it looks like there are already downstream users of it. In particular I found that hydra uses this functionality.

What I suggest in order to resolve it is to create a type in this module:

data PlutusDebugOverrides = PlutusDebugOverrides
  { pdoScript :: !(Maybe ByteString)
  , pdoProtocolVersion :: !(Maybe Version)
  , pdoLanguage :: !(Maybe Language)
  , pdoCostModelValues :: !(Maybe [Int64])
  , pdoExUnitsMem :: !(Maybe Natural)
  , pdoExUnitsSteps :: !(Maybe Natural)
  }

then the Opts in CLI become:

data Opts = Opts
  { optsScriptWithContext :: !String
  , optsOverrides :: !PlutusDebugOverrides
  }
  deriving (Show)

Then the only breaking change to this function would be addition of a new argument:

debugPlutus :: Crypto c => String -> PlutusDebugOverrides -> IO (PlutusDebugInfo c)