Minor cleanups

Author: rschu1ze

contrib/bech32/CMakeLists.txt

@@ -1,3 +1,9 @@
+option(ENABLE_BECH32 "Enable bech32 support" ${ENABLE_LIBRARIES})
+if ((NOT ENABLE_BECH32))
+    message (STATUS "Not using bech32")
+    return()
+endif()
+
 add_library(_bech32
     include/bech32.h
     src/bech32.cpp)

docs/en/sql-reference/functions/encoding-functions.md

@@ -968,29 +968,31 @@ Result:
 1    2
 ```
 
-## Bech32Encode {#bech32encode}
+## bech32Encode {#bech32encode}
 
 Encodes a binary data string, along with a human-readable part (HRP), using the [Bech32 or Bech32m](https://en.bitcoin.it/wiki/Bech32) algorithms.
 
 **Syntax**
 
 ```sql
-Bech32Encode(hrp, data[, witver])
+bech32Encode(hrp, data[, witver])
 ```
 
 **Parameters**
 
-- `hrp` — String of 1 - 83 lowercase characters specifying the "human-readable part" of the code. Usually 'bc' or 'tb'. [String](../data-types/string.md), [FixedString](../data-types/fixedstring.md).
-- `data` — String of binary data to encode. [String](../data-types/string.md), [FixedString](../data-types/fixedstring.md).
-- `witver` (optional, default = 1): An [unsigned integer](../../sql-reference/data-types/int-uint.md) specifying the version of the algorithm to run. 0 for Bech32 and 1 or greater for Bech32m.
+- `hrp` — String of 1 - 83 lowercase characters specifying the "human-readable part" of the code. Usually 'bc' or 'tb'. [String](../data-types/string.md) or [FixedString](../data-types/fixedstring.md).
+- `data` — String of binary data to encode. [String](../data-types/string.md) or [FixedString](../data-types/fixedstring.md).
+- `witver` - Witness version. Optional, default = 1. An [UInt*](../data-types/int-uint.md) specifying the version of the algorithm to run. 0 for Bech32 and 1 or greater for Bech32m.
 
 :::note
-When using the [FixedString](../data-types/fixedstring.md) data type, if a value does not fully fill the row it is padded with null characters. While the `Bech32Encode` function will handle this automatically for the hrp argument, for the data argument the values must not be padded. For this reason it is not recommended to use the [FixedString](../data-types/fixedstring.md) data type for your data values unless you are certain that they are all the same length and ensure that your [FixedString](../data-types/fixedstring.md) column is set to that length as well.
+When using the [FixedString](../data-types/fixedstring.md) data type, if a value does not fully fill the row it is padded with null characters.
+While the `bech32Encode` function will handle this automatically for the hrp argument, for the data argument the values must not be padded.
+For this reason it is not recommended to use the [FixedString](../data-types/fixedstring.md) data type for your data values unless you are certain that they are all the same length and ensure that your [FixedString](../data-types/fixedstring.md) column is set to that length as well.
 :::
 
 **Returned value**
 
-- A Bech32 address string, consisting of the human-readable part, a separator character which is always '1', and a data part. The length of the string will never exceed 90 characters. If the algorithm cannot generate a valid address from the input, it will return an empty string 
+- A Bech32 address string, consisting of the human-readable part, a separator character which is always '1', and a data part. The length of the string will never exceed 90 characters. If the algorithm cannot generate a valid address from the input, it will return an empty string.
 
 Type: [String](../data-types/string.md).
 
@@ -1003,57 +1005,58 @@ Query:
 ```sql
 SELECT bech32Encode('bc', unhex('751e76e8199196d454941c45d1b3a323f1433bd6'));
 ```
+
 Result:
 
 ```response
 bc1w508d6qejxtdg4y5r3zarvary0c5xw7k8zcwmq
 ```
 
-**Example**
-
 A witness version of 0 will result in a different address string.
 
 Query:
 
 ```sql
 SELECT bech32Encode('bc', unhex('751e76e8199196d454941c45d1b3a323f1433bd6'), 0);
 ```
+
 Result:
 
 ```response
 bc1w508d6qejxtdg4y5r3zarvary0c5xw7kj7gz7z
 ```
 
-**Example**
-
 While 'bc' (Mainnet) and 'tb' (Testnet) are the only allowed hrp values for the SegWit address format, Bech32 allows any hrp that satisfies the above requirements.
 
 Query:
 
 ```sql
 SELECT bech32Encode('abcdefg', unhex('751e76e8199196d454941c45d1b3a323f1433bd6'), 10);
 ```
+
 Result:
 
 ```response
 abcdefg1w508d6qejxtdg4y5r3zarvary0c5xw7k9rp8r4
 ```
 
-## Bech32Decode {#bech32decode}
+## bech32Decode {#bech32decode}
 
-Decodes a Bech32 address string generated by either the Bech32 or Bech32m algorithms.
+Decodes a Bech32 address string generated by either the bech32 or bech32m algorithms.
 
 **Syntax**
 
 ```sql
