update calculations of the size of value and UTxO for minUTxOValue calculation #2101

polinavino · 2021-01-15T01:20:02Z

using HeapWords instances and some estimates of size, this PR gives a more accurate estimate of the size of a single UTxO entry in bytes (for these estimates, see https://github.com/input-output-hk/cardano-ledger-specs/compare/polina/utxosize - the log of the tests should contain the traces of the TxOut and TxIn HeapWords)
this is needed for calculating the minimum amount of ada which must be contained in a UTxO based on its size
the size calculation in Value.hs now estimates the size of a Value according to the new CompactValue representation

polinavino · 2021-01-15T01:58:17Z

my free-range non-nix ormolu does something different : (

shelley-ma/impl/src/Cardano/Ledger/Mary/Value.hs

JaredCorduan · 2021-01-15T14:48:06Z

I just smashed the three commits into one commit and ran ormolu

polinavino · 2021-01-18T14:53:03Z

shelley-ma/impl/src/Cardano/Ledger/Mary/Value.hs

+        D) a blob of policyIDs
+        E) a blob of asset names
+  -}
+


write units everywhere
Size in the heap of values, in words (to get the size in bytes multiply by 4 on a 32-bit machine or 8 on a 64-bit machine)

Word - 8 bytes

ignoring 32 bit machines

ascii art of layout

decide on linking comments to/from the compact value definition

polinavino · 2021-01-18T14:53:44Z

shelley-ma/impl/src/Cardano/Ledger/Mary/Value.hs

+        A) a sequence of Word64s representing quantities
+        B) a sequence of Word16s representing policyId indices
+        C) Word16s representing asset name indices
+           (as a special case for empty asset names,


also a sequence

polinavino · 2021-01-18T14:59:39Z

shelley-ma/impl/src/Cardano/Ledger/Mary/Value.hs

+        wordLength * quanSize * totalNoAssets
+          + 2 * totalNoAssets * (index * wordLength)
+          + pidLength * noPIDs
+          + assetNamesLength


round up to Words

polinavino · 2021-01-18T14:59:46Z

shelley-ma/impl/src/Cardano/Ledger/Mary/Value.hs

+
+  size (Value _ v)
+    -- based on size in words stored in the compact representation of Value
+    | v == mempty = fromIntegral $ adaWords * wordLength


polinavino · 2021-01-18T16:31:19Z

shelley-ma/impl/src/Cardano/Ledger/Mary/Value.hs

+adaWords = 2
+
+-- number of words used to represent quantity
+quanSize :: Int


should be in bytes
8

polinavino · 2021-01-18T16:34:15Z

shelley-ma/impl/src/Cardano/Ledger/Mary/Value.hs

+  it takes a Word64 to represent an ada amount (unpacked in the compact representation)
+
+  2. CompactValueMultiAsset (used otherwise) takes an ada amount and token bundle data
+    i) Word64 (ada)


is there extra overhead here for i) and ii)?

no overhead

polinavino · 2021-01-18T16:36:34Z

shelley-ma/impl/src/Cardano/Ledger/Mary/Value.hs

+
+  2. CompactValueMultiAsset (used otherwise) takes an ada amount and token bundle data
+    i) Word64 (ada)
+    ii) Word (number of distinct types of multi-assets in the bundle)


Word type - made concrete in Alex's PR

polinavino · 2021-01-18T16:40:05Z

shelley-ma/impl/src/Cardano/Ledger/Mary/Value.hs

    where
-      -- add addrHashLen for each Policy ID
-      accum u ans = foldr accumIns (ans + policyIdLen) u
+      repSize =


remove wordLength, convert to bytes (but round up to nearest integral number of word64s)
add comment that this is in bytes

polinavino · 2021-01-18T16:47:22Z

shelley-ma/impl/src/Cardano/Ledger/Mary/Value.hs

+
+-- length of PID in bytes
+pidLength :: Int
+pidLength = 28


use actual crypto scheme
get the length of the value level representation of hash for the given crypto scheme

-- | The size in bytes of the output of 'digest'
sizeHash :: forall h proxy. HashAlgorithm h => proxy h -> Word
sizeHash _ = fromInteger (natVal (Proxy @(SizeHash h)))

polinavino · 2021-01-18T16:49:21Z

shelley-ma/impl/src/Cardano/Ledger/Mary/Value.hs

+
+-- number of words used to store number of MAs in a value
+noMAs :: Int
+noMAs = 1


use this instead of calculated number of MAs

polinavino · 2021-01-18T16:59:15Z

