refactor: Use SeqProxy instead of uint32 for all sequence-based keylets

include/xrpl/protocol/Indexes.h

@@ -12,6 +12,7 @@
 #include <xrpl/protocol/LedgerFormats.h>
 #include <xrpl/protocol/Protocol.h>
 #include <xrpl/protocol/STXChainBridge.h>
+#include <xrpl/protocol/SeqProxy.h>
 #include <xrpl/protocol/UintTypes.h>
 
 #include <array>
@@ -21,8 +22,6 @@
 #include <utility>
 
 namespace xrpl {
-
-class SeqProxy;
 /**
  * Keylet computation functions.
  *
@@ -123,7 +122,7 @@ trustLine(AccountID const& id, Issue const& issue) noexcept
  */
 /** @{ */
 Keylet
-offer(AccountID const& id, std::uint32_t seq) noexcept;
+offer(AccountID const& id, SeqProxy const& seq) noexcept;
 
 inline Keylet
 offer(uint256 const& key) noexcept
@@ -136,7 +135,7 @@ offer(uint256 const& key) noexcept
  * The initial directory page for a specific quality
  */
 Keylet
-quality(Keylet const& k, std::uint64_t q) noexcept;
+quality(Keylet const& k, std::uint64_t const q) noexcept;
 
 /**
  * The directory for the next lower quality
@@ -149,10 +148,7 @@ next(Keylet const& k);
  */
 /** @{ */
 Keylet
-ticket(AccountID const& id, std::uint32_t ticketSeq);
-
-Keylet
-ticket(AccountID const& id, SeqProxy ticketSeq);
+ticket(AccountID const& id, SeqProxy const& ticketSeq);
 
 inline Keylet
 ticket(uint256 const& key)
@@ -178,7 +174,7 @@ sponsorship(AccountID const& sponsor, AccountID const& sponsee) noexcept;
  */
 /** @{ */
 Keylet
-check(AccountID const& id, std::uint32_t seq) noexcept;
+check(AccountID const& id, SeqProxy const& seq) noexcept;
 
 inline Keylet
 check(uint256 const& key) noexcept
@@ -225,10 +221,10 @@ ownerDir(AccountID const& id) noexcept;
  */
 /** @{ */
 Keylet
-page(uint256 const& root, std::uint64_t index = 0) noexcept;
+page(uint256 const& root, std::uint64_t const index = 0) noexcept;
 
 inline Keylet
-page(Keylet const& root, std::uint64_t index = 0) noexcept
+page(Keylet const& root, std::uint64_t const index = 0) noexcept
 {
     XRPL_ASSERT(root.type == ltDIR_NODE, "xrpl::keylet::page : valid root type");
     return page(root.key, index);
@@ -239,13 +235,13 @@ page(Keylet const& root, std::uint64_t index = 0) noexcept
  * An escrow entry
  */
 Keylet
-escrow(AccountID const& src, std::uint32_t seq) noexcept;
+escrow(AccountID const& src, SeqProxy const& seq) noexcept;
 
 /**
  * A PaymentChannel
  */
 Keylet
-payChannel(AccountID const& src, AccountID const& dst, std::uint32_t seq) noexcept;
+payChannel(AccountID const& src, AccountID const& dst, SeqProxy const& seq) noexcept;
 
 /**
  * NFT page keylets
@@ -276,7 +272,7 @@ nftokenPage(Keylet const& k, uint256 const& token);
  * An offer from an account to buy or sell an NFT
  */
 Keylet
-nftokenOffer(AccountID const& owner, std::uint32_t seq);
+nftokenOffer(AccountID const& owner, SeqProxy const& seq);
 
 inline Keylet
 nftokenOffer(uint256 const& offer)
@@ -316,17 +312,17 @@ bridge(STXChainBridge const& bridge, STXChainBridge::ChainType chainType);
 
 // `seq` is stored as `sfXChainClaimID` in the object
 Keylet
-xChainClaimID(STXChainBridge const& bridge, std::uint64_t seq);
+xChainClaimID(STXChainBridge const& bridge, std::uint64_t const seq);
 
 // `seq` is stored as `sfXChainAccountCreateCount` in the object
 Keylet
-xChainCreateAccountClaimID(STXChainBridge const& bridge, std::uint64_t seq);
+xChainCreateAccountClaimID(STXChainBridge const& bridge, std::uint64_t const seq);
 
 Keylet
 did(AccountID const& account) noexcept;
 
 Keylet
-oracle(AccountID const& account, std::uint32_t const& documentID) noexcept;
+oracle(AccountID const& account, std::uint32_t const documentID) noexcept;
 
 Keylet
 credential(AccountID const& subject, AccountID const& issuer, Slice const& credType) noexcept;
@@ -337,9 +333,6 @@ credential(uint256 const& key) noexcept
     return {ltCREDENTIAL, key};
 }
 
-Keylet
-mptokenIssuance(std::uint32_t seq, AccountID const& issuer) noexcept;
-
 Keylet
 mptokenIssuance(MPTID const& issuanceID) noexcept;
 
@@ -362,7 +355,7 @@ Keylet
 mptoken(uint256 const& issuanceKey, AccountID const& holder) noexcept;
 
 Keylet
-vault(AccountID const& owner, std::uint32_t seq) noexcept;
+vault(AccountID const& owner, SeqProxy const& seq) noexcept;
 
 inline Keylet
 vault(uint256 const& vaultKey)
@@ -371,7 +364,7 @@ vault(uint256 const& vaultKey)
 }
 
 Keylet
