Add support for Permissioned DEX - XLS-0081d (#633)

* Add support for Permissioned DEX
* Update existing transactions and ledger objects.
* Add unit tests & ITs for Permissioned DEX
* Update Meta objects for Credentials.
* Update RPC request/response to hold a DomainID
* Update checkstyle to allow `while` statements on the same line.

Author: Patel-Raj11

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/client/path/BookOffersOffer.java

@@ -8,12 +8,14 @@
 import com.google.common.primitives.UnsignedInteger;
 import org.immutables.value.Value;
 import org.xrpl.xrpl4j.model.flags.OfferFlags;
+import org.xrpl.xrpl4j.model.ledger.BookWrapper;
 import org.xrpl.xrpl4j.model.ledger.LedgerObject;
 import org.xrpl.xrpl4j.model.transactions.Address;
 import org.xrpl.xrpl4j.model.transactions.CurrencyAmount;
 import org.xrpl.xrpl4j.model.transactions.Hash256;
 
 import java.math.BigDecimal;
+import java.util.List;
 import java.util.Optional;
 
 /**
@@ -218,4 +220,21 @@ default Optional<BigDecimal> ownerFunds() {
   default BigDecimal quality() {
     return new BigDecimal(qualityString());
   }
-}
+
+  /**
+   * The permissioned domain that the offer is part of.
+   *
+   * @return A {@link Hash256} representing DomainID.
+   */
+  @JsonProperty("DomainID")
+  Optional<Hash256> domainId();
+
+  /**
+   * An additional list of order book directories that this offer belongs to. Currently, this field only applicable to
+   * hybrid offers.
+   *
+   * @return A list of {@link BookWrapper} representing order book directories.
+   */
+  @JsonProperty("AdditionalBooks")
+  List<BookWrapper> additionalBooks();
+}

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/client/path/BookOffersRequestParams.java

@@ -10,6 +10,7 @@
 import org.xrpl.xrpl4j.model.client.common.LedgerSpecifier;
 import org.xrpl.xrpl4j.model.ledger.Issue;
 import org.xrpl.xrpl4j.model.transactions.Address;
+import org.xrpl.xrpl4j.model.transactions.Hash256;
 
 import java.util.Optional;
 
@@ -57,6 +58,16 @@ static ImmutableBookOffersRequestParams.Builder builder() {
   @JsonProperty("taker")
   Optional<Address> taker();
 
+  /**
+   * The object ID of a PermissionedDomain object. If this field is provided, the response will include only valid
+   * domain offers associated with that specific domain. If omitted, the response will include only hybrid and open
+   * offers for the trading pair, excluding all domain-specific offers.
+   *
+   * @return An optionally-present {@link Hash256}.
+   */
+  @JsonProperty("domain")
+  Optional<Hash256> domain();
+
   /**
    * Specifies the ledger version to request. A ledger version can be specified by ledger hash, numerical ledger index,
    * or a shortcut value.
@@ -74,4 +85,4 @@ static ImmutableBookOffersRequestParams.Builder builder() {
    * @return An optionally-present {@link UnsignedInteger}.
    */
   Optional<UnsignedInteger> limit();
-}
+}

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/client/path/RipplePathFindRequestParams.java

@@ -9,9 +9,9 @@
  * 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.
@@ -29,6 +29,7 @@
 import org.xrpl.xrpl4j.model.client.common.LedgerSpecifier;
 import org.xrpl.xrpl4j.model.transactions.Address;
 import org.xrpl.xrpl4j.model.transactions.CurrencyAmount;
+import org.xrpl.xrpl4j.model.transactions.Hash256;
 
 import java.util.List;
 import java.util.Optional;
