Skip to content

Commit

Permalink
Remove all duplicate textShow implementations
Browse files Browse the repository at this point in the history
Propagate textShow to cardano-cli
Propagate textShow to cardano-node
  • Loading branch information
Jimbo4350 committed Sep 23, 2022
1 parent a01ab6d commit 7e799d8
Show file tree
Hide file tree
Showing 18 changed files with 20 additions and 45 deletions.
1 change: 1 addition & 0 deletions cardano-api/src/Cardano/Api.hs
Expand Up @@ -700,6 +700,7 @@ module Cardano.Api (
renderTxInsExistError,
txInsExistInUTxO,
notScriptLockedTxIns,
textShow,
) where

import Cardano.Api.Address
Expand Down
2 changes: 1 addition & 1 deletion cardano-api/src/Cardano/Api/Convenience/Construction.hs
Expand Up @@ -32,7 +32,7 @@ import Cardano.Api.ProtocolParameters
import Cardano.Api.Query
import Cardano.Api.Tx
import Cardano.Api.TxBody
import Cardano.Api.TxSubmit.Types (textShow)
import Cardano.Api.Utils

-- | Construct a balanced transaction.
-- See Cardano.Api.Convenience.Query.queryStateForBalancedTx for a
Expand Down
2 changes: 1 addition & 1 deletion cardano-api/src/Cardano/Api/Convenience/Query.hs
Expand Up @@ -32,7 +32,7 @@ import Cardano.Api.NetworkId
import Cardano.Api.ProtocolParameters
import Cardano.Api.Query
import Cardano.Api.TxBody
import Cardano.Api.TxSubmit.Types (textShow)
import Cardano.Api.Utils

