Only interpret `TxSetFrame` with correct ledger state #3977

dmkozh · 2023-10-19T18:48:31Z

Description

Resolves #3958

Refactor TxSetFrame to distinguish between operations that are dependent on the ledger state vs those that aren't.

Most of the time we just process tx sets as XDR blobs. We only need to further interpret tx sets in a few cases (when validating the SCP nominees and applying the final tx set). These cases now have to explicitly use a different tx set interface ResolvedTxSetFrame which can only be created when TxSet points at current LCL.

Checklist

Reviewed the contributing document
Rebased on top of master (no merge commits)
Ran clang-format v8.0.0 (via make format or the Visual Studio extension)
Compiles
Ran all tests
If change impacts performance, include supporting evidence per the performance document

SirTyson

Looks like a helpful change! Just a few comments about raw pointers and TxSetFrame construction paths, but overall looks good.

src/ledger/LedgerManagerImpl.cpp

src/herder/TxSetFrame.h

src/herder/HerderImpl.cpp

src/herder/TxSetFrame.cpp

src/herder/TxSetFrame.h

src/herder/TxSetFrame.cpp

marta-lokhova

Thanks for the PR! I think this is definitely a tricky area, so would be great to ensure we have a proper contract for all the different tx set states, and add invariance where possible to prevent issues related to invalid local state in the future.

marta-lokhova · 2023-10-23T20:53:47Z

src/herder/HerderImpl.cpp

    // Even if we're in protocol 20, still check for number of phases, in case
    // we're dealing with the upgrade ledger that contains old-style transaction
    // set
-    if (txSet->numPhases() > static_cast<size_t>(TxSetFrame::Phase::SOROBAN) &&
-        mSorobanTransactionQueue)
+    if (mSorobanTransactionQueue != nullptr)


nit: if (mSorobanTransactionQueue)

Why though? I'm not a fan of pointer-to-bool casts as it's not immediately clear what you're dealing with.

mostly for consistency with the rest of the codebase using mSorobanTransactionQueue. I don't feel strongly though

src/herder/HerderSCPDriver.cpp

src/herder/TxSetFrame.h

src/herder/HerderImpl.cpp

src/herder/TxSetFrame.cpp

src/herder/test/HerderTests.cpp

marta-lokhova

the updates are easier to review, thanks! Left a few questions on lifetime of tx set cache items, and some transaction frame fee-related concerns

src/overlay/test/ItemFetcherTests.cpp

src/transactions/TransactionFrame.h

marta-lokhova · 2023-11-03T18:10:47Z

src/herder/TxSetFrame.h

+// Before even trying to validate and apply a TxSetFrame it has
+// to be interpreted and prepared for apply using the ledger state
+// this TxSetFrame refers to. This is typically performed by
+// `prepareForApply` method.
 class TxSetFrame : public NonMovableOrCopyable


now that the caching got moved out of TxSetFrame, shall we rename is to TxSetXDRFrame or something that suggests that it's just a wrapper around XDR? I think it'd help with readability and make it easier to spot places that should be using ApplicableTxSetFrame

Maybe, but I would probably do that as a followup to reduce the scope of changes a bit. I'm also not a fan of the static factory functions that return a different type, so I'd refactor that as well...

sounds good. let's an open an issue about this to we don't forget

Opened #4017

src/herder/TxSetFrame.cpp

src/herder/PendingEnvelopes.cpp

src/transactions/TransactionFrame.cpp

src/herder/TxSetFrame.cpp

marta-lokhova

Looks good to me! Much easier to reason about without the caches. Just a few small things I noticed

marta-lokhova · 2023-11-08T19:57:01Z

src/herder/TxSetFrame.h

+// Before even trying to validate and apply a TxSetFrame it has
+// to be interpreted and prepared for apply using the ledger state
+// this TxSetFrame refers to. This is typically performed by
+// `prepareForApply` method.
 class TxSetFrame : public NonMovableOrCopyable


sounds good. let's an open an issue about this to we don't forget

marta-lokhova · 2023-11-08T20:16:08Z

src/herder/TxSetFrame.h

                       xdr::xvector<TransactionEnvelope> const& txs,
                       bool useBaseFee, std::optional<int64_t> baseFee,
-                       Phase phase);
+                       TxSetFrame::Phase phase);


I know it was like this before your change, but can we make computeTxFees const, since we're cleaning up the API?

marta-lokhova · 2023-11-08T20:19:37Z

src/herder/TxSetFrame.cpp

