rename MpTokenObjectamount to MpTokenNumericAmount

nkramer44 · nkramer44 · commit b35789bc654c · 2025-03-25T13:49:54.000-04:00
diff --git a/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/client/ledger/LedgerEntryRequestParams.java b/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/client/ledger/LedgerEntryRequestParams.java
@@ -28,7 +28,6 @@
 import org.xrpl.xrpl4j.model.transactions.Address;
 import org.xrpl.xrpl4j.model.transactions.Hash256;
 import org.xrpl.xrpl4j.model.transactions.MpTokenIssuanceId;
-import org.xrpl.xrpl4j.model.transactions.MpTokenObjectAmount;
 import org.xrpl.xrpl4j.model.transactions.XChainBridge;
 
 import java.util.Optional;
diff --git a/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/client/mpt/MptHoldersMpToken.java b/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/client/mpt/MptHoldersMpToken.java
@@ -7,8 +7,7 @@
 import org.xrpl.xrpl4j.model.flags.MpTokenFlags;
 import org.xrpl.xrpl4j.model.transactions.Address;
 import org.xrpl.xrpl4j.model.transactions.Hash256;
-import org.xrpl.xrpl4j.model.transactions.MpTokenAmount;
-import org.xrpl.xrpl4j.model.transactions.MpTokenObjectAmount;
+import org.xrpl.xrpl4j.model.transactions.MpTokenNumericAmount;
 
 import java.util.Optional;
 