data QueryConvenienceError
= AcqFailure AcquiringFailure
Expand Down
4 changes: 1 addition & 3 deletions cardano-api/src/Cardano/Api/LedgerState.hs
Expand Up @@ -107,6 +107,7 @@ import Cardano.Api.NetworkId (NetworkId (..), NetworkMagic (NetworkMag
import Cardano.Api.ProtocolParameters
import Cardano.Api.Query (CurrentEpochState (..), ProtocolState,
SerialisedCurrentEpochState (..), decodeCurrentEpochState, decodeProtocolState)
import Cardano.Api.Utils (textShow)
import Cardano.Binary (DecoderError, FromCBOR)
import qualified Cardano.Chain.Genesis
import qualified Cardano.Chain.Update
Expand Down Expand Up @@ -1061,9 +1062,6 @@ readAlonzoGenesisConfig enc = do
firstExceptT (NEAlonzoConfig file . renderAlonzoGenesisError)
$ readAlonzoGenesis (GenesisFile file) (ncAlonzoGenesisHash enc)

textShow :: Show a => a -> Text
textShow = Text.pack . show

readShelleyGenesis
:: GenesisFile -> GenesisHashShelley
-> ExceptT ShelleyGenesisError IO ShelleyConfig
Expand Down
6 changes: 2 additions & 4 deletions cardano-api/src/Cardano/Api/TxSubmit/ErrorRender.hs
Expand Up @@ -8,14 +8,14 @@ module Cardano.Api.TxSubmit.ErrorRender
-- They will be defined here for now and then moved where they are supposed to be once they
-- are working.

import Cardano.Api.Utils (textShow)

import Cardano.Chain.Byron.API (ApplyMempoolPayloadErr (..))
import Cardano.Chain.UTxO.UTxO (UTxOError (..))
import Cardano.Chain.UTxO.Validation (TxValidationError (..), UTxOValidationError (..))

import Cardano.Prelude hiding ((%))

import qualified Data.Text as Text

import Formatting (build, sformat, stext, (%))

renderApplyMempoolPayloadErr :: ApplyMempoolPayloadErr -> Text
Expand Down Expand Up @@ -65,5 +65,3 @@ renderUTxOError ue =
UTxOMissingInput tx -> sformat ("Lookup of tx "% build %" failed") tx
UTxOOverlappingUnion -> "Union or two overlapping UTxO sets"

textShow :: Show a => a -> Text
textShow = Text.pack . show
5 changes: 0 additions & 5 deletions cardano-api/src/Cardano/Api/TxSubmit/Types.hs
Expand Up @@ -5,7 +5,6 @@ module Cardano.Api.TxSubmit.Types
, TxSubmitStatus (..)
, ApplyMempoolPayloadErr(..)
, renderTxSubmitStatus
, textShow
) where

import Cardano.Binary (DecoderError)
Expand All @@ -17,14 +16,12 @@ import Cardano.Prelude hiding ((%))

import Data.Aeson (ToJSON (..), Value (..))
import qualified Data.Aeson as Aeson
import qualified Data.Text as Text

import Formatting (build, sformat, (%))

import Cardano.Api.Environment
import Cardano.Api.TxSubmit.ErrorRender


data NodeApiEnv = NodeApiEnv
{ naeConfig :: Genesis.Config
, naeSocket :: SocketPath
Expand Down Expand Up @@ -66,5 +63,3 @@ renderTxSubmitStatus st =
TxSubmitBadTx tt -> mconcat ["Transactions of type '", tt, "' not supported"]
TxSubmitFail err -> renderApplyMempoolPayloadErr err

textShow :: Show a => a -> Text
textShow = Text.pack . show
1 change: 0 additions & 1 deletion cardano-cli/src/Cardano/CLI/Byron/Delegation.hs
Expand Up @@ -27,7 +27,6 @@ import Cardano.Crypto (ProtocolMagicId)
import qualified Cardano.Crypto as Crypto

import Cardano.CLI.Byron.Key (ByronKeyFailure, renderByronKeyFailure)
import Cardano.CLI.Helpers (textShow)
import Cardano.CLI.Types (CertificateFile (..))

data ByronDelegationError
Expand Down
7 changes: 3 additions & 4 deletions cardano-cli/src/Cardano/CLI/Byron/Genesis.hs
Expand Up @@ -22,10 +22,10 @@ import Data.Text.Lazy.Builder (toLazyText)
import Data.Time (UTCTime)
import Formatting.Buildable

import System.Directory (createDirectory, doesPathExist)
import Cardano.Api (Key (..), NetworkId, writeSecrets)
import Cardano.Api (Key (..), NetworkId, textShow, writeSecrets)
import Cardano.Api.Byron (ByronKey, SerialiseAsRawBytes (..), SigningKey (..),
toByronRequiresNetworkMagic)
toByronRequiresNetworkMagic)
import System.Directory (createDirectory, doesPathExist)

import qualified Cardano.Chain.Common as Common
import Cardano.Chain.Delegation hiding (Map, epoch)
Expand All @@ -37,7 +37,6 @@ import qualified Cardano.Crypto as Crypto

import Cardano.CLI.Byron.Delegation
import Cardano.CLI.Byron.Key
import Cardano.CLI.Helpers (textShow)
import Cardano.CLI.Types (GenesisFile (..))

data ByronGenesisError
Expand Down
3 changes: 1 addition & 2 deletions cardano-cli/src/Cardano/CLI/Byron/Key.hs
Expand Up @@ -18,7 +18,7 @@ import Cardano.Prelude hiding (option, show, trace, (%))
import Prelude (show)

import Control.Monad.Trans.Except.Extra (firstExceptT, handleIOExceptT, hoistEither, left,
right)
right)
import qualified Data.ByteString as SB
import qualified Data.ByteString.UTF8 as UTF8
import Data.String (fromString)
Expand All @@ -28,7 +28,6 @@ import Formatting (build, sformat, (%))
import Cardano.Api.Byron

import qualified Cardano.Chain.Common as Common
import Cardano.CLI.Helpers (textShow)
import Cardano.CLI.Shelley.Commands (ByronKeyFormat (..))
import Cardano.CLI.Types
import qualified Cardano.Crypto.Signing as Crypto
Expand Down
1 change: 0 additions & 1 deletion cardano-cli/src/Cardano/CLI/Byron/Tx.hs
Expand Up @@ -44,7 +44,6 @@ import qualified Cardano.Crypto.Signing as Crypto

