[ci] Remove /v0/total-amulet-balance and /v0/wallet-balance endpoints

Signed-off-by: Raymond Roestenburg <raymond.roestenburg@digitalasset.com>

Author: ray-roestenburg-da

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

@@ -249,12 +249,6 @@ abstract class ScanAppReference(
       httpCommand(HttpScanAppClient.LookupFeaturedAppRight(providerPartyId))
     }
 
-  @Help.Summary("Get the total balance of Amulet in the network")
-  def getTotalAmuletBalance(asOfEndOfRound: Long): Option[BigDecimal] =
-    consoleEnvironment.run {
-      httpCommand(HttpScanAppClient.GetTotalAmuletBalance(asOfEndOfRound))
-    }
-
   @Help.Summary("Get the Amulet config parameters for a given round")
   def getAmuletConfigForRound(
       round: Long
@@ -607,6 +601,11 @@ abstract class ScanAppReference(
       httpCommand(HttpScanAppClient.LookupInstrument(instrumentId))
     }
 
+  def getTotalAmuletBalance(): Option[BigDecimal] = {
+    lookupInstrument("Amulet")
+      .flatMap(_.totalSupply.map(s => BigDecimal(s)))
+  }
+
   def listInstruments() =
     consoleEnvironment.run {
       httpCommand(HttpScanAppClient.ListInstruments(pageSize = None, pageToken = None))

apps/app/src/test/resources/include/scans/_scan.conf

@@ -44,10 +44,6 @@
        ttl = 1s
        max-size = 1
       }
-      total-amulet-balance {
-       ttl = 1s
-       max-size = 1
-      }
       amulet-rules {
        ttl = 1s
        max-size = 1
@@ -64,10 +60,6 @@
        ttl = 1s
        max-size = 1
       }
-      wallet-balance {
-       ttl = 1s
-       max-size = 1
-      }
       amulet-config-for-round {
        ttl = 1s
        max-size = 1

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

@@ -440,16 +440,6 @@ class ScanFrontendTimeBasedIntegrationTest
         "Wait for round to close in scan",
         _ => sv1ScanBackend.getRoundOfLatestData()._1 shouldBe (firstRound + 1),
       )
-      // We do not check the backend computation here, nor do we want to rely on the exact amulet balance created in other tests,
-      // so here we simply test that:
-      // The total balance increased as a result of our tap by the tap amount minus some amount to account for holding fees
-      // The frontend shows the balance from the backend
-      sv1ScanBackend
-        .getTotalAmuletBalance(firstRound + 1)
-        .valueOrFail("Amulet balance not yet computed") should
-        (be > (sv1ScanBackend
-          .getTotalAmuletBalance(firstRound)
-          .valueOrFail("Amulet balance not yet computed") + 99.0))
 
       withFrontEnd("scan-ui") { implicit webDriver =>
         actAndCheck(

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

@@ -689,29 +689,6 @@ class ScanIntegrationTest extends IntegrationTest with WalletTestUtil with TimeT
     }
   }
 
-  "getWalletBalance should return 400 for invalid party ID" in { implicit env =>
-    implicit val sys = env.actorSystem
-    registerHttpConnectionPoolsCleanup(env)
-
-    val response = Http()
-      .singleRequest(
-        Get(
-          s"${sv1ScanBackend.httpClientConfig.url}/api/scan/v0/wallet-balance?party_id=None&asOfEndOfRound=0"
-        )
-      )
-      .futureValue
-
-    inside(response) {
-      case _ if response.status == StatusCodes.BadRequest =>
-        inside(Unmarshal(response.entity).to[String].value.value) {
-          case Success(successfullResponse) =>
-            successfullResponse should include(
-              "Invalid unique identifier `None` with missing namespace"
-            )
-        }
-    }
-  }
-
   "getUpdateHistory should return 400 for invalid after timestamp" in { implicit env =>
     import env.{actorSystem, executionContext}
     registerHttpConnectionPoolsCleanup(env)

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

@@ -290,89 +290,6 @@ class ScanTimeBasedIntegrationTest
     )
   }
 
