feat: add simulate RPC to dry-run a tx (XLS-69d)

API-CHANGELOG.md

@@ -26,15 +26,25 @@ In `api_version: 2`, the `signer_lists` field [will be moved](#modifications-to-
 
 The `network_id` field was added in the `server_info` response in version 1.5.0 (2019), but it is not returned in [reporting mode](https://xrpl.org/rippled-server-modes.html#reporting-mode).
 
-## XRP Ledger server version 2.0.0
+## XRP Ledger server version 2.3.0
+
+### Additions
+
+Additions are intended to be non-breaking (because they are purely additive).
 
-### Additions in 2.2
+- `simulate`: A new RPC that executes a dry run of a transaction submission without actually submitting it to the network for inclusion.
+
+## XRP Ledger server version 2.2.0
+
+### Additions
 
 Additions are intended to be non-breaking (because they are purely additive).
 
 - `feature`: A non-admin mode that uses the same formatting as admin RPC, but hides potentially-sensitive data.
 
-### Additions in 2.0
+## XRP Ledger server version 2.0.0
+
+### Additions
 
 Additions are intended to be non-breaking (because they are purely additive).
 
@@ -46,7 +56,7 @@ Additions are intended to be non-breaking (because they are purely additive).
 
 [Version 1.12.0](https://github.com/XRPLF/rippled/releases/tag/1.12.0) was released on Sep 6, 2023.
 
-### Additions in 1.12
+### Additions
 
 Additions are intended to be non-breaking (because they are purely additive).
 
@@ -88,7 +98,7 @@ Additions are intended to be non-breaking (because they are purely additive).
 
 [Version 1.11.0](https://github.com/XRPLF/rippled/releases/tag/1.11.0) was released on Jun 20, 2023.
 
-### Breaking changes in 1.11
+### Breaking changes
 
 - Added the ability to mark amendments as obsolete. For the `feature` admin API, there is a new possible value for the `vetoed` field. (https://github.com/XRPLF/rippled/pull/4291)
   - The value of `vetoed` can now be `true`, `false`, or `"Obsolete"`.
@@ -107,7 +117,7 @@ Additions are intended to be non-breaking (because they are purely additive).
     - `telREQUIRES_NETWORK_ID`: a `NetworkID` is required, but is not present. Add the field to the transaction, and try again.
     - `telWRONG_NETWORK`: a `NetworkID` is specified, but it is for a different network. Submit the transaction to a different server which is connected to the correct network.
 
-### Additions and bug fixes in 1.11
+### Additions and bug fixes
 
 - Added `nftoken_id`, `nftoken_ids` and `offer_id` meta fields into NFT `tx` and `account_tx` responses. (https://github.com/XRPLF/rippled/pull/4447)
 - Added an `account_flags` object to the `account_info` method response. (https://github.com/XRPLF/rippled/pull/4459)
@@ -119,7 +129,7 @@ Additions are intended to be non-breaking (because they are purely additive).
 [Version 1.10.0](https://github.com/XRPLF/rippled/releases/tag/1.10.0)
 was released on Mar 14, 2023.
 
-### Breaking changes in 1.10
+### Breaking changes
 
 - If the `XRPFees` feature is enabled, the `fee_ref` field will be
   removed from the [ledger subscription stream](https://xrpl.org/subscribe.html#ledger-stream), because it will no longer

include/xrpl/protocol/ErrorCodes.h

@@ -148,7 +148,10 @@ enum error_code_i {
     // Oracle
     rpcORACLE_MALFORMED = 94,
 
-    rpcLAST = rpcORACLE_MALFORMED  // rpcLAST should always equal the last code.
+    // Simulate
+    rpcTX_SIGNED = 95,
+
+    rpcLAST = rpcTX_SIGNED  // rpcLAST should always equal the last code.
 };
 
 /** Codes returned in the `warnings` array of certain RPC commands.

include/xrpl/protocol/jss.h

@@ -137,8 +137,10 @@ JSS(SendMax);                            // in: TransactionSign
 JSS(Sequence);                           // in/out: TransactionSign; field.
 JSS(SetFlag);                            // field.
 JSS(SetRegularKey);                      // transaction type.
+JSS(Signer);                             // field.
 JSS(SignerList);                         // ledger type.
 JSS(SignerListSet);                      // transaction type.
+JSS(Signers);                            // field.
 JSS(SigningPubKey);                      // field.
 JSS(TakerGets);                          // field.
 JSS(TakerPays);                          // field.

src/libxrpl/protocol/ErrorCodes.cpp

@@ -108,7 +108,8 @@ constexpr static ErrorInfo unorderedErrorInfos[]{
     {rpcTOO_BUSY,               "tooBusy",              "The server is too busy to help you now.", 503},
     {rpcTXN_NOT_FOUND,          "txnNotFound",          "Transaction not found.", 404},
     {rpcUNKNOWN_COMMAND,        "unknownCmd",           "Unknown method.", 405},
-    {rpcORACLE_MALFORMED,       "oracleMalformed",      "Oracle request is malformed.", 400}};
+    {rpcORACLE_MALFORMED,       "oracleMalformed",      "Oracle request is malformed.", 400},
+    {rpcTX_SIGNED,       "transactionSigned",           "Transaction should not be signed.", 400}};
 // clang-format on
 
 // Sort and validate unorderedErrorInfos at compile time.  Should be

src/libxrpl/protocol/InnerObjectFormats.cpp

@@ -36,7 +36,7 @@ InnerObjectFormats::InnerObjectFormats()
             {sfWalletLocator, soeOPTIONAL},
         });
 
-    add(sfSigner.jsonName.c_str(),
+    add(sfSigner.jsonName,
         sfSigner.getCode(),
         {
             {sfAccount, soeREQUIRED},

src/test/app/PseudoTx_test.cpp

@@ -92,8 +92,8 @@ struct PseudoTx_test : public beast::unit_test::suite
                 [&](OpenView& view, beast::Journal j) {
                     auto const result =
                         ripple::apply(env.app(), view, stx, tapNONE, j);
-                    BEAST_EXPECT(!result.second && result.first == temINVALID);
-                    return result.second;
+                    BEAST_EXPECT(!result.applied && result.ter == temINVALID);
+                    return result.applied;
                 });
         }
     }

src/test/app/Regression_test.cpp

@@ -76,8 +76,8 @@ struct Regression_test : public beast::unit_test::suite
 
             auto const result =
                 ripple::apply(env.app(), accum, *jt.stx, tapNONE, env.journal);
-            BEAST_EXPECT(result.first == tesSUCCESS);
-            BEAST_EXPECT(result.second);
+            BEAST_EXPECT(result.ter == tesSUCCESS);
+            BEAST_EXPECT(result.applied);
 
             accum.apply(*next);
         }
@@ -100,8 +100,8 @@ struct Regression_test : public beast::unit_test::suite
 
             auto const result =
                 ripple::apply(env.app(), accum, *jt.stx, tapNONE, env.journal);
-            BEAST_EXPECT(result.first == tecINSUFF_FEE);
-            BEAST_EXPECT(result.second);
+            BEAST_EXPECT(result.ter == tecINSUFF_FEE);
+            BEAST_EXPECT(result.applied);
 
             accum.apply(*next);
         }

src/test/app/TxQ_test.cpp

@@ -1062,11 +1062,10 @@ class TxQPosNegFlows_test : public beast::unit_test::suite
 
             env.app().openLedger().modify(
                 [&](OpenView& view, beast::Journal j) {
-                    // No need to initialize, since it's about to get set
-                    bool didApply;
-                    std::tie(parsed.ter, didApply) = ripple::apply(
+                    auto result = ripple::apply(
                         env.app(), view, *jt.stx, tapNONE, env.journal);
-                    return didApply;
+                    parsed.ter = result.ter;
+                    return result.applied;
                 });
             env.postconditions(jt, parsed);
         }
@@ -4174,8 +4173,8 @@ class TxQPosNegFlows_test : public beast::unit_test::suite
                 env.jt(noop(alice), seq(aliceSeq), openLedgerFee(env));
             auto const result =
                 ripple::apply(env.app(), view, *tx.stx, tapUNLIMITED, j);
-            BEAST_EXPECT(result.first == tesSUCCESS && result.second);
-            return result.second;
+            BEAST_EXPECT(result.ter == tesSUCCESS && result.applied);
+            return result.applied;
         });
         // the queued transaction is still there
         checkMetrics(__LINE__, env, 1, std::nullopt, 5, 3, 256);
@@ -4246,8 +4245,8 @@ class TxQPosNegFlows_test : public beast::unit_test::suite
                 noop(alice), ticket::use(tktSeq0 + 1), openLedgerFee(env));
             auto const result =
                 ripple::apply(env.app(), view, *tx.stx, tapUNLIMITED, j);
-            BEAST_EXPECT(result.first == tesSUCCESS && result.second);
-            return result.second;
+            BEAST_EXPECT(result.ter == tesSUCCESS && result.applied);
+            return result.applied;
         });
         // the queued transaction is still there
         checkMetrics(__LINE__, env, 1, std::nullopt, 5, 3, 256);

src/test/consensus/NegativeUNL_test.cpp

@@ -1924,9 +1924,9 @@ applyAndTestResult(jtx::Env& env, OpenView& view, STTx const& tx, bool pass)
 {
     auto res = apply(env.app(), view, tx, ApplyFlags::tapNONE, env.journal);
     if (pass)
-        return res.first == tesSUCCESS;
+        return res.ter == tesSUCCESS;
     else
-        return res.first == tefFAILURE || res.first == temDISABLED;
+        return res.ter == tefFAILURE || res.ter == temDISABLED;
 }
 
 bool

src/test/rpc/JSONRPC_test.cpp

@@ -2160,6 +2160,31 @@ class JSONRPC_test : public beast::unit_test::suite
             BEAST_EXPECT(RPC::contains_error(result));
             BEAST_EXPECT(!req[jss::tx_json].isMember(jss::Fee));
         }
+
+        {
+            // transaction with a higher base fee
+            Json::Value req;
+            test::jtx::Account const alice("alice");
+            Json::Reader().parse(
+                "{ \"tx_json\" : { \"TransactionType\": \"AccountDelete\", "
+                "\"Account\": \"" +
+                    env.master.human() + "\", \"Destination\": \"" +
+                    alice.human() + "\" } } ",
+                req);
+            Json::Value result = checkFee(
+                req,
+                Role::ADMIN,
+                true,
+                env.app().config(),
+                feeTrack,
+                env.app().getTxQ(),
+                env.app());
+
+            BEAST_EXPECT(!RPC::contains_error(result));
+            BEAST_EXPECT(
+                req[jss::tx_json].isMember(jss::Fee) &&
+                req[jss::tx_json][jss::Fee] == 50000000);
+        }
     }
 
     void