import Cardano.Api.Byron
import Cardano.CLI.Byron.Key (byronWitnessToVerKey)
import Cardano.CLI.Helpers (textShow)
import Cardano.CLI.Types (TxFile (..))
import Ouroboros.Consensus.Byron.Ledger (ByronBlock, GenTx (..))
import qualified Ouroboros.Consensus.Byron.Ledger as Byron
Expand Down
8 changes: 4 additions & 4 deletions cardano-cli/src/Cardano/CLI/Byron/UpdateProposal.hs
Expand Up @@ -15,19 +15,19 @@ import Control.Tracer (stdoutTracer, traceWith)
import qualified Data.ByteString as BS

import Cardano.Chain.Update (InstallerHash (..), ProtocolVersion (..),
SoftwareVersion (..), SystemTag (..))
SoftwareVersion (..), SystemTag (..))

import Ouroboros.Consensus.Ledger.SupportsMempool (txId)
import Ouroboros.Consensus.Util.Condense (condense)

import Cardano.Api (NetworkId, SerialiseAsRawBytes (..))
import Cardano.Api (NetworkId, SerialiseAsRawBytes (..), textShow)
import Cardano.Api.Byron (AsType (AsByronUpdateProposal), ByronProtocolParametersUpdate,
ByronUpdateProposal, makeByronUpdateProposal, toByronLedgerUpdateProposal)
ByronUpdateProposal, makeByronUpdateProposal, toByronLedgerUpdateProposal)

import Cardano.CLI.Byron.Genesis (ByronGenesisError)
import Cardano.CLI.Byron.Key (ByronKeyFailure, readByronSigningKey)
import Cardano.CLI.Byron.Tx (ByronTxError, nodeSubmitTx)
import Cardano.CLI.Helpers (HelpersError, ensureNewFileLBS, renderHelpersError, textShow)
import Cardano.CLI.Helpers (HelpersError, ensureNewFileLBS, renderHelpersError)
import Cardano.CLI.Shelley.Commands (ByronKeyFormat (..))
import Cardano.CLI.Types

Expand Down
10 changes: 3 additions & 7 deletions cardano-cli/src/Cardano/CLI/Helpers.hs
Expand Up @@ -9,7 +9,6 @@ module Cardano.CLI.Helpers
, pPrintCBOR
, readCBOR
, renderHelpersError
, textShow
, validateCBOR
, hushM
) where
Expand All @@ -24,16 +23,16 @@ import Control.Monad.Trans.Except.Extra (handleIOExceptT, left)
import qualified Data.ByteString as BS
import qualified Data.ByteString.Lazy as LB
import qualified Data.Text as Text
import System.Console.ANSI
import qualified System.Console.ANSI as ANSI
import System.Console.ANSI
import qualified System.IO as IO

import Cardano.Binary (Decoder, fromCBOR)
import Cardano.CLI.Types
import Cardano.Chain.Block (fromCBORABlockOrBoundary)
import qualified Cardano.Chain.Delegation as Delegation
import qualified Cardano.Chain.UTxO as UTxO
import qualified Cardano.Chain.Update as Update
import qualified Cardano.Chain.UTxO as UTxO
import Cardano.CLI.Types

import qualified System.Directory as IO

Expand Down Expand Up @@ -117,9 +116,6 @@ validateCBOR cborObject bs =
() <$ decodeCBOR bs (fromCBOR :: Decoder s Update.Vote)
Right "Valid Byron vote."

textShow :: Show a => a -> Text
textShow = Text.pack . show

-- | Convert an Either to a Maybe and execute the supplied handler
-- in the Left case.
hushM :: forall e m a. Monad m => Either e a -> (e -> m ()) -> m (Maybe a)
Expand Down
1 change: 0 additions & 1 deletion cardano-cli/src/Cardano/CLI/Run/Friendly.hs
Expand Up @@ -29,7 +29,6 @@ import Cardano.Api.Shelley (Address (ShelleyAddress),
KeyWitness (ShelleyBootstrapWitness, ShelleyKeyWitness), StakeAddress (..),
StakeCredential (..), StakePoolParameters (..), fromShelleyPaymentCredential,
fromShelleyStakeCredential, fromShelleyStakeReference)
import Cardano.CLI.Helpers (textShow)
import qualified Cardano.Ledger.Shelley.API as Shelley

yamlConfig :: Yaml.Config
Expand Down
1 change: 0 additions & 1 deletion cardano-cli/src/Cardano/CLI/Shelley/Run/Genesis.hs
Expand Up @@ -80,7 +80,6 @@ import qualified Cardano.Ledger.Shelley.PParams as Shelley
import Cardano.Ledger.Crypto (ADDRHASH, Crypto, StandardCrypto)
import Cardano.Ledger.Era ()

