├── .gitignore ├── .travis.yml ├── Cargo.toml ├── LICENSE ├── README.md └── src ├── constants.rs ├── db.rs ├── lib.rs ├── node.rs └── utils.rs /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | **/*.rs.bk 3 | Cargo.lock 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: rust 2 | rust: 3 | - stable 4 | 5 | cache: 6 | - cargo 7 | 8 | script: 9 | - RUST_BACKTRACE=1 cargo test --all 10 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "merkletree-rs" 3 | version = "0.0.3" 4 | authors = ["arnaucube "] 5 | edition = "2018" 6 | license = "GPL-3.0" 7 | description = "Sparse MerkleTree" 8 | repository = "https://github.com/arnaucube/merkletree-rs" 9 | readme = "README.md" 10 | 11 | [dependencies] 12 | tiny-keccak = "1.4.2" 13 | rustc-hex = "1.0.0" 14 | bitreader = "0.3.1" 15 | arrayref = "0.3.5" 16 | byteorder = "1.3.1" 17 | hex = "0.3.2" 18 | rusty-leveldb = "0.2.4" 19 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # merkletree-rs [![Crates.io](https://img.shields.io/crates/v/merkletree-rs.svg)](https://crates.io/crates/merkletree-rs) [![Build Status](https://travis-ci.org/arnaucube/merkletree-rs.svg?branch=master)](https://travis-ci.org/arnaucube/merkletree-rs) 2 | Sparse MerkleTree implementation in Rust. 3 | 4 | The MerkleTree is optimized in the design and concepts, to have a faster and lighter MerkleTree, maintaining compatibility with a non optimized MerkleTree. In this way, the MerkleRoot of the optimized MerkleTree will be the same that the MerkleRoot of the non optimized MerkleTree. 5 | 6 | Compatible with the Go version: https://github.com/arnaucube/go-merkletree 7 | 8 | 9 | ## Usage 10 | Import lib: 11 | ```rust 12 | extern crate merkletree_rs; 13 | use merkletree_rs::{db, MerkleTree, TestValue, Value}; 14 | ``` 15 | 16 | Create new tree: 17 | ```rust 18 | // to build the storage, the first parameter is the path and the second parameter specifies if wants to use a in_memory database or a directory of the filesystem 19 | let mut sto = db::Db::new("test".to_string(), true); 20 | let mut mt = MerkleTree::new(&mut sto, 140 as u32); 21 | ``` 22 | 23 | Add value to leaf: 24 | ```rust 25 | let val: TestValue = TestValue { 26 | bytes: "this is a test leaf".as_bytes().to_vec(), 27 | index_length: 15, 28 | }; 29 | mt.add(&val).unwrap(); 30 | ``` 31 | 32 | Get proof: 33 | ```rust 34 | let mp = mt.generate_proof(val.hi()); 35 | println!("{:?}", mp); 36 | ``` 37 | 38 | Verify proof: 39 | ```rust 40 | // check if the value exist 41 | let v = 42 | merkletree_rs::verify_proof(mt.get_root(), &mp, val.hi(), val.ht(), mt.get_num_levels()); 43 | println!("{:?}", v); 44 | 45 | // check if the don't value exist (in that case, the 'ht' will be an empty value) 46 | let v = merkletree_rs::verify_proof( 47 | mt.get_root(), 48 | &mp, 49 | val.hi(), 50 | merkletree_rs::constants::EMPTYNODEVALUE, 51 | mt.get_num_levels(), 52 | ); 53 | println!("{:?}", v); 54 | ``` 55 | 56 | Print current MerkleRoot: 57 | ```rust 58 | println!("{:?}", mt.get_root()); 59 | ``` 60 | -------------------------------------------------------------------------------- /src/constants.rs: -------------------------------------------------------------------------------- 1 | pub const TYPENODEEMPTY: u8 = 0; 2 | pub const TYPENODENORMAL: u8 = 1; 3 | pub const TYPENODEFINAL: u8 = 2; 4 | pub const TYPENODEVALUE: u8 = 3; 5 | pub const TYPENODEROOT: u8 = 4; 6 | pub const EMPTYNODEVALUE: [u8; 32] = [0; 32]; 7 | -------------------------------------------------------------------------------- /src/db.rs: -------------------------------------------------------------------------------- 1 | extern crate rusty_leveldb; 2 | 3 | use self::rusty_leveldb::DB; 4 | 5 | use super::constants; 6 | 7 | pub struct Db { 8 | storage: DB, 9 | } 10 | 11 | impl Db { 12 | pub fn new(path: String, in_memory: bool) -> Db { 13 | let opt: rusty_leveldb::Options; 14 | if in_memory { 15 | opt = rusty_leveldb::in_memory(); 16 | } else { 17 | opt = Default::default(); 18 | } 19 | let database = DB::open(path, opt).unwrap(); 20 | Db { storage: database } 21 | } 22 | pub fn insert(&mut self, k: [u8; 32], t: u8, il: u32, b: Vec) { 23 | let mut v: Vec; 24 | v = [t].to_vec(); 25 | let il_bytes = il.to_le_bytes(); 26 | v.extend(il_bytes.to_vec()); // il_bytes are [u8;4] (4 bytes) 27 | v.extend(&b); 28 | self.storage.put(&k[..], &v[..]).unwrap(); 29 | } 30 | pub fn get(&mut self, k: &[u8; 32]) -> (u8, u32, Vec) { 31 | if k.to_vec() == constants::EMPTYNODEVALUE.to_vec() { 32 | return (0, 0, constants::EMPTYNODEVALUE.to_vec()); 33 | } 34 | match self.storage.get(k) { 35 | Some(x) => { 36 | let t = x[0]; 37 | let il_bytes: [u8; 4] = [x[1], x[2], x[3], x[4]]; 38 | let il = u32::from_le_bytes(il_bytes); 39 | let b = &x[5..]; 40 | (t, il, b.to_vec()) 41 | } 42 | None => ( 43 | constants::TYPENODEEMPTY, 44 | 0, 45 | constants::EMPTYNODEVALUE.to_vec(), 46 | ), 47 | } 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #[macro_use] 2 | extern crate arrayref; 3 | extern crate hex; 4 | extern crate rustc_hex; 5 | extern crate tiny_keccak; 6 | 7 | use rustc_hex::ToHex; 8 | 9 | pub mod constants; 10 | pub mod db; 11 | pub mod node; 12 | pub mod utils; 13 | 14 | type Result = std::result::Result; 15 | 16 | pub struct TestValue { 17 | pub bytes: Vec, 18 | pub index_length: u32, 19 | } 20 | pub trait Value { 21 | fn bytes(&self) -> &Vec; 22 | fn index_length(&self) -> u32; 23 | fn hi(&self) -> [u8; 32]; 24 | fn ht(&self) -> [u8; 32]; 25 | } 26 | impl Value for TestValue { 27 | fn bytes(&self) -> &Vec { 28 | &self.bytes 29 | } 30 | fn index_length(&self) -> u32 { 31 | self.index_length 32 | } 33 | fn hi(&self) -> [u8; 32] { 34 | utils::hash_vec( 35 | self.bytes() 36 | .to_vec() 37 | .split_at(self.index_length() as usize) 38 | .0 39 | .to_vec(), 40 | ) 41 | } 42 | fn ht(&self) -> [u8; 32] { 43 | utils::hash_vec(self.bytes().to_vec()) 44 | } 45 | } 46 | 47 | pub struct MerkleTree<'a> { 48 | root: [u8; 32], 49 | num_levels: u32, 50 | sto: &'a mut db::Db, 51 | root_node_key: [u8;32], 52 | } 53 | impl<'a> MerkleTree<'a> { 54 | pub fn new(database: &'a mut db::Db, num_levels: u32) -> MerkleTree<'a> { 55 | let rnk: [u8; 32] = utils::hash_vec("root".as_bytes().to_vec()); 56 | let (_, _, root_vec) = database.get(&rnk); 57 | let mut root: [u8; 32] = [0;32]; 58 | root.copy_from_slice(&root_vec); // root will be [0;32] if not found (EMPTYNODEVALUE) 59 | 60 | MerkleTree { 61 | root: root, 62 | num_levels, 63 | sto: database, 64 | root_node_key: rnk, 65 | } 66 | } 67 | pub fn get_root(&mut self) -> [u8; 32] { 68 | self.root 69 | } 70 | pub fn get_num_levels(&mut self) -> u32 { 71 | self.num_levels 72 | } 73 | 74 | pub fn add(&mut self, v: &TestValue) -> Result<()> { 75 | // add the leaf that we are adding 76 | self.sto.insert( 77 | v.ht(), 78 | constants::TYPENODEVALUE, 79 | v.index_length(), 80 | v.bytes().to_vec(), 81 | ); 82 | 83 | let hi = v.hi(); 84 | let path = utils::get_path(self.num_levels, hi); 85 | let mut siblings: Vec<[u8; 32]> = Vec::new(); 86 | 87 | let mut node_hash = self.root; 88 | 89 | for i in (0..=self.num_levels - 2).rev() { 90 | // get node 91 | let (t, il, node_bytes) = self.sto.get(&node_hash); 92 | if t == constants::TYPENODEFINAL { 93 | let hi_child = 94 | utils::hash_vec(node_bytes.to_vec().split_at(il as usize).0.to_vec()); 95 | let path_child = utils::get_path(self.num_levels, hi_child); 96 | let pos_diff = utils::compare_paths(&path_child, &path); 97 | if pos_diff == -1 { 98 | return Err("node already exists".to_owned()); 99 | } 100 | let final_node_1_hash = utils::calc_hash_from_leaf_and_level( 101 | pos_diff as u32, 102 | &path_child, 103 | utils::hash_vec(node_bytes.to_vec()), 104 | ); 105 | self.sto.insert( 106 | final_node_1_hash, 107 | constants::TYPENODEFINAL, 108 | il, 109 | node_bytes.to_vec(), 110 | ); 111 | let final_node_2_hash = 112 | utils::calc_hash_from_leaf_and_level(pos_diff as u32, &path, v.ht()); 113 | self.sto.insert( 114 | final_node_2_hash, 115 | constants::TYPENODEFINAL, 116 | v.index_length(), 117 | v.bytes().to_vec(), 118 | ); 119 | 120 | // parent node 121 | let parent_node: node::TreeNode; 122 | if path[pos_diff as usize] { 123 | parent_node = node::TreeNode { 124 | child_l: final_node_1_hash, 125 | child_r: final_node_2_hash, 126 | } 127 | } else { 128 | parent_node = node::TreeNode { 129 | child_l: final_node_2_hash, 130 | child_r: final_node_1_hash, 131 | } 132 | } 133 | let empties = utils::get_empties_between_i_and_pos(i, pos_diff as u32 + 1); 134 | for empty in &empties { 135 | siblings.push(*empty); 136 | } 137 | 138 | let path_from_pos_diff = utils::cut_path(&path, (pos_diff + 1) as usize); 139 | 140 | self.root = self.replace_leaf( 141 | path_from_pos_diff, 142 | &siblings, 143 | parent_node.ht(), 144 | constants::TYPENODENORMAL, 145 | 0, 146 | parent_node.bytes().to_vec(), 147 | ); 148 | self.sto 149 | .insert(self.root_node_key, constants::TYPENODEROOT, 0, self.root.to_vec()); 150 | return Ok(()); 151 | } 152 | 153 | let node = node::parse_node_bytes(node_bytes); 154 | 155 | let sibling: [u8; 32]; 156 | if !path[i as usize] { 157 | node_hash = node.child_l; 158 | sibling = node.child_r; 159 | } else { 160 | sibling = node.child_l; 161 | node_hash = node.child_r; 162 | } 163 | siblings.push(*array_ref!(sibling, 0, 32)); 164 | if node_hash == constants::EMPTYNODEVALUE { 165 | if i == self.num_levels - 2 166 | && siblings[siblings.len() - 1] == constants::EMPTYNODEVALUE 167 | { 168 | let final_node_hash = 169 | utils::calc_hash_from_leaf_and_level(i + 1, &path, v.ht()); 170 | self.sto.insert( 171 | final_node_hash, 172 | constants::TYPENODEFINAL, 173 | v.index_length(), 174 | v.bytes().to_vec(), 175 | ); 176 | self.root = final_node_hash; 177 | self.sto 178 | .insert(self.root_node_key, constants::TYPENODEROOT, 0, self.root.to_vec()); 179 | return Ok(()); 180 | } 181 | let final_node_hash = utils::calc_hash_from_leaf_and_level(i, &path, v.ht()); 182 | let path_from_i = utils::cut_path(&path, i as usize); 183 | self.root = self.replace_leaf( 184 | path_from_i, 185 | &siblings, 186 | final_node_hash, 187 | constants::TYPENODEFINAL, 188 | v.index_length(), 189 | v.bytes().to_vec(), 190 | ); 191 | self.sto 192 | .insert(self.root_node_key, constants::TYPENODEROOT, 0, self.root.to_vec()); 193 | return Ok(()); 194 | } 195 | } 196 | self.root = self.replace_leaf( 197 | path, 198 | &siblings, 199 | v.ht(), 200 | constants::TYPENODEVALUE, 201 | v.index_length(), 202 | v.bytes().to_vec(), 203 | ); 204 | self.sto 205 | .insert(self.root_node_key, constants::TYPENODEROOT, 0, self.root.to_vec()); 206 | return Ok(()); 207 | } 208 | 209 | pub fn replace_leaf( 210 | &mut self, 211 | path: Vec, 212 | siblings: &Vec<[u8; 32]>, 213 | leaf_hash: [u8; 32], 214 | node_type: u8, 215 | index_length: u32, 216 | leaf_value: Vec, 217 | ) -> [u8; 32] { 218 | self.sto 219 | .insert(leaf_hash, node_type, index_length, leaf_value); 220 | let mut curr_node = leaf_hash; 221 | 222 | for i in 0..siblings.len() { 223 | if !path[i as usize] { 224 | let node = node::TreeNode { 225 | child_l: curr_node, 226 | child_r: siblings[siblings.len() - 1 - i], 227 | }; 228 | self.sto 229 | .insert(node.ht(), constants::TYPENODENORMAL, 0, node.bytes()); 230 | curr_node = node.ht(); 231 | } else { 232 | let node = node::TreeNode { 233 | child_l: siblings[siblings.len() - 1 - i], 234 | child_r: curr_node, 235 | }; 236 | self.sto 237 | .insert(node.ht(), constants::TYPENODENORMAL, 0, node.bytes()); 238 | curr_node = node.ht(); 239 | } 240 | } 241 | curr_node 242 | } 243 | 244 | pub fn get_value_in_pos(&mut self, hi: [u8; 32]) -> Vec { 245 | let path = utils::get_path(self.num_levels, hi); 246 | let mut node_hash = self.root; 247 | for i in (0..=self.num_levels - 2).rev() { 248 | let (t, il, node_bytes) = self.sto.get(&node_hash); 249 | if t == constants::TYPENODEFINAL { 250 | let hi_node = utils::hash_vec(node_bytes.to_vec().split_at(il as usize).0.to_vec()); 251 | let path_node = utils::get_path(self.num_levels, hi_node); 252 | let pos_diff = utils::compare_paths(&path_node, &path); 253 | if pos_diff != -1 { 254 | return constants::EMPTYNODEVALUE.to_vec(); 255 | } 256 | return node_bytes; 257 | } 258 | let node = node::parse_node_bytes(node_bytes); 259 | if !path[i as usize] { 260 | node_hash = node.child_l; 261 | } else { 262 | node_hash = node.child_r; 263 | } 264 | } 265 | let (_t, _il, node_bytes) = self.sto.get(&node_hash); 266 | node_bytes 267 | } 268 | 269 | pub fn generate_proof(&mut self, hi: [u8; 32]) -> Vec { 270 | let mut mp: Vec = Vec::new(); 271 | 272 | let mut empties: [u8; 32] = [0; 32]; 273 | let path = utils::get_path(self.num_levels, hi); 274 | 275 | let mut siblings: Vec<[u8; 32]> = Vec::new(); 276 | let mut node_hash = self.root; 277 | 278 | for i in 0..self.num_levels { 279 | let (t, il, node_bytes) = self.sto.get(&node_hash); 280 | if t == constants::TYPENODEFINAL { 281 | let real_value_in_pos = self.get_value_in_pos(hi); 282 | if real_value_in_pos == constants::EMPTYNODEVALUE { 283 | let leaf_hi = 284 | utils::hash_vec(node_bytes.to_vec().split_at(il as usize).0.to_vec()); 285 | let path_child = utils::get_path(self.num_levels, leaf_hi); 286 | let pos_diff = utils::compare_paths(&path_child, &path); 287 | if pos_diff as u32 == self.num_levels { 288 | return mp; 289 | } 290 | if pos_diff as u32 != self.num_levels - 1 - i { 291 | let sibling = utils::calc_hash_from_leaf_and_level( 292 | pos_diff as u32, 293 | &path_child, 294 | utils::hash_vec(node_bytes.to_vec()), 295 | ); 296 | let mut new_siblings: Vec<[u8; 32]> = Vec::new(); 297 | new_siblings.push(sibling); 298 | new_siblings.extend(siblings); 299 | siblings = new_siblings; 300 | // set empties bit 301 | let bit_pos = self.num_levels - 2 - pos_diff as u32; 302 | empties[(empties.len() as isize + (bit_pos as isize / 8 - 1) as isize) 303 | as usize] |= 1 << (bit_pos % 8); 304 | } 305 | } 306 | break; 307 | } 308 | let node = node::parse_node_bytes(node_bytes); 309 | let sibling: [u8; 32]; 310 | if !path[self.num_levels as usize - i as usize - 2] { 311 | node_hash = node.child_l; 312 | sibling = node.child_r; 313 | } else { 314 | sibling = node.child_l; 315 | node_hash = node.child_r; 316 | } 317 | if sibling != constants::EMPTYNODEVALUE { 318 | // set empties bit 319 | empties[(empties.len() as isize + (i as isize / 8 - 1) as isize) as usize] |= 320 | 1 << (i % 8); 321 | let mut new_siblings: Vec<[u8; 32]> = Vec::new(); 322 | new_siblings.push(sibling); 323 | new_siblings.extend(siblings); 324 | siblings = new_siblings; 325 | } 326 | } 327 | mp.append(&mut empties[..].to_vec()); 328 | for s in siblings { 329 | mp.append(&mut s.to_vec()); 330 | } 331 | mp 332 | } 333 | 334 | pub fn print_level(&mut self, parent: [u8; 32], mut lvl: u32, max_level: u32) { 335 | let mut line: String = "".to_string(); 336 | for _ in 0..lvl { 337 | line += &format!(" "); 338 | } 339 | line += &format!("lvl {}", lvl); 340 | line += &format!(" - '{}' = ", parent.to_hex()); 341 | let (t, _, node_bytes) = self.sto.get(&parent); 342 | let mut node = node::TreeNode { 343 | child_l: constants::EMPTYNODEVALUE, 344 | child_r: constants::EMPTYNODEVALUE, 345 | }; 346 | if t == constants::TYPENODENORMAL { 347 | node = node::parse_node_bytes(node_bytes); 348 | line += &format!("'{}' - '{}'", node.child_l.to_hex(), node.child_r.to_hex()); 349 | } else if t == constants::TYPENODEVALUE { 350 | // 351 | } else if t == constants::TYPENODEFINAL { 352 | let hash_node_bytes = utils::hash_vec(node_bytes); 353 | line += &format!("[final] final tree node: {} \n", hash_node_bytes.to_hex()); 354 | let (_, _, leaf_node_bytes) = self.sto.get(&hash_node_bytes); 355 | for _ in 0..lvl { 356 | line += " "; 357 | } 358 | let leaf_node_string = String::from_utf8_lossy(&leaf_node_bytes); 359 | line += &format!("leaf value: {}", leaf_node_string); 360 | } else { 361 | line += "[EMPTY Branch]" 362 | } 363 | println!("{}", line); 364 | lvl += 1; 365 | if node.child_r.len() > 0 366 | && lvl < max_level 367 | && t != constants::TYPENODEEMPTY 368 | && t != constants::TYPENODEFINAL 369 | { 370 | self.print_level(node.child_l, lvl, max_level); 371 | self.print_level(node.child_r, lvl, max_level); 372 | } 373 | } 374 | pub fn print_full_tree(&mut self) { 375 | let root = self.root.clone(); 376 | let num_levels = self.num_levels.clone(); 377 | self.print_level(root, 0, num_levels - 1); 378 | println!("root {:?}", &self.root.to_hex()); 379 | } 380 | pub fn print_levels_tree(&mut self, max_level: u32) { 381 | let root = self.root.clone(); 382 | let num_levels = self.num_levels.clone(); 383 | self.print_level(root, 0, num_levels - 1 - max_level); 384 | println!("root {:?}", self.root.to_hex()); 385 | } 386 | } 387 | 388 | pub fn verify_proof( 389 | root: [u8; 32], 390 | mp: &Vec, 391 | hi: [u8; 32], 392 | ht: [u8; 32], 393 | num_levels: u32, 394 | ) -> bool { 395 | let empties: Vec; 396 | empties = mp.split_at(32).0.to_vec(); 397 | 398 | let mut siblings: Vec<[u8; 32]> = Vec::new(); 399 | for i in (empties.len()..mp.len()).step_by(constants::EMPTYNODEVALUE.len()) { 400 | let mut sibling: [u8; 32] = [0; 32]; 401 | sibling.copy_from_slice(&mp[i..i + constants::EMPTYNODEVALUE.len()]); 402 | siblings.push(sibling); 403 | } 404 | 405 | let path = utils::get_path(num_levels, hi); 406 | let mut node_hash = ht; 407 | let mut sibling_used_pos = 0; 408 | 409 | for i in (0..=num_levels - 2).rev() { 410 | let sibling: [u8; 32]; 411 | if (empties[empties.len() - i as usize / 8 - 1] & (1 << (i % 8))) > 0 { 412 | sibling = siblings[sibling_used_pos]; 413 | sibling_used_pos += 1; 414 | } else { 415 | sibling = constants::EMPTYNODEVALUE; 416 | } 417 | 418 | let n: node::TreeNode; 419 | if path[num_levels as usize - i as usize - 2] { 420 | n = node::TreeNode { 421 | child_l: sibling, 422 | child_r: node_hash, 423 | } 424 | } else { 425 | n = node::TreeNode { 426 | child_l: node_hash, 427 | child_r: sibling, 428 | } 429 | } 430 | if node_hash == constants::EMPTYNODEVALUE && sibling == constants::EMPTYNODEVALUE { 431 | node_hash = constants::EMPTYNODEVALUE; 432 | } else { 433 | node_hash = n.ht(); 434 | } 435 | } 436 | if node_hash == root { 437 | return true; 438 | } 439 | false 440 | } 441 | 442 | #[cfg(test)] 443 | mod tests { 444 | use super::*; 445 | use rustc_hex::ToHex; 446 | 447 | #[test] 448 | fn test_hash_vec() { 449 | let a: Vec = From::from("test".to_string()); 450 | let h = utils::hash_vec(a); 451 | assert_eq!( 452 | "9c22ff5f21f0b81b113e63f7db6da94fedef11b2119b4088b89664fb9a3cb658", 453 | h.to_hex() 454 | ); 455 | } 456 | 457 | #[test] 458 | fn test_new_mt() { 459 | let mut sto = db::Db::new("test".to_string(), true); 460 | let mt = MerkleTree::new(&mut sto, 140); 461 | assert_eq!(140, mt.num_levels); 462 | assert_eq!( 463 | "0000000000000000000000000000000000000000000000000000000000000000", 464 | mt.root.to_hex() 465 | ); 466 | let (_t, _il, b) = mt.sto.get(&[0; 32]); 467 | assert_eq!(mt.root.to_vec(), b); 468 | } 469 | 470 | #[test] 471 | fn test_tree_node() { 472 | let n = node::TreeNode { 473 | child_l: [1; 32], 474 | child_r: [2; 32], 475 | }; 476 | assert_eq!("01010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202", 477 | n.bytes().to_hex()); 478 | assert_eq!( 479 | "346d8c96a2454213fcc0daff3c96ad0398148181b9fa6488f7ae2c0af5b20aa0", 480 | n.ht().to_hex() 481 | ); 482 | } 483 | 484 | #[test] 485 | fn test_add() { 486 | let mut sto = db::Db::new("test".to_string(), true); 487 | let mut mt = MerkleTree::new(&mut sto, 140); 488 | assert_eq!( 489 | "0000000000000000000000000000000000000000000000000000000000000000", 490 | mt.root.to_hex() 491 | ); 492 | let val = TestValue { 493 | bytes: vec![1, 2, 3, 4, 5], 494 | index_length: 3, 495 | }; 496 | mt.add(&val).unwrap(); 497 | let (_t, _il, b) = mt.sto.get(&val.ht()); 498 | assert_eq!(*val.bytes(), b); 499 | assert_eq!( 500 | "a0e72cc948119fcb71b413cf5ada12b2b825d5133299b20a6d9325ffc3e2fbf1", 501 | mt.root.to_hex() 502 | ); 503 | } 504 | 505 | #[test] 506 | fn test_add_2() { 507 | let mut sto = db::Db::new("test".to_string(), true); 508 | let mut mt = MerkleTree::new(&mut sto, 140); 509 | let val = TestValue { 510 | bytes: "this is a test leaf".as_bytes().to_vec(), 511 | index_length: 15, 512 | }; 513 | assert_eq!( 514 | "0000000000000000000000000000000000000000000000000000000000000000", 515 | mt.root.to_hex() 516 | ); 517 | mt.add(&val).unwrap(); 518 | let (_t, _il, b) = mt.sto.get(&val.ht()); 519 | assert_eq!(*val.bytes(), b); 520 | assert_eq!( 521 | "b4fdf8a653198f0e179ccb3af7e4fc09d76247f479d6cfc95cd92d6fda589f27", 522 | mt.root.to_hex() 523 | ); 524 | let val2 = TestValue { 525 | bytes: "this is a second test leaf".as_bytes().to_vec(), 526 | index_length: 15, 527 | }; 528 | mt.add(&val2).unwrap(); 529 | let (_t, _il, b) = mt.sto.get(&val2.ht()); 530 | assert_eq!(*val2.bytes(), b); 531 | assert_eq!( 532 | "8ac95e9c8a6fbd40bb21de7895ee35f9c8f30ca029dbb0972c02344f49462e82", 533 | mt.root.to_hex() 534 | ); 535 | } 536 | 537 | #[test] 538 | fn test_generate_proof_and_verify_proof() { 539 | let mut sto = db::Db::new("test".to_string(), true); 540 | let mut mt = MerkleTree::new(&mut sto, 140); 541 | let val = TestValue { 542 | bytes: "this is a test leaf".as_bytes().to_vec(), 543 | index_length: 15, 544 | }; 545 | assert_eq!( 546 | "0000000000000000000000000000000000000000000000000000000000000000", 547 | mt.root.to_hex() 548 | ); 549 | mt.add(&val).unwrap(); 550 | let (_t, _il, b) = mt.sto.get(&val.ht()); 551 | assert_eq!(*val.bytes(), b); 552 | assert_eq!( 553 | "b4fdf8a653198f0e179ccb3af7e4fc09d76247f479d6cfc95cd92d6fda589f27", 554 | mt.root.to_hex() 555 | ); 556 | let val2 = TestValue { 557 | bytes: "this is a second test leaf".as_bytes().to_vec(), 558 | index_length: 15, 559 | }; 560 | mt.add(&val2).unwrap(); 561 | let (_t, _il, b) = mt.sto.get(&val2.ht()); 562 | assert_eq!(*val2.bytes(), b); 563 | assert_eq!( 564 | "8ac95e9c8a6fbd40bb21de7895ee35f9c8f30ca029dbb0972c02344f49462e82", 565 | mt.root.to_hex() 566 | ); 567 | 568 | let mp = mt.generate_proof(val2.hi()); 569 | assert_eq!("0000000000000000000000000000000000000000000000000000000000000001fd8e1a60cdb23c0c7b2cf8462c99fafd905054dccb0ed75e7c8a7d6806749b6b", mp.to_hex()); 570 | 571 | // verify 572 | let v = verify_proof(mt.root, &mp, val2.hi(), val2.ht(), mt.num_levels); 573 | assert_eq!(true, v); 574 | } 575 | 576 | #[test] 577 | fn test_generate_proof_empty_leaf_and_verify_proof() { 578 | let mut sto = db::Db::new("test".to_string(), true); 579 | let mut mt = MerkleTree::new(&mut sto, 140); 580 | let val = TestValue { 581 | bytes: "this is a test leaf".as_bytes().to_vec(), 582 | index_length: 15, 583 | }; 584 | mt.add(&val).unwrap(); 585 | let val2 = TestValue { 586 | bytes: "this is a second test leaf".as_bytes().to_vec(), 587 | index_length: 15, 588 | }; 589 | mt.add(&val2).unwrap(); 590 | assert_eq!( 591 | "8ac95e9c8a6fbd40bb21de7895ee35f9c8f30ca029dbb0972c02344f49462e82", 592 | mt.root.to_hex() 593 | ); 594 | 595 | // proof of empty leaf 596 | let val3 = TestValue { 597 | bytes: "this is a third test leaf".as_bytes().to_vec(), 598 | index_length: 15, 599 | }; 600 | let mp = mt.generate_proof(val3.hi()); 601 | assert_eq!("000000000000000000000000000000000000000000000000000000000000000389741fa23da77c259781ad8f4331a5a7d793eef1db7e5200ddfc8e5f5ca7ce2bfd8e1a60cdb23c0c7b2cf8462c99fafd905054dccb0ed75e7c8a7d6806749b6b", mp.to_hex()); 602 | 603 | // verify that is a proof of an empty leaf (constants::EMPTYNODEVALUE) 604 | let v = verify_proof( 605 | mt.root, 606 | &mp, 607 | val3.hi(), 608 | constants::EMPTYNODEVALUE, 609 | mt.num_levels, 610 | ); 611 | assert_eq!(true, v); 612 | } 613 | 614 | #[test] 615 | fn test_harcoded_proofs_of_existing_leaf() { 616 | // check proof of value in leaf 617 | let mut root: [u8; 32] = [0; 32]; 618 | root.copy_from_slice( 619 | &hex::decode("7d7c5e8f4b3bf434f3d9d223359c4415e2764dd38de2e025fbf986e976a7ed3d") 620 | .unwrap(), 621 | ); 622 | let mp = hex::decode("0000000000000000000000000000000000000000000000000000000000000002d45aada6eec346222eaa6b5d3a9260e08c9b62fcf63c72bc05df284de07e6a52").unwrap(); 623 | let mut hi: [u8; 32] = [0; 32]; 624 | hi.copy_from_slice( 625 | &hex::decode("786677808ba77bdd9090a969f1ef2cbd1ac5aecd9e654f340500159219106878") 626 | .unwrap(), 627 | ); 628 | let mut ht: [u8; 32] = [0; 32]; 629 | ht.copy_from_slice( 630 | &hex::decode("786677808ba77bdd9090a969f1ef2cbd1ac5aecd9e654f340500159219106878") 631 | .unwrap(), 632 | ); 633 | let v = verify_proof(root, &mp, hi, ht, 140); 634 | assert_eq!(true, v); 635 | } 636 | 637 | #[test] 638 | fn test_harcoded_proofs_of_empty_leaf() { 639 | // check proof of value in leaf 640 | let mut root: [u8; 32] = [0; 32]; 641 | root.copy_from_slice( 642 | &hex::decode("8f021d00c39dcd768974ddfe0d21f5d13f7215bea28db1f1cb29842b111332e7") 643 | .unwrap(), 644 | ); 645 | let mp = hex::decode("0000000000000000000000000000000000000000000000000000000000000004bf8e980d2ed328ae97f65c30c25520aeb53ff837579e392ea1464934c7c1feb9").unwrap(); 646 | let mut hi: [u8; 32] = [0; 32]; 647 | hi.copy_from_slice( 648 | &hex::decode("a69792a4cff51f40b7a1f7ae596c6ded4aba241646a47538898f17f2a8dff647") 649 | .unwrap(), 650 | ); 651 | let v = verify_proof(root, &mp, hi, constants::EMPTYNODEVALUE, 140); 652 | assert_eq!(true, v); 653 | } 654 | 655 | #[test] 656 | fn test_add_leafs_different_order() { 657 | let mut sto1 = db::Db::new("test".to_string(), true); 658 | let mut mt1 = MerkleTree::new(&mut sto1, 140); 659 | mt1.add(&TestValue { 660 | bytes: "0 this is a test leaf".as_bytes().to_vec(), 661 | index_length: 15, 662 | }) 663 | .unwrap(); 664 | mt1.add(&TestValue { 665 | bytes: "1 this is a test leaf".as_bytes().to_vec(), 666 | index_length: 15, 667 | }) 668 | .unwrap(); 669 | mt1.add(&TestValue { 670 | bytes: "2 this is a test leaf".as_bytes().to_vec(), 671 | index_length: 15, 672 | }) 673 | .unwrap(); 674 | mt1.add(&TestValue { 675 | bytes: "3 this is a test leaf".as_bytes().to_vec(), 676 | index_length: 15, 677 | }) 678 | .unwrap(); 679 | mt1.add(&TestValue { 680 | bytes: "4 this is a test leaf".as_bytes().to_vec(), 681 | index_length: 15, 682 | }) 683 | .unwrap(); 684 | mt1.add(&TestValue { 685 | bytes: "5 this is a test leaf".as_bytes().to_vec(), 686 | index_length: 15, 687 | }) 688 | .unwrap(); 689 | // mt1.print_full_tree(); 690 | 691 | let mut sto2 = db::Db::new("test".to_string(), true); 692 | let mut mt2 = MerkleTree::new(&mut sto2, 140); 693 | mt2.add(&TestValue { 694 | bytes: "2 this is a test leaf".as_bytes().to_vec(), 695 | index_length: 15, 696 | }) 697 | .unwrap(); 698 | mt2.add(&TestValue { 699 | bytes: "1 this is a test leaf".as_bytes().to_vec(), 700 | index_length: 15, 701 | }) 702 | .unwrap(); 703 | mt2.add(&TestValue { 704 | bytes: "0 this is a test leaf".as_bytes().to_vec(), 705 | index_length: 15, 706 | }) 707 | .unwrap(); 708 | mt2.add(&TestValue { 709 | bytes: "5 this is a test leaf".as_bytes().to_vec(), 710 | index_length: 15, 711 | }) 712 | .unwrap(); 713 | mt2.add(&TestValue { 714 | bytes: "3 this is a test leaf".as_bytes().to_vec(), 715 | index_length: 15, 716 | }) 717 | .unwrap(); 718 | mt2.add(&TestValue { 719 | bytes: "4 this is a test leaf".as_bytes().to_vec(), 720 | index_length: 15, 721 | }) 722 | .unwrap(); 723 | // mt2.print_full_tree(); 724 | 725 | assert_eq!(mt1.root, mt2.root); 726 | assert_eq!( 727 | &mt1.root.to_hex(), 728 | "264397f84da141b3134dcde1d7540d27a2bf0d787bbe8365d9ad5c9c18d3c621" 729 | ); 730 | } 731 | 732 | #[test] 733 | fn test_add_1000_leafs() { 734 | let mut sto = db::Db::new("test".to_string(), true); 735 | let mut mt = MerkleTree::new(&mut sto, 140); 736 | for i in 0..1000 { 737 | mt.add(&TestValue { 738 | bytes: (i.to_string() + " this is a test leaf").as_bytes().to_vec(), 739 | index_length: 15, 740 | }) 741 | .unwrap(); 742 | } 743 | assert_eq!( 744 | mt.root.to_hex(), 745 | "6e2da580b2920cd78ed8d4e4bf41e209dfc99ef28bc19560042f0ac803e0d6f7" 746 | ); 747 | } 748 | 749 | #[test] 750 | fn test_get_root_in_db() { 751 | let mut sto = db::Db::new("test".to_string(), true); 752 | let mut mt = MerkleTree::new(&mut sto, 140); 753 | for i in 0..10 { 754 | mt.add(&TestValue { 755 | bytes: (i.to_string() + " this is a test leaf").as_bytes().to_vec(), 756 | index_length: 15, 757 | }) 758 | .unwrap(); 759 | } 760 | assert_eq!( 761 | mt.root.to_hex(), 762 | "9418fd35bae19de4ab033efaf7cc624adf6a42827e39029d8da13288e9c3170d" 763 | ); 764 | let mt2 = MerkleTree::new(&mut sto, 140); 765 | assert_eq!( 766 | mt2.root.to_hex(), 767 | "9418fd35bae19de4ab033efaf7cc624adf6a42827e39029d8da13288e9c3170d" 768 | ); 769 | } 770 | } 771 | -------------------------------------------------------------------------------- /src/node.rs: -------------------------------------------------------------------------------- 1 | use super::constants; 2 | use super::utils; 3 | 4 | pub struct TreeNode { 5 | pub child_l: [u8; 32], 6 | pub child_r: [u8; 32], 7 | } 8 | 9 | impl TreeNode { 10 | pub fn bytes(&self) -> Vec { 11 | concatenate_arrays(&self.child_l, &self.child_r) 12 | } 13 | pub fn ht(&self) -> [u8; 32] { 14 | utils::hash_vec(self.bytes()) 15 | } 16 | } 17 | 18 | fn concatenate_arrays(x: &[T], y: &[T]) -> Vec { 19 | let mut concat = x.to_vec(); 20 | concat.extend_from_slice(y); 21 | 22 | concat 23 | } 24 | 25 | pub fn parse_node_bytes(b: Vec) -> TreeNode { 26 | if b == constants::EMPTYNODEVALUE { 27 | let n = TreeNode { 28 | child_l: constants::EMPTYNODEVALUE, 29 | child_r: constants::EMPTYNODEVALUE, 30 | }; 31 | return n; 32 | } 33 | let child_l = &b[0..32]; 34 | let child_r = &b[32..]; 35 | TreeNode { 36 | child_l: *array_ref!(child_l, 0, 32), 37 | child_r: *array_ref!(child_r, 0, 32), 38 | } 39 | } 40 | 41 | #[cfg(test)] 42 | mod tests { 43 | use super::*; 44 | use rustc_hex::ToHex; 45 | 46 | #[test] 47 | fn test_hash_vec() { 48 | let n = TreeNode { 49 | child_l: constants::EMPTYNODEVALUE, 50 | child_r: constants::EMPTYNODEVALUE, 51 | }; 52 | assert_eq!( 53 | "ad3228b676f7d3cd4284a5443f17f1962b36e491b30a40b2405849e597ba5fb5", 54 | n.ht().to_hex() 55 | ) 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /src/utils.rs: -------------------------------------------------------------------------------- 1 | use super::constants; 2 | use super::node; 3 | use tiny_keccak::Keccak; 4 | 5 | pub fn hash_vec(b: Vec) -> [u8; 32] { 6 | let mut sha3 = Keccak::new_keccak256(); 7 | sha3.update(&b); 8 | let mut res: [u8; 32] = [0; 32]; 9 | sha3.finalize(&mut res); 10 | res 11 | } 12 | 13 | pub fn get_path(num_levels: u32, hi: [u8; 32]) -> Vec { 14 | let mut path = Vec::new(); 15 | for i in (0..=num_levels as usize - 2).rev() { 16 | path.push((hi[hi.len() - i / 8 - 1] & (1 << (i % 8))) > 0); 17 | } 18 | path 19 | } 20 | 21 | pub fn calc_hash_from_leaf_and_level( 22 | until_level: u32, 23 | path: &[bool], 24 | leaf_hash: [u8; 32], 25 | ) -> [u8; 32] { 26 | let mut node_curr_lvl = leaf_hash; 27 | for i in 0..until_level { 28 | if path[i as usize] { 29 | let node = node::TreeNode { 30 | child_l: constants::EMPTYNODEVALUE, 31 | child_r: node_curr_lvl, 32 | }; 33 | node_curr_lvl = node.ht(); 34 | } else { 35 | let node = node::TreeNode { 36 | child_l: node_curr_lvl, 37 | child_r: constants::EMPTYNODEVALUE, 38 | }; 39 | node_curr_lvl = node.ht(); 40 | } 41 | } 42 | node_curr_lvl 43 | } 44 | 45 | pub fn cut_path(path: &[bool], i: usize) -> Vec { 46 | let mut path_res: Vec = Vec::new(); 47 | for j in 0..path.len() { 48 | if j >= i { 49 | path_res.push(path[j]); 50 | } 51 | } 52 | path_res 53 | } 54 | 55 | pub fn compare_paths(a: &[bool], b: &[bool]) -> i32 { 56 | for i in (0..a.len()).rev() { 57 | if a[i] != b[i] { 58 | return i as i32; 59 | } 60 | } 61 | -1 62 | } 63 | 64 | pub fn get_empties_between_i_and_pos(i: u32, pos: u32) -> Vec<[u8; 32]> { 65 | let mut sibl: Vec<[u8; 32]> = Vec::new(); 66 | for _ in (pos..=i).rev() { 67 | sibl.push(constants::EMPTYNODEVALUE); 68 | } 69 | sibl 70 | } 71 | 72 | #[cfg(test)] 73 | mod tests { 74 | use super::*; 75 | use rustc_hex::ToHex; 76 | 77 | #[test] 78 | fn test_hash_vec() { 79 | let a: Vec = From::from("test"); 80 | assert_eq!("74657374", a.to_hex()); 81 | let h = hash_vec(a); 82 | assert_eq!( 83 | "9c22ff5f21f0b81b113e63f7db6da94fedef11b2119b4088b89664fb9a3cb658", 84 | h.to_hex() 85 | ); 86 | } 87 | } 88 | --------------------------------------------------------------------------------