#576: Add support for AMMClawback #601

agutierrez0 · 2025-02-19T21:46:35Z

closes #576

add AmmClawback to SignatureUtils, Transaction.java, TransactionType.java, and TransactionTypeTests.java
- add test in SignatureUtils for the new AmmClawback class
create AmmClawbackFlags with only tfCalwTwoAssets flag or unset flags
create AmmClawback under transactions
generate new definitions.json
create new AmmClawbackTest transaction test
updated rippled container version to 2.3.0 from 2.2.0-rc3
enable new AMMClawback amendment in rippled.cfg
added integration tests under AmmIt
- one test where we clawback with amount
- one test where we clawback two assets using tfClawbackTwoAssets
- one test where we clawback without amount and only clawback one asset

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

xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/environment/RippledContainer.java

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

xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/AmmIT.java

sappenin · 2025-02-26T00:35:35Z

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

+import org.xrpl.xrpl4j.model.flags.AmmClawbackFlags;
+import org.xrpl.xrpl4j.model.flags.TransactionFlags;
+import org.xrpl.xrpl4j.model.ledger.Issue;
+


Suggested change

import org.xrpl.xrpl4j.model.transactions.Address;

i have added this extra import, but on my IDE it shows as unused.

when i define the type for holder, i do see the Address references this path, but doesn't add the import. is there any reason why this happens?

I don't think you need an import here because AmmClawback and Address are in the same package. We can remove this

i have removed the extra import 👍🏽

sappenin · 2025-02-26T00:39:59Z

xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/AmmIT.java

+    // create Trustline from issuer to trader for currency TST and define two currencies
+    String testCurrency = "TST";
+    TrustSet trustSet = TrustSet.builder()
+        .account(traderKeyPair.publicKey().deriveAddress())


Need to fix formatting - use 2 spaces (no tabs)

after finally being able to build, i have been able to address all of the checkstyle errors

sappenin · 2025-02-26T00:40:48Z

xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/AmmIT.java

+    assertThat(trustlineSubmitResult2.engineResult()).isEqualTo(TransactionResultCodes.TES_SUCCESS);
+
+    // send payment of ZFT to trader wallet from issuer
+    Payment paymentZFT = Payment.builder()


This naming convention breaks our Checkstyle plugin. Need to replace all instances of ...ZFT with Zft. For example:

Suggested change

Payment paymentZFT = Payment.builder()

Payment paymentZft = Payment.builder()

sappenin · 2025-02-26T00:41:28Z

xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/AmmIT.java

+    assertThat(paymentZFTSubmitResult.engineResult()).isEqualTo(TransactionResultCodes.TES_SUCCESS);
+
+    // send payment of TST to trader wallet from issuer
+    Payment paymentTST = Payment.builder()


This naming convention breaks our Checkstyle plugin. Need to replace all instances of ...TFT with Tft. For example:

Suggested change

Payment paymentTST = Payment.builder()

Payment paymentTft = Payment.builder()

i've updated this along with all the other checkstyle issues

sappenin · 2025-02-26T00:43:12Z

xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/AmmIT.java

+    SubmitResult<TrustSet> trustlineSubmitResult2 = xrplClient.submit(signedTrustline2);
+    assertThat(trustlineSubmitResult2.engineResult()).isEqualTo(TransactionResultCodes.TES_SUCCESS);
+
+    // send payment of ZFT to trader wallet from issuer


Consider using real currency names, especially ones that are a familiar, like usd and xrp. It will be one less thing for developers to have keep track of while they seek to understand these tests.

i have replaced TST with USD and replaced ZFT with the existing token xrpl4j

and not sure why, i was able to build before committing... but after committing this last change, now my build constantly fails 😅

upd: build no longer failing

sappenin · 2025-02-26T00:48:17Z

xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/transactions/AmmClawbackTest.java

+        "    \"Fee\" : \"10\",\n" +
+        "    \"Sequence\" : 6,\n" +
+        "    \"SigningPubKey\" : \"02356E89059A75438887F9FEE2056A2890DB82A68353BE9C0C0C8F89C0018B37FC\",\n" +
+        "    \"TransactionType\" : \"AMMClawback\"\n" +


This test currently fails. Need to add this:

Suggested change

" \"TransactionType\" : \"AMMClawback\"\n" +

" \"TransactionType\" : \"AMMClawback\",\n" +

" \"Flags\" : 0" +

thanks for raising the issues in this unit test file, added the extra field to the json and switched to USD from TST

