Page MenuHomePhabricator
Differential D6066 Diff 20038 src/rpc/rawtransaction.cpp

Changeset View

Standalone View

View Options

src/rpc/rawtransaction.cpp

Show First 20 Lines • Show All 102 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() < 1 ||
{ {
RPCResult{"if verbose is not set or set to false", RPCResult{"if verbose is not set or set to false",
"\"data\" (string) The serialized, hex-encoded " "\"data\" (string) The serialized, hex-encoded "
"data for 'txid'\n"}, "data for 'txid'\n"},
RPCResult{ RPCResult{
"if verbose is set to true", "if verbose is set to true",
"{\n" "{\n"
" \"in_active_chain\": b, (bool) Whether specified block " " \"in_active_chain\": b, (bool) Whether specified block "
"is in " "is in the active chain or not (only present with explicit "
"the active chain or not (only present with explicit " "\"blockhash\" argument)\n"
"\"blockhash\" "
"argument)\n"
" \"hex\" : \"data\", (string) The serialized, " " \"hex\" : \"data\", (string) The serialized, "
"hex-encoded " "hex-encoded data for 'txid'\n"
"data for 'txid'\n"
" \"txid\" : \"id\", (string) The transaction id " " \"txid\" : \"id\", (string) The transaction id "
"(same as " "(same as provided)\n"
"provided)\n"
" \"hash\" : \"id\", (string) The transaction hash " " \"hash\" : \"id\", (string) The transaction hash "
"(differs from txid for witness transactions)\n" "(differs from txid for witness transactions)\n"
" \"size\" : n, (numeric) The serialized " " \"size\" : n, (numeric) The serialized "
"transaction " "transaction size\n"
"size\n"
" \"version\" : n, (numeric) The version\n" " \"version\" : n, (numeric) The version\n"
" \"locktime\" : ttt, (numeric) The lock time\n" " \"locktime\" : ttt, (numeric) The lock time\n"
" \"vin\" : [ (array of json objects)\n" " \"vin\" : [ (array of json objects)\n"
" {\n" " {\n"
" \"txid\": \"id\", (string) The transaction id\n" " \"txid\": \"id\", (string) The transaction id\n"
" \"vout\": n, (numeric) \n" " \"vout\": n, (numeric) \n"
" \"scriptSig\": { (json object) The script\n" " \"scriptSig\": { (json object) The script\n"
" \"asm\": \"asm\", (string) asm\n" " \"asm\": \"asm\", (string) asm\n"
Show All 14 Lines if (request.fHelp || request.params.size() < 1 ||
" \"scriptPubKey\" : { (json object)\n" " \"scriptPubKey\" : { (json object)\n"
" \"asm\" : \"asm\", (string) the " " \"asm\" : \"asm\", (string) the "
"asm\n" "asm\n"
" \"hex\" : \"hex\", (string) the " " \"hex\" : \"hex\", (string) the "
"hex\n" "hex\n"
" \"reqSigs\" : n, (numeric) The " " \"reqSigs\" : n, (numeric) The "
"required sigs\n" "required sigs\n"
" \"type\" : \"pubkeyhash\", (string) The " " \"type\" : \"pubkeyhash\", (string) The "
"type, eg " "type, eg 'pubkeyhash'\n"
"'pubkeyhash'\n"
" \"addresses\" : [ (json array of " " \"addresses\" : [ (json array of "
"string)\n" "string)\n"
" \"address\" (string) bitcoin " " \"address\" (string) bitcoin "
"address\n" "address\n"
" ,...\n" " ,...\n"
" ]\n" " ]\n"
" }\n" " }\n"
" }\n" " }\n"
" ,...\n" " ,...\n"
" ],\n" " ],\n"
" \"blockhash\" : \"hash\", (string) the block " " \"blockhash\" : \"hash\", (string) the block "
"hash\n" "hash\n"
" \"confirmations\" : n, (numeric) The " " \"confirmations\" : n, (numeric) The "
"confirmations\n" "confirmations\n"
" \"time\" : ttt, (numeric) The " " \"time\" : ttt, (numeric) The "
"transaction time in " "transaction time in seconds since epoch (Jan 1 1970 "
"seconds since epoch (Jan 1 1970 GMT)\n" "GMT)\n"
" \"blocktime\" : ttt (numeric) The block " " \"blocktime\" : ttt (numeric) The block "
"time in seconds " "time in seconds since epoch (Jan 1 1970 GMT)\n"
"since epoch (Jan 1 1970 GMT)\n"
"}\n"}, "}\n"},
}, },
RPCExamples{ RPCExamples{
HelpExampleCli("getrawtransaction", "\"mytxid\"") + HelpExampleCli("getrawtransaction", "\"mytxid\"") +
HelpExampleCli("getrawtransaction", "\"mytxid\" true") + HelpExampleCli("getrawtransaction", "\"mytxid\" true") +
HelpExampleRpc("getrawtransaction", "\"mytxid\", true") + HelpExampleRpc("getrawtransaction", "\"mytxid\", true") +
HelpExampleCli("getrawtransaction", HelpExampleCli("getrawtransaction",
"\"mytxid\" false \"myblockhash\"") + "\"mytxid\" false \"myblockhash\"") +
▲ Show 20 Lines • Show All 265 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() < 2 ||
request.params.size() > 3) { request.params.size() > 3) {
throw std::runtime_error(RPCHelpMan{ throw std::runtime_error(RPCHelpMan{
"createrawtransaction", "createrawtransaction",
"\nCreate a transaction spending the given inputs and creating " "\nCreate a transaction spending the given inputs and creating "
"new outputs.\n" "new outputs.\n"
"Outputs can be addresses or data.\n" "Outputs can be addresses or data.\n"
"Returns hex-encoded raw transaction.\n" "Returns hex-encoded raw transaction.\n"
"Note that the transaction's inputs are not signed, and\n" "Note that the transaction's inputs are not signed, and\n"
"it is not stored in the wallet or transmitted to the " "it is not stored in the wallet or transmitted to the network.\n",
"network.\n",
{ {
{ {
"inputs", "inputs",
RPCArg::Type::ARR, RPCArg::Type::ARR,
/* opt */ false, /* opt */ false,
/* default_val */ "", /* default_val */ "",
"A json array of json objects", "A json array of json objects",
{ {
▲ Show 20 Lines • Show All 175 Lines • ▼ Show 20 Linesstatic UniValue decodescript(const Config &config,
if (request.fHelp || request.params.size() != 1) { if (request.fHelp || request.params.size() != 1) {
throw std::runtime_error(RPCHelpMan{ throw std::runtime_error(RPCHelpMan{
"decodescript", "decodescript",
"\nDecode a hex-encoded script.\n", "\nDecode a hex-encoded script.\n",
{ {
{"hexstring", RPCArg::Type::STR_HEX, /* opt */ false, {"hexstring", RPCArg::Type::STR_HEX, /* opt */ false,
/* default_val */ "", "the hex-encoded script"}, /* default_val */ "", "the hex-encoded script"},
}, },
RPCResult{ RPCResult{"{\n"
"{\n"
" \"asm\":\"asm\", (string) Script public key\n" " \"asm\":\"asm\", (string) Script public key\n"
" \"hex\":\"hex\", (string) hex-encoded public key\n" " \"hex\":\"hex\", (string) hex-encoded public key\n"
" \"type\":\"type\", (string) The output type\n" " \"type\":\"type\", (string) The output type\n"
" \"reqSigs\": n, (numeric) The required signatures\n" " \"reqSigs\": n, (numeric) The required signatures\n"
" \"addresses\": [ (json array of string)\n" " \"addresses\": [ (json array of string)\n"
" \"address\" (string) bitcoin address\n" " \"address\" (string) bitcoin address\n"
" ,...\n" " ,...\n"
" ],\n" " ],\n"
" \"p2sh\",\"address\" (string) address of P2SH script " " \"p2sh\",\"address\" (string) address of P2SH script "
"wrapping " "wrapping this redeem script (not returned if the script "
"this redeem script (not returned if the script is already a " "is already a P2SH).\n"
"P2SH).\n"
"}\n"}, "}\n"},
RPCExamples{HelpExampleCli("decodescript", "\"hexstring\"") + RPCExamples{HelpExampleCli("decodescript", "\"hexstring\"") +
HelpExampleRpc("decodescript", "\"hexstring\"")}, HelpExampleRpc("decodescript", "\"hexstring\"")},
} }
.ToString()); .ToString());
} }
RPCTypeCheck(request.params, {UniValue::VSTR}); RPCTypeCheck(request.params, {UniValue::VSTR});
Show All 21 Linesstatic UniValue decodescript(const Config &config,
return r; return r;
} }
static UniValue combinerawtransaction(const Config &config, static UniValue combinerawtransaction(const Config &config,
const JSONRPCRequest &request) { const JSONRPCRequest &request) {
if (request.fHelp || request.params.size() != 1) { if (request.fHelp || request.params.size() != 1) {
throw std::runtime_error(RPCHelpMan{ throw std::runtime_error(RPCHelpMan{
"combinerawtransaction", "combinerawtransaction",
"\nCombine multiple partially signed transactions into " "\nCombine multiple partially signed transactions into one "
"one transaction.\n" "transaction.\n"
"The combined transaction may be another partially " "The combined transaction may be another partially signed "
"signed transaction or a \n" "transaction or a \n"
"fully signed transaction.", "fully signed transaction.",
{ {
{ {
"txs", "txs",
RPCArg::Type::ARR, RPCArg::Type::ARR,
/* opt */ false, /* opt */ false,
/* default_val */ "", /* default_val */ "",
"A json array of hex strings of partially " "A json array of hex strings of partially signed "
"signed transactions", "transactions",
{ {
{"hexstring", RPCArg::Type::STR_HEX, {"hexstring", RPCArg::Type::STR_HEX,
/* opt */ false, /* default_val */ "", /* opt */ false, /* default_val */ "",
"A transaction hash"}, "A transaction hash"},
}, },
}, },
}, },
RPCResult{"\"hex\" (string) The hex-encoded raw " RPCResult{"\"hex\" (string) The hex-encoded raw "
▲ Show 20 Lines • Show All 77 Lines • ▼ Show 20 Lines
static UniValue signrawtransactionwithkey(const Config &config, static UniValue signrawtransactionwithkey(const Config &config,
const JSONRPCRequest &request) { const JSONRPCRequest &request) {
if (request.fHelp || request.params.size() < 2 || if (request.fHelp || request.params.size() < 2 ||
request.params.size() > 4) { request.params.size() > 4) {
throw std::runtime_error(RPCHelpMan{ throw std::runtime_error(RPCHelpMan{
"signrawtransactionwithkey", "signrawtransactionwithkey",
"\nSign inputs for raw transaction (serialized, hex-encoded).\n" "\nSign inputs for raw transaction (serialized, hex-encoded).\n"
"The second argument is an array of base58-encoded private\n" "The second argument is an array of base58-encoded private\n"
"keys that will be the only keys used to sign the " "keys that will be the only keys used to sign the transaction.\n"
"transaction.\n" "The third optional argument (may be null) is an array of previous "
"The third optional argument (may be null) is an array of " "transaction outputs that\n"
"previous transaction outputs that\n"
"this transaction depends on but may not yet be in the block " "this transaction depends on but may not yet be in the block "
"chain.\n", "chain.\n",
{ {
{"hexstring", RPCArg::Type::STR_HEX, /* opt */ false, {"hexstring", RPCArg::Type::STR_HEX, /* opt */ false,
/* default_val */ "", "The transaction hex string"}, /* default_val */ "", "The transaction hex string"},
{ {
"privkeys", "privkeys",
RPCArg::Type::ARR, RPCArg::Type::ARR,
/* opt */ false, /* opt */ false,
/* default_val */ "", /* default_val */ "",
"A json array of base58-encoded private keys for " "A json array of base58-encoded private keys for signing",
"signing",
{ {
{"privatekey", RPCArg::Type::STR, {"privatekey", RPCArg::Type::STR,
/* opt */ false, /* default_val */ "", /* opt */ false, /* default_val */ "",
"private key in base58-encoding"}, "private key in base58-encoding"},
}, },
}, },
{ {
"prevtxs", "prevtxs",
RPCArg::Type::ARR, RPCArg::Type::ARR,
/* opt */ true, /* opt */ true,
/* default_val */ "", /* default_val */ "",
"A json array of previous dependent transaction " "A json array of previous dependent transaction outputs",
"outputs",
{ {
{ {
"", "",
RPCArg::Type::OBJ, RPCArg::Type::OBJ,
/* opt */ true, /* opt */ true,
/* default_val */ "", /* default_val */ "",
"", "",
{ {
▲ Show 20 Lines • Show All 80 Lines • ▼ Show 20 Lines
} }
static UniValue sendrawtransaction(const Config &config, static UniValue sendrawtransaction(const Config &config,
const JSONRPCRequest &request) { const JSONRPCRequest &request) {
if (request.fHelp || request.params.size() < 1 || if (request.fHelp || request.params.size() < 1 ||
request.params.size() > 2) { request.params.size() > 2) {
throw std::runtime_error(RPCHelpMan{ throw std::runtime_error(RPCHelpMan{
"sendrawtransaction", "sendrawtransaction",
"\nSubmits raw transaction (serialized, hex-encoded) to " "\nSubmits raw transaction (serialized, hex-encoded) to local node "
"local node and network.\n" "and network.\n"
"\nAlso see createrawtransaction and " "\nAlso see createrawtransaction and "
"signrawtransactionwithkey calls.\n", "signrawtransactionwithkey calls.\n",
{ {
{"hexstring", RPCArg::Type::STR_HEX, /* opt */ false, {"hexstring", RPCArg::Type::STR_HEX, /* opt */ false,
/* default_val */ "", "The hex string of the raw transaction"}, /* default_val */ "", "The hex string of the raw transaction"},
{"allowhighfees", RPCArg::Type::BOOL, /* opt */ true, {"allowhighfees", RPCArg::Type::BOOL, /* opt */ true,
/* default_val */ "false", "Allow high fees"}, /* default_val */ "false", "Allow high fees"},
}, },
▲ Show 20 Lines • Show All 42 Lines • ▼ Show 20 Lines
} }
static UniValue testmempoolaccept(const Config &config, static UniValue testmempoolaccept(const Config &config,
const JSONRPCRequest &request) { const JSONRPCRequest &request) {
if (request.fHelp || request.params.size() < 1 || if (request.fHelp || request.params.size() < 1 ||
request.params.size() > 2) { request.params.size() > 2) {
throw std::runtime_error(RPCHelpMan{ throw std::runtime_error(RPCHelpMan{
"testmempoolaccept", "testmempoolaccept",
"\nReturns if raw transaction (serialized, hex-encoded) " "\nReturns if raw transaction (serialized, hex-encoded) would be "
"would be accepted by mempool.\n" "accepted by mempool.\n"
"\nThis checks if the transaction violates the " "\nThis checks if the transaction violates the consensus or policy "
"consensus or policy rules.\n" "rules.\n"
"\nSee sendrawtransaction call.\n", "\nSee sendrawtransaction call.\n",
{ {
{ {
"rawtxs", "rawtxs",
RPCArg::Type::ARR, RPCArg::Type::ARR,
/* opt */ false, /* opt */ false,
/* default_val */ "", /* default_val */ "",
"An array of hex strings of raw transactions.\n" "An array of hex strings of raw transactions.\n"
" Length " " Length must be "
"must be one for now.", "one for now.",
{ {
{"rawtx", RPCArg::Type::STR_HEX, {"rawtx", RPCArg::Type::STR_HEX,
/* opt */ false, /* default_val */ "", ""}, /* opt */ false, /* default_val */ "", ""},
}, },
}, },
{"allowhighfees", RPCArg::Type::BOOL, /* opt */ true, {"allowhighfees", RPCArg::Type::BOOL, /* opt */ true,
/* default_val */ "false", "Allow high fees"}, /* default_val */ "false", "Allow high fees"},
}, },
▲ Show 20 Lines • Show All 443 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() < 1 ||
"inputs that are complete.\n" "inputs that are complete.\n"
"Implements the Finalizer and Extractor roles.\n", "Implements the Finalizer and Extractor roles.\n",
{ {
{"psbt", RPCArg::Type::STR, /* opt */ false, {"psbt", RPCArg::Type::STR, /* opt */ false,
/* default_val */ "", "A base64 string of a PSBT"}, /* default_val */ "", "A base64 string of a PSBT"},
{"extract", RPCArg::Type::BOOL, /* opt */ true, {"extract", RPCArg::Type::BOOL, /* opt */ true,
/* default_val */ "true", /* default_val */ "true",
"If true and the transaction is complete,\n" "If true and the transaction is complete,\n"
" extract and return " " extract and return the complete "
"the complete transaction in normal network " "transaction in normal network serialization instead of the "
"serialization instead of the PSBT."}, "PSBT."},
}, },
RPCResult{ RPCResult{
"{\n" "{\n"
" \"psbt\" : \"value\", (string) The base64-encoded " " \"psbt\" : \"value\", (string) The base64-encoded "
"partially signed transaction if not extracted\n" "partially signed transaction if not extracted\n"
" \"hex\" : \"value\", (string) The hex-encoded " " \"hex\" : \"value\", (string) The hex-encoded "
"network transaction if extracted\n" "network transaction if extracted\n"
" \"complete\" : true|false, (boolean) If the transaction " " \"complete\" : true|false, (boolean) If the transaction "
Show All 40 Lines
} }
static UniValue createpsbt(const Config &config, static UniValue createpsbt(const Config &config,
const JSONRPCRequest &request) { const JSONRPCRequest &request) {
if (request.fHelp || request.params.size() < 2 || if (request.fHelp || request.params.size() < 2 ||
request.params.size() > 3) { request.params.size() > 3) {
throw std::runtime_error(RPCHelpMan{ throw std::runtime_error(RPCHelpMan{
"createpsbt", "createpsbt",
"\nCreates a transaction in the Partially Signed " "\nCreates a transaction in the Partially Signed Transaction "
"Transaction format.\n" "format.\n"
"Implements the Creator role.\n", "Implements the Creator role.\n",
{ {
{ {
"inputs", "inputs",
RPCArg::Type::ARR, RPCArg::Type::ARR,
/* opt */ false, /* opt */ false,
/* default_val */ "", /* default_val */ "",
"A json array of json objects", "A json array of json objects",
▲ Show 20 Lines • Show All 55 Lines • ▼ Show 20 Lines if (request.fHelp || request.params.size() < 2 ||
"A key-value pair. The key must be " "A key-value pair. The key must be "
"\"data\", the value is hex-encoded data"}, "\"data\", the value is hex-encoded data"},
}, },
}, },
}, },
}, },
{"locktime", RPCArg::Type::NUM, /* opt */ true, {"locktime", RPCArg::Type::NUM, /* opt */ true,
/* default_val */ "0", /* default_val */ "0",
"Raw locktime. Non-0 value also locktime-activates " "Raw locktime. Non-0 value also locktime-activates inputs"},
"inputs"},
}, },
RPCResult{" \"psbt\" (string) The resulting raw " RPCResult{" \"psbt\" (string) The resulting raw "
"transaction (base64-encoded string)\n"}, "transaction (base64-encoded string)\n"},
RPCExamples{HelpExampleCli( RPCExamples{HelpExampleCli(
"createpsbt", "\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]" "createpsbt", "\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]"
"\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"")}, "\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"")},
} }
.ToString()); .ToString());
Show All 32 Linesstatic UniValue converttopsbt(const Config &config,
const JSONRPCRequest &request) { const JSONRPCRequest &request) {
if (request.fHelp || request.params.size() < 1 || if (request.fHelp || request.params.size() < 1 ||
request.params.size() > 2) { request.params.size() > 2) {
throw std::runtime_error(RPCHelpMan{ throw std::runtime_error(RPCHelpMan{
"converttopsbt", "converttopsbt",
"\nConverts a network serialized transaction to a PSBT. " "\nConverts a network serialized transaction to a PSBT. "
"This should be used only with createrawtransaction and " "This should be used only with createrawtransaction and "
"fundrawtransaction\n" "fundrawtransaction\n"
"createpsbt and walletcreatefundedpsbt should be used " "createpsbt and walletcreatefundedpsbt should be used for new "
"for new applications.\n", "applications.\n",
{ {
{"hexstring", RPCArg::Type::STR_HEX, /* opt */ false, {"hexstring", RPCArg::Type::STR_HEX, /* opt */ false,
/* default_val */ "", "The hex string of a raw transaction"}, /* default_val */ "", "The hex string of a raw transaction"},
{"permitsigdata", RPCArg::Type::BOOL, /* opt */ true, {"permitsigdata", RPCArg::Type::BOOL, /* opt */ true,
/* default_val */ "false", /* default_val */ "false",
"If true, any signatures in the input will be discarded " "If true, any signatures in the input will be discarded and "
"and conversion.\n" "conversion.\n"
" will continue. If false, " " will continue. If false, RPC "
"RPC will fail if any signatures are present."}, "will fail if any signatures are present."},
}, },
RPCResult{" \"psbt\" (string) The resulting raw " RPCResult{" \"psbt\" (string) The resulting raw "
"transaction (base64-encoded string)\n"}, "transaction (base64-encoded string)\n"},
RPCExamples{ RPCExamples{
"\nCreate a transaction\n" + "\nCreate a transaction\n" +
HelpExampleCli("createrawtransaction", HelpExampleCli("createrawtransaction",
"\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]" "\"[{\\\"txid\\\":\\\"myid\\\",\\\"vout\\\":0}]"
"\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"") + "\" \"[{\\\"data\\\":\\\"00010203\\\"}]\"") +
▲ Show 20 Lines • Show All 212 Lines • Show Last 20 Lines