shelley/chain-and-ledger/executable-spec/src/Cardano/Ledger/Val.hs

@@ -130,45 +131,30 @@ scaledMinDeposit v (Coin mv)
  -- The calculation should represent this equation
  -- minValueParameter / coinUTxOSize = actualMinValue / valueUTxOSize
  -- actualMinValue = (minValueParameter / coinUTxOSize) * valueUTxOSize
-  | otherwise = Coin $ adaPerUTxOByte * (utxoEntrySizeWithoutVal + size v) -- round down
+  | otherwise = Coin $ adaPerUTxOByte * (utxoEntrySizeWithoutVal + size v)


impose mv to be a lower bound

move this calc to UTxO rule in Mary?

polinavino · 2021-01-18T17:03:42Z

shelley/chain-and-ledger/executable-spec/src/Cardano/Ledger/Val.hs

-    addrHashLen = 28
+    -- lengths obtained from tracing on HeapWords of inputs and outputs, plus 6 for Map overhead
+    txoutLen :: Integer
+    txoutLen = 14


should depend on crypto (same as above comment)
exclude byron addresses from getting MAs

polinavino · 2021-01-18T17:11:56Z

shelley/chain-and-ledger/executable-spec/src/Cardano/Ledger/Val.hs

-    hashLen = 32
+    -- unpacked CompactCoin Word64 size in words
+    coinSize :: Integer
+    coinSize = fromIntegral $ heapWordsUnpacked (Coin 0)


Change this to compact coin

polinavino · 2021-01-18T17:14:01Z

shelley/chain-and-ledger/executable-spec/src/Cardano/Ledger/Val.hs

    utxoEntrySizeWithoutVal :: Integer
-    utxoEntrySizeWithoutVal = inputSize + outputSizeWithoutVal
+    utxoEntrySizeWithoutVal = (6 + txoutLen + txinLen) * wordSize


6 overhead in heapwords for each map entry

polinavino · 2021-01-18T17:16:05Z

shelley/chain-and-ledger/executable-spec/src/Cardano/Ledger/Val.hs

    adaPerUTxOByte :: Integer
-    adaPerUTxOByte = quot mv (utxoEntrySizeWithoutVal + uint)
+    adaPerUTxOByte = quot mv (utxoEntrySizeWithoutVal + coinSize * wordSize)


better comment

JaredCorduan · 2021-01-20T18:54:06Z

replaced by #2107

polinavino requested review from JaredCorduan and uroboros as code owners January 15, 2021 01:20

polinavino requested a review from redxaxder January 15, 2021 01:20

JaredCorduan reviewed Jan 15, 2021

View reviewed changes

shelley-ma/impl/src/Cardano/Ledger/Mary/Value.hs Outdated Show resolved Hide resolved

JaredCorduan force-pushed the polina/utxo-size branch from 97ce633 to 35db058 Compare January 15, 2021 14:46

JaredCorduan force-pushed the polina/utxo-size branch from ad1d7b5 to 502ede6 Compare January 15, 2021 20:49

nc6 mentioned this pull request Jan 18, 2021

draft of heapwords size estimate of utxos #2056

Closed

polinavino commented Jan 18, 2021

View reviewed changes

polinavino force-pushed the polina/utxo-size branch from 502ede6 to 95bc3e3 Compare January 19, 2021 21:21

min ada value calculations

4fe819b

redxaxder force-pushed the polina/utxo-size branch from 8dcb419 to 4fe819b Compare January 19, 2021 23:32

try to fix test

98de301

JaredCorduan mentioned this pull request Jan 20, 2021

min ada value calculations #2107

Merged

JaredCorduan closed this Jan 20, 2021

redxaxder deleted the polina/utxo-size branch April 20, 2021 17:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update calculations of the size of value and UTxO for minUTxOValue calculation #2101

update calculations of the size of value and UTxO for minUTxOValue calculation #2101

polinavino commented Jan 15, 2021 •

edited

polinavino commented Jan 15, 2021

JaredCorduan commented Jan 15, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021 •

edited

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

polinavino Jan 18, 2021

JaredCorduan commented Jan 20, 2021

update calculations of the size of value and UTxO for minUTxOValue calculation #2101

update calculations of the size of value and UTxO for minUTxOValue calculation #2101

Conversation

polinavino commented Jan 15, 2021 • edited

polinavino commented Jan 15, 2021

JaredCorduan commented Jan 15, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

polinavino Jan 18, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JaredCorduan commented Jan 20, 2021

polinavino commented Jan 15, 2021 •

edited

polinavino Jan 18, 2021 •

edited