mleku/libbase58
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make README as Markdown format

Browse Source
This commit is contained in:
CoperNick8
2018-07-03 13:32:30 +02:00
parent 1c9930a246
commit f0e2b756cd
2 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile.am
View File

@@ -14,7 +14,7 @@ pkgconfigdir = $(libdir)/pkgconfig
pkgconfig_DATA = libbase58.pc pkgconfig_DATA = libbase58.pc
dist_noinst_SCRIPTS = autogen.sh dist_noinst_SCRIPTS = autogen.sh
dist_doc_DATA = AUTHORS COPYING INSTALL README dist_doc_DATA = AUTHORS COPYING INSTALL README.md
if USE_TOOL if USE_TOOL
bin_PROGRAMS = base58 bin_PROGRAMS = base58

10
README → README.md
View File

@@ -3,8 +3,11 @@ Initialisation
Before you can use libbase58 for base58check, you must provide a SHA256 Before you can use libbase58 for base58check, you must provide a SHA256
function. The required function signature is: function. The required function signature is:
bool my_sha256(void *digest, const void *data, size_t datasz) bool my_sha256(void *digest, const void *data, size_t datasz)
Simply assign your function to b58_sha256_impl: Simply assign your function to b58_sha256_impl:
b58_sha256_impl = my_sha256; b58_sha256_impl = my_sha256;
This is only required if base58check is used. Raw base58 does not need SHA256. This is only required if base58check is used. Raw base58 does not need SHA256.
@@ -15,7 +18,9 @@ Decoding Base58
Simply allocate a buffer to store the binary data in, and set a variable with Simply allocate a buffer to store the binary data in, and set a variable with
the buffer size, and call the b58tobin function: the buffer size, and call the b58tobin function:
bool b58tobin(void *bin, size_t *binsz, const char *b58, size_t b58sz) bool b58tobin(void *bin, size_t *binsz, const char *b58, size_t b58sz)
The "canonical" base58 byte length will be assigned to binsz on success, which The "canonical" base58 byte length will be assigned to binsz on success, which
may be larger than the actual buffer if the input has many leading zeros. may be larger than the actual buffer if the input has many leading zeros.
Regardless of the canonical byte length, the full binary buffer will be used. Regardless of the canonical byte length, the full binary buffer will be used.
@@ -28,7 +33,9 @@ Validating Base58Check
After calling b58tobin, you can validate base58check data using the b58check After calling b58tobin, you can validate base58check data using the b58check
function: function:
int b58check(const void *bin, size_t binsz, const char *b58, size_t b58sz) int b58check(const void *bin, size_t binsz, const char *b58, size_t b58sz)
Call it with the same buffers used for b58tobin. If the return value is Call it with the same buffers used for b58tobin. If the return value is
negative, an error occurred. Otherwise, the return value is the base58check negative, an error occurred. Otherwise, the return value is the base58check
"version" byte from the decoded data. "version" byte from the decoded data.
@@ -39,7 +46,9 @@ Encoding Base58
Allocate a string to store the base58 content, create a size_t variable with the Allocate a string to store the base58 content, create a size_t variable with the
size of that allocation, and call: size of that allocation, and call:
bool b58enc(char *b58, size_t *b58sz, const void *data, size_t binsz) bool b58enc(char *b58, size_t *b58sz, const void *data, size_t binsz)
Note that you must pass a pointer to the string size variable, not the size Note that you must pass a pointer to the string size variable, not the size
itself. When b58enc returns, the variable will be modified to contain the actual itself. When b58enc returns, the variable will be modified to contain the actual
number of bytes used (including the null terminator). If encoding fails for any number of bytes used (including the null terminator). If encoding fails for any
@@ -52,5 +61,6 @@ Encoding Base58Check
Targeting base58check is done similarly to raw base58 encoding, but you must Targeting base58check is done similarly to raw base58 encoding, but you must
also provide a version byte: also provide a version byte:
bool b58check_enc(char *b58c, size_t *b58c_sz, uint8_t ver, bool b58check_enc(char *b58c, size_t *b58c_sz, uint8_t ver,
const void *data, size_t datasz) const void *data, size_t datasz)