Querying and submitting pending transactions

751        RPCExamples{
752            HelpExampleCli("getrawmempool", "true")
753            + HelpExampleRpc("getrawmempool", "true")
754        },
755        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
756{
757    bool fVerbose = false;
758    if (!request.params[0].isNull())
759        fVerbose = request.params[0].get_bool();
760
761    bool include_mempool_sequence = false;
762    if (!request.params[1].isNull()) {
763        include_mempool_sequence = request.params[1].get_bool();
764    }
765
766    return MempoolToJSON(EnsureAnyMemPool(request.context), fVerbose, include_mempool_sequence);
767},
768    };
769}
770
771static RPCMethod getmempoolancestors()
772{
773    return RPCMethod{
774        "getmempoolancestors",
775        "If txid is in the mempool, returns all in-mempool ancestors.\n",
776        {
777            {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"},
778            {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "True for a json object, false for array of transaction ids"},
779        },
780        {
781            RPCResult{"for verbose = false",
782                RPCResult::Type::ARR, "", "",
783                {{RPCResult::Type::STR_HEX, "", "The transaction id of an in-mempool ancestor transaction"}}},
784            RPCResult{"for verbose = true",
785                RPCResult::Type::OBJ_DYN, "", "",
786                {
787                    {RPCResult::Type::OBJ, "transactionid", "", MempoolEntryDescription()},
788                }},
789        },
790        RPCExamples{
791            HelpExampleCli("getmempoolancestors", "\"mytxid\"")
792            + HelpExampleRpc("getmempoolancestors", "\"mytxid\"")
793        },
794        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
795{
796    bool fVerbose = false;
797    if (!request.params[1].isNull())
798        fVerbose = request.params[1].get_bool();
799
800    auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
801
802    const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
803    LOCK(mempool.cs);
804
805    const auto entry{mempool.GetEntry(txid)};
806    if (entry == nullptr) {
807        throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
808    }
809
810    auto ancestors{mempool.CalculateMemPoolAncestors(*entry)};
811
812    if (!fVerbose) {
813        UniValue o(UniValue::VARR);
814        for (CTxMemPool::txiter ancestorIt : ancestors) {
815            o.push_back(ancestorIt->GetTx().GetHash().ToString());
816        }
817        return o;
818    } else {
819        UniValue o(UniValue::VOBJ);
820        for (CTxMemPool::txiter ancestorIt : ancestors) {
821            const CTxMemPoolEntry &e = *ancestorIt;
822            UniValue info(UniValue::VOBJ);
823            entryToJSON(mempool, info, e);
824            o.pushKVEnd(e.GetTx().GetHash().ToString(), std::move(info));
825        }
826        return o;
827    }
828},
829    };
830}
831
832static RPCMethod getmempooldescendants()
833{
834    return RPCMethod{
835        "getmempooldescendants",
836        "If txid is in the mempool, returns all in-mempool descendants.\n",
837        {
838            {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"},
839            {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "True for a json object, false for array of transaction ids"},
840        },
841        {
842            RPCResult{"for verbose = false",
843                RPCResult::Type::ARR, "", "",
844                {{RPCResult::Type::STR_HEX, "", "The transaction id of an in-mempool descendant transaction"}}},
845            RPCResult{"for verbose = true",
846                RPCResult::Type::OBJ_DYN, "", "",
847                {
848                    {RPCResult::Type::OBJ, "transactionid", "", MempoolEntryDescription()},
849                }},
850        },
851        RPCExamples{
852            HelpExampleCli("getmempooldescendants", "\"mytxid\"")
853            + HelpExampleRpc("getmempooldescendants", "\"mytxid\"")
854        },
855        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
856{
857    bool fVerbose = false;
858    if (!request.params[1].isNull())
859        fVerbose = request.params[1].get_bool();
860
861    auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
862
863    const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
864    LOCK(mempool.cs);
865
866    const auto it{mempool.GetIter(txid)};
867    if (!it) {
868        throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
869    }
870
871    CTxMemPool::setEntries setDescendants;
872    mempool.CalculateDescendants(*it, setDescendants);
873    // CTxMemPool::CalculateDescendants will include the given tx
874    setDescendants.erase(*it);
875
876    if (!fVerbose) {
877        UniValue o(UniValue::VARR);
878        for (CTxMemPool::txiter descendantIt : setDescendants) {
879            o.push_back(descendantIt->GetTx().GetHash().ToString());
880        }
881
882        return o;
883    } else {
884        UniValue o(UniValue::VOBJ);
885        for (CTxMemPool::txiter descendantIt : setDescendants) {
886            const CTxMemPoolEntry &e = *descendantIt;
887            UniValue info(UniValue::VOBJ);
888            entryToJSON(mempool, info, e);
889            o.pushKVEnd(e.GetTx().GetHash().ToString(), std::move(info));
890        }
891        return o;
892    }
893},
894    };
895}
896
897static RPCMethod getmempoolcluster()
898{
899    return RPCMethod{"getmempoolcluster",
900        "Returns mempool data for given cluster\n",
901        {
902            {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The txid of a transaction in the cluster"},
903        },
904        RPCResult{
905            RPCResult::Type::OBJ, "", "", ClusterDescription()},
906        RPCExamples{
907            HelpExampleCli("getmempoolcluster", "txid")
908            + HelpExampleRpc("getmempoolcluster", R"("txid")")
909        },
910        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
911{
912    uint256 hash = ParseHashV(request.params[0], "txid");
913
914    const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
915    LOCK(mempool.cs);
916
917    auto txid = Txid::FromUint256(hash);
918    const auto entry{mempool.GetEntry(txid)};
919    if (entry == nullptr) {
920        throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
921    }
922
923    auto cluster = mempool.GetCluster(txid);
924
925    UniValue info(UniValue::VOBJ);
926    clusterToJSON(mempool, info, cluster);
927    return info;
928},
929    };
930}
931
932static RPCMethod getmempoolentry()
933{
934    return RPCMethod{
935        "getmempoolentry",
936        "Returns mempool data for given transaction\n",
937        {
938            {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"},
939        },
940        RPCResult{
941            RPCResult::Type::OBJ, "", "", MempoolEntryDescription()},
942        RPCExamples{
943            HelpExampleCli("getmempoolentry", "\"mytxid\"")
944            + HelpExampleRpc("getmempoolentry", "\"mytxid\"")
945        },
946        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
947{
948    auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
949
950    const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
951    LOCK(mempool.cs);
952
953    const auto entry{mempool.GetEntry(txid)};
954    if (entry == nullptr) {
955        throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
956    }
957
958    UniValue info(UniValue::VOBJ);
959    entryToJSON(mempool, info, *entry);
960    return info;
961},
962    };
963}
964
965static RPCMethod gettxspendingprevout()
966{
967    return RPCMethod{"gettxspendingprevout",
968        "Scans the mempool (and the txospenderindex, if available) to find transactions spending any of the given outputs",
969        {
970            {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The transaction outputs that we want to check, and within each, the txid (string) vout (numeric).",
971                {
972                    {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
973                        {
974                            {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
975                            {"vout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The output number"},
976                        },
977                    },
978                },
979            },
980            {"options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "",
981                {
982                    {"mempool_only", RPCArg::Type::BOOL, RPCArg::DefaultHint{"true if txospenderindex unavailable, otherwise false"}, "If false and mempool lacks a relevant spend, use txospenderindex (throws an exception if not available)."},
983                    {"return_spending_tx", RPCArg::Type::BOOL, RPCArg::DefaultHint{"false"}, "If true, return the full spending tx."},
984                },
985            },
986        },
987        RPCResult{
988            RPCResult::Type::ARR, "", "",
989            {
990                {RPCResult::Type::OBJ, "", "",
991                {
992                    {RPCResult::Type::STR_HEX, "txid", "the transaction id of the checked output"},
993                    {RPCResult::Type::NUM, "vout", "the vout value of the checked output"},
994                    {RPCResult::Type::STR_HEX, "spendingtxid", /*optional=*/true, "the transaction id of the mempool transaction spending this output (omitted if unspent)"},
995                    {RPCResult::Type::STR_HEX, "spendingtx", /*optional=*/true, "the transaction spending this output (only if return_spending_tx is set, omitted if unspent)"},
996                    {RPCResult::Type::STR_HEX, "blockhash", /*optional=*/true, "the hash of the spending block (omitted if unspent or the spending tx is not confirmed)"},
997                }},
998            }
999        },
1000        RPCExamples{