Bip32 Functions¶

int bip32_key_free(const struct ext_key *hdkey)¶

Free a key allocated by bip32_key_from_seed_alloc, bip32_key_from_seed_custom or bip32_key_unserialize_alloc.

Parameters:	hdkey – Key to free.
Returns:	See Error Codes

int bip32_key_init(uint32_t version, uint32_t depth, uint32_t child_num, const unsigned char *chain_code, size_t chain_code_len, const unsigned char *pub_key, size_t pub_key_len, const unsigned char *priv_key, size_t priv_key_len, const unsigned char *hash160, size_t hash160_len, const unsigned char *parent160, size_t parent160_len, struct ext_key *output)¶: Initialize a key. :return: See Error Codes

int bip32_key_init_alloc(uint32_t version, uint32_t depth, uint32_t child_num, const unsigned char *chain_code, size_t chain_code_len, const unsigned char *pub_key, size_t pub_key_len, const unsigned char *priv_key, size_t priv_key_len, const unsigned char *hash160, size_t hash160_len, const unsigned char *parent160, size_t parent160_len, struct ext_key **output)¶: As per bip32_key_init, but allocates the key. :return: See Error Codes

int bip32_key_from_seed_custom(const unsigned char *bytes, size_t bytes_len, uint32_t version, const unsigned char *hmac_key, size_t hmac_key_len, uint32_t flags, struct ext_key *output)¶

Create a new master extended key from entropy.

This creates a new master key, i.e. the root of a new HD tree. The entropy passed in may produce an invalid key. If this happens, WALLY_ERROR will be returned and the caller should retry with new entropy.

Parameters:

bytes – Entropy to use.
bytes_len – Size of bytes in bytes. Must be one of BIP32_ENTROPY_LEN_128, BIP32_ENTROPY_LEN_256 or BIP32_ENTROPY_LEN_512.
version – Either BIP32_VER_MAIN_PRIVATE or BIP32_VER_TEST_PRIVATE, indicating mainnet or testnet/regtest respectively.
hmac_key – Custom data to HMAC-SHA512 with bytes before creating the key. Pass NULL to use the default BIP32 key of “Bitcoin seed”.
hmac_key_len – Size of hmac_key in bytes, or 0 if hmac_key is NULL.
flags – Either BIP32_FLAG_SKIP_HASH to skip hash160 calculation, or 0.
output – Destination for the resulting master extended key.

Returns:

See Error Codes

int bip32_key_from_seed(const unsigned char *bytes, size_t bytes_len, uint32_t version, uint32_t flags, struct ext_key *output)¶: As per bip32_key_from_seed_custom With the default BIP32 seed. :return: See Error Codes

int bip32_key_from_seed_custom_alloc(const unsigned char *bytes, size_t bytes_len, uint32_t version, const unsigned char *hmac_key, size_t hmac_key_len, uint32_t flags, struct ext_key **output)¶

As per bip32_key_from_seed_custom, but allocates the key. .. note:: The returned key should be freed with bip32_key_free.

Returns:	See Error Codes

int bip32_key_from_seed_alloc(const unsigned char *bytes, size_t bytes_len, uint32_t version, uint32_t flags, struct ext_key **output)¶

As per bip32_key_from_seed, but allocates the key. .. note:: The returned key should be freed with bip32_key_free.

Returns:	See Error Codes

int bip32_key_serialize(const struct ext_key *hdkey, uint32_t flags, unsigned char *bytes_out, size_t len)¶

Serialize an extended key to memory using BIP32 format.

Parameters:	hdkey – The extended key to serialize. flags – `BIP32_FLAG_KEY_` Flags indicating which key to serialize. You can not serialize a private extended key from a public extended key. bytes_out – Destination for the serialized key. len – Size of `bytes_out` in bytes. Must be `BIP32_SERIALIZED_LEN`.
Returns:	See Error Codes

int bip32_key_unserialize(const unsigned char *bytes, size_t bytes_len, struct ext_key *output)¶

Un-serialize an extended key from memory.

Parameters:	bytes – Storage holding the serialized key. bytes_len – Size of `bytes` in bytes. Must be `BIP32_SERIALIZED_LEN`. output – Destination for the resulting extended key.
Returns:	See Error Codes

int bip32_key_unserialize_alloc(const unsigned char *bytes, size_t bytes_len, struct ext_key **output)¶

As per bip32_key_unserialize, but allocates the key.

Note

The returned key should be freed with bip32_key_free.

Returns:	See Error Codes

int bip32_key_from_parent(const struct ext_key *hdkey, uint32_t child_num, uint32_t flags, struct ext_key *output)¶

Create a new child extended key from a parent extended key.

Parameters:

hdkey – The parent extended key.
child_num – The child number to create. Numbers greater than or equal to BIP32_INITIAL_HARDENED_CHILD represent hardened keys that cannot be created from public parent extended keys.
flags – BIP32_FLAG_KEY_ Flags indicating the type of derivation wanted. You can not derive a private child extended key from a public parent extended key.
output – Destination for the resulting child extended key.

Returns:

See Error Codes

int bip32_key_from_parent_alloc(const struct ext_key *hdkey, uint32_t child_num, uint32_t flags, struct ext_key **output)¶

As per bip32_key_from_parent, but allocates the key. .. note:: The returned key should be freed with bip32_key_free.

