[vesting] rewrite the private sale module #75

devfull · 2022-08-24T14:48:37Z

Closes #74

augucharles · 2022-09-09T08:26:52Z

src/Tokenomia/CardanoApi/Fees.hs

+-- | Utxo entry size calculation
+utxoEntrySize :: Value -> HasDatumHash -> Integer
+utxoEntrySize value datum =
+    utxoEntrySizeWithoutVal + Value.size (toMaryValue value) + datumHashSize datum


tu mets explicitement toMaryValue, y a-t-il une notion de rétrocompatibilité à prendre en compte également ? quel impact pour les futurs versions ? faudra-t-il changer cette fonction ?

This calculation is specific to the Alonzo era, as described in : https://github.com/input-output-hk/cardano-ledger/blob/2c203ead68913d660389f04a705c734c155c2a35/doc/explanations/min-utxo-alonzo.rst

The drawback of patching fees or minUTxO calculations is that those pieces of code are very unstable and will require maintenance. The only intent is to avoid generating a valid Address to build a TxOut for doing tests without IO as explained in the issue #74. We should use the original functions when appropriate.

augucharles · 2022-09-09T08:31:23Z

src/Tokenomia/CardanoApi/Fees.hs

+    datumHashSize :: HasDatumHash -> Integer
+    datumHashSize NoDatumHash = 0
+    datumHashSize WithDatumHash = 10
+
+    utxoEntrySizeWithoutVal :: Integer
+    utxoEntrySizeWithoutVal = 27


cardano est très "paramétrisable" dans le sens où on peut jouer avec les protocol-parameters sans avoir à sortir une nouvelle version du noeud, ces utxo et datumhash sizes font-elles parti de ces fameux paramètres ? le cas échéant, faut-il regrouper dans un fichier de conf les paramètres ?

The utxoEntrySizeWithoutVal and dataHashSize are not protocol parameters but lengths obtained experimentally. The documentation refers to them as "current constants" :

Note that the coinsPerUTxOWord is a protocol parameter and is subject to change. The values utxoEntrySizeWithoutVal and dataHashSize (dh) are fixed at least for the entire Alonzo era.

augucharles · 2022-09-09T08:33:06Z

src/Tokenomia/CardanoApi/Fees.hs

+    deriving stock (Show)
+
+-- | Utxo entry size calculation
+utxoEntrySize :: Value -> HasDatumHash -> Integer


la maj vasil introduit les inline datum qui peuvent impacter ce calcul
https://cips.cardano.org/cips/cip32/

augucharles · 2022-09-09T08:38:38Z

src/Tokenomia/CardanoApi/Fees.hs

+            ShelleyBasedEraShelley -> protocolParamMinUTxOValue
+            ShelleyBasedEraAllegra -> calculateMinimumUTxOAllegraMary
+            ShelleyBasedEraMary    -> calculateMinimumUTxOAllegraMary
+            ShelleyBasedEraAlonzo  -> calculateMinimumUTxOAlonzo
+  where
+    calculateMinimumUTxOAllegraMary :: Maybe Lovelace
+    calculateMinimumUTxOAllegraMary =
+        calcMinimumDeposit value
+            <$> protocolParamMinUTxOValue
+
+    calculateMinimumUTxOAlonzo :: Maybe Lovelace
+    calculateMinimumUTxOAlonzo =
+        (Lovelace (utxoEntrySize value datumHash) *)
+            <$> protocolParamUTxOCostPerWord


si je comprends bien on devra mettre ça à jour à chaque fois qu'on entre dans une nouvelle era qui touche à ce calcul ?

augucharles · 2022-09-09T08:45:27Z

src/Tokenomia/CardanoApi/Fees.hs

+            <$> protocolParamUTxOCostPerWord
+
+-- | Calculate minimumUTxO with default protocol parameters from a Value
+calculateDefaultMinimumUTxOFromValue ::


quelle est la motivation derrière ces fonctions default ? ou plutôt pourquoi avons-nous besoin des fonctions "non default" ?

The PParams in each era have a default instance, basically setting all fields to empty values. The non-default calculate* functions take a ProtocolParameters as argument. Those parameters could be retrieved from disk with IO. But given that the calculation use only one parameter in each era that is not susceptible to change, we can provide another default updated with the hardcoded needed value, and avoid doing IO in the process. The default functions are based on the non-default ones to give a clear design and to allow more generic calculations.

augucharles · 2022-09-09T08:47:12Z

src/Tokenomia/CardanoApi/Fees.hs

+        defaultCalculateMinimumUTxOParams era
+
+-- | Calculate minimumUTxO for a singleton Value from AssetId
+calculateMinimumUTxOFromAssetId ::


ce cas particulier est-il nécessaire ?