sappenin · 2025-02-26T00:48:58Z

xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/transactions/AmmClawbackTest.java

+                .value("25")
+                .build()
+        )
+        .holder(Address.of("rJVUeRqDFNs2xqA7ncVE6ZoAhPUoaJJSQm"))


This test is failing -- This transaction won't build without specifying asset1 and asset2.

i have addressed all of the failing tests in this unit test file

sappenin · 2025-02-26T00:49:54Z

xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/transactions/AmmClawbackTest.java

+                .value("25")
+                .build()
+        )
+        .holder(Address.of("rJVUeRqDFNs2xqA7ncVE6ZoAhPUoaJJSQm"))


This test is failing -- This transaction won't build without specifying asset1 and asset2.

fixed all the tests in this unit test file, all 3 passing now

sappenin · 2025-02-26T00:50:10Z

xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/transactions/AmmClawbackTest.java

+        .signingPublicKey(
+            PublicKey.fromBase16EncodedPublicKey("02356E89059A75438887F9FEE2056A2890DB82A68353BE9C0C0C8F89C0018B37FC")
+        )
+        .flags((AmmClawbackFlags) AmmClawbackFlags.UNSET)


Suggested change

.flags((AmmClawbackFlags) AmmClawbackFlags.UNSET)

.flags(AmmClawbackFlags.UNSET)

i have removed this unnecessary casting, my IDE was also showing i didnt need this

sappenin · 2025-02-26T00:50:57Z

xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/transactions/AmmClawbackTest.java

