comments

Signed-off-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>

Author: cocreature

daml/splice-amulet/daml/Splice/AmuletConfig.daml

@@ -61,7 +61,7 @@ data AmuletConfig unit = AmuletConfig with
       -- that should be used for command submissions.
     transferPreapprovalFee : Optional Decimal -- ^ Fee for keeping a transfer pre-approval around.
     featuredAppActivityMarkerAmount : Optional Decimal -- ^ $-amount used for the conversion from FeaturedAppActivityMarker -> AppRewardCoupon
-    externalPartyConfigStateTickDuration : Optional RelTime
+    externalPartyConfigStateTickDuration : Optional RelTime -- ^ Half the lifetime of an `ExternalPartyConfigState` contract and the overlap between two successive contracts.
   deriving (Eq, Show)
 
 getExternalPartyConfigStateTickDuration : AmuletConfig a -> RelTime

daml/splice-amulet/daml/Splice/ExternalPartyConfigState.daml

@@ -5,10 +5,16 @@ import qualified Splice.AmuletConfig as Unit
 import Splice.Util
 import Splice.Types
 
+-- | `ExternalPartyConfigState` stores the configuration required for transfer, allocations, traffic purchases and taps.
+-- While it exposes a subset of the information also available on `OpenMiningRound`, `ExternalPartyConfigState` contracts
+-- are active much longer allowing for a 24 delay between preparing and executing a transaction.
+--
+-- There are always two `ExternalPartyConfigState` contracts created approximately `externalPartyConfigStateTickDuration` apart from each other
+-- and each is active for `2 * externalPartyConfigStateTickDuration`.
 template ExternalPartyConfigState
   with
     dso : Party
-    holdingFeesOpenRoundNumber : Round
+    holdingFeesOpenRoundNumber : Round -- ^ The round number used
     amuletPrice : Decimal
     transferConfig : TransferConfigV2 Unit.USD
     targetArchiveAfter : Time -- ^ Lower bound on the time the contract gets archived, not enforced as a strict upper bound but the SVs will archive it shortly after this time has been reached.