#576: Add support for AMMClawback

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/flags/AmmClawbackFlags.java

@@ -0,0 +1,64 @@
+package org.xrpl.xrpl4j.model.flags;
+
+/*-
+ * ========================LICENSE_START=================================
+ * xrpl4j :: core
+ * %%
+ * Copyright (C) 2020 - 2023 XRPL Foundation and its contributors
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =========================LICENSE_END==================================
+ */
+
+import org.xrpl.xrpl4j.model.transactions.AmmClawback;
+
+/**
+ * {@link TransactionFlags} for {@link AmmClawback} transactions.
+ */
+public class AmmClawbackFlags extends TransactionFlags {
+  /**
+   * Constant {@link AmmDepositFlags} for the {@code tfClawTwoAssets} flag.
+   */
+  public static final AmmClawbackFlags CLAW_TWO_ASSETS = new AmmClawbackFlags(0x00000001);
+
+  /**
+   * Constant {@link AmmDepositFlags} for an unset value for "flags".
+   */
+  public static final AmmClawbackFlags UNSET = new AmmClawbackFlags(0L);
+
+  private AmmClawbackFlags(long value) {
+    super(value);
+  }
+
+  private AmmClawbackFlags() {
+  }
+
+  /**
+   * Construct an empty instance of {@link AmmClawbackFlags}. Transactions with empty flags will
+   * not be serialized with a {@code Flags} field.
+   *
+   * @return An empty {@link AmmClawbackFlags}.
+   */
+  public static AmmClawbackFlags empty() {
+    return new AmmClawbackFlags();
+  }
+
+  /**
+   * Whether the {@code tfClawTwoAssets} flag is set.
+   *
+   * @return {@code true} if {@code tfLPToken} is set, otherwise {@code false}.
+   */
+  public boolean tfClawTwoAssets() {
+    return this.isSet(CLAW_TWO_ASSETS);
+  }
+}

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/AmmClawback.java

@@ -0,0 +1,73 @@
+package org.xrpl.xrpl4j.model.transactions;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.google.common.annotations.Beta;
+import org.immutables.value.Value;
+import org.xrpl.xrpl4j.model.flags.AmmClawbackFlags;
+import org.xrpl.xrpl4j.model.ledger.Issue;
+
+import java.util.Optional;
+
+/**
+ * An {@link AmmClawback} transaction claws back tokens from a holder that has funds in an AMM pool.
+ */
+@Value.Immutable
+@JsonSerialize(as = ImmutableAmmClawback.class)
+@JsonDeserialize(as = ImmutableAmmClawback.class)
+@Beta
+public interface AmmClawback extends Transaction {
+
+  /**
+   * Construct a builder for this class.
+   *
+   * @return An {@link ImmutableAmmClawback.Builder}.
+   */
+  static ImmutableAmmClawback.Builder builder() {
+    return ImmutableAmmClawback.builder();
+  }
+
+  /**
+   * The address of the holder that has funds deposited in the AMM pool.
+   *
+   * @return An {@link Address}.
+   */
+  @JsonProperty("Holder")
+  Address holder();
+
+  /**
+   * The asset in the AMM pool that the issuer is looking to claw back.
+   *
+   * @return An {@link Issue}.
+   */
+  @JsonProperty("Asset")
+  Issue asset();
+
+  /**
+   * Other asset in the AMM pool that the issuer is looking to claw back.
+   *
+   * @return An {@link Issue}.
+   */
+  @JsonProperty("Asset2")
+  Issue asset2();
+
+  /**
+   * Optional field that specifies the maximum amount to clawback from the AMM pool.
+   *
+   * @return An {@link CurrencyAmount}.
+   */
+  @JsonProperty("Amount")
+  Optional<CurrencyAmount> amount();
+
+  /**
+   * Transaction Flags for {@link AmmClawback}, with the only option being tfClawTwoAssets.
+   *
+   * @return {@link AmmClawbackFlags#UNSET} if field was not set, otherwise returns with the set flag.
+   */
+  @JsonProperty("Flags")
+  @Value.Default
+  default AmmClawbackFlags flags() {
+    return AmmClawbackFlags.empty();
+  }
+}

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/Transaction.java

@@ -94,6 +94,7 @@ public interface Transaction {
       .put(ImmutableOracleSet.class, TransactionType.ORACLE_SET)
       .put(ImmutableOracleDelete.class, TransactionType.ORACLE_DELETE)
       .put(ImmutableUnknownTransaction.class, TransactionType.UNKNOWN)
+      .put(ImmutableAmmClawback.class, TransactionType.AMM_CLAWBACK)
       .build();
 
   /**

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/TransactionType.java

@@ -338,6 +338,7 @@ public enum TransactionType {
   @Beta
   ORACLE_DELETE("OracleDelete"),
 
+  AMM_CLAWBACK("AMMClawback"),
   /**
    * The {@link TransactionType} for any transaction that is unrecognized/unsupported by xrpl4j.
    */