#576: Add support for AMMClawback

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/crypto/signing/SignatureUtils.java

@@ -34,6 +34,7 @@
 import org.xrpl.xrpl4j.model.transactions.AccountSet;
 import org.xrpl.xrpl4j.model.transactions.Address;
 import org.xrpl.xrpl4j.model.transactions.AmmBid;
+import org.xrpl.xrpl4j.model.transactions.AmmClawback;
 import org.xrpl.xrpl4j.model.transactions.AmmCreate;
 import org.xrpl.xrpl4j.model.transactions.AmmDelete;
 import org.xrpl.xrpl4j.model.transactions.AmmDeposit;
@@ -395,6 +396,10 @@ public <T extends Transaction> SingleSignedTransaction<T> addSignatureToTransact
       transactionWithSignature = OracleDelete.builder().from((OracleDelete) transaction)
         .transactionSignature(signature)
         .build();
+    } else if (AmmClawback.class.isAssignableFrom(transaction.getClass())) {
+      transactionWithSignature = AmmClawback.builder().from((AmmClawback) transaction)
+        .transactionSignature(signature)
+        .build();
     } else if (MpTokenAuthorize.class.isAssignableFrom(transaction.getClass())) {
       transactionWithSignature = MpTokenAuthorize.builder().from((MpTokenAuthorize) transaction)
         .transactionSignature(signature)
@@ -622,6 +627,10 @@ public <T extends Transaction> T addMultiSignaturesToTransaction(T transaction,
       transactionWithSignatures = OracleDelete.builder().from((OracleDelete) transaction)
         .signers(signers)
         .build();
+    } else if (AmmClawback.class.isAssignableFrom(transaction.getClass())) {
+      transactionWithSignatures = AmmClawback.builder().from((AmmClawback) transaction)
+        .signers(signers)
+        .build();
     } else if (MpTokenAuthorize.class.isAssignableFrom(transaction.getClass())) {
       transactionWithSignatures = MpTokenAuthorize.builder().from((MpTokenAuthorize) transaction)
         .signers(signers)

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,72 @@
+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)
+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

@@ -99,6 +99,7 @@ public interface Transaction {
       .put(ImmutableMpTokenIssuanceDestroy.class, TransactionType.MPT_ISSUANCE_DESTROY)
       .put(ImmutableMpTokenIssuanceSet.class, TransactionType.MPT_ISSUANCE_SET)
       .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,10 @@ public enum TransactionType {
   @Beta
   ORACLE_DELETE("OracleDelete"),
 
+  /**
+   * The {@link TransactionType} for the {@link AmmClawback} transaction.
+   */
+  AMM_CLAWBACK("AMMClawback"),
   @Beta
   MPT_ISSUANCE_CREATE("MPTokenIssuanceCreate"),
   @Beta

xrpl4j-core/src/test/java/org/xrpl/xrpl4j/crypto/signing/SignatureUtilsTest.java

@@ -63,6 +63,7 @@
 import org.xrpl.xrpl4j.model.transactions.AccountSet;
 import org.xrpl.xrpl4j.model.transactions.Address;
 import org.xrpl.xrpl4j.model.transactions.AmmBid;
+import org.xrpl.xrpl4j.model.transactions.AmmClawback;
 import org.xrpl.xrpl4j.model.transactions.AmmCreate;
 import org.xrpl.xrpl4j.model.transactions.AmmDelete;
 import org.xrpl.xrpl4j.model.transactions.AmmDeposit;
@@ -850,6 +851,59 @@ void addSignatureToAmmCreate() {
     addSignatureToTransactionHelper(ammCreate);
   }
 
+  @Test
+  void addSignatureToAmmClawback() {
+    AmmClawback ammClawback = AmmClawback.builder()
+      .account(sourcePublicKey.deriveAddress())
+      .holder(sourcePublicKey.deriveAddress())
+      .amount(
+        IssuedCurrencyAmount.builder()
+          .currency("TST")
+          .issuer(Address.of("rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd"))
+          .value("25")
+          .build()
+      )
+      .asset(Issue.XRP)
+      .asset2(
+        Issue.builder()
+          .issuer(Address.of("rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd"))
+          .currency("TST")
+          .build()
+      )
+      .fee(XrpCurrencyAmount.ofDrops(10))
+      .sequence(UnsignedInteger.valueOf(6))
+      .signingPublicKey(sourcePublicKey)
+      .build();
+
+    addSignatureToTransactionHelper(ammClawback);
+  }
+
+  @Test
+  void addMultiSignaturesToAmmClawback() {
+    AmmClawback ammClawback = AmmClawback.builder()
+      .account(sourcePublicKey.deriveAddress())
+      .holder(sourcePublicKey.deriveAddress())
+      .amount(
+        IssuedCurrencyAmount.builder()
+          .currency("TST")
+          .issuer(Address.of("rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd"))
+          .value("25")
+          .build()
+      )
+      .asset(Issue.XRP)
+      .asset2(
+        Issue.builder()
+          .issuer(Address.of("rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd"))
+          .currency("TST")
+          .build()
+      )
+      .fee(XrpCurrencyAmount.ofDrops(10))
+      .sequence(UnsignedInteger.valueOf(6))
+      .build();
+
+    addMultiSignatureToTransactionHelper(ammClawback);
+  }
+
   @Test
   void addSignatureToAmmDeposit() {
     AmmDeposit deposit = AmmDeposit.builder()

xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/flags/AmmClawbackFlagsTest.java

@@ -0,0 +1,50 @@
+package org.xrpl.xrpl4j.model.flags;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import org.json.JSONException;
+import org.junit.jupiter.api.Test;
+
+class AmmClawbackFlagsTest extends AbstractFlagsTest {
+
+  @Test
+  void testFlagWithValue() {
+    AmmClawbackFlags flags = AmmClawbackFlags.CLAW_TWO_ASSETS;
+    assertThat(flags.isEmpty()).isFalse();
+
+    assertThat(flags.tfClawTwoAssets()).isTrue();
+    assertThat(flags.tfFullyCanonicalSig()).isFalse();
+    assertThat(flags.getValue()).isEqualTo(1L);
+  }
+
+  @Test
+  void testEmptyFlags() {
+    AmmClawbackFlags flags = AmmClawbackFlags.empty();
+    assertThat(flags.isEmpty()).isTrue();
+
+    assertThat(flags.tfClawTwoAssets()).isFalse();
+    assertThat(flags.tfFullyCanonicalSig()).isFalse();
+    assertThat(flags.getValue()).isZero();
+  }
+
+  @Test
+  void testJson() throws JSONException, JsonProcessingException {
+    TransactionFlagsWrapper wrapper = TransactionFlagsWrapper.of(AmmClawbackFlags.CLAW_TWO_ASSETS);
+    String json = String.format("{\n" +
+        "               \"flags\": %s\n" +
+        "}", AmmClawbackFlags.CLAW_TWO_ASSETS.getValue());
+
+    assertCanSerializeAndDeserialize(wrapper, json);
+  }
+
+  @Test
+  void testEmptyJson() throws JSONException, JsonProcessingException {
+    AmmClawbackFlags flags = AmmClawbackFlags.empty();
+    AbstractFlagsTest.TransactionFlagsWrapper wrapper = AbstractFlagsTest.TransactionFlagsWrapper.of(flags);
+    String json = "{\n" +
+        "}";
+
+    assertCanSerializeAndDeserialize(wrapper, json);
+  }
+}