cip-82: replace DevelomentFundConfig with IssuanceConfig.optDevelopmentFundPercentage and TransferConfig.optDevelopmentFundBeneficiary

Author: jose-velasco-ieu

daml/splice-amulet-test/daml/Splice/Scripts/TestLockAndAmuletExpiry.daml

@@ -33,7 +33,6 @@ scaleAmuletConfig amuletPrice config = AmuletConfig with
   packageConfig = config.packageConfig
   transferPreapprovalFee = fmap (/ amuletPrice) config.transferPreapprovalFee
   featuredAppActivityMarkerAmount = fmap (/ amuletPrice) config.featuredAppActivityMarkerAmount
-  developmentFundConfig = config.developmentFundConfig
 
 test : Script ()
 test = script do

daml/splice-amulet-test/daml/Splice/Scripts/UnitTests/Issuance.daml

@@ -120,11 +120,11 @@ testE1 : Script ()
 testE1 = script do
   validateOpenMiningRoundSummary summaryExample1
 
-  expectedParameters_E1_0_0p5 === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_0_0p5 summaryExample1 None
-  expectedParameters_E1_0p5_1p5 === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_0p5_1p5 summaryExample1 None
-  expectedParameters_E1_1p5_5 === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_1p5_5 summaryExample1 None
-  expectedParameters_E1_5_10 === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_5_10 summaryExample1 None
-  expectedParameters_E1_10plus === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_10plus summaryExample1 None
+  expectedParameters_E1_0_0p5 === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_0_0p5 summaryExample1
+  expectedParameters_E1_0p5_1p5 === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_0p5_1p5 summaryExample1
+  expectedParameters_E1_1p5_5 === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_1p5_5 summaryExample1
+  expectedParameters_E1_5_10 === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_5_10 summaryExample1
+  expectedParameters_E1_10plus === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_10plus summaryExample1
 
 
 -- Example 2: all zeros
@@ -154,7 +154,7 @@ testNoActivity : Script ()
 testNoActivity = script do
   validateOpenMiningRoundSummary summaryExamplNoActivity
 
-  expectedParameters_NoActivity_0_0p5 === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_0_0p5 summaryExamplNoActivity None
+  expectedParameters_NoActivity_0_0p5 === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_0_0p5 summaryExamplNoActivity
 
 
 -- Example 3: low activity
@@ -185,7 +185,7 @@ testE4 : Script ()
 testE4 = script do
   validateOpenMiningRoundSummary summaryExample3
 
-  expectedParameters_E3_0_0p5 === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_0_0p5 summaryExample3 None
+  expectedParameters_E3_0_0p5 === computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_0_0p5 summaryExample3
 
 
 -- Example 4: millions of SV reward weight
@@ -216,7 +216,7 @@ testLargeSvRewardWeight : Script ()
 testLargeSvRewardWeight = script do
   validateOpenMiningRoundSummary summaryExamplNoActivity
 
-  let actual = computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_10plus summaryExampleLargeSvRewardWeight None
+  let actual = computeIssuingRoundParameters tickDuration amuletPrice issuanceConfig_10plus summaryExampleLargeSvRewardWeight
   expectedParameters_LargeSvRewardWeight_10plus === actual
 
 

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

@@ -29,6 +29,7 @@ data TransferConfig unit = TransferConfig with
     maxNumInputs : Int -- ^ Maximum number of batch inputs for a transfer.
     maxNumOutputs : Int -- ^ Maximum number of batch outputs for a transfer.
     maxNumLockHolders : Int -- ^ Maximum number of lock holders allowed for a locked amulet.
+    optDevelopmentFundBeneficiary : Optional Party -- ^ Beneficiary for the Development Fund under CIP-0082.
   deriving (Eq, Show)
 
 -- | Configuration includes TransferConfig, issuance curve and tickDuration
@@ -45,8 +46,6 @@ 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
-    developmentFundConfig : Optional DevelopmentFundConfig
-      -- ^ Configuration for the development fund mechanics from CIP-0082.
   deriving (Eq, Show)
 
 -- $1/year specified as a daily rate
@@ -63,17 +62,15 @@ validAmuletConfig AmuletConfig
     , tickDuration
     , packageConfig
     , transferPreapprovalFee
