base58.h File Reference

#include "attributes.h"
#include "chainparams.h"
#include "key.h"
#include "pubkey.h"
#include "script/standard.h"
#include <string>
#include <vector>

Include dependency graph for base58.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
std::string	EncodeBase58 (const unsigned char *pbegin, const unsigned char *pend)
	Why base-58 instead of standard base-64 encoding? More...
std::string	EncodeBase58 (const std::vector< unsigned char > &vch)
	Encode a byte vector as a base58-encoded string. More...
NODISCARD bool	DecodeBase58 (const char *psz, std::vector< unsigned char > &vchRet, int max_ret_len)
	Decode a base58-encoded string (psz) into a byte vector (vchRet). More...
NODISCARD bool	DecodeBase58 (const std::string &str, std::vector< unsigned char > &vchRet, int max_ret_len)
	Decode a base58-encoded string (str) into a byte vector (vchRet). More...
std::string	EncodeBase58Check (const std::vector< unsigned char > &vchIn)
	Encode a byte vector into a base58-encoded string, including checksum. More...
NODISCARD bool	DecodeBase58Check (const char *psz, std::vector< unsigned char > &vchRet, int max_ret_len)
	Decode a base58-encoded string (psz) that includes a checksum into a byte vector (vchRet), return true if decoding is successful. More...
NODISCARD bool	DecodeBase58Check (const std::string &str, std::vector< unsigned char > &vchRet, int max_ret_len)
	Decode a base58-encoded string (str) that includes a checksum into a byte vector (vchRet), return true if decoding is successful. More...

Function Documentation

DecodeBase58() [1/2]

NODISCARD bool DecodeBase58	(	const char *	psz,
		std::vector< unsigned char > &	vchRet,
		int	max_ret_len
	)

Decode a base58-encoded string (psz) into a byte vector (vchRet).

return true if decoding is successful. psz cannot be nullptr.

Definition at line 23 of file base58.cpp.

Here is the caller graph for this function:

DecodeBase58() [2/2]

NODISCARD bool DecodeBase58	(	const std::string &	str,
		std::vector< unsigned char > &	vchRet,
		int	max_ret_len
	)

Decode a base58-encoded string (str) into a byte vector (vchRet).

return true if decoding is successful.

Definition at line 118 of file base58.cpp.

Here is the call graph for this function:

DecodeBase58Check() [1/2]

NODISCARD bool DecodeBase58Check	(	const char *	psz,
		std::vector< unsigned char > &	vchRet,
		int	max_ret_len
	)

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

Definition at line 135 of file base58.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

DecodeBase58Check() [2/2]

NODISCARD bool DecodeBase58Check	(	const std::string &	str,
		std::vector< unsigned char > &	vchRet,
		int	max_ret_len
	)

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

Definition at line 152 of file base58.cpp.

Here is the call graph for this function:

EncodeBase58() [1/2]

std::string EncodeBase58

(

const std::vector< unsigned char > &

vch

)

Encode a byte vector as a base58-encoded string.

Definition at line 113 of file base58.cpp.

Here is the call graph for this function:

EncodeBase58() [2/2]

std::string EncodeBase58	(	const unsigned char *	pbegin,
		const unsigned char *	pend
	)

Why base-58 instead of standard base-64 encoding?

• Don't want 0OIl characters that look the same in some fonts and could be used to create visually identical looking account numbers.
• A string with non-alphanumeric characters is not as easily accepted as an account number.
• E-mail usually won't line-break if there's no punctuation to break at.
• Double-clicking selects the whole number as one word if it's all alphanumeric. Encode a byte sequence as a base58-encoded string. pbegin and pend cannot be nullptr, unless both are.

Definition at line 73 of file base58.cpp.

Here is the caller graph for this function:

EncodeBase58Check()

std::string EncodeBase58Check

(

const std::vector< unsigned char > &

vchIn

)

Encode a byte vector into a base58-encoded string, including checksum.

Definition at line 126 of file base58.cpp.

Here is the call graph for this function: