feat: add support for non-root authorization in SorobanServer#simulateTransaction. (#708)

Author: overcat

CHANGELOG.md

@@ -11,6 +11,7 @@
 - feat: add `destinationMuxedId` and `destinationMuxedIdType` to `InvokeHostFunctionOperationResponse.AssetContractBalanceChange`.
 - feat: add `events` field to `GetTransactionsResponse.Transaction` and `GetTransactionResponse`, see [stellar-rpc#455](https://github.com/stellar/stellar-rpc/pull/455) for more details.
 - feat: add `oldestLedger`, `latestLedgerCloseTime` and `oldestLedgerCloseTime` fields to `GetEventsResponse`, and add `transactionIndex` and `operationIndex` fields to `GetEventsResponse.EventInfo`, check [Stellar RPC release log](https://github.com/stellar/stellar-rpc/releases/tag/v23.0.0-rc.1) for more information. 
+- feat: add support for non-root authorization in `SorobanServer#simulateTransaction`.
 
 ### Breaking changes:
 - refactor!: the following functions in `StrKey` are marked as deprecated, they will be removed in the next major release; please refer to the documentation for each function to see the corresponding replacement functions:

src/main/java/org/stellar/sdk/SorobanServer.java

@@ -489,6 +489,7 @@ public GetLatestLedgerResponse getLatestLedger() {
    *     org.stellar.sdk.operations.RestoreFootprintOperation}. Any provided footprint will be
    *     ignored.
    * @param resourceConfig Additional resource include in the simulation.
+   * @param authMode Explicitly allows users to opt-in to non-root authorization in recording mode.
    * @return A {@link SimulateTransactionResponse} object containing the cost, footprint,
    *     result/auth requirements (if applicable), and error of the transaction.
    * @throws org.stellar.sdk.exception.NetworkException All the exceptions below are subclasses of
@@ -502,10 +503,12 @@ public GetLatestLedgerResponse getLatestLedger() {
    *     target="_blank">simulateTransaction documentation</a>
    */
   public SimulateTransactionResponse simulateTransaction(
-      Transaction transaction, @Nullable SimulateTransactionRequest.ResourceConfig resourceConfig) {
+      Transaction transaction,
+      @Nullable SimulateTransactionRequest.ResourceConfig resourceConfig,
+      @Nullable SimulateTransactionRequest.AuthMode authMode) {
     // TODO: In the future, it may be necessary to consider FeeBumpTransaction.
     SimulateTransactionRequest params =
-        new SimulateTransactionRequest(transaction.toEnvelopeXdrBase64(), resourceConfig);
+        new SimulateTransactionRequest(transaction.toEnvelopeXdrBase64(), resourceConfig, authMode);
     return this.sendRequest(
         "simulateTransaction",
         params,
@@ -514,10 +517,11 @@ public SimulateTransactionResponse simulateTransaction(
 
   /**
    * An alias for {@link #simulateTransaction(Transaction,
-   * SimulateTransactionRequest.ResourceConfig)} with no resource leeway.
+   * SimulateTransactionRequest.ResourceConfig, SimulateTransactionRequest.AuthMode)} with no
+   * resource leeway, and no auth mode set.
    */
   public SimulateTransactionResponse simulateTransaction(Transaction transaction) {
-    return simulateTransaction(transaction, null);
+    return simulateTransaction(transaction, null, null);
   }
 
   /**

src/main/java/org/stellar/sdk/requests/sorobanrpc/SimulateTransactionRequest.java

@@ -1,5 +1,6 @@
 package org.stellar.sdk.requests.sorobanrpc;
 
+import com.google.gson.annotations.SerializedName;
 import java.math.BigInteger;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -18,6 +19,26 @@ public class SimulateTransactionRequest {
 
   ResourceConfig resourceConfig;
 
+  /**
+   * Explicitly allows users to opt-in to non-root authorization in recording mode.
+   *
+   * <p>Leaving this field unset will default to {@link AuthMode#ENFORCE} if auth entries are
+   * present, {@link AuthMode#RECORD} otherwise.
+   */
+  AuthMode authMode;
+
+  public enum AuthMode {
+    /** Always enforce mode, even with an empty list. */
+    @SerializedName("enforce")
+    ENFORCE,
+    /** Always recording mode, failing if any auth exists. */
+    @SerializedName("record")
+    RECORD,
+    /** Like {@code RECORD}, but allowing non-root authorization. */
+    @SerializedName("record_allow_nonroot")
+    RECORD_ALLOW_NONROOT;
+  }
+
   @Value
   @AllArgsConstructor
   @Builder

src/test/java/org/stellar/sdk/SorobanServerTest.java

@@ -997,7 +997,79 @@ public MockResponse dispatch(@NotNull RecordedRequest recordedRequest)
 
     SimulateTransactionRequest.ResourceConfig resourceConfig =
         new SimulateTransactionRequest.ResourceConfig(cpuInstructions);
-    SimulateTransactionResponse resp = server.simulateTransaction(transaction, resourceConfig);
+    SimulateTransactionResponse resp =
+        server.simulateTransaction(transaction, resourceConfig, null);
+    assertEquals(resp.getLatestLedger().longValue(), 14245L);
+    assertEquals(
+        resp.getTransactionData(),
+        "AAAAAAAAAAIAAAAGAAAAAem354u9STQWq5b3Ed1j9tOemvL7xV0NPwhn4gXg0AP8AAAAFAAAAAEAAAAH8dTe2OoI0BnhlDbH0fWvXmvprkBvBAgKIcL9busuuMEAAAABAAAABgAAAAHpt+eLvUk0FquW9xHdY/bTnpry+8VdDT8IZ+IF4NAD/AAAABAAAAABAAAAAgAAAA8AAAAHQ291bnRlcgAAAAASAAAAAAAAAABYt8SiyPKXqo89JHEoH9/M7K/kjlZjMT7BjhKnPsqYoQAAAAEAHifGAAAFlAAAAIgAAAAAAAAAAg==");
+    assertEquals(resp.getEvents().size(), 2);
+    assertEquals(
+        resp.getEvents().get(0),
+        "AAAAAQAAAAAAAAAAAAAAAgAAAAAAAAADAAAADwAAAAdmbl9jYWxsAAAAAA0AAAAg6bfni71JNBarlvcR3WP2056a8vvFXQ0/CGfiBeDQA/wAAAAPAAAACWluY3JlbWVudAAAAAAAABAAAAABAAAAAgAAABIAAAAAAAAAAFi3xKLI8peqjz0kcSgf38zsr+SOVmMxPsGOEqc+ypihAAAAAwAAAAo=");
+    assertEquals(
+        resp.getEvents().get(1),
+        "AAAAAQAAAAAAAAAB6bfni71JNBarlvcR3WP2056a8vvFXQ0/CGfiBeDQA/wAAAACAAAAAAAAAAIAAAAPAAAACWZuX3JldHVybgAAAAAAAA8AAAAJaW5jcmVtZW50AAAAAAAAAwAAABQ=");
+    assertEquals(resp.getMinResourceFee().longValue(), 58181L);
+    assertEquals(resp.getResults().size(), 1);
+    assertEquals(resp.getResults().get(0).getAuth().size(), 1);
+    assertEquals(
+        resp.getResults().get(0).getAuth().get(0),
+        "AAAAAAAAAAAAAAAB6bfni71JNBarlvcR3WP2056a8vvFXQ0/CGfiBeDQA/wAAAAJaW5jcmVtZW50AAAAAAAAAgAAABIAAAAAAAAAAFi3xKLI8peqjz0kcSgf38zsr+SOVmMxPsGOEqc+ypihAAAAAwAAAAoAAAAA");
+    assertEquals(resp.getResults().get(0).getXdr(), "AAAAAwAAABQ=");
+    server.close();
+    mockWebServer.close();
+  }
+
+  @Test
+  public void testSimulateTransactionWithAuthMode() throws IOException, SorobanRpcException {
+    String filePath =
+        "src/test/resources/soroban_server/simulate_transaction_with_resource_leeway.json";
+    String json = new String(Files.readAllBytes(Paths.get(filePath)));
+    Transaction transaction = buildSorobanTransaction(null, null);
+    BigInteger cpuInstructions = BigInteger.valueOf(20000L);
+    MockWebServer mockWebServer = new MockWebServer();
+    Dispatcher dispatcher =
+        new Dispatcher() {
+          @NotNull
+          @Override
+          public MockResponse dispatch(@NotNull RecordedRequest recordedRequest)
+              throws InterruptedException {
+            SorobanRpcRequest<SimulateTransactionRequest> sorobanRpcRequest =
+                gson.fromJson(
+                    recordedRequest.getBody().readUtf8(),
+                    new TypeToken<SorobanRpcRequest<SimulateTransactionRequest>>() {}.getType());
+            if ("POST".equals(recordedRequest.getMethod())
+                && sorobanRpcRequest.getMethod().equals("simulateTransaction")
+                && sorobanRpcRequest
+                    .getParams()
+                    .getTransaction()
+                    .equals(transaction.toEnvelopeXdrBase64())
+                && sorobanRpcRequest
+                    .getParams()
+                    .getResourceConfig()
+                    .getInstructionLeeway()
+                    .equals(cpuInstructions)
+                && sorobanRpcRequest
+                    .getParams()
+                    .getAuthMode()
+                    .equals(SimulateTransactionRequest.AuthMode.RECORD_ALLOW_NONROOT)) {
+              return new MockResponse().setResponseCode(200).setBody(json);
+            }
+            return new MockResponse().setResponseCode(404);
+          }
+        };
+    mockWebServer.setDispatcher(dispatcher);
+    mockWebServer.start();
+
+    HttpUrl baseUrl = mockWebServer.url("");
+    SorobanServer server = new SorobanServer(baseUrl.toString());
+
+    SimulateTransactionRequest.ResourceConfig resourceConfig =
+        new SimulateTransactionRequest.ResourceConfig(cpuInstructions);
+    SimulateTransactionResponse resp =
+        server.simulateTransaction(
+            transaction, resourceConfig, SimulateTransactionRequest.AuthMode.RECORD_ALLOW_NONROOT);
     assertEquals(resp.getLatestLedger().longValue(), 14245L);
     assertEquals(
         resp.getTransactionData(),