-loanBroker(AccountID const& owner, std::uint32_t seq) noexcept;
+loanBroker(AccountID const& owner, SeqProxy const& seq) noexcept;
 
 inline Keylet
 loanBroker(uint256 const& key)
@@ -380,7 +373,7 @@ loanBroker(uint256 const& key)
 }
 
 Keylet
-loan(uint256 const& loanBrokerID, std::uint32_t loanSeq) noexcept;
+loan(uint256 const& loanBrokerID, SeqProxy const& loanSeq) noexcept;
 
 inline Keylet
 loan(uint256 const& key)
@@ -389,7 +382,7 @@ loan(uint256 const& key)
 }
 
 Keylet
-permissionedDomain(AccountID const& account, std::uint32_t seq) noexcept;
+permissionedDomain(AccountID const& account, SeqProxy const& seq) noexcept;
 
 Keylet
 permissionedDomain(uint256 const& domainID) noexcept;
@@ -407,12 +400,6 @@ getQualityNext(uint256 const& uBase);
 std::uint64_t
 getQuality(uint256 const& uBase);
 
-uint256
-getTicketIndex(AccountID const& account, std::uint32_t uSequence);
-
-uint256
-getTicketIndex(AccountID const& account, SeqProxy ticketSeq);
-
 template <class... KeyletParams>
 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-member-init)
 struct KeyletDesc
@@ -426,6 +413,6 @@ struct KeyletDesc
 extern std::array<KeyletDesc<AccountID const&>, 6> const kDirectAccountKeylets;
 
 MPTID
-makeMptID(std::uint32_t sequence, AccountID const& account);
+makeMptID(std::uint32_t const sequence, AccountID const& account);
 
 }  // namespace xrpl

include/xrpl/protocol/SeqProxy.h

@@ -53,14 +53,29 @@ class SeqProxy
     operator=(SeqProxy const& other) = default;
 
     /**
-     * Factory function to return a sequence-based SeqProxy
+     * Factory function to return a sequence-based SeqProxy.
+     * Outside of tests, this function should only be used for "secondary" transaction sequences,
+     * e.g. `sfOfferSequence`, or sequence fields in an existing ledger object. DO NOT use this for
+     * the "primary" sequence of a transaction, `sfSequence`.
      */
     static constexpr SeqProxy
-    sequence(std::uint32_t v)
+    rawSequence(std::uint32_t v)
     {
         return SeqProxy{Type::Seq, v};
     }
 
+    /**
+     * Factory function to return a ticket-based SeqProxy.
+     * Outside of tests, this function should only be used for "secondary" transaction sequences,
+     * e.g. `sfOfferSequence`, or sequence fields in an existing ledger object. DO NOT use this for
+     * the "primary" ticket sequence of a transaction, `sfTicketSequence`.
+     */
+    static constexpr SeqProxy
+    rawTicket(std::uint32_t v)
+    {
+        return SeqProxy{Type::Ticket, v};
+    }
+
     [[nodiscard]] constexpr std::uint32_t
     value() const
     {

src/libxrpl/ledger/helpers/NFTokenHelpers.cpp

@@ -925,7 +925,7 @@ tokenOfferCreateApply(
         priorBalance < accountReserve(view, acct, j, {.ownerCountDelta = 1}))
         return tecINSUFFICIENT_RESERVE;
 
-    auto const offerID = keylet::nftokenOffer(acctID, seqProxy.value());
+    auto const offerID = keylet::nftokenOffer(acctID, seqProxy);
 
     // Create the offer:
     {