[ANCHOR-603] Add fee_details to SEP-6/24/31 Transaction object and ap…

…propriate RPC endpoints (#1283) ### Description Add protocol changes introduced in stellar/stellar-protocol#1441 and stellar/stellar-protocol#1429 ### Context Previously, protocol was lacking ability to break down fees being charged by the anchor. This PR adds this functionality ### Testing - `./gradlew test` ### Documentation stellar/stellar-docs#349 ### Known limitations N/A
stellar · Mar 15, 2024 · 8e2e1c6 · 8e2e1c6
1 parent f04e137
commit 8e2e1c6
Show file tree

Hide file tree

Showing 69 changed files with 634 additions and 179 deletions.
diff --git a/api-schema/src/main/java/org/stellar/anchor/api/callback/GetRateResponse.java b/api-schema/src/main/java/org/stellar/anchor/api/callback/GetRateResponse.java
@@ -5,7 +5,7 @@
 import lombok.Builder;
 import lombok.Data;
 import lombok.NoArgsConstructor;
-import org.stellar.anchor.api.sep.sep38.RateFee;
+import org.stellar.anchor.api.shared.FeeDetails;
 import reactor.util.annotation.Nullable;
 
 /**
@@ -37,7 +37,7 @@ public GetRateResponse(Rate rate) {
    * @return a GET /rate response with price, total_price, sell_amount, buy_amount and fee.
    */
   public static GetRateResponse indicativePrice(
-      String price, String sellAmount, String buyAmount, RateFee fee) {
+      String price, String sellAmount, String buyAmount, FeeDetails fee) {
     Rate rate =
         Rate.builder().price(price).sellAmount(sellAmount).buyAmount(buyAmount).fee(fee).build();
     return new GetRateResponse(rate);
@@ -60,6 +60,6 @@ public static class Rate {
     @Nullable
     Instant expiresAt;
 
-    @Nullable RateFee fee;
+    @Nullable FeeDetails fee;
   }
 }
diff --git a/api-schema/src/main/java/org/stellar/anchor/api/platform/GetQuoteResponse.java b/api-schema/src/main/java/org/stellar/anchor/api/platform/GetQuoteResponse.java
@@ -6,7 +6,7 @@
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
-import org.stellar.anchor.api.sep.sep38.RateFee;
+import org.stellar.anchor.api.shared.FeeDetails;
 import org.stellar.anchor.api.shared.StellarId;
 
 @Data
@@ -51,5 +51,5 @@ public class GetQuoteResponse {
   @SerializedName("created_at")
   Instant createdAt;
 
-  RateFee fee;
+  FeeDetails fee;
 }
diff --git a/api-schema/src/main/java/org/stellar/anchor/api/platform/PlatformTransactionData.java b/api-schema/src/main/java/org/stellar/anchor/api/platform/PlatformTransactionData.java
@@ -42,8 +42,12 @@ public class PlatformTransactionData {
   Amount amountOut;
 
   @SerializedName("amount_fee")
+  @Deprecated // ANCHOR-636
   Amount amountFee;
 
+  @SerializedName("fee_details")
+  FeeDetails feeDetails;
+
   @SerializedName("quote_id")
   String quoteId;
 

diff --git a/api-schema/src/main/java/org/stellar/anchor/api/rpc/method/NotifyAmountsUpdatedRequest.java b/api-schema/src/main/java/org/stellar/anchor/api/rpc/method/NotifyAmountsUpdatedRequest.java
@@ -6,6 +6,7 @@
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.shared.FeeDetails;
 
 @Data
 @SuperBuilder
@@ -18,6 +19,9 @@ public class NotifyAmountsUpdatedRequest extends RpcMethodParamsRequest {
   private AmountRequest amountOut;
 
   @SerializedName("amount_fee")
-  @NotNull
+  @Deprecated // ANCHOR-636
   private AmountRequest amountFee;
+
+  @SerializedName("fee_details")
+  private FeeDetails feeDetails;
 }
diff --git a/...rc/main/java/org/stellar/anchor/api/rpc/method/NotifyInteractiveFlowCompletedRequest.java b/...rc/main/java/org/stellar/anchor/api/rpc/method/NotifyInteractiveFlowCompletedRequest.java
@@ -6,6 +6,7 @@
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.shared.FeeDetails;
 
 @Data
 @SuperBuilder
@@ -21,10 +22,13 @@ public class NotifyInteractiveFlowCompletedRequest extends RpcMethodParamsReques
   @SerializedName("amount_out")
   private AmountAssetRequest amountOut;
 
-  @NotNull
   @SerializedName("amount_fee")
+  @Deprecated // ANCHOR-636
   private AmountAssetRequest amountFee;
 
+  @SerializedName("fee_details")
+  private FeeDetails feeDetails;
+
   @SerializedName("amount_expected")
   private AmountRequest amountExpected;
 }
diff --git a/...a/src/main/java/org/stellar/anchor/api/rpc/method/NotifyOffchainFundsReceivedRequest.java b/...a/src/main/java/org/stellar/anchor/api/rpc/method/NotifyOffchainFundsReceivedRequest.java
@@ -6,6 +6,7 @@
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.shared.FeeDetails;
 
 @Data
 @SuperBuilder
@@ -26,5 +27,9 @@ public class NotifyOffchainFundsReceivedRequest extends RpcMethodParamsRequest {
   private AmountRequest amountOut;
 
   @SerializedName("amount_fee")
+  @Deprecated // ANCHOR-636
   private AmountRequest amountFee;
+
+  @SerializedName("fee_details")
+  private FeeDetails feeDetails;
 }
diff --git a/...ma/src/main/java/org/stellar/anchor/api/rpc/method/NotifyOnchainFundsReceivedRequest.java b/...ma/src/main/java/org/stellar/anchor/api/rpc/method/NotifyOnchainFundsReceivedRequest.java
@@ -6,6 +6,7 @@
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.shared.FeeDetails;
 
 @Data
 @SuperBuilder
@@ -24,5 +25,9 @@ public class NotifyOnchainFundsReceivedRequest extends RpcMethodParamsRequest {
   private AmountRequest amountOut;
 
   @SerializedName("amount_fee")
+  @Deprecated // ANCHOR-636
   private AmountRequest amountFee;
+
+  @SerializedName("fee_details")
+  private FeeDetails feeDetails;
 }
diff --git a/api-schema/src/main/java/org/stellar/anchor/api/rpc/method/RequestOffchainFundsRequest.java b/api-schema/src/main/java/org/stellar/anchor/api/rpc/method/RequestOffchainFundsRequest.java
@@ -6,6 +6,7 @@
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.shared.FeeDetails;
 import org.stellar.anchor.api.shared.InstructionField;
 
 @Data
@@ -21,8 +22,12 @@ public class RequestOffchainFundsRequest extends RpcMethodParamsRequest {
   private AmountAssetRequest amountOut;
 
   @SerializedName("amount_fee")
+  @Deprecated // ANCHOR-636
   private AmountAssetRequest amountFee;
 
+  @SerializedName("fee_details")
+  private FeeDetails feeDetails;
+
   @SerializedName("amount_expected")
   private AmountRequest amountExpected;
 

diff --git a/api-schema/src/main/java/org/stellar/anchor/api/rpc/method/RequestOnchainFundsRequest.java b/api-schema/src/main/java/org/stellar/anchor/api/rpc/method/RequestOnchainFundsRequest.java
@@ -5,6 +5,7 @@
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.shared.FeeDetails;
 
 @Data
 @SuperBuilder
@@ -19,8 +20,12 @@ public class RequestOnchainFundsRequest extends RpcMethodParamsRequest {
   private AmountAssetRequest amountOut;
 
   @SerializedName("amount_fee")
+  @Deprecated // ANCHOR-636
   private AmountAssetRequest amountFee;
 
+  @SerializedName("fee_details")
+  private FeeDetails feeDetails;
+
   @SerializedName("amount_expected")
   private AmountRequest amountExpected;
 

diff --git a/api-schema/src/main/java/org/stellar/anchor/api/sep/sep24/TransactionResponse.java b/api-schema/src/main/java/org/stellar/anchor/api/sep/sep24/TransactionResponse.java
@@ -3,6 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 import java.time.Instant;
 import lombok.Data;
+import org.stellar.anchor.api.shared.FeeDetails;
 
 /** Base class of transaction responses for withdraw and deposit. */
 @Data
@@ -32,11 +33,16 @@ public class TransactionResponse {
   String amountOutAsset;
 
   @SerializedName("amount_fee")
+  @Deprecated // ANCHOR-636
   String amountFee;
 
   @SerializedName("amount_fee_asset")
+  @Deprecated // ANCHOR-636
   String amountFeeAsset;
 
+  @SerializedName("fee_details")
+  FeeDetails feeDetails;
+
   @SerializedName("started_at")
   Instant startedAt;
 

diff --git a/api-schema/src/main/java/org/stellar/anchor/api/sep/sep38/GetPriceResponse.java b/api-schema/src/main/java/org/stellar/anchor/api/sep/sep38/GetPriceResponse.java
@@ -3,6 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 import lombok.Builder;
 import lombok.Data;
+import org.stellar.anchor.api.shared.FeeDetails;
 
 /**
  * The response body of the GET /price endpoint of SEP-38.
@@ -25,5 +26,5 @@ public class GetPriceResponse {
   @SerializedName("buy_amount")
   String buyAmount;
 
-  RateFee fee;
+  FeeDetails fee;
 }
diff --git a/api-schema/src/main/java/org/stellar/anchor/api/sep/sep38/Sep38QuoteResponse.java b/api-schema/src/main/java/org/stellar/anchor/api/sep/sep38/Sep38QuoteResponse.java
@@ -4,6 +4,7 @@
 import java.time.Instant;
 import lombok.Builder;
 import lombok.Data;
+import org.stellar.anchor.api.shared.FeeDetails;
 
 /**
  * The response body of the POST /quote endpoint of SEP-38.
@@ -37,5 +38,5 @@ public class Sep38QuoteResponse {
   @SerializedName("buy_amount")
   String buyAmount;
 
-  RateFee fee;
+  FeeDetails fee;
 }
diff --git a/api-schema/src/main/java/org/stellar/anchor/api/sep/sep6/Sep6TransactionResponse.java b/api-schema/src/main/java/org/stellar/anchor/api/sep/sep6/Sep6TransactionResponse.java
@@ -5,6 +5,7 @@
 import java.util.Map;
 import lombok.Builder;
 import lombok.Data;
+import org.stellar.anchor.api.shared.FeeDetails;
 import org.stellar.anchor.api.shared.InstructionField;
 import org.stellar.anchor.api.shared.Refunds;
 
@@ -36,11 +37,16 @@ public class Sep6TransactionResponse {
   String amountOutAsset;
 
   @SerializedName("amount_fee")
+  @Deprecated // ANCHOR-636
   String amountFee;
 
   @SerializedName("amount_fee_asset")
+  @Deprecated // ANCHOR-636
   String amountFeeAsset;
 
+  @SerializedName("fee_details")
+  FeeDetails feeDetails;
+
   @SerializedName("quote_id")
   String quoteId;
 

diff --git a/...r/anchor/api/sep/sep38/RateFeeDetail.java → ...lar/anchor/api/shared/FeeDescription.java b/...r/anchor/api/sep/sep38/RateFeeDetail.java → ...lar/anchor/api/shared/FeeDescription.java
@@ -1,4 +1,4 @@
-package org.stellar.anchor.api.sep.sep38;
+package org.stellar.anchor.api.shared;
 
 import lombok.AllArgsConstructor;
 import lombok.Data;
@@ -7,12 +7,12 @@
 @Data
 @AllArgsConstructor
 @NoArgsConstructor
-public class RateFeeDetail {
+public class FeeDescription {
   String name;
   String description;
   String amount;
 
-  public RateFeeDetail(String name, String amount) {
+  public FeeDescription(String name, String amount) {
     this.name = name;
     this.amount = amount;
   }

diff --git a/...stellar/anchor/api/sep/sep38/RateFee.java → ...stellar/anchor/api/shared/FeeDetails.java b/...stellar/anchor/api/sep/sep38/RateFee.java → ...stellar/anchor/api/shared/FeeDetails.java
@@ -1,4 +1,4 @@
-package org.stellar.anchor.api.sep.sep38;
+package org.stellar.anchor.api.shared;
 
 import java.math.BigDecimal;
 import java.math.RoundingMode;
@@ -12,17 +12,17 @@
 @Data
 @AllArgsConstructor
 @NoArgsConstructor
-public class RateFee {
+public class FeeDetails {
   String total;
   String asset;
-  List<RateFeeDetail> details;
+  List<FeeDescription> details;
 
-  public RateFee(String total, String asset) {
+  public FeeDetails(String total, String asset) {
     this.total = total;
     this.asset = asset;
   }
 
-  public void addFeeDetail(RateFeeDetail feeDetail) {
+  public void addFeeDetail(FeeDescription feeDetail) {
     if (feeDetail == null || feeDetail.amount == null) {
       return;
     }

diff --git a/core/src/main/java/org/stellar/anchor/sep24/Sep24Service.java b/core/src/main/java/org/stellar/anchor/sep24/Sep24Service.java
@@ -594,8 +594,7 @@ public void validatedAndPopulateQuote(
     builder.amountInAsset(quote.getSellAsset());
     builder.amountOut(quote.getBuyAmount());
     builder.amountOutAsset(quote.getBuyAsset());
-    builder.amountFee(quote.getFee().getTotal());
-    builder.amountFeeAsset(quote.getFee().getAsset());
+    builder.feeDetails(quote.getFee());
 
     if (kind.equals(DEPOSIT.toString())) {
       builder.sourceAsset(quote.getSellAsset());

diff --git a/core/src/main/java/org/stellar/anchor/sep24/Sep24Transaction.java b/core/src/main/java/org/stellar/anchor/sep24/Sep24Transaction.java
@@ -1,6 +1,7 @@
 package org.stellar.anchor.sep24;
 
 import org.stellar.anchor.SepTransaction;
+import org.stellar.anchor.api.shared.FeeDetails;
 
 @SuppressWarnings("unused")
 public interface Sep24Transaction extends SepTransaction {
@@ -205,8 +206,10 @@ public interface Sep24Transaction extends SepTransaction {
    *
    * @return <code>amount_fee</code> field of the SEP-24 transaction history.
    */
+  @Deprecated // ANCHOR-636
   String getAmountFee();
 
+  @Deprecated // ANCHOR-636
   void setAmountFee(String amountFee);
 
   /**
@@ -216,10 +219,23 @@ public interface Sep24Transaction extends SepTransaction {
    *
    * @return <code>amount_fee_asset</code> field of the SEP-24 transaction history.
    */
+  @Deprecated // ANCHOR-636
   String getAmountFeeAsset();
 
+  @Deprecated // ANCHOR-636
   void setAmountFeeAsset(String amountFeeAsset);
 
+  /**
+   * Description of fee charged by the anchor. The schema for this object is defined in the Fee
+   * Details Object Schema and matches the one of SEP-38 quote's fee.
+   *
+   * @return Unified fields of SEP-24 transaction history complied from <code>amount_fee</code>,
+   *     <code>amount_fee_asset</code> and <code>fee_details</code>
+   */
+  FeeDetails getFeeDetails();
+
+  void setFeeDetails(FeeDetails feeDetails);
+
   Boolean getRefunded();
 
   void setRefunded(Boolean refunded);

diff --git a/core/src/main/java/org/stellar/anchor/sep24/Sep24TransactionBuilder.java b/core/src/main/java/org/stellar/anchor/sep24/Sep24TransactionBuilder.java
@@ -1,6 +1,7 @@
 package org.stellar.anchor.sep24;
 
 import java.time.Instant;
+import org.stellar.anchor.api.shared.FeeDetails;
 
 @SuppressWarnings("unused")
 public class Sep24TransactionBuilder {
@@ -105,11 +106,6 @@ public Sep24TransactionBuilder amountOut(String amountOut) {
     return this;
   }
 
-  public Sep24TransactionBuilder amountFee(String amountFee) {
-    txn.setAmountFee(amountFee);
-    return this;
-  }
-
   public Sep24TransactionBuilder amountInAsset(String amountInAsset) {
     txn.setAmountInAsset(amountInAsset);
     return this;
@@ -120,8 +116,8 @@ public Sep24TransactionBuilder amountOutAsset(String amountOutAsset) {
     return this;
   }
 
-  public Sep24TransactionBuilder amountFeeAsset(String amountFeeAsset) {
-    txn.setAmountFeeAsset(amountFeeAsset);
+  public Sep24TransactionBuilder feeDetails(FeeDetails feeDetails) {
+    txn.setFeeDetails(feeDetails);
     return this;
   }
 

diff --git a/core/src/main/java/org/stellar/anchor/sep31/Sep31Helper.java b/core/src/main/java/org/stellar/anchor/sep31/Sep31Helper.java
@@ -8,8 +8,8 @@ public class Sep31Helper {
   public static boolean allAmountAvailable(Sep31Transaction txn) {
     return txn.getAmountIn() != null
         && txn.getAmountInAsset() != null
-        && txn.getAmountFee() != null
-        && txn.getAmountFeeAsset() != null
+        && txn.getFeeDetails() != null
+        && txn.getFeeDetails().getAsset() != null
         && txn.getAmountOut() != null
         && txn.getAmountOutAsset() != null;
   }