-    , featuredAppActivityMarkerAmount
-    , developmentFundConfig }
+    , featuredAppActivityMarkerAmount}
   =
     validTransferConfig transferConfig &&
     validIssuanceCurve issuanceCurve &&
     validAmuletDecentralizedSynchronizerConfig decentralizedSynchronizer &&
     tickDuration > days 0 &&
     validPackageConfig packageConfig &&
     optional True (>= 0.0) transferPreapprovalFee &&
-    optional True (>= 0.0) featuredAppActivityMarkerAmount &&
-    optional True validDevelopmentFundConfig developmentFundConfig
+    optional True (>= 0.0) featuredAppActivityMarkerAmount
 
 validTransferConfig : TransferConfig unit -> Bool
 validTransferConfig TransferConfig
@@ -115,19 +112,6 @@ data PackageConfig = PackageConfig
 validPackageConfig : PackageConfig -> Bool
 validPackageConfig _ = True
 
--- | Configuration for the Development Fund established under CIP-0082.
---
--- See Splice.Scripts.Parameters for concrete values.
-data DevelopmentFundConfig = DevelopmentFundConfig
-  with
-    beneficiary : Optional Party
-    percentage : Decimal
-  deriving (Show, Eq)
-
-validDevelopmentFundConfig : DevelopmentFundConfig -> Bool
-validDevelopmentFundConfig DevelopmentFundConfig { percentage } =
-  percentage >= 0.0 && percentage <= 1.0
-
 instance Patchable (AmuletConfig USD) where
   patch new base current = AmuletConfig with
     transferConfig = patch new.transferConfig base.transferConfig current.transferConfig
@@ -137,7 +121,6 @@ instance Patchable (AmuletConfig USD) where
     packageConfig = patch new.packageConfig base.packageConfig current.packageConfig
     transferPreapprovalFee = patch new.transferPreapprovalFee base.transferPreapprovalFee current.transferPreapprovalFee
     featuredAppActivityMarkerAmount = patch new.featuredAppActivityMarkerAmount base.featuredAppActivityMarkerAmount current.featuredAppActivityMarkerAmount
-    developmentFundConfig = patch new.developmentFundConfig base.developmentFundConfig current.developmentFundConfig
 
 instance Patchable (TransferConfig USD) where
   patch new base current = TransferConfig with
@@ -149,6 +132,7 @@ instance Patchable (TransferConfig USD) where
     maxNumInputs = patch new.maxNumInputs base.maxNumInputs current.maxNumInputs
     maxNumOutputs = patch new.maxNumOutputs base.maxNumOutputs current.maxNumOutputs
     maxNumLockHolders = patch new.maxNumLockHolders base.maxNumLockHolders current.maxNumLockHolders
+    optDevelopmentFundBeneficiary = patch new.optDevelopmentFundBeneficiary base.optDevelopmentFundBeneficiary current.optDevelopmentFundBeneficiary
 
 instance Patchable PackageConfig where
   patch new base current = PackageConfig with
@@ -158,8 +142,3 @@ instance Patchable PackageConfig where
     validatorLifecycle = patch new.validatorLifecycle base.validatorLifecycle current.validatorLifecycle
     wallet = patch new.wallet base.wallet current.wallet
     walletPayments = patch new.walletPayments base.walletPayments current.walletPayments
-
-instance Patchable DevelopmentFundConfig where
-  patch new base current = DevelopmentFundConfig with
-    beneficiary = patch new.beneficiary base.beneficiary current.beneficiary
-    percentage = patch new.percentage base.percentage current.percentage

daml/splice-amulet/daml/Splice/AmuletRules.daml

@@ -25,7 +25,7 @@ import Splice.Api.Token.MetadataV1 as Api.Token.MetadataV1
 import Splice.Api.Token.HoldingV1 qualified as Api.Token.HoldingV1
 import Splice.Amulet
 import Splice.Amulet.TokenApiUtils
-import Splice.AmuletConfig (AmuletConfig(..), DevelopmentFundConfig(..), TransferConfig(..), validAmuletConfig, defaultTransferPreapprovalFee)
+import Splice.AmuletConfig (AmuletConfig(..), TransferConfig(..), validAmuletConfig, defaultTransferPreapprovalFee)
 import qualified Splice.AmuletConfig as Unit
 import Splice.Schedule
 import Splice.Expiry
@@ -132,13 +132,11 @@ template AmuletRules
         -- one under their control.
       controller Set.toList (transferControllers transfer)
       do