@@ -46,18 +45,18 @@ static ImmutableMptHoldersMpToken.Builder builder() {
   /**
    * The balance of this MPToken.
    *
-   * @return An {@link MpTokenObjectAmount}.
+   * @return An {@link MpTokenNumericAmount}.
    */
   @JsonProperty("mpt_amount")
-  MpTokenObjectAmount mptAmount();
+  MpTokenNumericAmount mptAmount();
 
   /**
    * The amount of MPToken that is locked.
    *
-   * @return An optionally present {@link MpTokenObjectAmount}.
+   * @return An optionally present {@link MpTokenNumericAmount}.
    */
   @JsonProperty("locked_amount")
-  Optional<MpTokenObjectAmount> lockedAmount();
+  Optional<MpTokenNumericAmount> lockedAmount();
 
   /**
    * The index of this MPToken.
diff --git a/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/jackson/modules/MpTokenNumericAmountDeserializer.java b/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/jackson/modules/MpTokenNumericAmountDeserializer.java
@@ -0,0 +1,29 @@
+package org.xrpl.xrpl4j.model.jackson.modules;
+
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
+import com.google.common.primitives.UnsignedLong;
+import org.xrpl.xrpl4j.model.transactions.MpTokenNumericAmount;
+
+import java.io.IOException;
+
+/**
+ * Custom Jackson deserializer for {@link MpTokenNumericAmount}s.
+ */
+public class MpTokenNumericAmountDeserializer extends StdDeserializer<MpTokenNumericAmount> {
+
+  /**
+   * No-args constructor.
+   */
+  public MpTokenNumericAmountDeserializer() {
+    super(MpTokenNumericAmount.class);
+  }
+
+  @Override
+  public MpTokenNumericAmount deserialize(JsonParser jsonParser, DeserializationContext ctxt) throws IOException {
+    // sfMaximumAmount is an STUInt64, which in JSON is normally represented in base 16, but sfMaximumAmount is
+    // in base 10
+    return MpTokenNumericAmount.of(UnsignedLong.valueOf(jsonParser.getText()));
+  }
+}
diff --git a/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/jackson/modules/MpTokenNumericAmountSerializer.java b/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/jackson/modules/MpTokenNumericAmountSerializer.java
@@ -3,24 +3,24 @@
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.SerializerProvider;
 import com.fasterxml.jackson.databind.ser.std.StdScalarSerializer;
-import org.xrpl.xrpl4j.model.transactions.MpTokenObjectAmount;
+import org.xrpl.xrpl4j.model.transactions.MpTokenNumericAmount;
 
 import java.io.IOException;
 
 /**
- * Custom Jackson serializer for {@link MpTokenObjectAmount}s.
+ * Custom Jackson serializer for {@link MpTokenNumericAmount}s.
  */
-public class MpTokenObjectAmountSerializer extends StdScalarSerializer<MpTokenObjectAmount> {
+public class MpTokenNumericAmountSerializer extends StdScalarSerializer<MpTokenNumericAmount> {
 
   /**
    * No-args constructor.
    */
-  public MpTokenObjectAmountSerializer() {
-    super(MpTokenObjectAmount.class, false);
+  public MpTokenNumericAmountSerializer() {
+    super(MpTokenNumericAmount.class, false);
   }
 
   @Override
-  public void serialize(MpTokenObjectAmount count, JsonGenerator gen, SerializerProvider provider) throws IOException {
+  public void serialize(MpTokenNumericAmount count, JsonGenerator gen, SerializerProvider provider) throws IOException {
     // sfMaximumAmount is an STUInt64, which in JSON is normally represented in base 16, but sfMaximumAmount is
     // in base 10
     gen.writeString(count.value().toString());
diff --git a/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/jackson/modules/MpTokenObjectAmountDeserializer.java b/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/jackson/modules/MpTokenObjectAmountDeserializer.java
diff --git a/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/ledger/MpTokenIssuanceObject.java b/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/ledger/MpTokenIssuanceObject.java
@@ -12,7 +12,7 @@
 import org.xrpl.xrpl4j.model.transactions.Hash256;
 import org.xrpl.xrpl4j.model.transactions.MpTokenIssuanceId;
 import org.xrpl.xrpl4j.model.transactions.MpTokenMetadata;
-import org.xrpl.xrpl4j.model.transactions.MpTokenObjectAmount;
+import org.xrpl.xrpl4j.model.transactions.MpTokenNumericAmount;
 import org.xrpl.xrpl4j.model.transactions.TransferFee;
 
 import java.util.Optional;
@@ -91,18 +91,18 @@ default AssetScale assetScale() {
   /**
    * The maximum number of this issuance that can be distributed to non-issuing accounts.
    *
-   * @return An optionally present {@link MpTokenObjectAmount}.
+   * @return An optionally present {@link MpTokenNumericAmount}.
    */
   @JsonProperty("MaximumAmount")
-  Optional<MpTokenObjectAmount> maximumAmount();
+  Optional<MpTokenNumericAmount> maximumAmount();
 
   /**
    * The sum of all token amounts that have been minted to all token holders.
    *
-   * @return An {@link MpTokenObjectAmount}.
+   * @return An {@link MpTokenNumericAmount}.
    */
   @JsonProperty("OutstandingAmount")
-  MpTokenObjectAmount outstandingAmount();
+  MpTokenNumericAmount outstandingAmount();
 
   /**
    * Arbitrary hex-encoded metadata about this issuance.
diff --git a/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/ledger/MpTokenObject.java b/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/ledger/MpTokenObject.java
@@ -7,13 +7,10 @@
 import org.immutables.value.Value;
 import org.immutables.value.Value.Immutable;
 import org.xrpl.xrpl4j.model.flags.MpTokenFlags;
-import org.xrpl.xrpl4j.model.flags.MpTokenIssuanceFlags;
 import org.xrpl.xrpl4j.model.transactions.Address;
-import org.xrpl.xrpl4j.model.transactions.AssetScale;
 import org.xrpl.xrpl4j.model.transactions.Hash256;
 import org.xrpl.xrpl4j.model.transactions.MpTokenIssuanceId;
-import org.xrpl.xrpl4j.model.transactions.MpTokenObjectAmount;
-import org.xrpl.xrpl4j.model.transactions.TransferFee;
+import org.xrpl.xrpl4j.model.transactions.MpTokenNumericAmount;
 
 import java.util.Optional;
 
@@ -67,12 +64,12 @@ default LedgerEntryType ledgerEntryType() {
   /**
    * The balance of this MPToken. Defaults to 0.
    *
-   * @return An {@link MpTokenObjectAmount}.
+   * @return An {@link MpTokenNumericAmount}.
    */
   @JsonProperty("MPTAmount")
   @Value.Default
-  default MpTokenObjectAmount mptAmount() {
-    return MpTokenObjectAmount.of(0);
+  default MpTokenNumericAmount mptAmount() {
+    return MpTokenNumericAmount.of(0);
   }
 
   /**
diff --git a/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/MpTokenAmount.java b/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/MpTokenAmount.java
@@ -27,6 +27,17 @@ static ImmutableMpTokenAmount.Builder builder() {
     return ImmutableMpTokenAmount.builder();
   }
 
+  /**
+   * Construct a {@code MpTokenAmount} builder, setting {@link #value()} to the string representation of the
+   * supplied {@link UnsignedLong}.
+   *
+   * @return An {@link ImmutableMpTokenAmount.Builder}.
+   */
+  static ImmutableMpTokenAmount.Builder builder(UnsignedLong value) {
+    return ImmutableMpTokenAmount.builder()
+      .value(value.toString());
+  }
+
   @JsonProperty("mpt_issuance_id")
   MpTokenIssuanceId mptIssuanceId();
 
diff --git a/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/MpTokenIssuanceCreate.java b/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/MpTokenIssuanceCreate.java
@@ -65,10 +65,10 @@ default MpTokenIssuanceCreateFlags flags() {
    * implementation will set this to an empty default field value, which will be interpreted at runtime as the current
    * maximum allowed value (currently 0x7FFF'FFFF'FFFF'FFFF).
    *
-   * @return An optionally present {@link MpTokenObjectAmount}.
+   * @return An optionally present {@link MpTokenNumericAmount}.
    */
   @JsonProperty("MaximumAmount")
-  Optional<MpTokenObjectAmount> maximumAmount();
+  Optional<MpTokenNumericAmount> maximumAmount();
 
   /**
    * Arbitrary metadata about this issuance, in hex format. The limit for this field is 1024 bytes.
diff --git a/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/Wrappers.java b/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/Wrappers.java
@@ -54,8 +54,8 @@
 import org.xrpl.xrpl4j.model.jackson.modules.MpTokenIssuanceIdSerializer;
 import org.xrpl.xrpl4j.model.jackson.modules.MpTokenMetadataDeserializer;
 import org.xrpl.xrpl4j.model.jackson.modules.MpTokenMetadataSerializer;
-import org.xrpl.xrpl4j.model.jackson.modules.MpTokenObjectAmountDeserializer;
-import org.xrpl.xrpl4j.model.jackson.modules.MpTokenObjectAmountSerializer;
+import org.xrpl.xrpl4j.model.jackson.modules.MpTokenNumericAmountDeserializer;
+import org.xrpl.xrpl4j.model.jackson.modules.MpTokenNumericAmountSerializer;
 import org.xrpl.xrpl4j.model.jackson.modules.NetworkIdDeserializer;
 import org.xrpl.xrpl4j.model.jackson.modules.NetworkIdSerializer;
 import org.xrpl.xrpl4j.model.jackson.modules.NfTokenIdDeserializer;
@@ -800,13 +800,13 @@ public String toString() {
 
   @Value.Immutable
   @Wrapped
-  @JsonSerialize(as = MpTokenObjectAmount.class, using = MpTokenObjectAmountSerializer.class)
-  @JsonDeserialize(as = MpTokenObjectAmount.class, using = MpTokenObjectAmountDeserializer.class)
+  @JsonSerialize(as = MpTokenNumericAmount.class, using = MpTokenNumericAmountSerializer.class)
+  @JsonDeserialize(as = MpTokenNumericAmount.class, using = MpTokenNumericAmountDeserializer.class)
   @Beta
-  abstract static class _MpTokenObjectAmount extends Wrapper<UnsignedLong> implements Serializable {
+  abstract static class _MpTokenNumericAmount extends Wrapper<UnsignedLong> implements Serializable {
 
-    public static MpTokenObjectAmount of(long amount) {
-      return MpTokenObjectAmount.of(UnsignedLong.valueOf(amount));
+    public static MpTokenNumericAmount of(long amount) {
+      return MpTokenNumericAmount.of(UnsignedLong.valueOf(amount));
     }
 
     @Override
diff --git a/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/metadata/MetaMpTokenIssuanceObject.java b/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/metadata/MetaMpTokenIssuanceObject.java
@@ -4,15 +4,12 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.google.common.primitives.UnsignedInteger;
-import org.immutables.value.Value;
 import org.immutables.value.Value.Immutable;
 import org.xrpl.xrpl4j.model.flags.MpTokenIssuanceFlags;
-import org.xrpl.xrpl4j.model.ledger.ImmutableMpTokenIssuanceObject;
-import org.xrpl.xrpl4j.model.ledger.LedgerObject;
 import org.xrpl.xrpl4j.model.transactions.Address;
 import org.xrpl.xrpl4j.model.transactions.AssetScale;
 import org.xrpl.xrpl4j.model.transactions.Hash256;
-import org.xrpl.xrpl4j.model.transactions.MpTokenObjectAmount;
+import org.xrpl.xrpl4j.model.transactions.MpTokenNumericAmount;
 import org.xrpl.xrpl4j.model.transactions.TransferFee;
 
 import java.util.Optional;
@@ -32,10 +29,10 @@ public interface MetaMpTokenIssuanceObject extends MetaLedgerObject {
   Optional<AssetScale> assetScale();
 
   @JsonProperty("MaximumAmount")
-  Optional<MpTokenObjectAmount> maximumAmount();
+  Optional<MpTokenNumericAmount> maximumAmount();
 
   @JsonProperty("OutstandingAmount")
-  Optional<MpTokenObjectAmount> outstandingAmount();
+  Optional<MpTokenNumericAmount> outstandingAmount();
 
   @JsonProperty("TransferFee")
   Optional<TransferFee> transferFee();
diff --git a/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/metadata/MetaMpTokenObject.java b/xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/transactions/metadata/MetaMpTokenObject.java
@@ -4,15 +4,12 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.google.common.primitives.UnsignedInteger;
-import org.immutables.value.Value;
 import org.immutables.value.Value.Immutable;
 import org.xrpl.xrpl4j.model.flags.MpTokenFlags;
-import org.xrpl.xrpl4j.model.ledger.ImmutableMpTokenObject;
-import org.xrpl.xrpl4j.model.ledger.LedgerObject;
 import org.xrpl.xrpl4j.model.transactions.Address;
 import org.xrpl.xrpl4j.model.transactions.Hash256;
 import org.xrpl.xrpl4j.model.transactions.MpTokenIssuanceId;
-import org.xrpl.xrpl4j.model.transactions.MpTokenObjectAmount;
+import org.xrpl.xrpl4j.model.transactions.MpTokenNumericAmount;
 
 import java.util.Optional;
 
@@ -31,7 +28,7 @@ public interface MetaMpTokenObject extends MetaLedgerObject {
   Optional<MpTokenIssuanceId> mpTokenIssuanceId();
 
   @JsonProperty("MPTAmount")
-  Optional<MpTokenObjectAmount> mptAmount();
+  Optional<MpTokenNumericAmount> mptAmount();
 
   /**
    * The identifying hash of the transaction that most recently modified this object.
diff --git a/xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/client/mpt/MptHoldersResponseTest.java b/xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/client/mpt/MptHoldersResponseTest.java
@@ -11,9 +11,8 @@
 import org.xrpl.xrpl4j.model.client.common.LedgerIndex;
 import org.xrpl.xrpl4j.model.flags.MpTokenFlags;
 import org.xrpl.xrpl4j.model.transactions.Hash256;
-import org.xrpl.xrpl4j.model.transactions.MpTokenAmount;
 import org.xrpl.xrpl4j.model.transactions.MpTokenIssuanceId;
-import org.xrpl.xrpl4j.model.transactions.MpTokenObjectAmount;
+import org.xrpl.xrpl4j.model.transactions.MpTokenNumericAmount;
 
 class MptHoldersResponseTest extends AbstractJsonTest {
 
@@ -26,8 +25,8 @@ void testJson() throws JSONException, JsonProcessingException {
         MptHoldersMpToken.builder()
           .account(ED_ADDRESS)
           .flags(MpTokenFlags.UNSET)
-          .mptAmount(MpTokenObjectAmount.of(20))
-          .lockedAmount(MpTokenObjectAmount.of(1))
+          .mptAmount(MpTokenNumericAmount.of(20))
+          .lockedAmount(MpTokenNumericAmount.of(1))
           .mpTokenIndex(Hash256.of("36D91DEE5EFE4A93119A8B84C944A528F2B444329F3846E49FE921040DE17E65"))
           .build()
       )
diff --git a/xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/ledger/MpTokenIssuanceObjectTest.java b/xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/ledger/MpTokenIssuanceObjectTest.java
@@ -13,7 +13,7 @@
 import org.xrpl.xrpl4j.model.transactions.Hash256;
 import org.xrpl.xrpl4j.model.transactions.MpTokenIssuanceId;
 import org.xrpl.xrpl4j.model.transactions.MpTokenMetadata;
-import org.xrpl.xrpl4j.model.transactions.MpTokenObjectAmount;
+import org.xrpl.xrpl4j.model.transactions.MpTokenNumericAmount;
 import org.xrpl.xrpl4j.model.transactions.TransferFee;
 
 class MpTokenIssuanceObjectTest extends AbstractJsonTest {
@@ -25,8 +25,8 @@ void testJson() throws JSONException, JsonProcessingException {
       .flags(MpTokenIssuanceFlags.of(122))
       .issuer(Address.of("rJo2Wu7dymuFaL3QgYaEwgAEN3VcgN8e8c"))
       .mpTokenMetadata(MpTokenMetadata.of("ABCD"))
-      .maximumAmount(MpTokenObjectAmount.of(9223372036854775807L))
-      .outstandingAmount(MpTokenObjectAmount.of(0))
+      .maximumAmount(MpTokenNumericAmount.of(9223372036854775807L))
+      .outstandingAmount(MpTokenNumericAmount.of(0))
       .ownerNode("0")
       .previousTransactionId(Hash256.of("8C20A85CE9EA44CEF32C8B06209890154D8810A8409D8582884566CD24DE694F"))
       .previousTransactionLedgerSequence(UnsignedInteger.valueOf(420))
@@ -62,8 +62,8 @@ void testTransferFeeAndAssetScaleDefaultToZero() {
       .flags(MpTokenIssuanceFlags.of(122))
       .issuer(Address.of("rJo2Wu7dymuFaL3QgYaEwgAEN3VcgN8e8c"))
       .mpTokenMetadata(MpTokenMetadata.of("ABCD"))
-      .maximumAmount(MpTokenObjectAmount.of(9223372036854775807L))
-      .outstandingAmount(MpTokenObjectAmount.of(0))
+      .maximumAmount(MpTokenNumericAmount.of(9223372036854775807L))
+      .outstandingAmount(MpTokenNumericAmount.of(0))
       .ownerNode("0")
       .previousTransactionId(Hash256.of("8C20A85CE9EA44CEF32C8B06209890154D8810A8409D8582884566CD24DE694F"))
       .previousTransactionLedgerSequence(UnsignedInteger.valueOf(420))
diff --git a/xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/ledger/MpTokenObjectTest.java b/xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/ledger/MpTokenObjectTest.java
@@ -11,7 +11,7 @@
 import org.xrpl.xrpl4j.model.transactions.Address;
 import org.xrpl.xrpl4j.model.transactions.Hash256;
 import org.xrpl.xrpl4j.model.transactions.MpTokenIssuanceId;
-import org.xrpl.xrpl4j.model.transactions.MpTokenObjectAmount;
+import org.xrpl.xrpl4j.model.transactions.MpTokenNumericAmount;
 
 class MpTokenObjectTest extends AbstractJsonTest {
 
@@ -20,7 +20,7 @@ void testJson() throws JSONException, JsonProcessingException {
     MpTokenObject mpTokenObject = MpTokenObject.builder()
       .account(Address.of("rUKufYPXYm5SRyfAQyn49j7fkMi4A8iwZ6"))
       .flags(MpTokenFlags.UNSET)
-      .mptAmount(MpTokenObjectAmount.of(100000))
+      .mptAmount(MpTokenNumericAmount.of(100000))
       .mpTokenIssuanceId(MpTokenIssuanceId.of("0000014A338173F978C65EB486DF107E9662F2E847A70F8A"))
       .ownerNode("0")
       .previousTransactionId(Hash256.of("F74BB6C80570839BBD4B9DE198BD1A3E7C633659250BA2BE5763A58068DF3C11"))
@@ -54,7 +54,7 @@ void testDefaultFields() {
       .index(Hash256.of("0B5F0A170BA45CB6BCF4B92319D63287429F4B7E7024C82AFB4D4275C43F5A6C"))
       .build();
 
-    assertThat(mpTokenObject.mptAmount()).isEqualTo(MpTokenObjectAmount.of(0));
+    assertThat(mpTokenObject.mptAmount()).isEqualTo(MpTokenNumericAmount.of(0));
     assertThat(mpTokenObject.ledgerEntryType()).isEqualTo(LedgerObject.LedgerEntryType.MP_TOKEN);
   }
 }
diff --git a/xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/transactions/MpTokenAmountTest.java b/xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/transactions/MpTokenAmountTest.java
diff --git a/xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/transactions/MpTokenIssuanceCreateTest.java b/xrpl4j-core/src/test/java/org/xrpl/xrpl4j/model/transactions/MpTokenIssuanceCreateTest.java
diff --git a/xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/MpTokenIT.java b/xrpl4j-integration-tests/src/test/java/org/xrpl/xrpl4j/tests/MpTokenIT.java