-Bech32Decode(address)
+bech32Decode(address)
 ```
 
 **Parameters**
 
-- `address` — Bech32 string to decode. [String](../data-types/string.md), [FixedString](../data-types/fixedstring.md).
+- `address` — Bech32 string to decode. [String](../data-types/string.md) or [FixedString](../data-types/fixedstring.md).
 
+:::note
 Unlike the encode function, `Bech32Decode` will automatically handle padded [FixedStrings](../data-types/fixedstring.md).
+:::
 
 **Returned value**
 
@@ -1066,21 +1069,21 @@ Type: ([String](../data-types/string.md), [String](../data-types/string.md)).
 Query:
 
 ```sql
-select tup.1 as hrp, hex(tup.2) as data from (select bech32Decode('bc1w508d6qejxtdg4y5r3zarvary0c5xw7kj7gz7z') as tup);
+SELECT tup.1 AS hrp, hex(tup.2) AS data FROM (SELECT bech32Decode('bc1w508d6qejxtdg4y5r3zarvary0c5xw7kj7gz7z') AS tup);
 ```
+
 Result:
 
 ```response
 bc   751E76E8199196D454941C45D1B3A323F1433BD6
 ```
 
-**Example**
-
 Query:
 
 ```sql
-select tup.1 as hrp, hex(tup.2) as data from (select bech32Decode('tb1w508d6qejxtdg4y5r3zarvary0c5xw7kzp034v') as tup);
+SELECT tup.1 AS hrp, hex(tup.2) AS data FROM (SELECT bech32Decode('tb1w508d6qejxtdg4y5r3zarvary0c5xw7kzp034v') AS tup);
 ```
+
 Result:
 
 ```response

src/Common/config.h.in

@@ -29,6 +29,7 @@
 #cmakedefine01 USE_S2_GEOMETRY
 #cmakedefine01 USE_FASTOPS
 #cmakedefine01 USE_SQIDS
+#cmakedefine01 USE_BECH32
 #cmakedefine01 USE_IDNA
 #cmakedefine01 USE_NLP
 #cmakedefine01 USE_VECTORSCAN

src/Functions/CMakeLists.txt

@@ -61,7 +61,6 @@ list (APPEND PRIVATE_LIBS
         boost::filesystem
         divide_impl
         ch_contrib::xxHash
-        ch_contrib::bech32
 )
 
 if (TARGET OpenSSL::Crypto)
@@ -80,6 +79,10 @@ if (TARGET ch_contrib::llvm)
     list (APPEND PRIVATE_LIBS ch_contrib::llvm)
 endif ()
 
+if (TARGET ch_contrib::bech32)
+    list (APPEND PRIVATE_LIBS ch_contrib::bech32)
+endif()
+
 if (TARGET ch_contrib::base64)
     list (APPEND PRIVATE_LIBS ch_contrib::base64)
 endif()