-        now <- getTime
         checkExpectedDso dso expectedDso
         let rewardsConfig = RewardsIssuanceConfig with
               issueAppRewards = True
               issueValidatorRewards = True
-            configUsd = getValueAsOf now configSchedule
-        executeTransfer rewardsConfig context dso configUsd.developmentFundConfig transfer
+        executeTransfer rewardsConfig context dso transfer
 
     nonconsuming choice AmuletRules_CreateExternalPartySetupProposal : AmuletRules_CreateExternalPartySetupProposalResult
       -- ^ Propose to host an external party
@@ -161,8 +159,7 @@ template AmuletRules
         require "preapprovalExpiresAt is not in the past" (preapprovalExpiresAt > now)
         let configUsd = getValueAsOf now configSchedule
         (amuletPaid, _) <- computeTransferPreapprovalFee (preapprovalExpiresAt `subTime` now) configUsd context.context dso
-        (transferResult, meta) <-
-          splitAndBurn validator amuletPaid inputs context.context dso "create ExternalPartySetupProposal" configUsd.developmentFundConfig
+        (transferResult, meta) <- splitAndBurn validator amuletPaid inputs context.context dso "create ExternalPartySetupProposal"
         proposalCid <- create ExternalPartySetupProposal with
           user
           validator
@@ -190,8 +187,7 @@ template AmuletRules
         require "expiresAt is not in the past" (expiresAt > now)
         let configUsd = getValueAsOf now configSchedule
         (amuletPaid, _) <- computeTransferPreapprovalFee (expiresAt `subTime` now) configUsd context.context dso
-        (transferResult, meta) <-
-          splitAndBurn provider amuletPaid inputs context.context dso "create TransferPreapproval" configUsd.developmentFundConfig
+        (transferResult, meta) <- splitAndBurn provider amuletPaid inputs context.context dso "create TransferPreapproval"
         transferPreapprovalCid <- create TransferPreapproval with
           receiver
           provider
@@ -230,8 +226,7 @@ template AmuletRules
         let transferConfigAmulet = scaleFees (1.0 / openRound.amuletPrice) openRound.transferConfigUsd
         (trafficCostAmulet, trafficCostUsd) <- computeSynchronizerFees dso provider trafficAmount this context
         -- We want to burn exactly trafficCostAmulet, and createFee is already burnt by the self-transfer itself, so we subtract the createFee from the amount we split off and burn explicitly.
-        (transferResult, meta) <-
-          splitAndBurn provider (trafficCostAmulet - transferConfigAmulet.createFee.fee) inputs context dso "traffic purchase" configUsd.developmentFundConfig
+        (transferResult, meta) <- splitAndBurn provider (trafficCostAmulet - transferConfigAmulet.createFee.fee) inputs context dso "traffic purchase"
         -- create a new MemberTraffic contract for the purchased traffic
         purchasedTraffic <- create MemberTraffic with
           dso
@@ -446,14 +441,11 @@ template AmuletRules
         summary : OpenMiningRoundSummary
       controller dso
       do
-        now <- getTime
         miningRound <- fetchAndArchive (ForDso with dso) miningRoundCid
         validateOpenMiningRoundSummary summary
 
-        let
-          optDevelopmentFundPercentage = (.percentage) <$> (getValueAsOf now configSchedule).developmentFundConfig
-          params = computeIssuingRoundParameters
-            miningRound.tickDuration miningRound.amuletPrice miningRound.issuanceConfig summary optDevelopmentFundPercentage
+        let params = computeIssuingRoundParameters
+              miningRound.tickDuration miningRound.amuletPrice miningRound.issuanceConfig summary
 
         -- record unclaimed reward contract
         let totalUnclaimedRewards = params.unclaimedValidatorRewards + params.unclaimedAppRewards + params.unclaimedSvRewards
@@ -472,6 +464,7 @@ template AmuletRules
             else pure None
 
         -- create issuing round
+        now <- getTime
         let tickDuration = miningRound.tickDuration
         let opensAt = addRelTime now tickDuration
         let targetClosesAt = addRelTime opensAt (tickDuration + tickDuration)
@@ -756,13 +749,11 @@ data RewardsIssuanceConfig = RewardsIssuanceConfig with
     issueValidatorRewards : Bool
 
 -- | Execute a transfer.