import Cardano.CLI.Helpers (textShow)
import Cardano.CLI.Shelley.Commands
import Cardano.CLI.Shelley.Key
import Cardano.CLI.Shelley.Orphans ()
Expand Down
2 changes: 0 additions & 2 deletions cardano-cli/src/Cardano/CLI/Shelley/Run/Governance.hs
Expand Up @@ -56,8 +56,6 @@ renderShelleyGovernanceError err =
"Error decoding cost model: " <> Text.pack err' <> " at: " <> fp
ShelleyGovernanceCmdCostModelReadError err' ->
"Error reading the cost model: " <> Text.pack (displayError err')
where
textShow x = Text.pack (show x)


runGovernanceCmd :: GovernanceCmd -> ExceptT ShelleyGovernanceCmdError IO ()
Expand Down
3 changes: 1 addition & 2 deletions cardano-cli/src/Cardano/CLI/Shelley/Run/Key.hs
Expand Up @@ -24,8 +24,8 @@ import Control.Monad.Trans.Except.Extra (firstExceptT, hoistEither, le
import qualified Codec.Binary.Bech32 as Bech32

import qualified Cardano.Crypto.DSIGN as DSIGN
import qualified Cardano.Crypto.Signing as Byron.Crypto
import qualified Cardano.Crypto.Signing as Byron
import qualified Cardano.Crypto.Signing as Byron.Crypto
import qualified Cardano.Crypto.Signing as Crypto
import qualified Cardano.Crypto.Wallet as Crypto
import qualified Cardano.Ledger.Keys as Shelley
Expand All @@ -36,7 +36,6 @@ import Cardano.Api.Crypto.Ed25519Bip32 (xPrvFromBytes)
import Cardano.Api.Shelley

import qualified Cardano.CLI.Byron.Key as Byron
import Cardano.CLI.Helpers (textShow)
import Cardano.CLI.Shelley.Commands
import Cardano.CLI.Shelley.Key (InputDecodeError, readSigningKeyFileAnyOf)
import Cardano.CLI.Types (SigningKeyFile (..), VerificationKeyFile (..))
Expand Down
4 changes: 1 addition & 3 deletions cardano-node/src/Cardano/Node/Tracing/Era/Shelley.hs
Expand Up @@ -21,6 +21,7 @@ import qualified Data.Aeson.Types as Aeson
import qualified Data.Set as Set
import qualified Data.Text as Text

import Cardano.Api (textShow)
import qualified Cardano.Api as Api
import Cardano.Api.Orphans ()
import qualified Cardano.Api.Shelley as Api
Expand Down Expand Up @@ -1197,9 +1198,6 @@ instance LogFormatting Praos.PraosEnvelopeError where
-- Helper functions
--------------------------------------------------------------------------------

textShow :: Show a => a -> Text
textShow = Text.pack . show

showLastAppBlockNo :: WithOrigin (LastAppliedBlock crypto) -> Text
showLastAppBlockNo wOblk = case withOriginToMaybe wOblk of
Nothing -> "Genesis Block"
Expand Down
4 changes: 1 addition & 3 deletions cardano-node/src/Cardano/Tracing/OrphanInstances/Shelley.hs
Expand Up @@ -25,6 +25,7 @@ import qualified Data.Aeson.Types as Aeson
import qualified Data.Set as Set
import qualified Data.Text as Text

import Cardano.Api (textShow)
import qualified Cardano.Api as Api
import Cardano.Api.Orphans ()
import qualified Cardano.Api.Shelley as Api
Expand Down Expand Up @@ -1217,9 +1218,6 @@ instance ToObject Praos.PraosEnvelopeError where
-- Helper functions
--------------------------------------------------------------------------------

textShow :: Show a => a -> Text
textShow = Text.pack . show

showLastAppBlockNo :: WithOrigin (LastAppliedBlock crypto) -> Text
showLastAppBlockNo wOblk = case withOriginToMaybe wOblk of
Nothing -> "Genesis Block"
Expand Down

0 comments on commit 7e799d8

Please sign in to comment.