The C interface to Bitcoin validation components

2001 */
2002BITCOINKERNEL_API btck_BlockHash* BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_header_get_hash(
2003    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);
2004
2005/**
2006 * @brief Get the previous btck_BlockHash from btck_BlockHeader. The returned hash
2007 * is unowned and only valid for the lifetime of the btck_BlockHeader.
2008 *
2009 * @param[in] header    Non-null btck_BlockHeader
2010 * @return              Previous btck_BlockHash
2011 */
2012BITCOINKERNEL_API const btck_BlockHash* btck_block_header_get_prev_hash(
2013    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);
2014
2015/**
2016 * @brief Get the timestamp from btck_BlockHeader.
2017 *
2018 * @param[in] header    Non-null btck_BlockHeader
2019 * @return              Block timestamp (Unix epoch seconds)
2020 */
2021BITCOINKERNEL_API uint32_t btck_block_header_get_timestamp(
2022    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);
2023
2024/**
2025 * @brief Get the nBits difficulty target from btck_BlockHeader.
2026 *
2027 * @param[in] header    Non-null btck_BlockHeader
2028 * @return              Difficulty target (compact format)
2029 */
2030BITCOINKERNEL_API uint32_t btck_block_header_get_bits(
2031    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);
2032
2033/**
2034 * @brief Get the version from btck_BlockHeader.
2035 *
2036 * @param[in] header    Non-null btck_BlockHeader
2037 * @return              Block version
2038 */
2039BITCOINKERNEL_API int32_t btck_block_header_get_version(
2040    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);
2041
2042/**
2043 * @brief Get the nonce from btck_BlockHeader.
2044 *
2045 * @param[in] header    Non-null btck_BlockHeader
2046 * @return              Nonce
2047 */
2048BITCOINKERNEL_API uint32_t btck_block_header_get_nonce(
2049    const btck_BlockHeader* header) BITCOINKERNEL_ARG_NONNULL(1);
2050
2051/**
2052 * @brief Serializes the btck_BlockHeader to bytes.
2053 * This is consensus serialization that is also used for the P2P network.
2054 *
2055 * @param[in] header    Non-null.
2056 * @param[out] output   The serialized block header (80 bytes).
2057 * @return              0 on success.
2058 */
2059BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_block_header_to_bytes(
2060    const btck_BlockHeader* header, unsigned char output[80]) BITCOINKERNEL_ARG_NONNULL(1, 2);
2061
2062/**
2063 * Destroy the btck_BlockHeader.
2064 */
2065BITCOINKERNEL_API void btck_block_header_destroy(btck_BlockHeader* header);
2066
2067///@}
2068
2069/** @name Testing
2070 * Functions intended for testing purposes only.
2071 */
2072///@{
2073
2074/**
2075 * @brief Override the current time with a fixed timestamp for testing.
2076 *
2077 * Affects all kernel time reads globally. The caller is responsible
2078 * for gating usage (e.g. restricting to regtest) if desired.
2079 *
2080 * The upper bound (4294967295) matches the maximum value of a block header
2081 * timestamp.
2082 *
2083 * @param[in] timestamp Unix epoch seconds, or 0 to restore the system clock.
2084 * @return              0 on success, non-zero if timestamp is outside the
2085 *                      valid [0, 4294967295] range.
2086 */
2087BITCOINKERNEL_API int BITCOINKERNEL_WARN_UNUSED_RESULT btck_set_mock_time(int64_t timestamp);
2088
2089///@}
2090
2091#ifdef __cplusplus
2092} // extern "C"
2093#endif // __cplusplus
2094
2095#endif // BITCOIN_KERNEL_BITCOINKERNEL_H
2096