DevelopmentFundCoupon minting in MintingDelegation

Squashed commits from PR reviewed in #3598

Signed-off-by: Divam <dfordivam@gmail.com>

Author: dfordivam

apps/app/src/test/scala/org/lfdecentralizedtrust/splice/integration/tests/WalletMintingDelegationTimeBasedIntegrationTest.scala

@@ -6,6 +6,7 @@ package org.lfdecentralizedtrust.splice.integration.tests
 import org.lfdecentralizedtrust.splice.codegen.java.splice.amulet.{
   Amulet,
   AppRewardCoupon,
+  DevelopmentFundCoupon,
   UnclaimedActivityRecord,
   ValidatorRewardCoupon,
   ValidatorRight,
@@ -438,6 +439,7 @@ class WalletMintingDelegationTimeBasedIntegrationTest
       val appRewardAmount = BigDecimal(100.0)
       val unclaimedActivityAmount = BigDecimal(200.0)
       val validatorRewardAmount = BigDecimal(500.0)
+      val developmentFundAmount = BigDecimal(300.0)
 
       // For ValidatorRewardCoupon, we need ValidatorRight for beneficiary
       aliceValidatorBackend.participantClientWithAdminToken.ledger_api_extensions.commands
@@ -523,6 +525,22 @@ class WalletMintingDelegationTimeBasedIntegrationTest
                 issuingRound.round,
               ).create,
             )
+
+          // Create DevelopmentFundCoupon
+          sv1Backend.participantClientWithAdminToken.ledger_api_extensions.commands
+            .submitWithResult(
+              userId = sv1Backend.config.ledgerApiUser,
+              actAs = Seq(dsoParty),
+              readAs = Seq.empty,
+              update = new DevelopmentFundCoupon(
+                dsoParty.toProtoPrimitive,
+                beneficiaryParty.party.toProtoPrimitive,
+                dsoParty.toProtoPrimitive, // fundManager = dso
+                developmentFundAmount.bigDecimal,
+                env.environment.clock.now.plus(Duration.ofDays(1)).toInstant,
+                "test development fund coupon",
+              ).create,
+            )
         }
 
         // Advance time to collect all rewards
@@ -544,6 +562,9 @@ class WalletMintingDelegationTimeBasedIntegrationTest
             externalPartyWallet.store
               .listSortedLivenessActivityRecords(issuingRoundsMap)
               .futureValue shouldBe empty
+            externalPartyWallet.store
+              .listDevelopmentFundCoupons()
+              .futureValue shouldBe empty
           }
         }
       }
@@ -558,7 +579,8 @@ class WalletMintingDelegationTimeBasedIntegrationTest
             issuingRound.optIssuancePerValidatorFaucetCoupon.orElse(java.math.BigDecimal.ZERO)
           )) +
           (validatorRewardAmount * BigDecimal(issuingRound.issuancePerValidatorRewardCoupon)) +
-          unclaimedActivityAmount
+          unclaimedActivityAmount +
+          developmentFundAmount
 
       actualIncrease shouldBe expectedTotalReward
 

apps/wallet/src/main/scala/org/lfdecentralizedtrust/splice/wallet/automation/MintingDelegationCollectRewardsTrigger.scala