This is the simplest way to call the calculation in the GenerateNative module for example, to encompass with a single call the same minUTxO for all singleton values based on the given AssetClass.

validatePrivateSale PrivateSale{..} = let proportions = TranchesProportions $ proportion <$> tranchesProperties in liftEither $ do ε <- calculateDefaultMinimumUTxOFromAssetClass assetClass

augucharles · 2022-09-09T08:52:37Z

src/Tokenomia/CardanoApi/FromPlutus/Value.hs

+    )
+
+import PlutusTx.Builtins                    ( fromBuiltin )
+import Plutus.V1.Ledger.Ada                 ( adaSymbol, adaToken )


on a pas mal de références à Plutus.V1, je ne me rends pas compte de ce que va apporter Plutus.V2 comme modifications. Je crois que V2 arrive avec Vasil si je ne me trompe pas, à moins que ce soit déjà déployé.

augucharles · 2022-09-09T08:57:19Z

src/Tokenomia/CardanoApi/PParams.hs

@@ -0,0 +1,42 @@
+{-# LANGUAGE ImportQualifiedPost            #-}


besoin de faire un point sur la gestion de ces paramètres de manière générale dans tokenomia

augucharles · 2022-09-09T08:58:18Z

src/Tokenomia/CardanoApi/Value.hs

+unLovelace :: Lovelace -> Integer
+unLovelace (Lovelace l) = l
+
+unQuantity :: Quantity -> Integer
+unQuantity (Quantity l) = l


je ne sais pas pour unQuantity mais il me semble que unLovelace existe déjà

I don't see it anywhere : https://github.com/input-output-hk/cardano-node/blob/b112a608ef1706bea7c03760f81b97f654cc73af/cardano-api/src/Cardano/Api/Value.hs#L95-L97

augucharles · 2022-09-09T08:59:08Z

src/Tokenomia/Common/Aeson/AssetClass.hs

+    , assetClassToJSON
+    ) where
+
+import Control.Arrow                        ( (***) )


c'est quoi ?

I should have used bimap instead.

augucharles · 2022-09-09T09:00:27Z

src/Tokenomia/Common/Aeson/AssetClass.hs

+assetClassFromJSON :: Value -> Parser AssetClass
+assetClassFromJSON = withObject "AssetClass" $ \o ->
+    assetClass
+        <$> (fromString <$> o .: "currencySymbol")
+        <*> (fromString <$> o .: "tokenName")
+
+-- | Alternative AssetClass Value to the ToJSON instance
+assetClassToJSON :: AssetClass -> Value
+assetClassToJSON x =
+    let (currencySymbol, tokenName) = (show *** toString) $ unAssetClass x
+    in
+        object
+            [ "currencySymbol" .= currencySymbol
+            , "tokenName" .= tokenName
+            ]


les toJSON avec les lenses faisaient pas le taf ?

augucharles · 2022-09-09T09:02:06Z

src/Tokenomia/Common/Arbitrary/AssetClass.hs

@@ -0,0 +1,86 @@
+{-# LANGUAGE DerivingStrategies             #-}


tu ne mets pas le repertoire Arbitrary avec ce qui est lié aux tests ?

augucharles · 2022-09-09T09:02:11Z

src/Tokenomia/Common/Arbitrary/AssetClass.hs

@@ -0,0 +1,86 @@
+{-# LANGUAGE DerivingStrategies             #-}


tu ne mets pas le repertoire Arbitrary avec ce qui est lié aux tests ?

augucharles · 2022-09-09T09:03:50Z

src/Tokenomia/Common/Arbitrary/AssetClass.hs

+instance Arbitrary CurrencySymbol where
+    arbitrary = CurrencySymbol <$> arbitrary
+    shrink x  = CurrencySymbol <$> shrink (unCurrencySymbol x)


tu me conseilles de regarder la doc de quickcheck pour comprendre un peu les arbitrary et les shrinks ?

augucharles · 2022-09-09T09:08:22Z

src/Tokenomia/Common/Arbitrary/Modifiers.hs

+    ) where
+
+
+newtype Restricted a


comment ça marche ? tu lui passe genre Restricted Positive et ça dit à quickcheck que tu veux que des valeurs positives ?

augucharles · 2022-09-09T09:17:01Z

src/Tokenomia/Common/Arbitrary/Value.hs

+instance Arbitrary (Restricted Value) where
+    arbitrary =
+            Restricted . mconcat
+                <$> uncurry assetClassValue <$$> gen
+      where
+        gen :: Gen [(AssetClass, Integer)]
+        gen =
+            zip
+                <$> (getRestricted <$$> Set.toList <$> arbitrary)
+                <*> (getPositive <$$> arbitrary)


curieux de comprendre un peu plus en détail comment ça marche :)

augucharles · 2022-09-09T09:18:59Z

src/Tokenomia/Common/Arbitrary/Wallet.hs

