[#UniValue]
= UniValue
:mrdocs:

A dynamically typed JSON value used across Bitcoin Core's RPC layer.

== Synopsis

Declared in `<univalue/include/univalue.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class UniValue;
----

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:AmountFromValue.adoc[`AmountFromValue`]
| Validate and return a CAmount from a UniValue number or string.
| xref:BanMapFromJson.adoc[`BanMapFromJson`]
| Convert a JSON array to a `banmap_t` object.
| xref:BanMapToJson.adoc[`BanMapToJson`]
| Convert a `banmap_t` object to a JSON array.
| xref:ConstructTransaction.adoc[`ConstructTransaction`]
| Create a transaction from univalue parameters
| xref:CreateUTXOSnapshot.adoc[`CreateUTXOSnapshot`]
| Helper to create UTXO snapshots given a chainstate and a file handle.
| xref:DescribeAddress.adoc[`DescribeAddress`]
| Describe an address as a JSON object for RPC output.
| xref:EvalDescriptorStringOrObject.adoc[`EvalDescriptorStringOrObject`]
| Evaluate a descriptor given as a string, or as a {"desc":...,"range":...} object, with default range of 1000.
| xref:ExecuteHTTPRPC.adoc[`ExecuteHTTPRPC`]
| Execute a single HTTP request containing one or more JSONRPC requests. Specified jreq will be modified and status will be returned.
| xref:JSONRPCError.adoc[`JSONRPCError`]
| Build a JSON‐RPC error object.
| xref:JSONRPCExec.adoc[`JSONRPCExec`]
| Execute an RPC request and return its JSON‐RPC reply.
| xref:JSONRPCPSBTError.adoc[`JSONRPCPSBTError`]
| Build a JSON‐RPC error object for a PSBT error.
| xref:JSONRPCProcessBatchReply.adoc[`JSONRPCProcessBatchReply`]
| Parse JSON‐RPC batch reply into a vector
| xref:JSONRPCReplyObj.adoc[`JSONRPCReplyObj`]
| Build a JSON‐RPC reply object from a result or error.
| xref:JSONRPCRequestObj.adoc[`JSONRPCRequestObj`]
| JSON‐RPC 2.0 request, only used in bitcoin‐cli
| xref:JSONRPCTransactionError.adoc[`JSONRPCTransactionError`]
| Build a JSON‐RPC error object for a transaction error.
| xref:MempoolInfoToJSON.adoc[`MempoolInfoToJSON`]
| Mempool information to JSON
| xref:MempoolToJSON.adoc[`MempoolToJSON`]
| Mempool to JSON
| xref:NormalizeOutputs.adoc[`NormalizeOutputs`]
| Normalize univalue‐represented outputs
| xref:ParseConfirmTarget.adoc[`ParseConfirmTarget`]
| Parse a confirm target option and raise an RPC error if it is invalid.
| xref:ParseDescriptorRange.adoc[`ParseDescriptorRange`]
| Parse a JSON range specified as an int64 or as a [int64, int64]pair.
| xref:ParseFeeRate.adoc[`ParseFeeRate`]
| Parse a json number or string, denoting BTC/kvB, into a CFeeRate (sat/kvB). Reject negative values or rates larger than 1BTC/kvB.
| xref:ParseHashO.adoc[`ParseHashO`]
| Parse a hex‐encoded hash from a named field of an object.
| xref:ParseHashV.adoc[`ParseHashV`]
| Parse a hex‐encoded hash from a UniValue, throwing an RPC error if it is not valid hex.
| xref:ParseHexO.adoc[`ParseHexO`]
| Parse a hex‐encoded byte vector from a named field of an object.
| xref:ParseHexV.adoc[`ParseHexV`]
| Parse a hex‐encoded byte vector from a UniValue, throwing an RPC error if it is not valid hex.
| xref:ParseOutputs.adoc[`ParseOutputs`]
| Parse normalized outputs into destination, amount tuples
| xref:ParsePrevouts.adoc[`ParsePrevouts`]
| Parse a prevtxs UniValue array and get the map of coins from it
| xref:ParseSighashString.adoc[`ParseSighashString`]
| Parse a sighash string representation and raise an RPC error if it is invalid.
| xref:ParseVerbosity.adoc[`ParseVerbosity`]
| Parses verbosity from provided UniValue.
| xref:PushWarnings-02.adoc[`PushWarnings`]
| Push warning messages to an RPC "warnings" field as a JSON array of strings.
| xref:RPCConvertNamedValues.adoc[`RPCConvertNamedValues`]
| Convert named arguments to command‐specific RPC representation
| xref:RPCConvertValues.adoc[`RPCConvertValues`]
| Convert positional arguments to command‐specific RPC representation
| xref:RPCTypeCheckObj.adoc[`RPCTypeCheckObj`]
| Check that an object contains the expected keys with the expected value types.
| xref:RunCommandParseJSON.adoc[`RunCommandParseJSON`]
| Execute a command which returns JSON, and parse the result.
| xref:ValueFromAmount.adoc[`ValueFromAmount`]
| Convert an amount in satoshis into a JSON value denominated in whole coins.
| xref:blockToJSON.adoc[`blockToJSON`]
| Block description to JSON
| xref:blockheaderToJSON.adoc[`blockheaderToJSON`]
| Block header to JSON
| xref:node/GetWarningsForRpc.adoc[`node::GetWarningsForRpc`]
| RPC helper function that wraps warnings.GetMessages().
| xref:wallet/AppendLastProcessedBlock.adoc[`wallet::AppendLastProcessedBlock`]
| Appends the wallet's last processed block to an RPC result object.
| xref:wallet/LabelFromValue.adoc[`wallet::LabelFromValue`]
| Validates and extracts an address label from an RPC value.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#