-executeTransfer
-  : RewardsIssuanceConfig -> TransferContext -> Party -> Optional DevelopmentFundConfig -> Transfer
-  -> Update TransferResult
-executeTransfer config context dso optFundConfig t  = do
+executeTransfer : RewardsIssuanceConfig -> TransferContext -> Party -> Transfer -> Update TransferResult
+executeTransfer config context dso t  = do
   -- compute summaries
   csum <- summarizeAndValidateContext context dso t
-  isum <- summarizeAndConsumeInputs csum dso t.sender t.inputs optFundConfig
+  isum <- summarizeAndConsumeInputs csum dso t.sender t.inputs
   osum <- preprocessOutputs csum.config t.sender t.outputs
   summary <- summarizeTransfer t.sender csum.openRound csum.config isum osum
   -- check that overall transfer constraints are satisfied
@@ -877,8 +868,8 @@ getIssuingMiningRound csum round = do
     Some issuingRound -> pure issuingRound
 
 summarizeAndConsumeInputs
-  : TransferContextSummary -> Party -> Party -> [TransferInput] -> Optional DevelopmentFundConfig -> Update TransferInputsSummary
-summarizeAndConsumeInputs csum dso sender inps optFundConfig = do
+  : TransferContextSummary -> Party -> Party -> [TransferInput] -> Update TransferInputsSummary
+summarizeAndConsumeInputs csum dso sender inps = do
     foldlA (summarizeAndConsumeInput csum.openRound.round) initialSummary inps
   where
     forOwner = ForOwner with dso; owner = sender
@@ -1010,13 +1001,9 @@ summarizeAndConsumeInputs csum dso sender inps optFundConfig = do
         totalDevelopmentFundAmount = s.totalDevelopmentFundAmount
 
     summarizeAndConsumeInput _round s (InputDevelopmentFundCoupon couponCid) = do
-      let abortWithBeneficiaryNotConfigured =
-            abort "DevelopmentFundCoupon cannot be consumed without a beneficiary in the development fund configuration"
-      case optFundConfig of
-        None -> abortWithBeneficiaryNotConfigured
-        Some (DevelopmentFundConfig { beneficiary = None }) -> abortWithBeneficiaryNotConfigured
-        Some (DevelopmentFundConfig { beneficiary = Some beneficiary }) ->
-          require "sender matches development fund beneficiary" $ sender == beneficiary
+      case csum.config.optDevelopmentFundBeneficiary of
+        None -> abort "DevelopmentFundCoupon cannot be consumed without the Development Fund beneficiary configured"
+        Some developmentFundBeneficiary -> require "sender matches development fund beneficiary" $ sender == developmentFundBeneficiary
       coupon <- fetchAndArchive forDso couponCid
       return TransferInputsSummary with
         totalAmuletAmount = s.totalAmuletAmount
@@ -1210,6 +1197,7 @@ scaleFees s c = TransferConfig with
     maxNumInputs = c.maxNumInputs
     maxNumOutputs = c.maxNumOutputs
     maxNumLockHolders = c.maxNumLockHolders
+    optDevelopmentFundBeneficiary = c.optDevelopmentFundBeneficiary
 
 transferConfigAmuletFromOpenRound : OpenMiningRound -> TransferConfig Amulet
 transferConfigAmuletFromOpenRound openRound = scaleFees (1.0 / openRound.amuletPrice) openRound.transferConfigUsd
@@ -1592,8 +1580,7 @@ template TransferPreapproval
          amuletRules <- fetchPublicReferenceData (ForDso dso) context.amuletRules (AmuletRules_Fetch dso)
          let configUsd = getValueAsOf now amuletRules.configSchedule
          (amuletPaid, _) <- computeTransferPreapprovalFee extension configUsd context.context dso
-         (transferResult, meta) <-
-           splitAndBurn provider amuletPaid inputs context.context dso "renew TransferPreapproval" configUsd.developmentFundConfig
+         (transferResult, meta) <- splitAndBurn provider amuletPaid inputs context.context dso "renew TransferPreapproval"
          transferPreapprovalCid <- create this with
            lastRenewedAt = now
            expiresAt = newExpiresAt
@@ -1651,15 +1638,13 @@ computeTransferPreapprovalFee duration amuletConfig context dso = do
   let feeAmulet = feeUsd / contextMiningRound.amuletPrice
   pure (feeAmulet, feeUsd)
 
