Function getrawtransaction

src/rpc/rawtransaction.cpp:214–365

}

static RPCMethod getrawtransaction()
{
    const std::vector<RPCResult> verbosity_1_block{
        {RPCResult::Type::BOOL, "in_active_chain", /*optional=*/true, "Whether specified block is in the active chain or not (only present with explicit \"blockhash\" argument)"},
        {RPCResult::Type::STR_HEX, "blockhash", /*optional=*/true, "the block hash"},
        {RPCResult::Type::NUM, "confirmations", /*optional=*/true, "The confirmations"},
        {RPCResult::Type::NUM_TIME, "blocktime", /*optional=*/true, "The block time expressed in " + UNIX_EPOCH_TIME},
        {RPCResult::Type::NUM, "time", /*optional=*/true, "Same as \"blocktime\""},
        {RPCResult::Type::STR_HEX, "hex", "The serialized, hex-encoded data for 'txid'"},
    };
    const auto v2_extras = Cat<std::vector<RPCResult>>(
        std::vector<RPCResult>{{
            RPCResult::Type::NUM, "fee", /*optional=*/true,
            "transaction fee in " + CURRENCY_UNIT + ", omitted if block undo data is not available"
        }},
        TxDoc({.elision_mode = ElisionMode::Silent,
               .prevout = true,
               .prevout_optional = true,
               .vin_inner_elision = "Same vin fields as verbosity = 1"}));
    return RPCMethod{
                "getrawtransaction",

                "By default, this call only returns a transaction if it is in the mempool. If -txindex is enabled\n"
                "and no blockhash argument is passed, it will return the transaction if it is in the mempool or any block.\n"
                "If a blockhash argument is passed, it will return the transaction if\n"
                "the specified block is available and the transaction is in that block.\n\n"
                "Hint: Use gettransaction for wallet transactions.\n\n"

                "If verbosity is 0 or omitted, returns the serialized transaction as a hex-encoded string.\n"
                "If verbosity is 1, returns a JSON Object with information about the transaction.\n"
                "If verbosity is 2, returns a JSON Object with information about the transaction, including fee and prevout information.",
                {
                    {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
                    {"verbosity|verbose", RPCArg::Type::NUM, RPCArg::Default{0}, "0 for hex-encoded data, 1 for a JSON object, and 2 for JSON object with fee and prevout",
                     RPCArgOptions{.skip_type_check = true}},
                    {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "The block in which to look for the transaction"},
                },
                {
                    RPCResult{"if verbosity is not set or set to 0",
                         RPCResult::Type::STR, "data", "The serialized transaction as a hex-encoded string for 'txid'"
                     },
                     RPCResult{"if verbosity is set to 1",
                         RPCResult::Type::OBJ, "", "",
                         Cat<std::vector<RPCResult>>(
                         verbosity_1_block,
                         TxDoc({.txid_field_doc="The transaction id (same as provided)"})),
                    },
                    RPCResult{"for verbosity = 2", RPCResult::Type::OBJ, "", "",
                    Cat(ElideGroup(verbosity_1_block, "Same output as verbosity = 1"), v2_extras)},
                },
                RPCExamples{
                    HelpExampleCli("getrawtransaction", "\"mytxid\"")
            + HelpExampleCli("getrawtransaction", "\"mytxid\" 1")
            + HelpExampleRpc("getrawtransaction", "\"mytxid\", 1")
            + HelpExampleCli("getrawtransaction", "\"mytxid\" 0 \"myblockhash\"")
            + HelpExampleCli("getrawtransaction", "\"mytxid\" 1 \"myblockhash\"")
            + HelpExampleCli("getrawtransaction", "\"mytxid\" 2 \"myblockhash\"")
                },