@@ -0,0 +1,205 @@
+{-# LANGUAGE DerivingStrategies             #-}


merde j'y pense que maintenant mais j'espère que t'as pas eu à refaire tout ça alors que ça se trouve peut être là dedans https://github.com/input-output-hk/cardano-wallet

augucharles · 2022-09-09T09:20:15Z

bin/cardano-address-script

@@ -0,0 +1,38 @@
+#!/bin/bash


potentiellement remplacé complètement le binaire par l'intégration directe de la lib haskell https://github.com/input-output-hk/cardano-addresses

Or, maybe with https://github.com/input-output-hk/cardano-node/blob/master/cardano-api/gen/Gen/Cardano/Api/Typed.hs

augucharles · 2022-09-09T09:22:35Z

src/Tokenomia/Common/Arbitrary/Wallet.hs

@@ -0,0 +1,205 @@
+{-# LANGUAGE DerivingStrategies             #-}
+{-# LANGUAGE ImportQualifiedPost            #-}


faudrait qu'on se mette au clair tous les formats utilisés dans cardano avec les key, les hash, le bech32, cbor,...
je me suis pas mal cassé les dents sur les conversions en jouant avec la lib typescript

augucharles · 2022-09-09T09:26:03Z

src/Tokenomia/Common/Data/List/Extra.hs

+para :: (a -> [a] -> b -> b) -> b -> [a] -> b
+para f z = go
+  where
+    go []     = z
+    go (x:xs) = f x xs (go xs)


haha toujours plus compliqué :D
qu'est ce que c'est ?

A paramorphism is a generalization of a catamorphism or a fold. A catamorphism takes a operator and a starting value, and reduces a list by applying this operator on each element and an accumulator. A paramorphism is more powerful in that the combining step function not only see the next element, but also the remaining elements as well.

This trick allows to implement mapLastWith effectively, by distinguishing whether the list to map on has more than on element, and apply a different function depending on the case.

add preprod in network options

Update redesign-vesting branch

devfull added 2 commits August 24, 2022 16:37

[vesting] rewrite the private sale module

2942a57

[vesting] add minimumUTxO calculation and tests

eb1c725

augucharles reviewed Sep 9, 2022

View reviewed changes

augucharles and others added 8 commits September 14, 2022 15:03

add preprod in network options

0ac9298

Merge pull request #76 from smart-chain-fr/preprod-support

8f3ec5d

add preprod in network options

[network] add a local state query module

b751353

[network] add a query for system start

0d6a3e3

[network] add relative to absolute time support

0a60a26

[network] enable reading query args from env

2feceb4

[polish] keep universal quantification implicit

6f80c86

[polish] keep universal quantification implicit

6ac20cf

devfull and others added 7 commits October 6, 2022 12:21

[vesting] fix slot conversion with local query

fe04fc8

[vesting] fix min allocation for non-ada asset

3f7b121

[network] rewrite tests for monadic functions

fba8968

[vesting] add SlotNo in NativeScriptInfo

01df2d6

[nix] update cardano-node to 1.35.3

f44f3c1

Merge pull request #77 from smart-chain-fr/main

504095c

Update redesign-vesting branch

add missing parameters in preprod env config

469e882

augucharles merged commit cbc3930 into mlabs/private-sale-staging Jan 20, 2023

augucharles deleted the redesign-vesting branch January 20, 2023 15:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[vesting] rewrite the private sale module #75

[vesting] rewrite the private sale module #75

devfull commented Aug 24, 2022

augucharles Sep 9, 2022

devfull Sep 9, 2022

augucharles Sep 9, 2022

devfull Sep 9, 2022

augucharles Sep 9, 2022

augucharles Sep 9, 2022

augucharles Sep 9, 2022

devfull Sep 9, 2022

augucharles Sep 9, 2022

devfull Sep 9, 2022

augucharles Sep 9, 2022

augucharles Sep 9, 2022

augucharles Sep 9, 2022

devfull Sep 9, 2022

augucharles Sep 9, 2022

devfull Sep 9, 2022

augucharles Sep 9, 2022

augucharles Sep 9, 2022

augucharles Sep 9, 2022

augucharles Sep 9, 2022

augucharles Sep 9, 2022

augucharles Sep 9, 2022

augucharles Sep 9, 2022

augucharles Sep 9, 2022

devfull Sep 9, 2022

augucharles Sep 9, 2022

augucharles Sep 9, 2022

devfull Sep 9, 2022

		@@ -0,0 +1,205 @@
		{-# LANGUAGE DerivingStrategies #-}
		{-# LANGUAGE ImportQualifiedPost #-}

[vesting] rewrite the private sale module #75

[vesting] rewrite the private sale module #75

Conversation

devfull commented Aug 24, 2022

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

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

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