Batch Amendment

include/xrpl/protocol/Feature.h

@@ -80,7 +80,7 @@ namespace detail {
 // Feature.cpp. Because it's only used to reserve storage, and determine how
 // large to make the FeatureBitset, it MAY be larger. It MUST NOT be less than
 // the actual number of amendments. A LogicError on startup will verify this.
-static constexpr std::size_t numFeatures = 78;
+static constexpr std::size_t numFeatures = 79;
 
 /** Amendments that this server supports and the default voting behavior.
    Whether they are enabled depends on the Rules defined in the validated
@@ -371,6 +371,7 @@ extern uint256 const fixReducedOffersV2;
 extern uint256 const fixEnforceNFTokenTrustline;
 extern uint256 const fixInnerObjTemplate2;
 extern uint256 const featureInvariantsV1_1;
+extern uint256 const featureBatch;
 
 }  // namespace ripple
 

include/xrpl/protocol/SField.h

@@ -373,6 +373,7 @@ extern SF_UINT8 const sfScale;
 extern SF_UINT8 const sfTickSize;
 extern SF_UINT8 const sfUNLModifyDisabling;
 extern SF_UINT8 const sfHookResult;
+extern SF_UINT8 const sfBatchIndex;
 
 // 16-bit integers (common)
 extern SF_UINT16 const sfLedgerEntryType;
@@ -441,6 +442,7 @@ extern SF_UINT32 const sfEmitGeneration;
 extern SF_UINT32 const sfVoteWeight;
 extern SF_UINT32 const sfFirstNFTokenSequence;
 extern SF_UINT32 const sfOracleDocumentID;
+extern SF_UINT32 const sfOuterSequence;
 
 // 64-bit integers (common)
 extern SF_UINT64 const sfIndexNext;
@@ -650,6 +652,10 @@ extern SField const sfXChainClaimProofSig;
 extern SField const sfXChainCreateAccountProofSig;
 extern SField const sfXChainClaimAttestationCollectionElement;
 extern SField const sfXChainCreateAccountAttestationCollectionElement;
+extern SField const sfRawTransaction;
+extern SField const sfBatchExecution;
+extern SField const sfBatchTxn;
+extern SField const sfBatchSigner;
 
 // array of objects (common)
 // ARRAY/1 is reserved for end of array
@@ -675,6 +681,9 @@ extern SField const sfHookParameters;
 extern SField const sfHookGrants;
 extern SField const sfXChainClaimAttestations;
 extern SField const sfXChainCreateAccountAttestations;
+extern SField const sfBatchExecutions;
+extern SField const sfRawTransactions;
+extern SField const sfBatchSigners;
 
 //------------------------------------------------------------------------------
 

include/xrpl/protocol/STTx.h

@@ -124,6 +124,9 @@ class STTx final : public STObject, public CountedObject<STTx>
     checkSign(RequireFullyCanonicalSig requireCanonicalSig, Rules const& rules)
         const;
 
+    Expected<void, std::string>
+    checkBatchSign() const;
+
     // SQL Functions with metadata.
     static std::string const&
     getMetaSQLInsertReplaceHeader();

include/xrpl/protocol/TER.h

@@ -338,7 +338,8 @@ enum TECcodes : TERUnderlyingType {
     tecINVALID_UPDATE_TIME = 188,
     tecTOKEN_PAIR_NOT_FOUND = 189,
     tecARRAY_EMPTY = 190,
-    tecARRAY_TOO_LARGE = 191
+    tecARRAY_TOO_LARGE = 191,
+    tecBATCH_FAILURE = 192
 };
 
 //------------------------------------------------------------------------------

include/xrpl/protocol/TxFlags.h

@@ -185,6 +185,14 @@ constexpr std::uint32_t tfDepositMask = ~(tfUniversal | tfDepositSubTx);
 constexpr std::uint32_t tfClearAccountCreateAmount     = 0x00010000;
 constexpr std::uint32_t tfBridgeModifyMask = ~(tfUniversal | tfClearAccountCreateAmount);
 
+// Batch Flags
+constexpr std::uint32_t tfAllOrNothing                 = 0x00000001;
+constexpr std::uint32_t tfOnlyOne                      = 0x00000002;
+constexpr std::uint32_t tfUntilFailure                 = 0x00000004;
+constexpr std::uint32_t tfIndependent                 = 0x00000008;
+constexpr std::uint32_t const tfBatchMask =
+    ~(tfUniversal | tfAllOrNothing | tfOnlyOne | tfUntilFailure | tfIndependent);
+
 // clang-format on
 
 }  // namespace ripple

include/xrpl/protocol/TxFormats.h

@@ -197,6 +197,9 @@ enum TxType : std::uint16_t
     /** This transaction type deletes an Oracle instance */
     ttORACLE_DELETE = 52,
 
+    /** This transaction type creates a Batch instance */
+    ttBATCH = 53,
+
     /** This system-generated transaction type is used to update the status of the various amendments.
 
         For details, see: https://xrpl.org/amendments.html

include/xrpl/protocol/TxMeta.h

@@ -126,13 +126,31 @@ class TxMeta
         return static_cast<bool>(mDelivered);
     }
 
+    STArray const&
+    getBatchExecutions() const
+    {
+        return *mBatchExecutions;
+    }
+
+    void
+    setBatchExecutions(STArray const& batchExecutions)
+    {
+        mBatchExecutions = batchExecutions;
+    }
+    bool
+    hasBatchExecutions() const
+    {
+        return static_cast<bool>(mBatchExecutions);
+    }
+
 private:
     uint256 mTransactionID;
     std::uint32_t mLedger;
     std::uint32_t mIndex;
     int mResult;
 
     std::optional<STAmount> mDelivered;
+    std::optional<STArray> mBatchExecutions;
 
     STArray mNodes;
 };

include/xrpl/protocol/jss.h

@@ -65,6 +65,7 @@ JSS(AssetPrice);           // in: Oracle
 JSS(AuthAccount);          // in: AMM Auction Slot
 JSS(AuthAccounts);         // in: AMM Auction Slot
 JSS(BaseAsset);            // in: Oracle
+JSS(Batch);                // transaction type
 JSS(Bridge);               // ledger type.
 JSS(Check);                // ledger type.
 JSS(CheckCancel);          // transaction type.
@@ -128,6 +129,7 @@ JSS(PriceData);                          // field.
 JSS(Provider);                           // field.
 JSS(QuoteAsset);                         // in: Oracle.
 JSS(RippleState);                        // ledger type.
+JSS(RawTransaction);                     // in: Batch
 JSS(SLE_hit_rate);                       // out: GetCounts.
 JSS(SetFee);                             // transaction type.
 JSS(UNLModify);                          // transaction type.

src/libxrpl/protocol/Feature.cpp

@@ -500,6 +500,7 @@ REGISTER_FIX    (fixInnerObjTemplate2,          Supported::yes, VoteBehavior::De
 // InvariantsV1_1 will be changes to Supported::yes when all the
 // invariants expected to be included under it are complete.
 REGISTER_FEATURE(InvariantsV1_1,                Supported::no, VoteBehavior::DefaultNo);
+REGISTER_FEATURE(Batch,                         Supported::yes, VoteBehavior::DefaultNo);
 
 // The following amendments are obsolete, but must remain supported
 // because they could potentially get enabled.

src/libxrpl/protocol/InnerObjectFormats.cpp

@@ -147,6 +147,25 @@ InnerObjectFormats::InnerObjectFormats()
             {sfAssetPrice, soeOPTIONAL},
             {sfScale, soeDEFAULT},
         });
+
+    add(sfBatchExecution.jsonName.c_str(),
+        sfBatchExecution.getCode(),
+        {{sfTransactionType, soeREQUIRED},
+         {sfTransactionResult, soeREQUIRED},
+         {sfTransactionHash, soeOPTIONAL}});
+
+    add(sfBatchTxn.jsonName.c_str(),
+        sfBatchTxn.getCode(),
+        {{sfAccount, soeREQUIRED},
+         {sfOuterSequence, soeREQUIRED},
+         {sfSequence, soeOPTIONAL},
+         {sfBatchIndex, soeREQUIRED}});
+
+    add(sfBatchSigner.jsonName.c_str(),
+        sfBatchSigner.getCode(),
+        {{sfAccount, soeREQUIRED},
+         {sfSigningPubKey, soeREQUIRED},
+         {sfTxnSignature, soeREQUIRED}});
 }
 
 InnerObjectFormats const&

src/libxrpl/protocol/SField.cpp

@@ -98,6 +98,7 @@ CONSTRUCT_TYPED_SFIELD(sfTickSize,              "TickSize",             UINT8,
 CONSTRUCT_TYPED_SFIELD(sfUNLModifyDisabling,    "UNLModifyDisabling",   UINT8,     17);
 CONSTRUCT_TYPED_SFIELD(sfHookResult,            "HookResult",           UINT8,     18);
 CONSTRUCT_TYPED_SFIELD(sfWasLockingChainSend,   "WasLockingChainSend",  UINT8,     19);
+CONSTRUCT_TYPED_SFIELD(sfBatchIndex,            "BatchIndex",           UINT8,     20);
 
 // 16-bit integers
 CONSTRUCT_TYPED_SFIELD(sfLedgerEntryType,       "LedgerEntryType",      UINT16,     1, SField::sMD_Never);
@@ -167,6 +168,7 @@ CONSTRUCT_TYPED_SFIELD(sfEmitGeneration,        "EmitGeneration",       UINT32,
 CONSTRUCT_TYPED_SFIELD(sfVoteWeight,            "VoteWeight",           UINT32,    48);
 CONSTRUCT_TYPED_SFIELD(sfFirstNFTokenSequence,  "FirstNFTokenSequence", UINT32,    50);
 CONSTRUCT_TYPED_SFIELD(sfOracleDocumentID,      "OracleDocumentID",     UINT32,    51);
+CONSTRUCT_TYPED_SFIELD(sfOuterSequence,         "OuterSequence",        UINT32,    52);
 
 // 64-bit integers (common)
 CONSTRUCT_TYPED_SFIELD(sfIndexNext,             "IndexNext",            UINT64,     1);
@@ -390,6 +392,10 @@ CONSTRUCT_UNTYPED_SFIELD(sfXChainCreateAccountAttestationCollectionElement,
                                                  "XChainCreateAccountAttestationCollectionElement",
                                                                         OBJECT,    31);
 CONSTRUCT_UNTYPED_SFIELD(sfPriceData,            "PriceData",           OBJECT,    32);
+CONSTRUCT_UNTYPED_SFIELD(sfRawTransaction,       "RawTransaction",      OBJECT,    33);
+CONSTRUCT_UNTYPED_SFIELD(sfBatchExecution,       "BatchExecution",      OBJECT,    34);
+CONSTRUCT_UNTYPED_SFIELD(sfBatchTxn,             "BatchTxn",            OBJECT,    35);
+CONSTRUCT_UNTYPED_SFIELD(sfBatchSigner,          "BatchSigner",         OBJECT,    36);
 
 // array of objects
 //                                                                            ARRAY/1 is reserved for end of array
@@ -420,6 +426,9 @@ CONSTRUCT_UNTYPED_SFIELD(sfXChainCreateAccountAttestations,
 // 23 is unused and available for use
 CONSTRUCT_UNTYPED_SFIELD(sfPriceDataSeries,     "PriceDataSeries",      ARRAY,     24);
 CONSTRUCT_UNTYPED_SFIELD(sfAuthAccounts,        "AuthAccounts",         ARRAY,     25);
+CONSTRUCT_UNTYPED_SFIELD(sfBatchExecutions,     "BatchExecutions",      ARRAY,     26);
+CONSTRUCT_UNTYPED_SFIELD(sfRawTransactions,     "RawTransactions",      ARRAY,     27);
+CONSTRUCT_UNTYPED_SFIELD(sfBatchSigners,        "BatchSigners",         ARRAY,     28, SField::sMD_Default, SField::notSigning);
 
 // clang-format on
 

src/libxrpl/protocol/STTx.cpp

@@ -187,6 +187,17 @@ STTx::getSeqProxy() const
     if (seq != 0)
         return SeqProxy::sequence(seq);
 
+    if (isFieldPresent(sfBatchTxn))
+    {
+        STObject const batchTxn = const_cast<ripple::STTx&>(*this)
+                                      .getField(sfBatchTxn)
+                                      .downcast<STObject>();
+        std::uint32_t const startSequence{
+            batchTxn.getFieldU32(sfOuterSequence)};
+        std::uint32_t const batchIndex{batchTxn.getFieldU8(sfBatchIndex)};
+        return SeqProxy::sequence(startSequence + batchIndex);
+    }
+
     std::optional<std::uint32_t> const ticketSeq{operator[](~sfTicketSequence)};
     if (!ticketSeq)
         // No TicketSequence specified.  Return the Sequence, whatever it is.
@@ -346,6 +357,82 @@ STTx::checkSingleSign(RequireFullyCanonicalSig requireCanonicalSig) const
     return {};
 }
 
+Expected<void, std::string>
+STTx::checkBatchSign() const
+{
+    STArray const& signers{getFieldArray(sfBatchSigners)};
+
+    // There are well known bounds that the number of signers must be within.
+    if (signers.size() == 0 || signers.size() > 8)
+        return Unexpected("Invalid Batch Signers array size.");
+
+    // We can ease the computational load inside the loop a bit by
+    // pre-constructing part of the data that we hash.  Fill a Serializer
+    // with the stuff that stays constant from signature to signature.
+
+    Serializer const dataStart{startMultiSigningData(*this)};
+
+    // We also use the sfAccount field inside the loop.  Get it once.
+    // auto const txnAccountID = getAccountID(sfAccount);
+
+    // Determine whether signatures must be full canonical.
+    bool const fullyCanonical = true;
+
+    // Signers must be in sorted order by AccountID.
+    AccountID lastAccountID(beast::zero);
+
+    for (auto const& signer : signers)
+    {
+        auto const accountID = signer.getAccountID(sfAccount);
+
+        // // The account owner may not multisign for themselves.
+        // if (accountID == txnAccountID)
+        //     return Unexpected("Invalid multisigner.");
+
+        // No duplicate signers allowed.
+        if (lastAccountID == accountID)
+            return Unexpected("Duplicate Signers not allowed.");
+
+        // Accounts must be in order by account ID.  No duplicates allowed.
+        if (lastAccountID > accountID)
+            return Unexpected("Unsorted Signers array.");
+
+        // The next signature must be greater than this one.
+        lastAccountID = accountID;
+
+        // Verify the signature.
+        bool validSig = false;
+        try
+        {
+            Serializer s = dataStart;
+            finishMultiSigningData(accountID, s);
+
+            auto spk = signer.getFieldVL(sfSigningPubKey);
+
+            if (publicKeyType(makeSlice(spk)))
+            {
+                Blob const signature = signer.getFieldVL(sfTxnSignature);
+                validSig = verify(
+                    PublicKey(makeSlice(spk)),
+                    s.slice(),
+                    makeSlice(signature),
+                    fullyCanonical);
+            }
+        }
+        catch (std::exception const&)
+        {
+            // We assume any problem lies with the signature.
+            validSig = false;
+        }
+        if (!validSig)
+            return Unexpected(
+                std::string("Invalid signature on account ") +
+                toBase58(accountID) + ".");
+    }
+    // All signatures verified.
+    return {};
+}
+
 Expected<void, std::string>
 STTx::checkMultiSign(
     RequireFullyCanonicalSig requireCanonicalSig,

src/libxrpl/protocol/TER.cpp

@@ -115,6 +115,7 @@ transResults()
         MAKE_ERROR(tecTOKEN_PAIR_NOT_FOUND,          "Token pair is not found in Oracle object."),
         MAKE_ERROR(tecARRAY_EMPTY,                   "Array is empty."),
         MAKE_ERROR(tecARRAY_TOO_LARGE,               "Array is too large."),
+        MAKE_ERROR(tecBATCH_FAILURE,                 "Tx Batch Failure."),
 
         MAKE_ERROR(tefALREADY,                     "The exact transaction was already in this ledger."),
         MAKE_ERROR(tefBAD_ADD_AUTH,                "Not authorized to add account."),

src/libxrpl/protocol/TxFormats.cpp

@@ -45,6 +45,7 @@ TxFormats::TxFormats()
         {sfTxnSignature, soeOPTIONAL},
         {sfSigners, soeOPTIONAL},  // submit_multisigned
         {sfNetworkID, soeOPTIONAL},
+        {sfBatchTxn, soeOPTIONAL},
     };
 
     add(jss::AccountSet,
@@ -505,6 +506,14 @@ TxFormats::TxFormats()
             {sfOracleDocumentID, soeREQUIRED},
         },
         commonFields);
+
+    add(jss::Batch,
+        ttBATCH,
+        {
+            {sfRawTransactions, soeREQUIRED},
+            {sfBatchSigners, soeOPTIONAL},
+        },
+        commonFields);
 }
 
 TxFormats const&

src/libxrpl/protocol/TxMeta.cpp

@@ -43,6 +43,9 @@ TxMeta::TxMeta(
 
     if (obj.isFieldPresent(sfDeliveredAmount))
         setDeliveredAmount(obj.getFieldAmount(sfDeliveredAmount));
+
+    if (obj.isFieldPresent(sfBatchExecutions))
+        setBatchExecutions(obj.getFieldArray(sfBatchExecutions));
 }
 
 TxMeta::TxMeta(uint256 const& txid, std::uint32_t ledger, STObject const& obj)
@@ -61,6 +64,9 @@ TxMeta::TxMeta(uint256 const& txid, std::uint32_t ledger, STObject const& obj)
 
     if (obj.isFieldPresent(sfDeliveredAmount))
         setDeliveredAmount(obj.getFieldAmount(sfDeliveredAmount));
+
+    if (obj.isFieldPresent(sfBatchExecutions))
+        setBatchExecutions(obj.getFieldArray(sfBatchExecutions));
 }
 
 TxMeta::TxMeta(uint256 const& txid, std::uint32_t ledger, Blob const& vec)
@@ -205,6 +211,8 @@ TxMeta::getAsObject() const
     metaData.emplace_back(mNodes);
     if (hasDeliveredAmount())
         metaData.setFieldAmount(sfDeliveredAmount, getDeliveredAmount());
+    if (hasBatchExecutions())
+        metaData.setFieldArray(sfBatchExecutions, getBatchExecutions());
     return metaData;
 }