@@ -12,13 +12,15 @@ import org.lfdecentralizedtrust.splice.codegen.java.splice.amuletrules.{
 import org.lfdecentralizedtrust.splice.codegen.java.splice.amuletrules.transferinput.{
   InputAmulet,
   InputAppRewardCoupon,
+  InputDevelopmentFundCoupon,
   InputUnclaimedActivityRecord,
   InputValidatorLivenessActivityRecord,
   InputValidatorRewardCoupon,
 }
 import org.lfdecentralizedtrust.splice.codegen.java.splice.amulet.{
   AppRewardCoupon,
   Amulet,
+  DevelopmentFundCoupon,
   UnclaimedActivityRecord,
   ValidatorRewardCoupon,
   ValidatorRight,
@@ -155,7 +157,8 @@ class MintingDelegationCollectRewardsTrigger(
     val hasRewardsToCollect = couponsData.livenessActivityRecords.nonEmpty ||
       validatorRewardCouponsToCollect.nonEmpty ||
       couponsData.appRewardCoupons.nonEmpty ||
-      couponsData.unclaimedActivityRecords.nonEmpty
+      couponsData.unclaimedActivityRecords.nonEmpty ||
+      couponsData.developmentFundCoupons.nonEmpty
     // Merge amulets only if we're above 2x the merge limit to reduce potential waste of traffic
     val shouldMergeAmulets = amulets.size >= 2 * mergeLimit
 
@@ -205,6 +208,7 @@ class MintingDelegationCollectRewardsTrigger(
               s"${filteredCouponsData.validatorRewardCoupons.size} validator reward coupons, " +
               s"${filteredCouponsData.appRewardCoupons.size} app reward coupons, " +
               s"${filteredCouponsData.unclaimedActivityRecords.size} unclaimed activity records, " +
+              s"${filteredCouponsData.developmentFundCoupons.size} development fund coupons, " +
               s"and merged ${amuletsToMerge.size} amulets for delegation ${delegation.contractId}"
           )
           true
@@ -255,8 +259,10 @@ class MintingDelegationCollectRewardsTrigger(
         UnclaimedActivityRecord.ContractId,
         UnclaimedActivityRecord,
       ]],
-      // Handle DevelopmentFundCoupon once it lands on main branch
-      // Issue: https://github.com/hyperledger-labs/splice/issues/3554
+      developmentFundCoupons: Seq[Contract[
+        DevelopmentFundCoupon.ContractId,
+        DevelopmentFundCoupon,
+      ]],
   )
 
   private def fetchCouponsData(
@@ -274,11 +280,13 @@ class MintingDelegationCollectRewardsTrigger(
       )
       appRewardCouponsWithQuantity <- store.listSortedAppRewards(issuingRoundsMap)
       unclaimedActivityRecords <- store.listUnclaimedActivityRecords()
+      developmentFundCoupons <- store.listDevelopmentFundCoupons()
     } yield CouponsData(
       livenessActivityRecordsWithQuantity.map(_._1),
       validatorRewardCoupons,
       appRewardCouponsWithQuantity.map(_._1),
       unclaimedActivityRecords,
+      developmentFundCoupons,
     )
   }
 
@@ -308,12 +316,17 @@ class MintingDelegationCollectRewardsTrigger(
         new InputUnclaimedActivityRecord(record.contractId): TransferInput
       }
 
+    val developmentFundCouponInputs: Seq[TransferInput] =
+      couponsData.developmentFundCoupons.map { coupon =>
+        new InputDevelopmentFundCoupon(coupon.contractId): TransferInput
+      }
+
     val amuletInputs: Seq[TransferInput] = amuletsToMerge.map { amulet =>
       new InputAmulet(amulet.contractId): TransferInput
     }
 
     val allInputs = livenessInputs ++ validatorCouponInputs ++ appCouponInputs ++
-      unclaimedActivityRecordInputs ++ amuletInputs
+      unclaimedActivityRecordInputs ++ developmentFundCouponInputs ++ amuletInputs
     allInputs.take(maxNumInputs)
   }
 

apps/wallet/src/main/scala/org/lfdecentralizedtrust/splice/wallet/store/ExternalPartyWalletStore.scala

