bip32.h File Reference

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>

Include dependency graph for bip32.h:

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

Go to the source code of this file.

Classes
struct	path_bip32_t

Macros
#define	BIP32_HARDENED_MASK   0x80000000u
#define	MAX_BIP32_PATH   10

Functions
bool	bip32_path_read (const uint8_t *in, size_t in_len, uint32_t *out, size_t out_len)
bool	bip32_path_format (const uint32_t *bip32_path, size_t bip32_path_len, char *out, size_t out_len)
bool	bip32_path_format_simple (path_bip32_t *bip32, char *out, size_t out_len)
	Format a BIP32 path as a string.

Macro Definition Documentation

BIP32_HARDENED_MASK

#define BIP32_HARDENED_MASK   0x80000000u

Hardening mask for BIP32 path elements

Definition at line 10 of file bip32.h.

MAX_BIP32_PATH

#define MAX_BIP32_PATH   10

Maximum length of BIP32 path allowed.

Definition at line 15 of file bip32.h.

Function Documentation

bip32_path_format()

bool bip32_path_format	(	const uint32_t *	bip32_path,
		size_t	bip32_path_len,
		char *	out,
		size_t	out_len
	)

Format BIP32 path as string.

Parameters

[in]	bip32_path	Pointer to 32-bit integer input buffer.
[in]	bip32_path_len	Maximum number of BIP32 paths in the input buffer.
[out]	out	Pointer to output string.
[in]	out_len	Length of the output string.

Returns

true if success, false otherwise.

Definition at line 49 of file bip32.c.

bip32_path_format_simple()

bool bip32_path_format_simple	(	path_bip32_t *	bip32,
		char *	out,
		size_t	out_len
	)

Format a BIP32 path as a string.

Convenience wrapper around bip32_path_format() for the path_bip32_t structure.

Parameters

[in]	bip32	The BIP32 path structure.
[out]	out	The output buffer to store the formatted string.
[in]	out_len	The length of the output buffer.

Returns

true if the BIP32 path was successfully formatted, false otherwise.

Definition at line 92 of file bip32.c.

bip32_path_read()

bool bip32_path_read	(	const uint8_t *	in,
		size_t	in_len,
		uint32_t *	out,
		size_t	out_len
	)

Read BIP32 path from byte buffer.

Parameters

[in]	in	Pointer to input byte buffer.
[in]	in_len	Length of input byte buffer.
[out]	out	Pointer to output 32-bit integer buffer.
[in]	out_len	Number of BIP32 paths read in the output buffer.

Returns

true if success, false otherwise.

Definition at line 26 of file bip32.c.