├── .gitattributes ├── .gitignore ├── LICENSE ├── README.md └── borsh-cpp └── src ├── BorshCpp.hpp └── main.cpp /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.vscode 2 | /.vs 3 | 4 | **/x64 5 | **/x84 6 | **/*.vcxproj.* 7 | **/*.vcxproj 8 | 9 | /*.o 10 | /*.out -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Borsh in C++   [![C++ 17 Ref badge]][c++ 17] 2 | 3 | [borsh]: https://borsh.io 4 | [c++ 17]: https://en.wikipedia.org/wiki/C%2B%2B17 5 | [c++ 17 ref badge]: https://img.shields.io/badge/C%2B%2B-17-blue.svg 6 | 7 | **borsh-cpp** is a single header C++ implementation of the [Borsh] binary serialization format. 8 | 9 | Borsh stands for _Binary Object Representation Serializer for Hashing_. It is meant to be used in 10 | security-critical projects as it prioritizes [consistency, safety, speed][borsh], and comes with a 11 | strict [specification](https://github.com/near/borsh#specification). 12 | 13 | ## Example 14 | 15 | ```cpp 16 | #include "BorshCpp.hpp" 17 | 18 | int main() 19 | { 20 | bool cArray[2] = {true, false}; 21 | auto initList = {"1", "2"}; 22 | 23 | std::vector dynamicArray = { 24 | 34, 25 | 85, 26 | 255 27 | }; 28 | 29 | BorshEncoder encoder; 30 | encoder 31 | .Encode( 32 | /* Integers */ 33 | (uint8_t)0xff, 34 | (uint16_t)0xffff, 35 | (uint32_t)0xffffffff, 36 | 37 | /* Floats */ 38 | 230.121312f, 39 | 230.121312, 40 | 41 | /* Bools */ 42 | true, 43 | 44 | /* Strings */ 45 | "Hola mundo!!!", // suppport ascii 46 | u8"Hola mundo!!!🤓", // and utf8 only as literals!!!!! 47 | 48 | /* C Array */ 49 | std::pair{cArray, 2}, 50 | 51 | /* Initializer List */ 52 | initList, 53 | 54 | /* Vectors */ 55 | dynamicArray 56 | ); 57 | 58 | for (auto c : encoder.GetBuffer()) 59 | { 60 | printf("%d ", c); 61 | } 62 | printf("\n"); 63 | 64 | auto buffer = encoder.GetBuffer(); 65 | BorshDecoder decoder; 66 | 67 | // hold the decoded data 68 | uint8_t uInt8{}; 69 | uint16_t uInt16{}; 70 | uint32_t uInt32{}; 71 | float f32{}; 72 | double f64{}; 73 | bool b{}; 74 | std::string str{}; 75 | std::string u8Str{}; 76 | 77 | decoder.Decode( 78 | buffer.data(), 79 | uInt8, uInt16, uInt32, f32, f64, b, str, u8Str 80 | ); 81 | 82 | std::cout << 83 | (uint32_t)uInt8 << " " << 84 | uInt16 << " " << 85 | uInt32 << " " << 86 | f32 << " " << 87 | f64 << " " << 88 | b << " " << 89 | str << " " << 90 | u8Str << " " << 91 | "\n"; 92 | } 93 | ``` 94 | 95 | ## Types 96 | 97 | | Borsh | C++ | 98 | | ---------------- | -------------------------- | 99 | | `bool` | `true or false` | 100 | | `u8` integer | `uint8_t` | 101 | | `u16` integer | `uint16_t` | 102 | | `u32` integer | `uint32_t` | 103 | | `u64` integer | `uint64_t` | 104 | | `u128` integer | `Not supported` | 105 | | `i8` integer | `int8_t` | 106 | | `i16` integer | `int16_t` | 107 | | `i32` integer | `int32_t` | 108 | | `i64` integer | `int64_t` | 109 | | `i128` integer | `Not supported` | 110 | | `f32` float | `float` | 111 | | `f64` float | `double` | 112 | | fixed-size array | `std::initializer_list` | 113 | | fixed-size array | `T*, size_t size` | 114 | | dynamic array | `std::vector` | 115 | | UTF-8 string | `std::string(u8"🤓")` | 116 | | UTF-8 string | `u8"🤓"` | 117 | | option | `Not supported` | 118 | | set | `Not supported` | 119 | | map | `Not supported` | 120 | | structs | `Not supported` | 121 | | enum | `Not supported` | 122 | 123 | 124 | ## Limitations 125 | For now only support serialization for all previous types, but for decode only a few for now 126 | -------------------------------------------------------------------------------- /borsh-cpp/src/BorshCpp.hpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | #include 12 | #include 13 | 14 | namespace BorshCppInternals 15 | { 16 | template 17 | struct is_string 18 | { 19 | static const bool value = false; 20 | }; 21 | 22 | template 23 | struct is_string> 24 | { 25 | static const bool value = true; 26 | }; 27 | 28 | template 29 | struct is_container 30 | { 31 | static const bool value = false; 32 | }; 33 | 34 | template 35 | struct is_container> 36 | { 37 | static const bool value = true; 38 | }; 39 | 40 | template 41 | struct is_container> 42 | { 43 | static const bool value = true; 44 | }; 45 | 46 | template 47 | struct is_container> 48 | { 49 | static const bool value = true; 50 | }; 51 | 52 | template 53 | struct is_container> 54 | { 55 | static const bool value = true; 56 | }; 57 | 58 | template 59 | struct is_container> 60 | { 61 | static const bool value = true; 62 | }; 63 | 64 | template 65 | struct is_stdarray 66 | { 67 | static const bool value = false; 68 | }; 69 | 70 | template 71 | struct is_stdarray> 72 | { 73 | static const bool value = true; 74 | }; 75 | 76 | template 77 | struct is_map 78 | { 79 | static const bool value = false; 80 | }; 81 | 82 | template 83 | struct is_map> 84 | { 85 | static const bool value = true; 86 | }; 87 | 88 | template 89 | struct is_map> 90 | { 91 | static const bool value = true; 92 | }; 93 | 94 | } 95 | 96 | class BorshEncoder 97 | { 98 | public: 99 | template 100 | constexpr BorshEncoder& Encode(const T& ... types) { 101 | // Encode((types...)); 102 | (Encode(types), ...); 103 | // printf("asd"); 104 | return *this; 105 | } 106 | 107 | template 108 | constexpr BorshEncoder &Encode(const T value) 109 | { 110 | if constexpr (std::is_integral::value) 111 | { 112 | const size_t typeSize = sizeof(T); 113 | uint8_t offset = 0; 114 | 115 | for (size_t i = 0; i < typeSize; i++) 116 | { 117 | m_Buffer.push_back((value >> offset) & 0xff); 118 | offset += 8; 119 | } 120 | } 121 | 122 | if constexpr (std::is_floating_point::value) 123 | { 124 | assert(!std::isnan(value) || "NaN value found"); 125 | 126 | // From https://github.com/naphaso/cbor-cpp/blob/master/src/encoder.cpp 127 | const void *punny = &value; 128 | 129 | for (size_t i = 0; i < sizeof(T); i++) 130 | { 131 | m_Buffer.push_back(*((uint8_t *)punny + i)); 132 | } 133 | } 134 | 135 | return *this; 136 | } 137 | 138 | BorshEncoder &Encode(const std::string &str) 139 | { 140 | // Write the size of the string as an u32 integer 141 | Encode(static_cast(str.size())); 142 | 143 | m_Buffer.insert(m_Buffer.begin() + m_Buffer.size(), str.begin(), str.end()); 144 | 145 | return *this; 146 | } 147 | 148 | BorshEncoder &Encode(const char *str) 149 | { 150 | const uint32_t size = std::strlen(str); 151 | // Write the size of the string as an u32 integer 152 | Encode(size); 153 | 154 | auto bytes = reinterpret_cast(str); 155 | 156 | m_Buffer.insert(m_Buffer.begin() + m_Buffer.size(), bytes, bytes + size); 157 | 158 | return *this; 159 | } 160 | 161 | template 162 | constexpr BorshEncoder &Encode(const std::initializer_list &initList) 163 | { 164 | return Encode(std::pair{initList.begin(), initList.size()}); 165 | } 166 | 167 | template 168 | constexpr BorshEncoder &Encode( const std::pair cArray) 169 | { 170 | return Encode(std::pair{(const T*)cArray.first, cArray.second}); 171 | } 172 | 173 | template 174 | constexpr BorshEncoder &Encode( const std::pair cArray) 175 | { 176 | auto [array, size] = cArray; 177 | 178 | static_assert(std::is_integral::value || (size > 0), "The size of the c array must be a unsigned integer value"); 179 | 180 | if constexpr (std::is_array::value) 181 | { 182 | printf("Es array"); 183 | } 184 | 185 | if constexpr (std::is_integral::value) 186 | { 187 | for (size_t i = 0; i < size; ++i) 188 | { 189 | Encode(*array); 190 | ++array; 191 | } 192 | } 193 | else if constexpr (std::is_floating_point::value) 194 | { 195 | for (size_t i = 0; i < size; ++i) 196 | { 197 | Encode(*array); 198 | ++array; 199 | } 200 | } 201 | else if constexpr (BorshCppInternals::is_string::value) 202 | { 203 | for (size_t i = 0; i < size; ++i) 204 | { 205 | Encode(*array); 206 | ++array; 207 | } 208 | } 209 | else if constexpr (std::is_same::value) 210 | { 211 | for (size_t i = 0; i < size; ++i) 212 | { 213 | Encode(*array); 214 | ++array; 215 | } 216 | } 217 | else 218 | { 219 | assert(false || "The type of the array is not supported"); 220 | } 221 | 222 | return *this; 223 | } 224 | 225 | template 226 | constexpr BorshEncoder &Encode(const std::vector &vector) 227 | { 228 | Encode((uint32_t)vector.size()); 229 | Encode(std::pair{vector.data(), vector.size()}); 230 | 231 | return *this; 232 | } 233 | 234 | const std::vector &GetBuffer() const 235 | { 236 | return m_Buffer; 237 | } 238 | 239 | private: 240 | std::vector m_Buffer; 241 | }; 242 | 243 | class BorshDecoder 244 | { 245 | public: 246 | template 247 | void Decode(const uint8_t *bufferBegin, Types& ... retriveValues) 248 | { 249 | uint8_t *offset = (uint8_t *)bufferBegin; 250 | 251 | // DecodeInternal(&offset, retriveValues...); 252 | (DecodeInternal(&offset, retriveValues), ...); 253 | } 254 | 255 | private: 256 | template 257 | void DecodeInternal(uint8_t **offset, T& value) 258 | { 259 | if constexpr (std::is_integral::value || std::is_floating_point::value) 260 | { 261 | // std::cout << typeid(T).name() << '\n'; 262 | value = *((T *)*(offset)); 263 | (*offset) += sizeof(T); 264 | } 265 | else if constexpr (BorshCppInternals::is_string::value) 266 | { 267 | uint32_t strSize = *((uint32_t *)*(offset)); 268 | (*offset) += 4; 269 | 270 | value = std::string((*offset), ((*offset) + strSize)); 271 | 272 | (*offset) += strSize; 273 | } 274 | else 275 | { 276 | assert(false || "The type of the array is not supported"); 277 | } 278 | } 279 | }; -------------------------------------------------------------------------------- /borsh-cpp/src/main.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | #include "BorshCpp.hpp" 5 | 6 | int main() 7 | { 8 | bool cArray[2] = {true, false}; 9 | auto initList = {"1", "2"}; 10 | 11 | std::vector dynamicArray = { 12 | 34, 13 | 85, 14 | 255 15 | }; 16 | 17 | BorshEncoder encoder; 18 | encoder 19 | .Encode( 20 | /* Integers */ 21 | (uint8_t)0xff, 22 | (uint16_t)0xffff, 23 | (uint32_t)0xffffffff, 24 | 25 | /* Floats */ 26 | 230.121312f, 27 | 230.121312, 28 | 29 | /* Bools */ 30 | true, 31 | 32 | /* Strings */ 33 | "Hola mundo!!!", // suppport ascii 34 | u8"Hola mundo!!!🤓", // and utf8 only as literals!!!!! 35 | 36 | /* C Array */ 37 | std::pair{cArray, 2}, 38 | 39 | /* Initializer List */ 40 | initList, 41 | 42 | /* Vectors */ 43 | dynamicArray 44 | ); 45 | 46 | for (auto c : encoder.GetBuffer()) 47 | { 48 | printf("%d ", c); 49 | } 50 | printf("\n"); 51 | 52 | auto buffer = encoder.GetBuffer(); 53 | BorshDecoder decoder; 54 | 55 | // hold the decoded data 56 | uint8_t uInt8{}; 57 | uint16_t uInt16{}; 58 | uint32_t uInt32{}; 59 | float f32{}; 60 | double f64{}; 61 | bool b{}; 62 | std::string str{}; 63 | std::string u8Str{}; 64 | 65 | decoder.Decode( 66 | buffer.data(), 67 | uInt8, uInt16, uInt32, f32, f64, b, str, u8Str 68 | ); 69 | 70 | std::cout << 71 | (uint32_t)uInt8 << " " << 72 | uInt16 << " " << 73 | uInt32 << " " << 74 | f32 << " " << 75 | f64 << " " << 76 | b << " " << 77 | str << " " << 78 | u8Str << " " << 79 | "\n"; 80 | } --------------------------------------------------------------------------------