[ANCHOR-686] Add user_action_required_by (#1368)

### Description - Add new field `user_action_required_by` to SEP-6/24/31 transactions and related DB entries. - Added configuration option for SEP-6 and SEP-24 to set initial value on transaction creation. - Added support for related RPC requests to update this field. - Added ability to query platform transactions sorted by `user_action_required_by` field ### Context Implements stellar/stellar-protocol#1484 ### Testing - `./gradlew test` - New test cases covering all new features ### Documentation https://stellarorg.atlassian.net/browse/ANCHOR-688 https://stellarorg.atlassian.net/browse/ANCHOR-704 ### Known limitations N/A
stellar · May 17, 2024 · 618de46 · 618de46
1 parent c333bd0
commit 618de46
Show file tree

Hide file tree

Showing 59 changed files with 388 additions and 30 deletions.
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
@@ -60,6 +60,9 @@ public class PlatformTransactionData {
   @SerializedName("completed_at")
   Instant completedAt;
 
+  @SerializedName("user_action_required_by")
+  Instant userActionRequiredBy;
+
   @SerializedName("transfer_received_at")
   Instant transferReceivedAt;
 

diff --git a/api-schema/src/main/java/org/stellar/anchor/api/platform/TransactionsOrderBy.java b/api-schema/src/main/java/org/stellar/anchor/api/platform/TransactionsOrderBy.java
@@ -2,7 +2,8 @@
 
 public enum TransactionsOrderBy {
   CREATED_AT("started_at"),
-  TRANSFER_RECEIVED_AT("transfer_received_at");
+  TRANSFER_RECEIVED_AT("transfer_received_at"),
+  USER_ACTION_REQUIRED_BY("user_action_required_by");
 
   private final String tableName;
 

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
@@ -1,18 +1,21 @@
 package org.stellar.anchor.api.rpc.method;
 
 import com.google.gson.annotations.SerializedName;
+import java.time.Instant;
 import javax.validation.constraints.NotNull;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.rpc.method.features.SupportsUserActionRequiredBy;
 import org.stellar.anchor.api.shared.FeeDetails;
 
 @Data
 @SuperBuilder
 @AllArgsConstructor
 @EqualsAndHashCode(callSuper = false)
-public class NotifyInteractiveFlowCompletedRequest extends RpcMethodParamsRequest {
+public class NotifyInteractiveFlowCompletedRequest extends RpcMethodParamsRequest
+    implements SupportsUserActionRequiredBy {
 
   @NotNull
   @SerializedName("amount_in")
@@ -31,4 +34,7 @@ public class NotifyInteractiveFlowCompletedRequest extends RpcMethodParamsReques
 
   @SerializedName("amount_expected")
   private AmountRequest amountExpected;
+
+  @SerializedName("user_action_required_by")
+  Instant userActionRequiredBy;
 }
diff --git a/.../src/main/java/org/stellar/anchor/api/rpc/method/NotifyOffchainFundsAvailableRequest.java b/.../src/main/java/org/stellar/anchor/api/rpc/method/NotifyOffchainFundsAvailableRequest.java
@@ -1,17 +1,23 @@
 package org.stellar.anchor.api.rpc.method;
 
 import com.google.gson.annotations.SerializedName;
+import java.time.Instant;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.rpc.method.features.SupportsUserActionRequiredBy;
 
 @Data
 @SuperBuilder
 @AllArgsConstructor
 @EqualsAndHashCode(callSuper = false)
-public class NotifyOffchainFundsAvailableRequest extends RpcMethodParamsRequest {
+public class NotifyOffchainFundsAvailableRequest extends RpcMethodParamsRequest
+    implements SupportsUserActionRequiredBy {
 
   @SerializedName("external_transaction_id")
   private String externalTransactionId;
+
+  @SerializedName("user_action_required_by")
+  Instant userActionRequiredBy;
 }
diff --git a/...ma/src/main/java/org/stellar/anchor/api/rpc/method/NotifyOffchainFundsPendingRequest.java b/...ma/src/main/java/org/stellar/anchor/api/rpc/method/NotifyOffchainFundsPendingRequest.java
@@ -1,17 +1,23 @@
 package org.stellar.anchor.api.rpc.method;
 
 import com.google.gson.annotations.SerializedName;
+import java.time.Instant;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.rpc.method.features.SupportsUserActionRequiredBy;
 
 @Data
 @SuperBuilder
 @AllArgsConstructor
 @EqualsAndHashCode(callSuper = false)
-public class NotifyOffchainFundsPendingRequest extends RpcMethodParamsRequest {
+public class NotifyOffchainFundsPendingRequest extends RpcMethodParamsRequest
+    implements SupportsUserActionRequiredBy {
 
   @SerializedName("external_transaction_id")
   private String externalTransactionId;
+
+  @SerializedName("user_action_required_by")
+  Instant userActionRequiredBy;
 }
diff --git a/...ema/src/main/java/org/stellar/anchor/api/rpc/method/RequestCustomerInfoUpdateRequest.java b/...ema/src/main/java/org/stellar/anchor/api/rpc/method/RequestCustomerInfoUpdateRequest.java
@@ -1,21 +1,27 @@
 package org.stellar.anchor.api.rpc.method;
 
 import com.google.gson.annotations.SerializedName;
+import java.time.Instant;
 import java.util.List;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.rpc.method.features.SupportsUserActionRequiredBy;
 
 @Data
 @SuperBuilder
 @AllArgsConstructor
 @EqualsAndHashCode(callSuper = false)
-public class RequestCustomerInfoUpdateRequest extends RpcMethodParamsRequest {
+public class RequestCustomerInfoUpdateRequest extends RpcMethodParamsRequest
+    implements SupportsUserActionRequiredBy {
 
   @SerializedName("required_customer_info_message")
   private String requiredCustomerInfoMessage;
 
   @SerializedName("required_customer_info_updates")
   private List<String> requiredCustomerInfoUpdates;
+
+  @SerializedName("user_action_required_by")
+  Instant userActionRequiredBy;
 }
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
@@ -1,19 +1,22 @@
 package org.stellar.anchor.api.rpc.method;
 
 import com.google.gson.annotations.SerializedName;
+import java.time.Instant;
 import java.util.Map;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.rpc.method.features.SupportsUserActionRequiredBy;
 import org.stellar.anchor.api.shared.FeeDetails;
 import org.stellar.anchor.api.shared.InstructionField;
 
 @Data
 @SuperBuilder
 @AllArgsConstructor
 @EqualsAndHashCode(callSuper = false)
-public class RequestOffchainFundsRequest extends RpcMethodParamsRequest {
+public class RequestOffchainFundsRequest extends RpcMethodParamsRequest
+    implements SupportsUserActionRequiredBy {
 
   @SerializedName("amount_in")
   private AmountAssetRequest amountIn;
@@ -33,4 +36,7 @@ public class RequestOffchainFundsRequest extends RpcMethodParamsRequest {
 
   @SerializedName("instructions")
   Map<String, InstructionField> instructions;
+
+  @SerializedName("user_action_required_by")
+  Instant userActionRequiredBy;
 }
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
@@ -1,17 +1,20 @@
 package org.stellar.anchor.api.rpc.method;
 
 import com.google.gson.annotations.SerializedName;
+import java.time.Instant;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.rpc.method.features.SupportsUserActionRequiredBy;
 import org.stellar.anchor.api.shared.FeeDetails;
 
 @Data
 @SuperBuilder
 @AllArgsConstructor
 @EqualsAndHashCode(callSuper = false)
-public class RequestOnchainFundsRequest extends RpcMethodParamsRequest {
+public class RequestOnchainFundsRequest extends RpcMethodParamsRequest
+    implements SupportsUserActionRequiredBy {
 
   @SerializedName("amount_in")
   private AmountAssetRequest amountIn;
@@ -36,4 +39,7 @@ public class RequestOnchainFundsRequest extends RpcMethodParamsRequest {
   private String memoType;
 
   private String memo;
+
+  @SerializedName("user_action_required_by")
+  Instant userActionRequiredBy;
 }
diff --git a/api-schema/src/main/java/org/stellar/anchor/api/rpc/method/RequestTrustRequest.java b/api-schema/src/main/java/org/stellar/anchor/api/rpc/method/RequestTrustRequest.java
@@ -1,12 +1,19 @@
 package org.stellar.anchor.api.rpc.method;
 
+import com.google.gson.annotations.SerializedName;
+import java.time.Instant;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import org.stellar.anchor.api.rpc.method.features.SupportsUserActionRequiredBy;
 
 @Data
 @SuperBuilder
 @AllArgsConstructor
 @EqualsAndHashCode(callSuper = false)
-public class RequestTrustRequest extends RpcMethodParamsRequest {}
+public class RequestTrustRequest extends RpcMethodParamsRequest
+    implements SupportsUserActionRequiredBy {
+  @SerializedName("user_action_required_by")
+  Instant userActionRequiredBy;
+}
diff --git a/...rc/main/java/org/stellar/anchor/api/rpc/method/features/SupportsUserActionRequiredBy.java b/...rc/main/java/org/stellar/anchor/api/rpc/method/features/SupportsUserActionRequiredBy.java
@@ -0,0 +1,9 @@
+package org.stellar.anchor.api.rpc.method.features;
+
+import java.time.Instant;
+
+public interface SupportsUserActionRequiredBy {
+  Instant getUserActionRequiredBy();
+
+  void setUserActionRequiredBy(Instant userActionRequiredBy);
+}
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
@@ -49,6 +49,9 @@ public class TransactionResponse {
   @SerializedName("completed_at")
   Instant completedAt;
 
+  @SerializedName("user_action_required_by")
+  Instant userActionRequiredBy;
+
   @SerializedName("stellar_transaction_id")
   String stellarTransactionId;
 

diff --git a/api-schema/src/main/java/org/stellar/anchor/api/sep/sep31/Sep31GetTransactionResponse.java b/api-schema/src/main/java/org/stellar/anchor/api/sep/sep31/Sep31GetTransactionResponse.java
@@ -69,6 +69,9 @@ public static class TransactionResponse {
     @SerializedName("completed_at")
     Instant completedAt;
 
+    @SerializedName("user_action_required_by")
+    Instant userActionRequiredBy;
+
     @SerializedName("stellar_transaction_id")
     String stellarTransactionId;
 

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
@@ -78,6 +78,9 @@ public class Sep6TransactionResponse {
   @SerializedName("completed_at")
   String completedAt;
 
+  @SerializedName("user_action_required_by")
+  String userActionRequiredBy;
+
   @SerializedName("stellar_transaction_id")
   String stellarTransactionId;
 

diff --git a/core/src/main/java/org/stellar/anchor/SepTransaction.java b/core/src/main/java/org/stellar/anchor/SepTransaction.java
@@ -53,6 +53,15 @@ public interface SepTransaction {
   Instant getCompletedAt();
 
   void setCompletedAt(Instant completedAt);
+
+  /**
+   * The date and time user action is required by. See SEP protocols for more details.
+   *
+   * @return date and time of user action required by.
+   */
+  Instant getUserActionRequiredBy();
+
+  void setUserActionRequiredBy(Instant requiredBy);
   /**
    * <code>transaction_id</code> on Stellar network of the transfer that either completed the
    * deposit or started the withdrawal.

diff --git a/core/src/main/java/org/stellar/anchor/config/Sep24Config.java b/core/src/main/java/org/stellar/anchor/config/Sep24Config.java
@@ -11,6 +11,8 @@ public interface Sep24Config {
 
   DepositInfoGeneratorType getDepositInfoGeneratorType();
 
+  Long getInitialUserDeadlineSeconds();
+
   @Getter
   @Setter
   class Features {

diff --git a/core/src/main/java/org/stellar/anchor/config/Sep6Config.java b/core/src/main/java/org/stellar/anchor/config/Sep6Config.java
@@ -5,6 +5,7 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
+import org.jetbrains.annotations.Nullable;
 
 public interface Sep6Config {
   boolean isEnabled();
@@ -13,6 +14,9 @@ public interface Sep6Config {
 
   DepositInfoGeneratorType getDepositInfoGeneratorType();
 
+  @Nullable
+  Long getInitialUserDeadlineSeconds();
+
   @Getter
   @Setter
   @AllArgsConstructor

diff --git a/core/src/main/java/org/stellar/anchor/sep24/Sep24Helper.java b/core/src/main/java/org/stellar/anchor/sep24/Sep24Helper.java
@@ -25,6 +25,8 @@ static void setSharedTransactionResponseFields(TransactionResponse txnR, Sep24Tr
     if (txn.getToAccount() != null) txnR.setTo(txn.getToAccount());
     if (txn.getStartedAt() != null) txnR.setStartedAt(txn.getStartedAt());
     if (txn.getCompletedAt() != null) txnR.setCompletedAt(txn.getCompletedAt());
+    if (txn.getUserActionRequiredBy() != null)
+      txnR.setUserActionRequiredBy(txn.getUserActionRequiredBy());
   }
 
   static TransactionResponse updateRefundInfo(

diff --git a/core/src/main/java/org/stellar/anchor/sep24/Sep24Service.java b/core/src/main/java/org/stellar/anchor/sep24/Sep24Service.java
@@ -204,6 +204,10 @@ public InteractiveTransactionResponse withdraw(
             .assetCode(assetCode)
             .assetIssuer(asset.getIssuer())
             .startedAt(Instant.now())
+            .userActionRequiredBy(
+                sep24Config.getInitialUserDeadlineSeconds() == null
+                    ? null
+                    : Instant.now().plusSeconds(sep24Config.getInitialUserDeadlineSeconds()))
             .sep10Account(token.getAccount())
             .sep10AccountMemo(token.getAccountMemo())
             .fromAccount(sourceAccount)
@@ -397,6 +401,10 @@ public InteractiveTransactionResponse deposit(Sep10Jwt token, Map<String, String
             .assetCode(assetCode)
             .assetIssuer(depositRequest.get("asset_issuer"))
             .startedAt(Instant.now())
+            .userActionRequiredBy(
+                sep24Config.getInitialUserDeadlineSeconds() == null
+                    ? null
+                    : Instant.now().plusSeconds(sep24Config.getInitialUserDeadlineSeconds()))
             .sep10Account(token.getAccount())
             .sep10AccountMemo(token.getAccountMemo())
             .toAccount(destinationAccount)

diff --git a/core/src/main/java/org/stellar/anchor/sep24/Sep24TransactionBuilder.java b/core/src/main/java/org/stellar/anchor/sep24/Sep24TransactionBuilder.java
@@ -41,6 +41,11 @@ public Sep24TransactionBuilder startedAt(Instant time) {
     return this;
   }
 
+  public Sep24TransactionBuilder userActionRequiredBy(Instant time) {
+    txn.setUserActionRequiredBy(time);
+    return this;
+  }
+
   public Sep24TransactionBuilder completedAt(Instant time) {
     txn.setCompletedAt(time);
     return this;

diff --git a/core/src/main/java/org/stellar/anchor/sep31/Sep31Transaction.java b/core/src/main/java/org/stellar/anchor/sep31/Sep31Transaction.java
@@ -151,6 +151,7 @@ default Sep31GetTransactionResponse toSep31GetTransactionResponse() {
                 .stellarMemoType(getStellarMemoType())
                 .startedAt(getStartedAt())
                 .completedAt(getCompletedAt())
+                .userActionRequiredBy(getUserActionRequiredBy())
                 .stellarTransactionId(getStellarTransactionId())
                 .externalTransactionId(getExternalTransactionId())
                 .refunded(getRefunded())

diff --git a/core/src/main/java/org/stellar/anchor/sep6/Sep6Service.java b/core/src/main/java/org/stellar/anchor/sep6/Sep6Service.java
@@ -132,6 +132,10 @@ public StartDepositResponse deposit(Sep10Jwt token, StartDepositRequest request)
             .assetIssuer(asset.getIssuer())
             .amountExpected(request.getAmount())
             .startedAt(Instant.now())
+            .userActionRequiredBy(
+                sep6Config.getInitialUserDeadlineSeconds() == null
+                    ? null
+                    : Instant.now().plusSeconds(sep6Config.getInitialUserDeadlineSeconds()))
             .sep10Account(token.getAccount())
             .sep10AccountMemo(token.getAccountMemo())
             .toAccount(request.getAccount())
@@ -226,6 +230,10 @@ public StartDepositResponse depositExchange(Sep10Jwt token, StartDepositExchange
             .feeDetails(amounts.feeDetails)
             .amountExpected(request.getAmount())
             .startedAt(Instant.now())
+            .userActionRequiredBy(
+                sep6Config.getInitialUserDeadlineSeconds() == null
+                    ? null
+                    : Instant.now().plusSeconds(sep6Config.getInitialUserDeadlineSeconds()))
             .sep10Account(token.getAccount())
             .sep10AccountMemo(token.getAccountMemo())
             .toAccount(request.getAccount())
@@ -299,6 +307,10 @@ public StartWithdrawResponse withdraw(Sep10Jwt token, StartWithdrawRequest reque
             .amountInAsset(asset.getSep38AssetName())
             .amountExpected(request.getAmount())
             .startedAt(Instant.now())
+            .userActionRequiredBy(
+                sep6Config.getInitialUserDeadlineSeconds() == null
+                    ? null
+                    : Instant.now().plusSeconds(sep6Config.getInitialUserDeadlineSeconds()))
             .sep10Account(token.getAccount())
             .sep10AccountMemo(token.getAccountMemo())
             .fromAccount(sourceAccount)
@@ -388,6 +400,10 @@ public StartWithdrawResponse withdrawExchange(
             .feeDetails(amounts.getFeeDetails())
             .amountExpected(request.getAmount())
             .startedAt(Instant.now())
+            .userActionRequiredBy(
+                sep6Config.getInitialUserDeadlineSeconds() == null
+                    ? null
+                    : Instant.now().plusSeconds(sep6Config.getInitialUserDeadlineSeconds()))
             .sep10Account(token.getAccount())
             .sep10AccountMemo(token.getAccountMemo())
             .fromAccount(sourceAccount)