Merge pull request #5001 from IntersectMBO/aniketd/remove-heapwords

Remove heapwords from core and shelley

Author: aniketd

eras/shelley/impl/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## 1.17.0.0
 
+* Remove `HeapWords` instances for: #5001
+  - `ShelleyTxOut`
 * Move `Annotator` instances, `txSeqDecoder` and `mapTraverseableDecoderA` to `testlib`
 * Deprecate `witsFromTxWitnesses`
 * Expose access to `ShelleyTxRaw`, `ShelleyTxAuxDataRaw`, `ShelleyTxBodyRaw`, `ShelleyTxWitsRaw`, `MkMultiSig`

eras/shelley/impl/cardano-ledger-shelley.cabal

@@ -116,7 +116,6 @@ library
     data-default,
     deepseq,
     groups,
-    heapwords,
     mempack,
     microlens,
     mtl,

eras/shelley/impl/src/Cardano/Ledger/Shelley/TxOut.hs

@@ -24,8 +24,6 @@ module Cardano.Ledger.Shelley.TxOut (
   valueEitherShelleyTxOutL,
 ) where
 
-import qualified Cardano.Crypto.Hash as HS
-import Cardano.HeapWords (HeapWords (..))
 import Cardano.Ledger.Address (Addr (..), CompactAddr, compactAddr, decompactAddr)
 import Cardano.Ledger.Binary (
   DecCBOR (..),
@@ -48,11 +46,8 @@ import Cardano.Ledger.Shelley.PParams ()
 import Cardano.Ledger.Val (Val)
 import Control.DeepSeq (NFData (rnf))
 import Data.Aeson (KeyValue, ToJSON (..), object, pairs, (.=))
-import qualified Data.ByteString.Short as SBS (ShortByteString, pack)
 import Data.Maybe (fromMaybe)
 import Data.MemPack
-import Data.Proxy (Proxy (..))
-import Data.Word (Word8)
 import GHC.Stack (HasCallStack)
 import Lens.Micro
 import NoThunks.Class (InspectHeapNamed (..), NoThunks (..))
@@ -121,11 +116,6 @@ valueEitherShelleyTxOutL =
     )
 {-# INLINE valueEitherShelleyTxOutL #-}
 
--- assume Shelley+ type address : payment addr, staking addr (same length as payment), plus 1 word overhead
-instance (Era era, HeapWords (CompactForm (Value era))) => HeapWords (ShelleyTxOut era) where
-  heapWords (TxOutCompact _ vl) =
-    3 + heapWords packedADDRHASH + heapWords vl
-
 instance (Era era, Val (Value era)) => Show (ShelleyTxOut era) where
   show = show . viewCompactTxOut -- FIXME: showing TxOut as a tuple is just sad
 
@@ -196,12 +186,3 @@ toTxOutPair (ShelleyTxOut !addr !amount) =
   [ "address" .= addr
   , "amount" .= amount
   ]
-
--- a ShortByteString of the same length as the ADDRHASH
--- used to calculate heapWords
-packedADDRHASH :: SBS.ShortByteString
-packedADDRHASH =
-  SBS.pack $
-    replicate
-      (fromIntegral (1 + 2 * HS.sizeHash (Proxy :: Proxy ADDRHASH)))
-      (1 :: Word8)

libs/cardano-ledger-core/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## 1.18.0.0
 
+* Remove `HeapWords` instances for: #5001
+  - `Coin`
+  - `DeltaCoin`
+  - `CompactFormCoin`
+  - `CompactFormDeltaCoin`
+  - `SafeHash`
+  - `StrictMaybe DataHash`
+  - `TxId`
+  - `TxIn`
 * Add `addCompactCoin` to `Cardano.Ledger.Coin` and deprecate `Cardano.Ledger.UMap.addCompact`
   in its favor
 * Move `sumCompactCoin` to `Cardano.Ledger.Coin`

libs/cardano-ledger-core/cardano-ledger-core.cabal

@@ -118,7 +118,6 @@ library
     data-default >=0.8,
     deepseq,
     groups,
-    heapwords,
     iproute,
     measures,
     mempack,

libs/cardano-ledger-core/src/Cardano/Ledger/Coin.hs

@@ -35,7 +35,6 @@ module Cardano.Ledger.Coin (
 )
 where
 
-import Cardano.HeapWords (HeapWords)
 import Cardano.Ledger.BaseTypes (
   HasZero (..),
   Inject (..),
@@ -83,15 +82,15 @@ newtype Coin = Coin {unCoin :: Integer}
     )
   deriving (Show) via Quiet Coin
   deriving (Semigroup, Monoid, Group, Abelian) via Sum Integer
-  deriving newtype (PartialOrd, ToCBOR, EncCBOR, HeapWords)
+  deriving newtype (PartialOrd, ToCBOR, EncCBOR)
 
 instance FromCBOR Coin where
   fromCBOR = Coin . toInteger <$> Plain.decodeWord64
 
 instance DecCBOR Coin
 
 newtype DeltaCoin = DeltaCoin Integer
-  deriving (Eq, Ord, Generic, Enum, NoThunks, HeapWords)
+  deriving (Eq, Ord, Generic, Enum, NoThunks)
   deriving (Show) via Quiet DeltaCoin
   deriving (Semigroup, Monoid, Group, Abelian) via Sum Integer
   deriving newtype (PartialOrd, NFData, ToCBOR, DecCBOR, EncCBOR, ToJSON, FromJSON)
@@ -124,7 +123,7 @@ rationalToCoinViaCeiling = Coin . ceiling
 
 instance Compactible Coin where
   newtype CompactForm Coin = CompactCoin {unCompactCoin :: Word64}
-    deriving (Eq, Show, NoThunks, NFData, HeapWords, Prim, Ord, ToCBOR, ToJSON, FromJSON)
+    deriving (Eq, Show, NoThunks, NFData, Prim, Ord, ToCBOR, ToJSON, FromJSON)
     deriving (Semigroup, Monoid, Group, Abelian) via Sum Word64
 
   toCompact (Coin c) = CompactCoin <$> integerToWord64 c
@@ -145,7 +144,7 @@ instance MemPack (CompactForm Coin) where
 
 instance Compactible DeltaCoin where
   newtype CompactForm DeltaCoin = CompactDeltaCoin Word64
-    deriving (Eq, Show, NoThunks, NFData, HeapWords, ToJSON, Prim)
+    deriving (Eq, Show, NoThunks, NFData, ToJSON, Prim)
 
   toCompact (DeltaCoin dc) = CompactDeltaCoin <$> integerToWord64 dc
   fromCompact (CompactDeltaCoin cdc) = DeltaCoin (unCoin (word64ToCoin cdc))

libs/cardano-ledger-core/src/Cardano/Ledger/Hashes.hs

@@ -82,7 +82,6 @@ where
 import qualified Cardano.Crypto.DSIGN as DSIGN
 import qualified Cardano.Crypto.Hash as Hash
 import qualified Cardano.Crypto.VRF as VRF
-import Cardano.HeapWords (HeapWords (..))
 import Cardano.Ledger.Binary (
   DecCBOR (..),
   EncCBOR (..),
@@ -332,7 +331,6 @@ newtype SafeHash i = SafeHash (Hash.Hash HASH i)
     , NoThunks
     , NFData
     , SafeToHash
-    , HeapWords
     , ToCBOR
     , FromCBOR
     , EncCBOR

libs/cardano-ledger-core/src/Cardano/Ledger/Plutus/Data.hs

@@ -16,8 +16,6 @@
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE UndecidableInstances #-}
 {-# LANGUAGE ViewPatterns #-}
--- This is needed for the `HeapWords (StrictMaybe (DataHash c))` instance
-{-# OPTIONS_GHC -fno-warn-orphans #-}
 
 module Cardano.Ledger.Plutus.Data (
   PlutusData (..),
@@ -39,7 +37,6 @@ module Cardano.Ledger.Plutus.Data (
 )
 where
 
-import Cardano.HeapWords (HeapWords (..), heapWords0, heapWords1)
 import Cardano.Ledger.BaseTypes (StrictMaybe (..))
 import Cardano.Ledger.Binary (
   DecCBOR (..),
@@ -189,10 +186,6 @@ dataHashSize :: StrictMaybe DataHash -> Integer
 dataHashSize SNothing = 0
 dataHashSize (SJust _) = 10
 
-instance HeapWords (StrictMaybe DataHash) where
-  heapWords SNothing = heapWords0
-  heapWords (SJust a) = heapWords1 a
-
 -- ============================================================================
 -- Datum
 

libs/cardano-ledger-core/src/Cardano/Ledger/TxIn.hs

@@ -24,8 +24,6 @@ module Cardano.Ledger.TxIn (
 where
 
 import Cardano.Crypto.Hash.Class (hashToTextAsHex)
-import Cardano.HeapWords (HeapWords (..))
-import qualified Cardano.HeapWords as HW
 import Cardano.Ledger.BaseTypes (TxIx (..), mkTxIxPartial)
 import Cardano.Ledger.Binary (
   DecCBOR (..),
@@ -61,11 +59,7 @@ import NoThunks.Class (NoThunks (..))
 -- | A unique ID of a transaction, which is computable from the transaction.
 newtype TxId = TxId {unTxId :: SafeHash EraIndependentTxBody}
   deriving (Show, Eq, Ord, Generic)
-  deriving newtype (NoThunks, ToJSON, FromJSON, HeapWords, EncCBOR, DecCBOR, NFData, MemPack)
-
-instance HeapWords TxIn where
-  heapWords (TxIn txId _) =
-    2 + HW.heapWords txId + 1 {- txIx -}
+  deriving newtype (NoThunks, ToJSON, FromJSON, EncCBOR, DecCBOR, NFData, MemPack)
 
 instance ToJSON TxIn where
   toJSON = toJSON . txInToText