+import org.xrpl.xrpl4j.model.flags.TransactionFlags;
+import org.xrpl.xrpl4j.model.ledger.Issue;
+
+public class AmmClawbackTest extends AbstractJsonTest {


Use this as a standard Javadoc for unit tests:

Suggested change

public class AmmClawbackTest extends AbstractJsonTest {

/**

* Unit tests for {@link AmmClawback}.

**/

public class AmmClawbackTest extends AbstractJsonTest {

i have added this, thanks for mentioning i didn't know these were called a "Javadoc"

sappenin · 2025-02-26T00:58:37Z

xrpl4j-core/src/main/resources/definitions.json

        "nth": 258,
-        "isVLEncoded": false,
-        "isSerialized": false,
-        "isSigningField": false,
        "type": "Amount"
      }


What version of rippled did you generate this definitions.json from?

i initially generated the definitions.json using this branch on the xrpl.js library. i compared it to the definitions.json that was commited to that repo after adding support for AMMClawback, and noticed mine was different so i used the same one the xrpl.js library used.

should i instead commit the file i get by running the script again on the latest in rippled's develop branch?

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

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

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

xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/AmmIT.java

xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/environment/RippledContainer.java

agutierrez0 · 2025-03-25T15:40:03Z

@nkramer44 / @sappenin - was looking to wrap up this work, could you PTAL? saw comment on this thread, not sure if we want to wait till that's merged?

sappenin · 2025-03-25T16:10:52Z

@nkramer44 / @sappenin - was looking to wrap up this work, could you PTAL? saw comment on this thread, not sure if we want to wait till that's merged?

@agutierrez0 Please see my code review comments. If they've been addressed, please add a response to let me know to go check. Once addressed, I'll resolve the comments.

sappenin · 2025-03-25T16:11:50Z

xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/transactions/AmmClawbackTest.java

+  @Test
+  void testJson() throws JSONException, JsonProcessingException {
+    AmmClawback ammClawback = AmmClawback.builder()
+        .account(Address.of("rJVUeRqDFNs2xqA7ncVE6ZoAhPUoaJJSQm"))


Please set your tabs to use spaces and set all indent levels to 2.

I have just applied this formatting to all of the files I have changed, these are my IntelliJ settings:

let me know if i should change any of these settings and re apply again

agutierrez0 · 2025-03-25T18:52:20Z

@sappenin i have addressed your requested changes (format change requested today + changes requested on Feb 25th), could you please take a look?

Angel Gutierrez added 12 commits February 9, 2025 14:40

generate definitions.json from xrpl.js script

8c0896e

add amm clawback transaction and transaction flags

f7ede3e

add ammclawback to signature utils

6208633

set up tests, almost full flow working

ad2caee

cleanup test

ccee59b

remove extra print lines

e526d46

make enable rippling private again

c8aab1f

enable AMMClawback amendment, create two integration tests

b1f8c42

add one more integration test

3149b86

add comment for unset flag

ee8054c

add some comments to AmmClawback class

21b1e9d

merge main into this branch

fcd0407

agutierrez0 requested review from nkramer44, nhartner and sappenin as code owners February 19, 2025 21:46

agutierrez0 commented Feb 19, 2025

View reviewed changes

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

agutierrez0 commented Feb 19, 2025

View reviewed changes

xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/environment/RippledContainer.java Show resolved Hide resolved

agutierrez0 commented Feb 19, 2025

View reviewed changes

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/AmmClawback.java Outdated Show resolved Hide resolved

agutierrez0 commented Feb 19, 2025

View reviewed changes

xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/AmmIT.java Show resolved Hide resolved

sappenin requested changes Feb 26, 2025

View reviewed changes

sappenin reviewed Feb 26, 2025

View reviewed changes

Angel Gutierrez added 5 commits February 25, 2025 23:36

fix build by addressing TransactionFlags reference

10b2b50

add Address import to AmmClawback class

850fa74

fix all checkstyle issues, successful build

b030ff5

address issues in unit test

16dc361

address changes for currencies used

ec0c5d2

nkramer44 requested changes Feb 27, 2025

View reviewed changes

Angel Gutierrez added 3 commits February 27, 2025 19:05

add new empty method and add tests for AmmClawbackFlags

60396cd

change default for AmmClawbackFlags to empty instead of Unset

1c92ba8

add multi signature transaction helper test for signature utils

0513be4

Angel Gutierrez added 4 commits February 27, 2025 19:14

update rippled version and fix checkstyle issues

7d8f95d

fix amm clawback test class failing test

6f41e95

remove failing data driven test types

d699102

go back to version 2.3.0 rippled container

f06efc0

nkramer44 self-assigned this Mar 10, 2025

remove extra address import

8984374

agutierrez0 requested review from nkramer44 and sappenin March 11, 2025 21:41

sappenin reviewed Mar 25, 2025

View reviewed changes

Angel Gutierrez added 3 commits March 25, 2025 14:04

apply formatting for files changes

3c03a3a

fix indenting and build

aaeba34

fix more formatting

f67ba31

agutierrez0 requested a review from sappenin March 25, 2025 18:58

nkramer44 assigned nkramer44 and unassigned nkramer44 Mar 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#576: Add support for AMMClawback #601

#576: Add support for AMMClawback #601

agutierrez0 commented Feb 19, 2025 •

edited

Loading

sappenin Feb 26, 2025

agutierrez0 Feb 26, 2025

nkramer44 Mar 10, 2025

agutierrez0 Mar 10, 2025

sappenin Feb 26, 2025

agutierrez0 Feb 26, 2025

sappenin Feb 26, 2025

agutierrez0 Mar 25, 2025

sappenin Feb 26, 2025

agutierrez0 Feb 26, 2025

sappenin Feb 26, 2025

agutierrez0 Feb 26, 2025

agutierrez0 Feb 28, 2025

sappenin Feb 26, 2025

agutierrez0 Feb 26, 2025

sappenin Feb 26, 2025

agutierrez0 Feb 26, 2025

sappenin Feb 26, 2025

agutierrez0 Feb 26, 2025

sappenin Feb 26, 2025

agutierrez0 Feb 26, 2025

sappenin Feb 26, 2025

agutierrez0 Feb 26, 2025

sappenin Feb 26, 2025

agutierrez0 Feb 26, 2025

agutierrez0 commented Mar 25, 2025

sappenin commented Mar 25, 2025

sappenin Mar 25, 2025

agutierrez0 Mar 25, 2025

agutierrez0 commented Mar 25, 2025

	Payment paymentZFT = Payment.builder()
	Payment paymentZft = Payment.builder()

	Payment paymentTST = Payment.builder()
	Payment paymentTft = Payment.builder()

	" \"TransactionType\" : \"AMMClawback\"\n" +
	" \"TransactionType\" : \"AMMClawback\",\n" +
	" \"Flags\" : 0" +

	.flags((AmmClawbackFlags) AmmClawbackFlags.UNSET)
	.flags(AmmClawbackFlags.UNSET)

#576: Add support for AMMClawback #601

Are you sure you want to change the base?

#576: Add support for AMMClawback #601

Conversation

agutierrez0 commented Feb 19, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agutierrez0 commented Mar 25, 2025

sappenin commented Mar 25, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agutierrez0 commented Mar 25, 2025

agutierrez0 commented Feb 19, 2025 •

edited

Loading