[#DecodeBase58Check]
= DecodeBase58Check
:mrdocs:

Decode a base58‐encoded string (str) that includes a checksum into a byte vector (vchRet), return true if decoding is successful

== Synopsis

Declared in `<base58.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
bool
DecodeBase58Check(
    std::string const& str,
    std::vector<unsigned char>& vchRet,
    int max_ret_len);
----

== Return Value

true if decoding succeeds and the checksum matches.

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Parameters

[cols="1,4"]
|===
| Name| Description
| *str*
| The base58check‐encoded string to decode.
| *vchRet*
| Output vector that receives the decoded payload (checksum stripped).
| *max_ret_len*
| Maximum number of decoded bytes to accept.
|===


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