[#bech32-Encode]
= xref:bech32.adoc[bech32]::Encode
:relfileprefix: ../
:mrdocs:

Encode a Bech32 or Bech32m string. If hrp contains uppercase characters, this will cause an assertion error. Encoding must be one of BECH32 or BECH32M.

== Synopsis

Declared in `<bech32.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::string
Encode(
    xref:bech32/Encoding.adoc[Encoding] encoding,
    std::string const& hrp,
    std::vector<uint8_t> const& values);
----

== Return Value

The encoded Bech32(m) string.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *encoding*
| The Bech32 variant to use (BECH32 or BECH32M).
| *hrp*
| The human‐readable part; must be lowercase.
| *values*
| The base32 data payload to encode.
|===


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