@@ -72,9 +73,9 @@ static ImmutableRipplePathFindRequestParams.Builder builder() {
    * {@link CurrencyAmount} that the destination account would receive in a transaction.
    *
    * <p>Special case: You can specify "-1" (for XRP) or provide "-1" as the contents of
-   * {@link org.xrpl.xrpl4j.model.transactions.IssuedCurrencyAmount#value()} (for non-XRP currencies).
-   * This requests a path to deliver as much as possible, while spending no more than the amount specified in
-   * {@link #sendMax()} (if provided).
+   * {@link org.xrpl.xrpl4j.model.transactions.IssuedCurrencyAmount#value()} (for non-XRP currencies). This requests a
+   * path to deliver as much as possible, while spending no more than the amount specified in {@link #sendMax()} (if
+   * provided).
    *
    * @return A {@link CurrencyAmount} denoting the destination amount.
    */
@@ -102,12 +103,21 @@ static ImmutableRipplePathFindRequestParams.Builder builder() {
   List<PathCurrency> sourceCurrencies();
 
   /**
-   * Specifies the ledger version to request. A ledger version can be specified by ledger hash,
-   * numerical ledger index, or a shortcut value.
+   * The object ID of a PermissionedDomain object. If this field is included, then only valid paths for this domain will
+   * be returned.
+   *
+   * @return An optionally-present {@link Hash256}.
+   */
+  @JsonProperty("domain")
+  Optional<Hash256> domain();
+
+  /**
+   * Specifies the ledger version to request. A ledger version can be specified by ledger hash, numerical ledger index,
+   * or a shortcut value.
    *
    * @return A {@link LedgerSpecifier} specifying the ledger version to request.
    */
   @JsonUnwrapped
   LedgerSpecifier ledgerSpecifier();
-  
-}
+
+}

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

@@ -9,9 +9,9 @@
  * 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.
@@ -47,6 +47,11 @@ public class OfferCreateFlags extends TransactionFlags {
    */
   protected static final OfferCreateFlags SELL = new OfferCreateFlags(0x00080000L);
 
+  /**
+   * Constant {@link OfferCreateFlags} for the {@code tfHybrid} flag.
+   */
+  protected static final OfferCreateFlags HYBRID = new OfferCreateFlags(0x00100000L);
+
   private OfferCreateFlags(long value) {
     super(value);
   }
@@ -79,21 +84,23 @@ private static OfferCreateFlags of(
     boolean tfPassive,
     boolean tfImmediateOrCancel,
     boolean tfFillOrKill,
-    boolean tfSell
+    boolean tfSell,
+    boolean tfHybrid
   ) {
     long value = Flags.of(
       tfFullyCanonicalSig ? TransactionFlags.FULLY_CANONICAL_SIG : UNSET,
       tfPassive ? PASSIVE : UNSET,
       tfImmediateOrCancel ? IMMEDIATE_OR_CANCEL : UNSET,
       tfFillOrKill ? FILL_OR_KILL : UNSET,
-      tfSell ? SELL : UNSET
+      tfSell ? SELL : UNSET,
+      tfHybrid ? HYBRID : UNSET
     ).getValue();
     return new OfferCreateFlags(value);
   }
 
   /**
-   * Construct an empty instance of {@link OfferCreateFlags}. Transactions with empty flags will
-   * not be serialized with a {@code Flags} field.
+   * Construct an empty instance of {@link OfferCreateFlags}. Transactions with empty flags will not be serialized with
+   * a {@code Flags} field.
    *
    * @return An empty {@link OfferCreateFlags}.
    */
@@ -102,8 +109,8 @@ public static OfferCreateFlags empty() {
   }
 
   /**
-   * If enabled, the offer does not consume offers that exactly match it, and instead becomes an
-   * Offer object in the ledger. It still consumes offers that cross it.
+   * If enabled, the offer does not consume offers that exactly match it, and instead becomes an Offer object in the
+   * ledger. It still consumes offers that cross it.
    *
    * @return {@code true} if {@code tfPassive} is set, otherwise {@code false}.
    */
@@ -112,10 +119,10 @@ public boolean tfPassive() {
   }
 
   /**
-   * Treat the offer as an Immediate or Cancel order . If enabled, the offer never becomes a ledger object:
-   * it only tries to match existing offers in the ledger. If the offer cannot match any offers immediately,
-   * it executes "successfully" without trading any currency. In this case, the transaction has the result code
-   * tesSUCCESS, but creates no Offer objects in the ledger.
+   * Treat the offer as an Immediate or Cancel order . If enabled, the offer never becomes a ledger object: it only
+   * tries to match existing offers in the ledger. If the offer cannot match any offers immediately, it executes
+   * "successfully" without trading any currency. In this case, the transaction has the result code tesSUCCESS, but
+   * creates no Offer objects in the ledger.
    *
    * @return {@code true} if {@code tfImmediateOrCancel} is set, otherwise {@code false}.
    */
@@ -124,10 +131,10 @@ public boolean tfImmediateOrCancel() {
   }
 
   /**
-   * Treat the offer as a Fill or Kill order . Only try to match existing offers in the ledger, and only do so if
-   * the entire TakerPays quantity can be obtained. If the fix1578 amendment is enabled and the offer cannot be
-   * executed when placed, the transaction has the result code tecKILLED; otherwise, the transaction uses the result
-   * code tesSUCCESS even when it was killed without trading any currency.
+   * Treat the offer as a Fill or Kill order . Only try to match existing offers in the ledger, and only do so if the
+   * entire TakerPays quantity can be obtained. If the fix1578 amendment is enabled and the offer cannot be executed
+   * when placed, the transaction has the result code tecKILLED; otherwise, the transaction uses the result code
+   * tesSUCCESS even when it was killed without trading any currency.
    *
    * @return {@code true} if {@code tfFillOrKill} is set, otherwise {@code false}.
    */
@@ -144,6 +151,14 @@ public boolean tfSell() {
     return this.isSet(OfferCreateFlags.SELL);
   }
 
+  /**
+   * Indicates the offer is hybrid.
+   *
+   * @return {@code true} if {@code tfHybrid} is set, otherwise {@code false}.
+   */
+  public boolean tfHybrid() {
+    return this.isSet(OfferCreateFlags.HYBRID);
+  }
 
   /**
    * A builder class for {@link OfferCreateFlags} flags.
@@ -154,6 +169,7 @@ public static class Builder {
     private boolean tfImmediateOrCancel = false;
     private boolean tfFillOrKill = false;
     private boolean tfSell = false;
+    private boolean tfHybrid = false;
 
     /**
      * Set {@code tfPassive} to the given value.
@@ -203,6 +219,18 @@ public Builder tfSell(boolean tfSell) {
       return this;
     }
 
+    /**
+     * Set {@code tfHybrid} to the given value.
+     *
+     * @param tfHybrid A boolean value.
+     *
+     * @return The same {@link Builder}.
+     */
+    public Builder tfHybrid(boolean tfHybrid) {
+      this.tfHybrid = tfHybrid;
+      return this;
+    }
+
     /**
      * Build a new {@link OfferCreateFlags} from the current boolean values.
      *
@@ -214,8 +242,9 @@ public OfferCreateFlags build() {
         tfPassive,
         tfImmediateOrCancel,
         tfFillOrKill,
-        tfSell
+        tfSell,
+        tfHybrid
       );
     }
   }
-}
+}

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

@@ -9,9 +9,9 @@
  * 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.
@@ -37,6 +37,11 @@ public class OfferFlags extends Flags {
    */
   protected static final OfferFlags SELL = new OfferFlags(0x00020000);
 
+  /**
+   * Constant {@link OfferFlags} for the {@code lsfHybrid} flag.
+   */
+  protected static final OfferFlags HYBRID = new OfferFlags(0x00040000);
+
   private OfferFlags(long value) {
     super(value);
   }
@@ -62,12 +67,21 @@ public boolean lsfPassive() {
   }
 
   /**
-   * The object was placed as a sell offer. This has no effect on the object in the ledger (because tfSell only
-   * matters if you get a better rate than you asked for, which cannot happen after the object enters the ledger).
+   * The object was placed as a sell offer. This has no effect on the object in the ledger (because tfSell only matters
+   * if you get a better rate than you asked for, which cannot happen after the object enters the ledger).
    *
    * @return {@code true} if {@code lsfSell} is set, otherwise {@code false}.
    */
   public boolean lsfSell() {
     return this.isSet(SELL);
   }
-}
+
+  /**
+   * Indicates the offer is hybrid. (meaning it is part of both a domain and open order book).
+   *
+   * @return {@code true} if {@code lsfHybrid} is set, otherwise {@code false}.
+   */
+  public boolean lsfHybrid() {
+    return this.isSet(HYBRID);
+  }
+}

xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/ledger/Book.java

@@ -0,0 +1,63 @@
+package org.xrpl.xrpl4j.model.ledger;
+
+/*-
+ * ========================LICENSE_START=================================
+ * xrpl4j :: model
+ * %%
+ * Copyright (C) 2020 - 2022 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 com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import org.immutables.value.Value.Immutable;
+import org.xrpl.xrpl4j.model.transactions.Hash256;
+
+/**
+ * Object referencing a specific page of an offer directory.
+ */
+@Immutable
+@JsonSerialize(as = ImmutableBook.class)
+@JsonDeserialize(as = ImmutableBook.class)
+public interface Book {
+
+  /**
+   * Construct a builder for this class.
+   *
+   * @return An {@link ImmutableBook.Builder}.
+   */
+  static ImmutableBook.Builder builder() {
+    return ImmutableBook.builder();
+  }
+
+  /**
+   * The ID of the Offer Directory that links to this offer.
+   *
+   * @return A {@link Hash256} containing the ID.
+   */
+  @JsonProperty("BookDirectory")
+  Hash256 bookDirectory();
+
+  /**
+   * A hint indicating which page of the offer directory links to this object, in case the directory consists of
+   * multiple pages.
+   *
+   * @return A {@link String} containing the hint.
+   */
+  @JsonProperty("BookNode")
+  String bookNode();
+
+}