@@ -6,6 +6,7 @@ package org.lfdecentralizedtrust.splice.wallet.store
 import org.lfdecentralizedtrust.splice.codegen.java.splice.amulet.{
   Amulet,
   AppRewardCoupon,
+  DevelopmentFundCoupon,
   LockedAmulet,
   UnclaimedActivityRecord,
   ValidatorRewardCoupon,
@@ -92,6 +93,18 @@ trait ExternalPartyWalletStore extends TransferInputStore with NamedLogging {
       .listContracts(UnclaimedActivityRecord.COMPANION, limit)
       .map(_.map(_.contract))
 
+  def listDevelopmentFundCoupons(
+      limit: Limit = Limit.DefaultLimit
+  )(implicit tc: TraceContext): Future[Seq[
+    Contract[
+      DevelopmentFundCoupon.ContractId,
+      DevelopmentFundCoupon,
+    ]
+  ]] =
+    multiDomainAcsStore
+      .listContracts(DevelopmentFundCoupon.COMPANION, limit)
+      .map(_.map(_.contract))
+
   def lookupValidatorRight()(implicit
       tc: TraceContext
   ): Future[Option[Contract[ValidatorRight.ContractId, ValidatorRight]]] =
@@ -193,6 +206,10 @@ object ExternalPartyWalletStore {
           co.payload.dso == dso &&
           co.payload.beneficiary == externalParty
         }(ExternalPartyWalletAcsStoreRowData(_)),
+        mkFilter(DevelopmentFundCoupon.COMPANION) { co =>
+          co.payload.dso == dso &&
+          co.payload.beneficiary == externalParty
+        }(ExternalPartyWalletAcsStoreRowData(_)),
         // ValidatorRight is needed for collecting ValidatorRewardCoupons which
         // may have been issued to the external party for traffic purchases, via
         // MintingDelegation. The external party is both the user AND the

daml/dars.lock

@@ -124,7 +124,7 @@ splice-wallet-payments 0.1.6 6124379528eeb6fa17ecdab15577c29abb33d0c0d34dc5f2680
 splice-wallet-payments 0.1.7 4e3e0d9cdadf80f4bf8f3cd3660d5287c084c9a29f23c901aabce597d72fd467
 splice-wallet-payments 0.1.8 e48ea337ee3335c8bb3206a2501ce947ac1a7bdb1825cee8f28bad64f5a7bc4b
 splice-wallet-payments 0.1.9 7f4e081ad96f2ccded0c053b0cf5ddddae1139dfc3bb89cefcf77ea70f2cecb7
-splice-wallet-test 0.1.19 b77428ab7dcff349857721f418fd1b25d85325ba0d0f75482af57773db7fcdae
+splice-wallet-test 0.1.19 6184b47ef584d5dd4b36a4ea97fa71e09af0c51e4569db5cd66c636e568b6f81
 splitwell 0.1.0 075c76de553ab88383a7c69de134afa82aacfdf8ea8fcfe8852c4b199c3b2669
 splitwell 0.1.1 ccb1a0215053062202052e1a052f9214da3fdae5253a6d43e2e155ff4f57fe75
 splitwell 0.1.10 d42676a366f7ca7a2409974dd3054aa4d83ab29baa3b2086ad021407b0a1a295
@@ -142,4 +142,4 @@ splitwell 0.1.6 872da0dd7986fd768930f85d6a7310a94a0ef924e7fbb7bb7a4e149f2b5feb74
 splitwell 0.1.7 841d1c9c86b5c8f3a39059459ecd8febedf7703e18f117300bb0ebf4423db096
 splitwell 0.1.8 63b8153a08ceb4bf40d807acc5712372c3eac548c266be4d5e92470b4f655515
 splitwell 0.1.9 b6267905698d2798b9ef171e27d49fb88e052ec0ec0e0675a3a1b275c7d037d4
-splitwell-test 0.1.19 4e4909acaa20009d7485d51bb8c385c5c2fb8ca441365e58ff90c9e544ee5e8f
+splitwell-test 0.1.19 c6ec7ab2af6ff076b37ba6e5be2d6b615acf7d289d3c00ddd87ff7da349c7192

daml/splice-wallet-test/daml/Splice/Scripts/Wallet/TestMintingDelegation.daml

@@ -74,6 +74,15 @@ testMintingDelegation = do
     reason = ""
     expiresAt = now `addRelTime` days 60
 
+  let developmentFundCouponAmount = 50.0
+  developmentFundCouponCid <- submit app.dso $ createCmd DevelopmentFundCoupon with
+    dso = app.dso
+    beneficiary = beneficiary
+    fundManager = app.dso
+    amount = developmentFundCouponAmount
+    expiresAt = now `addRelTime` days 60
+    reason = "Test development fund coupon"
+
   -- Wait for rounds to advance so coupons can be minted
   runNextIssuance app
   runNextIssuance app
@@ -96,7 +105,8 @@ testMintingDelegation = do
         InputValidatorLivenessActivityRecord livenessActivityRecordCid,
         InputAppRewardCoupon appRewardCouponCid,
         InputValidatorRewardCoupon validatorRewardCouponCid,
-        InputUnclaimedActivityRecord unclaimedActivityRecordCid
+        InputUnclaimedActivityRecord unclaimedActivityRecordCid,
+        InputDevelopmentFundCoupon developmentFundCouponCid
       ]
     context = PaymentTransferContext with
       context
@@ -111,7 +121,7 @@ testMintingDelegation = do
   let expectedValidatorFaucetAmount = getIssuingMiningRoundIssuancePerValidatorFaucetCoupon issuingRound
   let expectedAppReward = appRewardCouponAmount * issuingRound.issuancePerUnfeaturedAppRewardCoupon
   let expectedValidatorReward = validatorRewardCouponAmount * issuingRound.issuancePerValidatorRewardCoupon
-  let expectedTotal = expectedValidatorFaucetAmount + expectedAppReward + expectedValidatorReward + unclaimedRewardCouponAmount
+  let expectedTotal = expectedValidatorFaucetAmount + expectedAppReward + expectedValidatorReward + unclaimedRewardCouponAmount + developmentFundCouponAmount
 
   require ("Combined reward should match expected " <> show expectedTotal <> ", got: " <> show reward)
     (reward >= expectedTotal - 1.0 && reward <= expectedTotal + 1.0)