cip-82: add allocateDevelopmentFundCoupon to Wallet API

Signed-off-by: Jose Velasco <jose.velasco@intellecteu.com>

Author: jose-velasco-ieu

apps/app/src/main/scala/org/lfdecentralizedtrust/splice/console/WalletAppReference.scala

@@ -16,6 +16,7 @@ import org.lfdecentralizedtrust.splice.codegen.java.splice.wallet.{
 import org.lfdecentralizedtrust.splice.environment.SpliceConsoleEnvironment
 import org.lfdecentralizedtrust.splice.http.v0.definitions.{
   AllocateAmuletResponse,
+  AllocateDevelopmentFundCouponResponse,
   GetBuyTrafficRequestStatusResponse,
   GetTransferOfferStatusResponse,
   TransferInstructionResultResponse,
@@ -600,6 +601,34 @@ abstract class WalletAppReference(
       httpCommand(HttpWalletAppClient.TokenStandard.RejectAllocationRequest(id))
     }
   }
+
+  @Help.Summary("Allocate a DevelopmentFundCoupon")
+  @Help.Description(
+    "Allocates development-fund resources by consuming UnclaimedDevelopmentFundCoupons and creating a new " +
+      "DevelopmentFundCoupon for the specified beneficiary and amount."
+  )
+  def allocateDevelopmentFundCoupon(
+      unclaimedDevelopmentFundCouponContractIds: Seq[
+        amuletCodegen.UnclaimedDevelopmentFundCoupon.ContractId
+      ],
+      beneficiary: PartyId,
+      amount: BigDecimal,
+      expiresAt: CantonTimestamp,
+      reason: String,
+      fundManager: PartyId,
+  ): AllocateDevelopmentFundCouponResponse =
+    consoleEnvironment.run {
+      httpCommand(
+        HttpWalletAppClient.AllocateDevelopmentFundCouponRequest(
+          unclaimedDevelopmentFundCouponContractIds,
+          beneficiary,
+          amount,
+          expiresAt,
+          reason,
+          fundManager,
+        )
+      )
+    }
 }
 
 /** Client (aka remote) reference to a wallet app in the style of ParticipantClientReference, i.e.,

apps/wallet/src/main/openapi/wallet-internal.yaml

@@ -871,6 +871,31 @@ paths:
         "500":
           $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/500"
 
+  /v0/wallet/development-fund-coupons/allocate:
+    post:
+      tags: [ wallet ]
+      x-jvm-package: wallet
+      operationId: "allocateDevelopmentFundCoupon"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/AllocateDevelopmentFundCouponRequest"
+      responses:
+        "200":
+          description: ok
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/AllocateDevelopmentFundCouponResponse"
+        "400":
+          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/400"
+        "404":
+          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/404"
+        "500":
+          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/500"
+
 
 components:
   schemas:
@@ -1612,3 +1637,39 @@ components:
           type: object
           additionalProperties:
             type: string
+
+    AllocateDevelopmentFundCouponRequest:
+      type: object
+      required:
+        - unclaimed_development_fund_coupon_contract_ids
+        - beneficiary
+        - amount
+        - expiresAt
+        - reason
+        - fundManager
+      properties:
+        unclaimed_development_fund_coupon_contract_ids:
+          type: array
+          items:
+            type: string
+        beneficiary:
+          type: string
+        amount:
+          type: string
+        expiresAt:
+          type: integer
+          format: int64
+        reason:
+          type: string
+        fundManager:
+          type: string
+
+    AllocateDevelopmentFundCouponResponse:
+      type: object
+      required:
+        - development_fund_coupon_contract_id
+      properties:
+        development_fund_coupon_contract_id:
+          type: string
+        unclaimed_development_fund_coupon_contract_id:
+          type: string

apps/wallet/src/main/scala/org/lfdecentralizedtrust/splice/wallet/admin/api/client/commands/HttpWalletAppClient.scala

@@ -1351,4 +1351,44 @@ object HttpWalletAppClient {
     }
   }
 
+  final case class AllocateDevelopmentFundCouponRequest(
+      unclaimedDevelopmentFundCouponContractIds: Seq[
+        amuletCodegen.UnclaimedDevelopmentFundCoupon.ContractId
+      ],
+      beneficiary: PartyId,
+      amount: BigDecimal,
+      expiresAt: CantonTimestamp,
+      reason: String,
+      fundManager: PartyId,
+  ) extends InternalBaseCommand[
+        http.AllocateDevelopmentFundCouponResponse,
+        definitions.AllocateDevelopmentFundCouponResponse,
+      ] {
+    override def submitRequest(
+        client: WalletClient,
+        headers: List[HttpHeader],
+    ): EitherT[Future, Either[
+      Throwable,
+      HttpResponse,
+    ], http.AllocateDevelopmentFundCouponResponse] = client.allocateDevelopmentFundCoupon(
+      body = definitions.AllocateDevelopmentFundCouponRequest(
+        unclaimedDevelopmentFundCouponContractIds.map(_.contractId).toVector,
+        Codec.encode(beneficiary),
+        Codec.encode(amount),
+        Codec.encode(expiresAt),
+        reason,
+        Codec.encode(fundManager),
+      )
+    )
+
+    override protected def handleOk()(implicit
+        decoder: TemplateJsonDecoder
+    ): PartialFunction[http.AllocateDevelopmentFundCouponResponse, Either[
+      String,
+      definitions.AllocateDevelopmentFundCouponResponse,
+    ]] = { case http.AllocateDevelopmentFundCouponResponse.OK(value) =>
+      Right(value)
+    }
+  }
+
 }

apps/wallet/src/main/scala/org/lfdecentralizedtrust/splice/wallet/admin/http/HttpWalletHandler.scala

@@ -7,7 +7,11 @@ import org.apache.pekko.stream.Materializer
 import org.lfdecentralizedtrust.splice.codegen.java.splice.amulet as amuletCodegen
 import org.lfdecentralizedtrust.splice.codegen.java.splice.amuletallocation as amuletAllocationCodegen
 import org.lfdecentralizedtrust.splice.codegen.java.splice.validatorlicense as validatorLicenseCodegen
-import org.lfdecentralizedtrust.splice.codegen.java.splice.amulet.{Amulet, LockedAmulet}
+import org.lfdecentralizedtrust.splice.codegen.java.splice.amulet.{
+  Amulet,
+  LockedAmulet,
+  UnclaimedDevelopmentFundCoupon,
+}
 import org.lfdecentralizedtrust.splice.codegen.java.splice.wallet.install.amuletoperationoutcome.COO_AcceptedAppPayment
 import org.lfdecentralizedtrust.splice.codegen.java.splice.wallet.install.{
   AmuletOperationOutcome,
@@ -77,8 +81,12 @@ import org.lfdecentralizedtrust.splice.codegen.java.splice.api.token.transferins
 }
 import org.lfdecentralizedtrust.splice.http.v0.definitions.{
   AllocateAmuletRequest,
+  AllocateDevelopmentFundCouponRequest,
+  AllocateDevelopmentFundCouponResponse,
   CreateTokenStandardTransferRequest,
 }
+import org.lfdecentralizedtrust.splice.util.SpliceUtil.damlDecimal
+
 import org.lfdecentralizedtrust.splice.wallet.admin.http.UserWalletAuthExtractor.WalletUserRequest
 
 import java.math.RoundingMode as JRM
@@ -1278,4 +1286,80 @@ class HttpWalletHandler(
       )
     }
   }
+
+  override def allocateDevelopmentFundCoupon(
+      respond: WalletResource.AllocateDevelopmentFundCouponResponse.type
+  )(body: AllocateDevelopmentFundCouponRequest)(
+      extracted: WalletUserRequest
+  ): Future[WalletResource.AllocateDevelopmentFundCouponResponse] = {
+    implicit val WalletUserRequest(user, userWallet, traceContext) = extracted
+    withSpan(s"$workflowId.rejectAllocationRequest") { implicit traceContext => _ =>
+      val store = userWallet.store
+      for {
+        domain <- scanConnection.getAmuletRulesDomain()(traceContext)
+        amuletRules <- scanConnection.getAmuletRulesWithState()
+        amuletRulesCt = amuletRules.toAssignedContract.getOrElse(
+          throw Status.Code.FAILED_PRECONDITION.toStatus
+            .withDescription(
+              s"AmuletRules contract is not assigned to a domain."
+            )
+            .asRuntimeException()
+        )
+        beneficiary = Codec.tryDecode(Codec.Party)(body.beneficiary)
+        fundManagerFromRequest = Codec.tryDecode(Codec.Party)(body.fundManager)
+        amount = Codec.tryDecode(Codec.BigDecimal)(body.amount)
+        expiresAt = Codec.tryDecode(Codec.Timestamp)(body.expiresAt)
+        unclaimedDevelopmentFundCouponContractIds = body.unclaimedDevelopmentFundCouponContractIds
+          .map(
+            Codec.tryDecodeJavaContractId(UnclaimedDevelopmentFundCoupon.COMPANION)(_)
+          )
+        optDevelopmentFundManager =
+          amuletRulesCt.contract.payload.configSchedule.initialValue.optDevelopmentFundManager
+            .map(Codec.tryDecode(Codec.Party)(_))
+            .toScala
+        // validate development fund manager
+        _ =
+          optDevelopmentFundManager match {
+            case None =>
+              throw Status.FAILED_PRECONDITION
+                .withDescription("Development fund manager has not been configured.")
+                .asRuntimeException()
+            case Some(developmentFundManager)
+                if developmentFundManager == fundManagerFromRequest &&
+                  fundManagerFromRequest == store.key.endUserParty =>
+              ()
+            case Some(_) =>
+              throw Status.PERMISSION_DENIED
+                .withDescription("Invalid fundManager")
+                .asRuntimeException()
+          }
+        cmd = amuletRulesCt
+          .exercise(
+            _.exerciseAmuletRules_AllocateDevelopmentFundCoupon(
+              unclaimedDevelopmentFundCouponContractIds.asJava,
+              beneficiary.toProtoPrimitive,
+              damlDecimal(amount),
+              expiresAt.toInstant,
+              fundManagerFromRequest.toProtoPrimitive,
+              body.reason,
+            )
+          )
+        result <- userWallet.connection
+          .submit(
+            Seq(store.key.validatorParty, store.key.endUserParty),
+            Seq.empty,
+            cmd,
+          )
+          .withSynchronizerId(domain)
+          .noDedup
+          .withDisclosedContracts(userWallet.connection.disclosedContracts(amuletRules))
+          .yieldResult()
+      } yield WalletResource.AllocateDevelopmentFundCouponResponseOK(
+        AllocateDevelopmentFundCouponResponse(
+          result.exerciseResult.developmentFundCouponCid.contractId,
+          result.exerciseResult.optUnclaimedDevelopmentFundCouponCid.toScala.map(_.contractId),
+        )
+      )
+    }
+  }
 }