-splitAndBurn
-  : Party -> Decimal -> [TransferInput] -> TransferContext -> Party -> Text -> Optional DevelopmentFundConfig
-  -> Update (TransferResult, Metadata)
-splitAndBurn sender amount inputs context dso usage optFundConfig = do
+splitAndBurn : Party -> Decimal -> [TransferInput] -> TransferContext -> Party -> Text -> Update (TransferResult, Metadata)
+splitAndBurn sender amount inputs context dso usage = do
 -- do not create activity records as part of the transfer. We create a validator activity record for the full burn below.
   let rewardsConfig = RewardsIssuanceConfig with
         issueAppRewards = False
         issueValidatorRewards = False
-  transferResult <- executeTransfer rewardsConfig context dso optFundConfig Transfer with
+  transferResult <- executeTransfer rewardsConfig context dso Transfer with
     sender
     provider = sender
     inputs

daml/splice-amulet/daml/Splice/Issuance.daml

@@ -25,6 +25,8 @@ data IssuanceConfig = IssuanceConfig with
     optValidatorFaucetCap : Optional Decimal
       -- ^ Maximal amount in $ for the per-validator issuance of validator faucet coupons;
       -- Introduced as part of CIP-3. Defaults to 2.85 USD.
+    optDevelopmentFundPercentage : Optional Decimal
+      -- ^ Percentage of each mint emission allocated to the Development Fund under CIP-0082.
   deriving (Eq, Show)
 
 -- | Getter with the right default value for the validator faucet cap.
@@ -44,7 +46,8 @@ validIssuanceConfig this@IssuanceConfig{..} =
     && validatorRewardCap >= 0.0
     && featuredAppRewardCap >= 0.0
     && unfeaturedAppRewardCap >= 0.0
-    && getValidatorFaucetCap this >= 0.0
+    && getValidatorFaucetCap this >= 0.0 &&
+    optional True (\pct -> pct >= 0.0 && pct <= 1.0) optDevelopmentFundPercentage
 
 
 -- computation of issuance per round
@@ -83,10 +86,8 @@ validateOpenMiningRoundSummary summary = do
     require "totalUnfeaturedAppRewardCoupons >= 0.0" (summary.totalUnfeaturedAppRewardCoupons >= 0.0)
     require "totalValidatorFaucetCoupons >= 0" (getTotalValidatorFaucetCoupons summary >= 0)
 
-computeIssuingRoundParameters
-  : RelTime -> Decimal -> IssuanceConfig -> OpenMiningRoundSummary -> Optional Decimal
-  -> IssuingRoundParameters
-computeIssuingRoundParameters tickDuration amuletPrice config summary optDevelopmentFundPercentage =
+computeIssuingRoundParameters : RelTime -> Decimal -> IssuanceConfig -> OpenMiningRoundSummary -> IssuingRoundParameters
+computeIssuingRoundParameters tickDuration amuletPrice config summary =
     IssuingRoundParameters with
       issuancePerValidatorRewardCoupon = validatorRewardIssuance.issuancePerCoupon
       issuancePerUnfeaturedAppRewardCoupon = unfeaturedAppIssuance.issuancePerCoupon
@@ -99,7 +100,7 @@ computeIssuingRoundParameters tickDuration amuletPrice config summary optDevelop
       issuancePerValidatorFaucetCoupon = validatorFaucetIssuance.issuancePerCoupon
       amuletsToIssueToDevelopmentFund
   where
-    developmentFundPercentage = fromOptional 0.0 optDevelopmentFundPercentage
+    developmentFundPercentage = fromOptional 0.0 config.optDevelopmentFundPercentage
 
     amuletsToIssueToSvs =
       adjustedAmuletsToIssueInRound
@@ -190,3 +191,4 @@ instance Patchable IssuanceConfig where
     featuredAppRewardCap = patch new.featuredAppRewardCap base.featuredAppRewardCap current.featuredAppRewardCap
     unfeaturedAppRewardCap = patch new.unfeaturedAppRewardCap base.unfeaturedAppRewardCap current.unfeaturedAppRewardCap
     optValidatorFaucetCap = patch new.optValidatorFaucetCap base.optValidatorFaucetCap current.optValidatorFaucetCap
+    optDevelopmentFundPercentage = patch new.optDevelopmentFundPercentage base.optDevelopmentFundPercentage current.optDevelopmentFundPercentage