-  "get total amulet balance" in { implicit env =>
-    val (_, _) = onboardAliceAndBob()
-
-    def roundNum() =
-      sv1ScanBackend.getLatestOpenMiningRound(getLedgerTime).contract.payload.round.number
-    roundNum() shouldBe (firstRound + 1)
-
-    val tapRound1Amount = BigDecimal(500.0)
-    clue(s"Tap in round ${firstRound + 1}") {
-      aliceWalletClient.tap(tapRound1Amount)
-    }
-
-    advanceRoundsToNextRoundOpening
-
-    roundNum() shouldBe (firstRound + 2)
-
-    val tapRound2Amount = BigDecimal(500.0)
-    clue(s"Tap in round ${firstRound + 2}") {
-      bobWalletClient.tap(tapRound2Amount)
-    }
-
-    actAndCheck(
-      s"advance to close round ${firstRound + 2}",
-      (0 to 4).foreach(_ => advanceRoundsToNextRoundOpening),
-    )(
-      s"check round ${firstRound + 2} is closed",
-      _ => {
-        sv1ScanBackend.automation.trigger[ScanAggregationTrigger].runOnce().futureValue
-        sv1ScanBackend.getRoundOfLatestData()._1 shouldBe firstRound + 2
-        sv1ScanBackend.getAggregatedRounds().value shouldBe ScanAggregator.RoundRange(
-          firstRound + 0,
-          firstRound + 2,
-        )
-      },
-    )
-
-    clue(
-      s"Get total balances for round ${firstRound + 0}, ${firstRound + 1} and ${firstRound + 2}"
-    ) {
-      val total0 =
-        sv1ScanBackend
-          .getTotalAmuletBalance(firstRound + 0)
-          .getOrElse(BigDecimal(0))
-      val total1 =
-        sv1ScanBackend
-          .getTotalAmuletBalance(firstRound + 1)
-          .getOrElse(BigDecimal(0))
-      val total2 =
-        sv1ScanBackend
-          .getTotalAmuletBalance(firstRound + 2)
-          .valueOrFail("Amulet balance not yet computed")
-
-      val holdingFeeAfterOneRound = 1 * defaultHoldingFeeAmulet
-      val holdingFeeAfterTwoRounds = 2 * defaultHoldingFeeAmulet
-
-      total0 shouldBe 0.0
-      total1 shouldBe (walletUsdToAmulet(tapRound1Amount) - holdingFeeAfterOneRound)
-      total2 shouldBe (
-        walletUsdToAmulet(tapRound1Amount) - holdingFeeAfterTwoRounds +
-          walletUsdToAmulet(tapRound2Amount) - holdingFeeAfterOneRound
-      )
-      sv1ScanBackend.getAggregatedRounds().value shouldBe ScanAggregator.RoundRange(
-        firstRound + 0,
-        firstRound + 2,
-      )
-      sv1ScanBackend
-        .listRoundTotals(firstRound + 0, firstRound + 2)
-        .map(rt => (rt.closedRound, BigDecimal(rt.totalAmuletBalance))) shouldBe List(
-        firstRound + 0L -> total0,
-        firstRound + 1L -> total1,
-        firstRound + 2L -> total2,
-      )
-      assertThrowsAndLogsCommandFailures(
-        sv1ScanBackend.listRoundTotals(firstRound + 1, firstRound + 3),
-        _.errorMessage should include("is outside of the available rounds range"),
-      )
-      assertThrowsAndLogsCommandFailures(
-        sv1ScanBackend.listRoundPartyTotals(firstRound + 1, firstRound + 3),
-        _.errorMessage should include("is outside of the available rounds range"),
-      )
-    }
-  }
-
   "Not get aggregates for incorrect ranges" in { implicit env =>
     clue("Try to get round totals for negative rounds") {
       val startRounds = List(-1L, 0L, -1L, 1L, -1L)

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

@@ -7,7 +7,6 @@ import org.lfdecentralizedtrust.splice.config.ConfigTransforms.{
 import org.lfdecentralizedtrust.splice.integration.EnvironmentDefinition
 import org.lfdecentralizedtrust.splice.integration.tests.SpliceTests.IntegrationTest
 import org.lfdecentralizedtrust.splice.sv.automation.singlesv.LocalSequencerConnectionsTrigger
-import org.lfdecentralizedtrust.splice.util.SpliceUtil.defaultIssuanceCurve
 import org.lfdecentralizedtrust.splice.util.{SvTestUtil, TimeTestUtil, WalletTestUtil}
 
 import scala.util.Try
@@ -139,39 +138,6 @@ class ScanWithGradualStartsTimeBasedIntegrationTest
     }
 
     val validatorLivenessActivityRecordAmount = 2.85
-    clue("Aggregated total amulet balance on both scan apps should match") {
-      val svRewardPerRound =
-        BigDecimal(
-          computeSvRewardInRound0(
-            defaultIssuanceCurve.initialValue,
-            defaultTickDuration,
-            dsoSize = 2,
-          )
-        )
-      forEvery(
-        Table(
-          ("round", "total floor", "total ceiling"),
-          // Alice has 23 USD in Amulet, Bob has 3 USD, all minus holding fees
-          (2L, walletUsdToAmulet(25.9), walletUsdToAmulet(26.0)),
-          // sv2 did not start up it's validator app (thus wallet), so it won't claim any coupons.
-          (
-            3L,
-            // validator liveness activity record: SV1, Alice, Bob
-            walletUsdToAmulet(
-              26.0 + validatorLivenessActivityRecordAmount * 3 - smallAmount
-            ) + svRewardPerRound,
-            walletUsdToAmulet(26.0 + validatorLivenessActivityRecordAmount * 3) + svRewardPerRound,
-          ),
-        )
-      ) { (round, floor, ceil) =>
-        val total1 =
-          sv1ScanBackend.getTotalAmuletBalance(round).valueOrFail("Amulet balance not yet computed")
-        val total2 =
-          sv2ScanBackend.getTotalAmuletBalance(round).valueOrFail("Amulet balance not yet computed")
-        total1 shouldBe total2
-        total1 should beWithin(floor, ceil)
-      }
-    }
 
     clue("Aggregated rewards collected on both scan apps should match") {
       forEvery(

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

@@ -106,10 +106,13 @@ class TokenStandardMetadataTimeBasedIntegrationTest
       )(
         "rounds are defined and include tapped amulet",
         _ => {
-          val (roundNumber, _) = sv1ScanBackend.getRoundOfLatestData()
-          val totalBalance = sv1ScanBackend
-            .getTotalAmuletBalance(roundNumber)
-            .getOrElse(fail("total balance not yet defined"))
+          val totalBalance = BigDecimal(
+            sv1ScanBackend
+              .lookupInstrument("Amulet")
+              .flatMap(_.totalSupply)
+              .valueOrFail("total balance not yet defined")
+          )
+
           totalBalance should be >= walletUsdToAmulet(99.0)
         },
       )

apps/scan/src/main/openapi/scan.yaml

@@ -1174,70 +1174,6 @@ paths:
         "500":
           $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/500"
 
-  /v0/total-amulet-balance:
-    get:
-      deprecated: true
-      tags: [deprecated, scan]
-      x-jvm-package: scan
-      operationId: "getTotalAmuletBalance"
-      description: | 
-        **Deprecated**, use /registry/metadata/v1/instruments/Amulet token standard metadata API endpoint, see 
-        https://docs.sync.global/app_dev/token_standard/openapi/token_metadata.html.
-        
-        **This endpoint will be removed in a future release**        
-        
-        Get the total balance of Amulet in the network.
-      parameters:
-        - in: query
-          name: asOfEndOfRound
-          required: true
-          schema:
-            type: integer
-            format: int64
-      responses:
-        "200":
-          description: ok
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/GetTotalAmuletBalanceResponse"
-        "404":
-          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/404"
-
-  /v0/wallet-balance:
-    get:
-      deprecated: true
-      tags: [deprecated]
-      x-jvm-package: scan
-      operationId: "getWalletBalance"
-      description: |
-        **Deprecated**, use /v0/holdings/summary with /v0/state/acs/snapshot-timestamp instead. 
-        
-        **This endpoint will be removed in a future release**
-        
-        Get the Amulet balance for a specific party at the end of a closed round.
-      parameters:
-        - in: query
-          name: party_id
-          required: true
-          schema:
-            type: string
-        - in: query
-          name: asOfEndOfRound
-          required: true
-          schema:
-            type: integer
-            format: int64
-      responses:
-        "200":
-          description: ok
-          content:
-            application/json:
-              schema:
-                "$ref": "#/components/schemas/GetWalletBalanceResponse"
-        "404":
-          $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/responses/404"
-
   /v0/amulet-config-for-round:
     get:
       deprecated: true
@@ -1790,18 +1726,6 @@ components:
       properties:
         featured_app_right:
           $ref: "../../../../common/src/main/openapi/common-external.yaml#/components/schemas/Contract"
-    GetWalletBalanceResponse:
-      type: object
-      required: ["wallet_balance"]
-      properties:
-        wallet_balance:
-          type: string
-    GetTotalAmuletBalanceResponse:
-      type: object
-      required: ["total_balance"]
-      properties:
-        total_balance:
-          type: string
     GetAmuletConfigForRoundResponse:
       type: object
       required:

apps/scan/src/main/scala/org/lfdecentralizedtrust/splice/scan/ScanApp.scala

@@ -323,8 +323,6 @@ class ScanApp(
         store,
         acsSnapshotStore,
         config.spliceInstanceNames,
-        packageVersionSupport,
-        clock,
         loggerFactory,
       )
 

apps/scan/src/main/scala/org/lfdecentralizedtrust/splice/scan/admin/api/client/commands/HttpScanAppClient.scala

@@ -557,23 +557,6 @@ object HttpScanAppClient {
     }
   }
 
-  case class GetTotalAmuletBalance(asOfEndOfRound: Long)
-      extends InternalBaseCommand[http.GetTotalAmuletBalanceResponse, Option[BigDecimal]] {
-
-    override def submitRequest(
-        client: ScanClient,
-        headers: List[HttpHeader],
-    ): EitherT[Future, Either[Throwable, HttpResponse], http.GetTotalAmuletBalanceResponse] =
-      client.getTotalAmuletBalance(asOfEndOfRound, headers)
-
-    override def handleOk()(implicit decoder: TemplateJsonDecoder) = {
-      case http.GetTotalAmuletBalanceResponse.OK(response) =>
-        Codec.decode(Codec.BigDecimal)(response.totalBalance).map(Some(_))
-      case http.GetTotalAmuletBalanceResponse.NotFound(_) =>
-        Right(None)
-    }
-  }
-
   final case class RateStep(
       amount: BigDecimal,
       rate: BigDecimal,