Returns:	See Error Codes

int bip32_key_from_parent_path(const struct ext_key *hdkey, const uint32_t *child_path, size_t child_path_len, uint32_t flags, struct ext_key *output)¶

Create a new child extended key from a parent extended key and a path.

Parameters:	hdkey – The parent extended key. child_path – The path of child numbers to create. child_path_len – The number of child numbers in `child_path`. flags – `BIP32_FLAG_` Flags indicating the type of derivation wanted. output – Destination for the resulting child extended key.
Returns:	See Error Codes

int bip32_key_from_parent_path_alloc(const struct ext_key *hdkey, const uint32_t *child_path, size_t child_path_len, uint32_t flags, struct ext_key **output)¶

As per bip32_key_from_parent_path, but allocates the key. .. note:: The returned key should be freed with bip32_key_free.

Returns:	See Error Codes

int bip32_key_from_parent_path_str(const struct ext_key *hdkey, const char *path_str, uint32_t child_num, uint32_t flags, struct ext_key *output)¶

Create a new child extended key from a parent extended key and a path string.

Parameters:	hdkey – The parent extended key. path_str – The BIP32 path string of child numbers to create. child_num – The child number to use if `path_str` contains a `` wildcard. flags* – `BIP32_FLAG_` Flags indicating the type of derivation wanted. output – Destination for the resulting child extended key.

int bip32_key_from_parent_path_str_n(const struct ext_key *hdkey, const char *path_str, size_t path_str_len, uint32_t child_num, uint32_t flags, struct ext_key *output)¶

Create a new child extended key from a parent extended key and a known-length path string.

See bip32_key_from_parent_path_str.

int bip32_key_from_parent_path_str_alloc(const struct ext_key *hdkey, const char *path_str, uint32_t child_num, uint32_t flags, struct ext_key **output)¶: As per bip32_key_from_parent_path_str, but allocates the key. .. note:: The returned key should be freed with bip32_key_free.

int bip32_key_from_parent_path_str_n_alloc(const struct ext_key *hdkey, const char *path_str, size_t path_str_len, uint32_t child_num, uint32_t flags, struct ext_key **output)¶: As per bip32_key_from_parent_path_str_n, but allocates the key. .. note:: The returned key should be freed with bip32_key_free.

int bip32_key_with_tweak_from_parent_path(const struct ext_key *hdkey, const uint32_t *child_path, size_t child_path_len, uint32_t flags, struct ext_key *output)¶

Derive the pub tweak from a parent extended key and a path.

Parameters:	hdkey – The parent extended key. child_path – The path of child numbers to create. child_path_len – The number of child numbers in `child_path`. bytes_out – Destination for the resulting pub tweak. len – Length of `bytes_out` in bytes. Must be `EC_PRIVATE_KEY_LEN`.
Returns:	See Error Codes

int bip32_key_with_tweak_from_parent_path_alloc(const struct ext_key *hdkey, const uint32_t *child_path, size_t child_path_len, uint32_t flags, struct ext_key **output)¶

As per bip32_key_with_tweak_from_parent_path, but allocates the key. .. note:: The returned key should be freed with bip32_key_free.

Returns:	See Error Codes

int bip32_key_to_base58(const struct ext_key *hdkey, uint32_t flags, char **output)¶

Convert an extended key to base58.

Parameters:	hdkey – The extended key. flags – `BIP32_FLAG_KEY_` Flags indicating which key to serialize. You can not serialize a private extended key from a public extended key. output – Destination for the resulting key in base58. The string returned should be freed using `wally_free_string`.
Returns:	See Error Codes

int bip32_key_from_base58(const char *base58, struct ext_key *output)¶

Convert a base58 encoded extended key to an extended key.

Parameters:	base58 – The extended key in base58. output – Destination for the resulting extended key.
Returns:	See Error Codes

int bip32_key_from_base58_n(const char *base58, size_t base58_len, struct ext_key *output)¶

Convert a known-length base58 encoded extended key to an extended key.

See bip32_key_from_base58. :return: See Error Codes

int bip32_key_from_base58_alloc(const char *base58, struct ext_key **output)¶

As per bip32_key_from_base58, but allocates the key.

Note

The returned key should be freed with bip32_key_free.

Returns:	See Error Codes

int bip32_key_from_base58_n_alloc(const char *base58, size_t base58_len, struct ext_key **output)¶

As per bip32_key_from_base58_n, but allocates the key.

Note

The returned key should be freed with bip32_key_free.

Returns:	See Error Codes

int bip32_key_strip_private_key(struct ext_key *hdkey)¶

Converts a private extended key to a public extended key. Afterwards, only public child extended keys can be derived, and only the public serialization can be created. If the provided key is already public, nothing will be done.

Parameters:	hdkey – The extended key to covert.
Returns:	See Error Codes

int bip32_key_get_fingerprint(struct ext_key *hdkey, unsigned char *bytes_out, size_t len)¶

Get the BIP32 fingerprint for an extended key. Performs hash160 calculation if previously skipped with BIP32_FLAG_SKIP_HASH.

Parameters:	hdkey – The extended key. bytes_out – Destination for the fingerprint. len – Size of `bytes_out` in bytes. Must be `BIP32_KEY_FINGERPRINT_LEN`.
Returns:	See Error Codes