Skip to content

Commit

Permalink
Added method to compute over-the-wire CBOR encoded transaction size
Browse files Browse the repository at this point in the history
  • Loading branch information
crocodile-dentist committed Aug 1, 2024
1 parent 48c5fd3 commit 2195d2b
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 9 deletions.
3 changes: 3 additions & 0 deletions eras/allegra/impl/src/Cardano/Ledger/Allegra/Tx.hs
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ instance Crypto c => EraTx (AllegraEra c) where
sizeTxF = sizeShelleyTxF
{-# INLINE sizeTxF #-}

wireSizeTxF = sizeShelleyTxF
{-# INLINE wireSizeTxF #-}

validateNativeScript = validateTimelock
{-# INLINE validateNativeScript #-}

Expand Down
17 changes: 13 additions & 4 deletions eras/alonzo/impl/src/Cardano/Ledger/Alonzo/Tx.hs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RankNTypes #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE StandaloneDeriving #-}
{-# LANGUAGE TypeApplications #-}
Expand Down Expand Up @@ -186,9 +187,12 @@ instance Crypto c => EraTx (AlonzoEra c) where
auxDataTxL = auxDataAlonzoTxL
{-# INLINE auxDataTxL #-}

sizeTxF = sizeAlonzoTxF
sizeTxF = sizeAlonzoTxF toCBORForSizeComputation
{-# INLINE sizeTxF #-}

wireSizeTxF = sizeAlonzoTxF encCBOR
{-# INLINE wireSizeTxF #-}

validateNativeScript = validateTimelock
{-# INLINE validateNativeScript #-}

Expand Down Expand Up @@ -236,13 +240,18 @@ auxDataAlonzoTxL = lens auxiliaryData (\tx txTxAuxData -> tx {auxiliaryData = tx
{-# INLINEABLE auxDataAlonzoTxL #-}

-- | txsize computes the length of the serialised bytes
sizeAlonzoTxF :: forall era. EraTx era => SimpleGetter (AlonzoTx era) Integer
sizeAlonzoTxF =
sizeAlonzoTxF ::
forall era b.
(EraTx era, Num b) =>
-- | encoding for CBOR size or mempool submission
(AlonzoTx era -> Encoding) ->
SimpleGetter (AlonzoTx era) b
sizeAlonzoTxF enc =
to $
fromIntegral
. LBS.length
. serialize (eraProtVerLow @era)
. toCBORForSizeComputation
. enc
{-# INLINEABLE sizeAlonzoTxF #-}

isValidAlonzoTxL :: Lens' (AlonzoTx era) IsValid
Expand Down
7 changes: 6 additions & 1 deletion eras/babbage/impl/src/Cardano/Ledger/Babbage/Tx.hs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ module Cardano.Ledger.Babbage.Tx (
)
where

import Cardano.Ledger.Binary (EncCBOR (encCBOR))

import Cardano.Ledger.Allegra.Tx (validateTimelock)
import Cardano.Ledger.Alonzo.Tx as X
import Cardano.Ledger.Alonzo.TxSeq (
Expand Down Expand Up @@ -47,9 +49,12 @@ instance Crypto c => EraTx (BabbageEra c) where
auxDataTxL = auxDataAlonzoTxL
{-# INLINE auxDataTxL #-}

sizeTxF = sizeAlonzoTxF
sizeTxF = sizeAlonzoTxF X.toCBORForSizeComputation
{-# INLINE sizeTxF #-}

wireSizeTxF = sizeAlonzoTxF encCBOR
{-# INLINE wireSizeTxF #-}

validateNativeScript = validateTimelock
{-# INLINE validateNativeScript #-}

Expand Down
8 changes: 7 additions & 1 deletion eras/conway/impl/src/Cardano/Ledger/Conway/Tx.hs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ module Cardano.Ledger.Conway.Tx (
)
where

import Cardano.Ledger.Binary (EncCBOR (encCBOR))

import Cardano.Ledger.Allegra.Tx (validateTimelock)
import Cardano.Ledger.Alonzo.Core (AlonzoEraTxWits)
import Cardano.Ledger.Alonzo.Tx (
Expand All @@ -21,6 +23,7 @@ import Cardano.Ledger.Alonzo.Tx (
isValidAlonzoTxL,
mkBasicAlonzoTx,
sizeAlonzoTxF,
toCBORForSizeComputation,
witsAlonzoTxL,
)
import Cardano.Ledger.Alonzo.TxSeq (
Expand Down Expand Up @@ -62,9 +65,12 @@ instance Crypto c => EraTx (ConwayEra c) where
auxDataTxL = auxDataAlonzoTxL
{-# INLINE auxDataTxL #-}

sizeTxF = sizeAlonzoTxF
sizeTxF = sizeAlonzoTxF toCBORForSizeComputation
{-# INLINE sizeTxF #-}

wireSizeTxF = sizeAlonzoTxF encCBOR
{-# INLINE wireSizeTxF #-}

validateNativeScript = validateTimelock
{-# INLINE validateNativeScript #-}

Expand Down
3 changes: 3 additions & 0 deletions eras/mary/impl/src/Cardano/Ledger/Mary/Tx.hs
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ instance Crypto c => EraTx (MaryEra c) where
sizeTxF = sizeShelleyTxF
{-# INLINE sizeTxF #-}

wireSizeTxF = sizeShelleyTxF
{-# INLINE wireSizeTxF #-}

validateNativeScript = validateTimelock
{-# INLINE validateNativeScript #-}

Expand Down
5 changes: 4 additions & 1 deletion eras/shelley/impl/src/Cardano/Ledger/Shelley/Tx.hs
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ auxDataShelleyTxL =
{-# INLINEABLE auxDataShelleyTxL #-}

-- | Size getter for `ShelleyTx`.
sizeShelleyTxF :: Era era => SimpleGetter (ShelleyTx era) Integer
sizeShelleyTxF :: (Era era, Num b) => SimpleGetter (ShelleyTx era) b
sizeShelleyTxF = to (\(TxConstr (Memo _ bytes)) -> fromIntegral $ SBS.length bytes)
{-# INLINEABLE sizeShelleyTxF #-}

Expand Down Expand Up @@ -200,6 +200,9 @@ instance Crypto c => EraTx (ShelleyEra c) where
sizeTxF = sizeShelleyTxF
{-# INLINE sizeTxF #-}

wireSizeTxF = sizeShelleyTxF
{-# INLINE wireSizeTxF #-}

validateNativeScript = validateMultiSig
{-# INLINE validateNativeScript #-}

Expand Down
4 changes: 4 additions & 0 deletions libs/cardano-ledger-core/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Version history for `cardano-ledger-core`

## 1.14.2.0

* Add `wireSizeTxF` to `EraTx` class

## 1.14.1.0

### `testlib`
Expand Down
2 changes: 1 addition & 1 deletion libs/cardano-ledger-core/cardano-ledger-core.cabal
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cabal-version: 3.0
name: cardano-ledger-core
version: 1.14.1.0
version: 1.14.2.0
license: Apache-2.0
maintainer: operations@iohk.io
author: IOHK
Expand Down
6 changes: 5 additions & 1 deletion libs/cardano-ledger-core/src/Cardano/Ledger/Core.hs
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ import Data.Maybe.Strict (StrictMaybe)
import Data.Sequence.Strict (StrictSeq)
import Data.Set (Set)
import Data.Void (Void)
import Data.Word (Word64)
import Data.Word (Word32, Word64)
import GHC.Stack (HasCallStack)
import Lens.Micro
import NoThunks.Class (NoThunks)
Expand Down Expand Up @@ -153,8 +153,12 @@ class

auxDataTxL :: Lens' (Tx era) (StrictMaybe (AuxiliaryData era))

-- | For estimations of impact on block space
sizeTxF :: SimpleGetter (Tx era) Integer

-- | For end use by eg. diffusion layer in transaction submission protocol
wireSizeTxF :: SimpleGetter (Tx era) Word32

-- | Using information from the transaction validate the supplied native script.
validateNativeScript :: Tx era -> NativeScript era -> Bool

Expand Down

0 comments on commit 2195d2b

Please sign in to comment.