cip-82: add withdrawDevelopmentFundCoupon 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

@@ -20,6 +20,7 @@ import org.lfdecentralizedtrust.splice.http.v0.definitions.{
   GetBuyTrafficRequestStatusResponse,
   GetTransferOfferStatusResponse,
   TransferInstructionResultResponse,
+  WithdrawDevelopmentFundCouponResponse,
 }
 import org.lfdecentralizedtrust.splice.util.{Contract, ContractWithState}
 import org.lfdecentralizedtrust.splice.wallet.admin.api.client.commands.HttpWalletAppClient
@@ -604,7 +605,7 @@ abstract class WalletAppReference(
 
   @Help.Summary("Allocate a DevelopmentFundCoupon")
   @Help.Description(
-    "Allocates development-fund resources by consuming UnclaimedDevelopmentFundCoupons and creating a new " +
+    "Allocate development-fund resources by consuming UnclaimedDevelopmentFundCoupons and creating a new " +
       "DevelopmentFundCoupon for the specified beneficiary and amount."
   )
   def allocateDevelopmentFundCoupon(
@@ -619,7 +620,7 @@ abstract class WalletAppReference(
   ): AllocateDevelopmentFundCouponResponse =
     consoleEnvironment.run {
       httpCommand(
-        HttpWalletAppClient.AllocateDevelopmentFundCouponRequest(
+        HttpWalletAppClient.AllocateDevelopmentFundCoupon(
           unclaimedDevelopmentFundCouponContractIds,
           beneficiary,
           amount,
@@ -632,7 +633,7 @@ abstract class WalletAppReference(
 
   @Help.Summary("List active development fund coupons")
   @Help.Description(
-    "List all active development fund coupons for the configured user acting as a beneficiary or development fund manager"
+    "List all active development fund coupons for the configured user acting as a beneficiary or development fund manager."
   )
   def listActiveDevelopmentFundCoupons(): Seq[
     Contract[
@@ -643,6 +644,20 @@ abstract class WalletAppReference(
     consoleEnvironment.run {
       httpCommand(HttpWalletAppClient.ListActiveDevelopmentFundCoupons)
     }
+
+  @Help.Summary("Withdraw a DevelopmentFundCoupon")
+  @Help.Description(
+    "Withdraw a DevelopmentFundCoupon where the configured user acts as the development fund manager."
+  )
+  def withdrawDevelopmentFundCoupon(
+      developmentFundCouponContractId: amuletCodegen.DevelopmentFundCoupon.ContractId,
+      reason: String,
+  ): WithdrawDevelopmentFundCouponResponse =
+    consoleEnvironment.run {
+      httpCommand(
+        HttpWalletAppClient.WithdrawDevelopmentFundCoupon(developmentFundCouponContractId, reason)
+      )
+    }
 }
 
 /** Client (aka remote) reference to a wallet app in the style of ParticipantClientReference, i.e.,

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

@@ -891,6 +891,8 @@ paths:
                 "$ref": "#/components/schemas/AllocateDevelopmentFundCouponResponse"
         "400":
           $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/400"
+        "403":
+          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/403"
         "404":
           $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/404"
         "500":
@@ -913,6 +915,37 @@ paths:
         "500":
           $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/500"
 
+  /v0/wallet/development-fund-coupons/{contract_id}/withdraw:
+    post:
+      tags: [ wallet ]
+      x-jvm-package: wallet
+      operationId: "withdrawDevelopmentFundCoupon"
+      parameters:
+        - in: path
+          name: contract_id
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/WithdrawDevelopmentFundCouponRequest"
+      responses:
+        "200":
+          description: ok
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/WithdrawDevelopmentFundCouponResponse"
+        "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:
@@ -1701,3 +1734,20 @@ components:
           type: array
           items:
             $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/schemas/Contract"
+
+    WithdrawDevelopmentFundCouponRequest:
+      type: object
+      required:
+        - reason
+      properties:
+        reason:
+          type: string
+
+    WithdrawDevelopmentFundCouponResponse:
+      type: object
+      required:
+        - unclaimed_development_fund_coupon_contract_id
+      properties:
+        unclaimed_development_fund_coupon_contract_id:
+          type: string
+

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

@@ -1351,7 +1351,7 @@ object HttpWalletAppClient {
     }
   }
 
-  final case class AllocateDevelopmentFundCouponRequest(
+  final case class AllocateDevelopmentFundCoupon(
       unclaimedDevelopmentFundCouponContractIds: Seq[
         amuletCodegen.UnclaimedDevelopmentFundCoupon.ContractId
       ],
@@ -1419,4 +1419,32 @@ object HttpWalletAppClient {
     }
   }
 
+  final case class WithdrawDevelopmentFundCoupon(
+      developmentFundCouponContractId: amuletCodegen.DevelopmentFundCoupon.ContractId,
+      reason: String,
+  ) extends InternalBaseCommand[
+        http.WithdrawDevelopmentFundCouponResponse,
+        definitions.WithdrawDevelopmentFundCouponResponse,
+      ] {
+    override def submitRequest(
+        client: WalletClient,
+        headers: List[HttpHeader],
+    ): EitherT[Future, Either[
+      Throwable,
+      HttpResponse,
+    ], http.WithdrawDevelopmentFundCouponResponse] = client.withdrawDevelopmentFundCoupon(
+      developmentFundCouponContractId.contractId,
+      body = definitions.WithdrawDevelopmentFundCouponRequest(reason),
+    )
+
+    override protected def handleOk()(implicit
+        decoder: TemplateJsonDecoder
+    ): PartialFunction[http.WithdrawDevelopmentFundCouponResponse, Either[
+      String,
+      definitions.WithdrawDevelopmentFundCouponResponse,
+    ]] = { case http.WithdrawDevelopmentFundCouponResponse.OK(value) =>
+      Right(value)
+    }
+  }
+
 }

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

@@ -84,9 +84,10 @@ import org.lfdecentralizedtrust.splice.http.v0.definitions.{
   AllocateDevelopmentFundCouponRequest,
   AllocateDevelopmentFundCouponResponse,
   CreateTokenStandardTransferRequest,
+  WithdrawDevelopmentFundCouponRequest,
+  WithdrawDevelopmentFundCouponResponse,
 }
 import org.lfdecentralizedtrust.splice.util.SpliceUtil.damlDecimal
-
 import org.lfdecentralizedtrust.splice.wallet.admin.http.UserWalletAuthExtractor.WalletUserRequest
 
 import java.math.RoundingMode as JRM
@@ -1366,13 +1367,55 @@ class HttpWalletHandler(
   override def listActiveDevelopmentFundCoupons(
       respond: v0.WalletResource.ListActiveDevelopmentFundCouponsResponse.type
   )()(
-      tuser: WalletUserRequest
+      extracted: WalletUserRequest
   ): Future[v0.WalletResource.ListActiveDevelopmentFundCouponsResponse] = {
-    implicit val WalletUserRequest(user, userWallet, traceContext) = tuser
-    listContracts(
-      amuletCodegen.DevelopmentFundCoupon.COMPANION,
-      userWallet.store,
-      d0.ListActiveDevelopmentFundCouponsResponse(_),
-    )
+    implicit val WalletUserRequest(user, userWallet, traceContext) = extracted
+    withSpan(s"$workflowId.listActiveDevelopmentFundCoupons") { _ => _ =>
+      listContracts(
+        amuletCodegen.DevelopmentFundCoupon.COMPANION,
+        userWallet.store,
+        d0.ListActiveDevelopmentFundCouponsResponse(_),
+      )
+    }
+  }
+
+  override def withdrawDevelopmentFundCoupon(
+      respond: WalletResource.WithdrawDevelopmentFundCouponResponse.type
+  )(contractId: String, body: WithdrawDevelopmentFundCouponRequest)(
+      extracted: WalletUserRequest
+  ): Future[WalletResource.WithdrawDevelopmentFundCouponResponse] = {
+    implicit val WalletUserRequest(user, userWallet, traceContext) = extracted
+    withSpan(s"$workflowId.withdrawDevelopmentFundCoupon") { _ => _ =>
+      val store = userWallet.store
+      val developmentFundCouponContractId =
+        Codec.tryDecodeJavaContractId(UnclaimedDevelopmentFundCoupon.COMPANION)(contractId)
+      for {
+        domain <- scanConnection.getAmuletRulesDomain()(traceContext)
+        developmentFundCoupon <- store.multiDomainAcsStore
+          .getContractById(amuletCodegen.DevelopmentFundCoupon.COMPANION)(
+            developmentFundCouponContractId
+          )
+          .map(
+            _.toAssignedContract.getOrElse(
+              throw Status.Code.FAILED_PRECONDITION.toStatus
+                .withDescription(s"DevelopmentFundCoupon is not assigned to a synchronizer.")
+                .asRuntimeException()
+            )
+          )
+        result <- userWallet.connection
+          .submit(
+            Seq(store.key.validatorParty, store.key.endUserParty),
+            Seq.empty,
+            developmentFundCoupon.exercise(_.exerciseDevelopmentFundCoupon_Withdraw(body.reason)),
+          )
+          .withSynchronizerId(domain)
+          .noDedup
+          .yieldResult()
+      } yield WalletResource.WithdrawDevelopmentFundCouponResponseOK(
+        WithdrawDevelopmentFundCouponResponse(
+          result.exerciseResult.unclaimedDevelopmentFundCouponCid.contractId
+        )
+      )
+    }
   }
 }