bip32.h

Go to the documentation of this file.

// Copyright (c) 2019-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_UTIL_BIP32_H
#define BITCOIN_UTIL_BIP32_H
 
#include <cstdint>
#include <span>
#include <string>
#include <util/expected.h>
#include <vector>
 
static constexpr uint32_t BIP32_UNHARDENED_FLAG = 0x0;
static constexpr uint32_t BIP32_HARDENED_FLAG = 0x80000000;
 
struct KeyPathElement {
    uint32_t index;
    bool is_hardened;
 
    uint32_t ChildNumber() const { return index | (is_hardened ? BIP32_HARDENED_FLAG : BIP32_UNHARDENED_FLAG); }
};
 
util::Expected<KeyPathElement, std::string> ParseKeyPathElement(std::span<const char> elem);
 
[[nodiscard]] bool ParseHDKeypath(const std::string& keypath_str, std::vector<uint32_t>& keypath);
 
std::string WriteHDKeypath(const std::vector<uint32_t>& keypath, bool apostrophe = false);
std::string FormatHDKeypath(const std::vector<uint32_t>& path, bool apostrophe = false);
 
bool HasHardenedDerivation(std::span<const uint32_t> keypath);
 
#endif // BITCOIN_UTIL_BIP32_H