+            txOps = tx.v1().tx.operations.size();
+            break;
+        case ENVELOPE_TYPE_TX_FEE_BUMP:
+            txOps = tx.feeBump().tx.innerTx.v1().tx.operations.size();


fee bumps add an extra op to the inner tx op count

marta-lokhova · 2023-11-08T20:21:02Z

src/herder/TxSetFrame.cpp

+        size_t txOps = 0;
+        switch (tx.type())
+        {
+        case ENVELOPE_TYPE_TX_V0:


I'm getting warnings about other envelope types that aren't handled. Should we add a default and throw?

This is only used for logging actually, so I would rather handle unknown/incorrect envelopes gracefully. I've renamed the function for clarity as well.

marta-lokhova · 2023-11-08T21:08:47Z

src/transactions/TransactionFrame.cpp

        protocolVersion, sorobanResources(),
-        static_cast<uint32_t>(xdr::xdr_size(mEnvelope)), 0, sorobanConfig,
-        cfg));
+        static_cast<uint32_t>(xdr::xdr_size(mEnvelope)), 0, sorobanConfig, cfg);


nit: safer would be to do getResources(false).getVal(TX_BYTE_SIZE)

src/transactions/TransactionFrame.cpp

…ger state. Most of the time we just process tx sets as XDR blobs. We only need to interpret tx sets in a few cases (when validating the SCP nominees and applying the final tx set). These cases now have to explicitly use a different tx set interface `ApplicableTxSetFrame` which can only be created from a TxSet that points at current LCL. Also remove caching of Soroban resource fee from tx frame. Fee caching proved to be a major footgun that might introduce divergence in asynchronous flows (any type of catchup).

marta-lokhova · 2023-11-09T02:03:50Z

r+ fe7bbcf

SirTyson reviewed Oct 23, 2023

View reviewed changes

marta-lokhova requested changes Oct 24, 2023

View reviewed changes

dmkozh force-pushed the txset_fix branch from 134c14a to 5e00a86 Compare November 2, 2023 21:35

marta-lokhova mentioned this pull request Nov 3, 2023

[test] herder handles soroban traffic correctly #4012

Closed

3 tasks

marta-lokhova requested changes Nov 3, 2023

View reviewed changes

marta-lokhova reviewed Nov 6, 2023

View reviewed changes

src/herder/TxSetFrame.cpp Outdated Show resolved Hide resolved

dmkozh force-pushed the txset_fix branch 2 times, most recently from 7d69623 to 4383758 Compare November 7, 2023 21:53

marta-lokhova approved these changes Nov 8, 2023

View reviewed changes

dmkozh mentioned this pull request Nov 8, 2023

Cleanup: rename TxSetFrame to TxSetXDRFrame #4017

Closed

dmkozh added 2 commits November 8, 2023 18:34

!fixup review comments.

fe7bbcf

dmkozh force-pushed the txset_fix branch from 4383758 to fe7bbcf Compare November 9, 2023 00:20

latobarita merged commit acca92e into stellar:master Nov 9, 2023
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Only interpret `TxSetFrame` with correct ledger state #3977

Only interpret `TxSetFrame` with correct ledger state #3977

dmkozh commented Oct 19, 2023

SirTyson left a comment •

edited

Loading

marta-lokhova left a comment

marta-lokhova Oct 23, 2023

dmkozh Oct 24, 2023

marta-lokhova Oct 25, 2023

marta-lokhova left a comment

marta-lokhova Nov 3, 2023

dmkozh Nov 6, 2023

marta-lokhova Nov 8, 2023

dmkozh Nov 8, 2023

marta-lokhova left a comment

marta-lokhova Nov 8, 2023

marta-lokhova Nov 8, 2023

dmkozh Nov 8, 2023

marta-lokhova Nov 8, 2023

dmkozh Nov 8, 2023

marta-lokhova Nov 8, 2023

dmkozh Nov 8, 2023

marta-lokhova Nov 8, 2023

dmkozh Nov 8, 2023

marta-lokhova commented Nov 9, 2023

Only interpret TxSetFrame with correct ledger state #3977

Only interpret TxSetFrame with correct ledger state #3977

Conversation

dmkozh commented Oct 19, 2023

Description

Checklist

SirTyson left a comment • edited Loading

Choose a reason for hiding this comment

marta-lokhova left a 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

marta-lokhova left a 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

marta-lokhova left a 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

marta-lokhova commented Nov 9, 2023

Only interpret `TxSetFrame` with correct ledger state #3977

Only interpret `TxSetFrame` with correct ledger state #3977

SirTyson left a comment •

edited

Loading