├── .gitignore ├── LICENSE ├── README.md ├── merklemap.go ├── merklemap.pb.go ├── merklemap.proto └── merklemap_test.go /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 2 | *.o 3 | *.a 4 | *.so 5 | 6 | # Folders 7 | _obj 8 | _test 9 | 10 | # Architecture specific extensions/prefixes 11 | *.[568vq] 12 | [568vq].out 13 | 14 | *.cgo1.go 15 | *.cgo2.c 16 | _cgo_defun.c 17 | _cgo_gotypes.go 18 | _cgo_export.* 19 | 20 | _testmain.go 21 | 22 | *.exe 23 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | merklemap 2 | ========= 3 | 4 | A radix Merkle tree stored on disk 5 | -------------------------------------------------------------------------------- /merklemap.go: -------------------------------------------------------------------------------- 1 | package merklemap 2 | 3 | import ( 4 | "crypto/sha256" 5 | "encoding/binary" 6 | "fmt" 7 | "io" 8 | "os" 9 | "sync" 10 | ) 11 | 12 | func assert(flag bool) { 13 | if !flag { 14 | panic("assertion failed") 15 | } 16 | } 17 | 18 | func min(a int, b int) int { 19 | if a < b { 20 | return a 21 | } else { 22 | return b 23 | } 24 | } 25 | 26 | type MapError struct { 27 | msg string 28 | } 29 | 30 | func (err *MapError) Error() string { 31 | return err.msg 32 | } 33 | 34 | type Map struct { 35 | allocMutex sync.Mutex 36 | fileName string 37 | } 38 | 39 | const HEADER_SIZE = 1024 40 | 41 | type header struct { 42 | NrNodes int64 43 | } 44 | 45 | func (header *header) Write(w io.Writer) error { 46 | err := binary.Write(w, binary.LittleEndian, header) 47 | if err != nil { 48 | return err 49 | } 50 | // pad 51 | _, err = w.Write(make([]byte, HEADER_SIZE-binary.Size(header))) 52 | return err 53 | } 54 | 55 | const KEY_BYTES = 32 56 | const HASH_BYTES = 32 57 | const DATA_BYTES = 32 58 | const ELEMENT_BITS = 4 59 | const KEY_ELEMENTS = KEY_BYTES * 8 / ELEMENT_BITS 60 | const NODE_CHILDREN = 1 << ELEMENT_BITS 61 | 62 | const NODE_SIZE = 1024 63 | 64 | func Hash(data []byte) *[HASH_BYTES]byte { 65 | hash := sha256.New() 66 | hash.Write(data) 67 | hashVal := new([HASH_BYTES]byte) 68 | copy(hashVal[:], hash.Sum(make([]byte, 0))) 69 | return hashVal 70 | } 71 | 72 | type leafData struct { 73 | Hash [HASH_BYTES]byte 74 | Value [HASH_BYTES]byte 75 | } 76 | 77 | type nodeData struct { 78 | Children [NODE_CHILDREN]int64 79 | ChildHashes [NODE_CHILDREN][HASH_BYTES]byte 80 | leafData 81 | } 82 | 83 | type diskNode struct { 84 | nodeData 85 | SubstringLength int64 // number of elements (i.e. in units of ELEMENT_BITS bits) 86 | KeySubstring [KEY_BYTES]byte 87 | } 88 | 89 | type hashNode struct { 90 | Hash []byte 91 | HasTwoChildren bool 92 | } 93 | 94 | type node struct { 95 | nodeData 96 | Index int64 97 | KeyOffset int 98 | KeySubstring []byte // slice of elements 99 | MapHashes *[NODE_CHILDREN - 1]*hashNode 100 | } 101 | 102 | // hardcoded for ELEMENT_BITS = 4 103 | func bytesToElements(bytes []byte) []byte { 104 | if ELEMENT_BITS != 4 { 105 | panic("not implemented") 106 | } 107 | elements := make([]byte, len(bytes)*2) 108 | for i, b := range bytes { 109 | elements[i*2] = b >> 4 110 | elements[i*2+1] = b & 0xf 111 | } 112 | return elements 113 | } 114 | 115 | // hardcoded for ELEMENT_BITS = 4 116 | func elementsToBytes(elements []byte) []byte { 117 | if ELEMENT_BITS != 4 { 118 | panic("not implemented") 119 | } 120 | bytes := make([]byte, len(elements)/2) 121 | for i := range bytes { 122 | bytes[i] = elements[i*2]<<4 | elements[i*2+1] 123 | } 124 | if len(elements)%2 == 1 { 125 | bytes = append(bytes, elements[len(elements)-1]<<4) 126 | } 127 | return bytes 128 | } 129 | 130 | func (n *node) BuildMapHashes(treeIx int) []byte { 131 | leafIx := treeIx - NODE_CHILDREN + 1 132 | if leafIx >= 0 { 133 | // leaf 134 | if n.Children[leafIx] > 0 { 135 | return n.ChildHashes[leafIx][:] 136 | } else { 137 | return make([]byte, 0) 138 | } 139 | } else { 140 | hn := &hashNode{Hash: make([]byte, 0)} 141 | for i := 0; i < 2; i++ { 142 | hn.Hash = append(hn.Hash, n.BuildMapHashes(treeIx*2+1+i)...) // might be empty 143 | } 144 | if len(hn.Hash) > HASH_BYTES { 145 | // only hash if both children were non-empty 146 | hn.HasTwoChildren = true 147 | hn.Hash = Hash(hn.Hash)[:] 148 | } 149 | n.MapHashes[treeIx] = hn 150 | return hn.Hash 151 | } 152 | } 153 | 154 | func (n *node) EnsureMapHashes() *[NODE_CHILDREN - 1]*hashNode { 155 | if n.MapHashes == nil { 156 | n.MapHashes = new([NODE_CHILDREN - 1]*hashNode) 157 | n.BuildMapHashes(0) 158 | } 159 | return n.MapHashes 160 | } 161 | 162 | // Indexes into the binary tree (row = depth, column = in-order index in row) 163 | func (n *node) IndexHashNode(row int, column int) int { 164 | return (1 << uint(row)) - 1 + column 165 | } 166 | 167 | func (n *node) getHashNode(index int) *hashNode { 168 | leafIx := index - NODE_CHILDREN + 1 169 | if leafIx >= 0 { 170 | return &hashNode{Hash: n.ChildHashes[leafIx][:]} 171 | } 172 | treeHashes := n.EnsureMapHashes() 173 | return treeHashes[index] 174 | } 175 | 176 | func (n *node) setChildHash(childIx int, hash []byte) { 177 | copy(n.ChildHashes[childIx][:], hash) 178 | n.MapHashes = nil // invalidate 179 | } 180 | 181 | func (parent *node) SetChild(childIx int, child *node) { 182 | parent.Children[childIx] = child.Index 183 | // propagate hash 184 | if child.KeyOffset+len(child.KeySubstring) == KEY_ELEMENTS { 185 | // leaf 186 | parent.setChildHash(childIx, child.Hash[:]) 187 | } else { 188 | parent.setChildHash(childIx, child.getHashNode(child.IndexHashNode(0, 0)).Hash) 189 | } 190 | } 191 | 192 | func (dn *diskNode) fromDisk(index int64, keyOffset int) *node { 193 | n := new(node) 194 | n.nodeData = dn.nodeData 195 | n.Index = index 196 | n.KeyOffset = keyOffset 197 | n.KeySubstring = bytesToElements(dn.KeySubstring[:])[:dn.SubstringLength] 198 | return n 199 | } 200 | 201 | func (n *node) toDisk() *diskNode { 202 | dn := new(diskNode) 203 | dn.nodeData = n.nodeData 204 | copy(dn.KeySubstring[:], elementsToBytes(n.KeySubstring)) 205 | dn.SubstringLength = int64(len(n.KeySubstring)) 206 | return dn 207 | } 208 | 209 | func (handle *Handle) clear() error { 210 | _, err := handle.file.Seek(0, os.SEEK_SET) 211 | if err != nil { 212 | return err 213 | } 214 | var header header 215 | header.NrNodes = 0 216 | err = header.Write(handle.file) 217 | if err != nil { 218 | return err 219 | } 220 | offset, err := handle.file.Seek(0, os.SEEK_CUR) 221 | if err != nil { 222 | return err 223 | } 224 | err = handle.file.Truncate(offset) 225 | return err 226 | } 227 | 228 | func Open(fileName string) (*Map, error) { 229 | tree := new(Map) 230 | tree.fileName = fileName 231 | handle, err := tree.GetSnapshot(-1).OpenHandle() 232 | if err != nil { 233 | return nil, err 234 | } 235 | defer handle.Close() 236 | // Test to see if the file exists in a usable form by reading its header 237 | header := new(header) 238 | err = binary.Read(handle.file, binary.LittleEndian, header) 239 | if err != nil { 240 | // Initialize file 241 | err := handle.clear() 242 | if err != nil { 243 | return nil, err 244 | } 245 | _, err = handle.FinishUpdate() 246 | if err != nil { 247 | return nil, err 248 | } 249 | return tree, nil 250 | } else { 251 | return tree, nil 252 | } 253 | } 254 | 255 | func (handle *Handle) readNode(nodeIx int64, keyOffset int) (*node, error) { 256 | dn := new(diskNode) 257 | _, err := handle.file.Seek(int64(HEADER_SIZE+NODE_SIZE*(nodeIx-1)), os.SEEK_SET) 258 | if err != nil { 259 | return nil, err 260 | } 261 | err = binary.Read(handle.file, binary.LittleEndian, dn) 262 | if err != nil { 263 | return nil, err 264 | } 265 | // debug check 266 | header, err := handle.readHeader() 267 | if err != nil { 268 | panic(err) 269 | } 270 | n := dn.fromDisk(nodeIx, keyOffset) 271 | for i, c := range n.Children { 272 | if c < 0 || c >= header.NrNodes+1 { 273 | panic(fmt.Sprintf("child out of range: %x[%x]=%x", n.Index, i, c)) 274 | } 275 | } 276 | return n, nil 277 | } 278 | 279 | func (handle *Handle) writeNode(node *node) error { 280 | _, err := handle.file.Seek(int64(HEADER_SIZE+NODE_SIZE*(node.Index-1)), os.SEEK_SET) 281 | if err != nil { 282 | return err 283 | } 284 | dn := node.toDisk() 285 | err = binary.Write(handle.file, binary.LittleEndian, dn) 286 | if err != nil { 287 | return err 288 | } 289 | padding := NODE_SIZE - binary.Size(dn) 290 | _, err = handle.file.Write(make([]byte, padding)) 291 | return err 292 | } 293 | 294 | func (handle *Handle) readHeader() (*header, error) { 295 | _, err := handle.file.Seek(0, os.SEEK_SET) 296 | if err != nil { 297 | return nil, err 298 | } 299 | header := new(header) 300 | err = binary.Read(handle.file, binary.LittleEndian, header) 301 | if err != nil { 302 | return nil, err 303 | } 304 | return header, nil 305 | } 306 | 307 | func (handle *Handle) writeHeader(header *header) error { 308 | _, err := handle.file.Seek(0, os.SEEK_SET) 309 | if err != nil { 310 | return err 311 | } 312 | return binary.Write(handle.file, binary.LittleEndian, header) 313 | } 314 | 315 | func (handle *Handle) allocNode() (int64, error) { 316 | handle.tree.allocMutex.Lock() 317 | defer handle.tree.allocMutex.Unlock() 318 | // read current number of nodes 319 | header, err := handle.readHeader() 320 | if err != nil { 321 | return -1, err 322 | } 323 | // get the new new node index 324 | header.NrNodes++ 325 | newIndex := header.NrNodes 326 | // write back increased number of nodes 327 | err = handle.writeHeader(header) 328 | if err != nil { 329 | return -1, err 330 | } 331 | return newIndex, nil 332 | } 333 | 334 | // Note: doesn't write the node onto disk yet 335 | func (handle *Handle) newNode(keyOffset int) (*node, error) { 336 | ix, err := handle.allocNode() 337 | if err != nil { 338 | return nil, err 339 | } 340 | n := &node{Index: ix, KeyOffset: keyOffset} 341 | return n, nil 342 | } 343 | 344 | func firstMismatch(slice1 []byte, slice2 []byte) int { 345 | shorterLen := min(len(slice1), len(slice2)) 346 | for i := 0; i < shorterLen; i++ { 347 | if slice1[i] != slice2[i] { 348 | return i 349 | } 350 | } 351 | return shorterLen 352 | } 353 | 354 | // returns (nodes on matching path, position of last node, mismatch position in last node, error) 355 | func (handle *Handle) partialLookup(key []byte) ([]*node, int, int, error) { 356 | if handle.root == 0 { 357 | // no root, empty tree 358 | return nil, 0, 0, nil 359 | } 360 | root, err := handle.readNode(handle.root, 0) 361 | if err != nil { 362 | return nil, 0, 0, err 363 | } 364 | nodes := []*node{root} 365 | n := root 366 | pos := 0 367 | for { 368 | mismatchPos := 0 369 | // First, compare the substring on the current n. 370 | if len(n.KeySubstring) > 0 { 371 | keySubstr := key[pos : pos+len(n.KeySubstring)] 372 | nodeSubstr := n.KeySubstring 373 | mismatchPos = firstMismatch(keySubstr, nodeSubstr) 374 | if mismatchPos != len(n.KeySubstring) { 375 | // Mismatch in the middle of the edge 376 | return nodes, pos, mismatchPos, nil 377 | } 378 | pos += len(n.KeySubstring) 379 | } 380 | if pos == KEY_ELEMENTS { 381 | // Full match 382 | return nodes, KEY_ELEMENTS, 0, nil 383 | } 384 | if pos > KEY_ELEMENTS { 385 | return nil, 0, 0, &MapError{"corrupted tree: key too long"} 386 | } 387 | // Then, index into the children 388 | childIx := key[pos] 389 | if n.Children[childIx] == 0 { 390 | // Mismatch at the end of the edge 391 | return nodes, pos - len(n.KeySubstring), len(n.KeySubstring), nil 392 | } else { 393 | pos++ 394 | n, err = handle.readNode(n.Children[childIx], pos) 395 | nodes = append(nodes, n) 396 | if err != nil { 397 | return nil, 0, 0, err 398 | } 399 | } 400 | } 401 | } 402 | 403 | func (handle *Handle) GetPath(keyBytes *[KEY_BYTES]byte) ( 404 | value *[HASH_BYTES]byte, path *MerklePath, err error, 405 | ) { 406 | key := bytesToElements(keyBytes[:]) 407 | nodes, pos, _, err := handle.partialLookup(key) 408 | if err != nil { 409 | return 410 | } 411 | if len(nodes) == 0 || pos != KEY_ELEMENTS { 412 | return 413 | } 414 | pathHashes := make([]*SiblingHash, 0) 415 | for _, n := range nodes { 416 | for j := 0; j < ELEMENT_BITS; j++ { 417 | keyIx := n.KeyOffset + len(n.KeySubstring) 418 | if keyIx == KEY_ELEMENTS { 419 | break 420 | } 421 | elem := key[keyIx] 422 | hnIx := n.IndexHashNode(j, int(elem>>uint(ELEMENT_BITS-j))) 423 | hashNode := n.getHashNode(hnIx) 424 | if hashNode.HasTwoChildren { 425 | siblingSide := int(1 - ((elem >> uint(ELEMENT_BITS-j-1)) & 1)) 426 | siblingNode := n.getHashNode(hnIx*2 + 1 + siblingSide) 427 | isLeftSibling := siblingSide == 0 428 | pathHashes = append(pathHashes, &SiblingHash{ 429 | Hash: siblingNode.Hash, 430 | IsLeftSibling: &isLeftSibling, 431 | }) 432 | } 433 | } 434 | } 435 | value = &nodes[len(nodes)-1].Value 436 | path = &MerklePath{SiblingHashes: pathHashes} 437 | return 438 | } 439 | 440 | func (handle *Handle) updatePath(path []*node) error { 441 | for { 442 | ix, err := handle.allocNode() 443 | if err != nil { 444 | return err 445 | } 446 | n := path[len(path)-1] 447 | oldix := n.Index 448 | n.Index = ix 449 | handle.writeNode(n) 450 | if len(path) == 1 { 451 | handle.root = ix 452 | return nil 453 | } else { 454 | parent := path[len(path)-2] 455 | setChild := false 456 | for i, child := range parent.Children { 457 | if child == oldix { 458 | parent.SetChild(i, n) 459 | setChild = true 460 | break 461 | } 462 | } 463 | if !setChild { 464 | return &MapError{"Inconsistent tree!"} 465 | } 466 | // continue with one node less 467 | path = path[:len(path)-1] 468 | } 469 | } 470 | } 471 | 472 | func (handle *Handle) Set(keyBytes *[KEY_BYTES]byte, value *[HASH_BYTES]byte) error { 473 | key := bytesToElements(keyBytes[:]) 474 | 475 | data := &leafData{Value: *value, Hash: *Hash(append(keyBytes[:], value[:]...))} 476 | 477 | nodes, pos, mismatchPos, err := handle.partialLookup(key) 478 | if err != nil { 479 | return err 480 | } 481 | if len(nodes) == 0 { 482 | // Create root node 483 | rootNode, err := handle.newNode(0) 484 | if err != nil { 485 | return err 486 | } 487 | rootNode.leafData = *data 488 | rootNode.KeySubstring = key 489 | err = handle.writeNode(rootNode) 490 | if err != nil { 491 | return err 492 | } 493 | handle.root = rootNode.Index 494 | return nil 495 | } else { 496 | lastNode := nodes[len(nodes)-1] 497 | if pos == KEY_ELEMENTS { 498 | // Update leaf node 499 | lastNode.leafData = *data 500 | } else { 501 | // Make new child node 502 | newNode, err := handle.newNode(pos + mismatchPos + 1) 503 | if err != nil { 504 | return err 505 | } 506 | newNode.KeySubstring = key[pos+mismatchPos+1:] 507 | newNode.leafData = *data 508 | if mismatchPos == len(lastNode.KeySubstring) { 509 | lastNode.SetChild(int(key[pos+mismatchPos]), newNode) 510 | } else { 511 | // Split node: allocate second child node 512 | splitNode, err := handle.newNode(pos + mismatchPos + 1) 513 | if err != nil { 514 | return err 515 | } 516 | oldSubstr := lastNode.KeySubstring 517 | mismatchedSubstr := oldSubstr[mismatchPos+1 : len(lastNode.KeySubstring)] 518 | splitNode.KeySubstring = mismatchedSubstr 519 | 520 | splitNode.leafData = lastNode.leafData 521 | lastNode.leafData = leafData{} 522 | copy(splitNode.Children[:], lastNode.Children[:]) 523 | copy(splitNode.ChildHashes[:], lastNode.ChildHashes[:]) 524 | copy(lastNode.Children[:], make([]int64, NODE_CHILDREN)) 525 | copy(lastNode.ChildHashes[:], make([][HASH_BYTES]byte, NODE_CHILDREN)) 526 | 527 | assert(oldSubstr[mismatchPos] != key[pos+mismatchPos]) 528 | lastNode.SetChild(int(oldSubstr[mismatchPos]), splitNode) 529 | lastNode.SetChild(int(key[pos+mismatchPos]), newNode) 530 | 531 | lastNode.KeySubstring = oldSubstr[:mismatchPos] 532 | 533 | err = handle.writeNode(splitNode) 534 | if err != nil { 535 | return err 536 | } 537 | } 538 | err = handle.writeNode(newNode) 539 | if err != nil { 540 | return err 541 | } 542 | } 543 | return handle.updatePath(nodes) 544 | } 545 | } 546 | 547 | func (handle *Handle) GetRootHash() (*[HASH_BYTES]byte, error) { 548 | if handle.root == 0 { 549 | // zero nodes 550 | return new([HASH_BYTES]byte), nil 551 | } 552 | n, err := handle.readNode(handle.root, 0) 553 | if err != nil { 554 | return nil, err 555 | } 556 | if len(n.KeySubstring) == KEY_ELEMENTS { 557 | // one node 558 | return &n.Hash, nil 559 | } else { 560 | // multiple nodes 561 | rootHash := new([HASH_BYTES]byte) 562 | copy(rootHash[:], n.getHashNode(n.IndexHashNode(0, 0)).Hash) 563 | return rootHash, nil 564 | } 565 | } 566 | 567 | func (path *MerklePath) ComputeRootHash(key *[HASH_BYTES]byte, value *[HASH_BYTES]byte) []byte { 568 | hash := Hash(append(key[:], value[:]...))[:] 569 | for i := len(path.SiblingHashes) - 1; i >= 0; i-- { 570 | siblingHash := path.SiblingHashes[i] 571 | if *siblingHash.IsLeftSibling { 572 | hash = Hash(append(siblingHash.Hash, hash...))[:] 573 | } else { 574 | hash = Hash(append(hash, siblingHash.Hash...))[:] 575 | } 576 | } 577 | return hash 578 | } 579 | 580 | type Snapshot struct { 581 | tree *Map 582 | root int64 583 | } 584 | 585 | type Handle struct { 586 | tree *Map 587 | file *os.File 588 | root int64 589 | } 590 | 591 | func (snapshot *Snapshot) OpenHandle() (*Handle, error) { 592 | fi, err := os.OpenFile(snapshot.tree.fileName, os.O_RDWR|os.O_CREATE, 0600) 593 | if err != nil { 594 | return nil, err 595 | } 596 | return &Handle{tree: snapshot.tree, file: fi, root: snapshot.root}, nil 597 | } 598 | 599 | // Closes the handle after read operations (you could have done writes, but 600 | // without getting back a new snapshot, they would be useless) 601 | // Note: idempotent (can be called repeatedly without problems) 602 | func (handle *Handle) Close() error { 603 | return handle.file.Close() 604 | } 605 | 606 | // Closes the handle after some update operations 607 | func (handle *Handle) FinishUpdate() (*Snapshot, error) { 608 | // Sync the file: we want to make sure snapshots are only visible once they've 609 | // been properly committed to disk 610 | err := handle.file.Sync() 611 | if err != nil { 612 | return nil, err 613 | } 614 | err = handle.Close() 615 | if err != nil { 616 | return nil, err 617 | } 618 | return &Snapshot{tree: handle.tree, root: handle.root}, nil 619 | } 620 | 621 | func (tree *Map) GetSnapshot(id int64) *Snapshot { 622 | return &Snapshot{tree: tree, root: id} 623 | } 624 | 625 | func (snapshot *Snapshot) GetId() int64 { 626 | return snapshot.root 627 | } 628 | -------------------------------------------------------------------------------- /merklemap.pb.go: -------------------------------------------------------------------------------- 1 | // Code generated by protoc-gen-go. 2 | // source: merklemap.proto 3 | // DO NOT EDIT! 4 | 5 | package merklemap 6 | 7 | import proto "code.google.com/p/goprotobuf/proto" 8 | import json "encoding/json" 9 | import math "math" 10 | 11 | // Reference proto, json, and math imports to suppress error if they are not otherwise used. 12 | var _ = proto.Marshal 13 | var _ = &json.SyntaxError{} 14 | var _ = math.Inf 15 | 16 | type SiblingHash struct { 17 | Hash []byte `protobuf:"bytes,1,req,name=hash" json:"hash,omitempty"` 18 | IsLeftSibling *bool `protobuf:"varint,2,req,name=is_left_sibling" json:"is_left_sibling,omitempty"` 19 | XXX_unrecognized []byte `json:"-"` 20 | } 21 | 22 | func (m *SiblingHash) Reset() { *m = SiblingHash{} } 23 | func (m *SiblingHash) String() string { return proto.CompactTextString(m) } 24 | func (*SiblingHash) ProtoMessage() {} 25 | 26 | func (m *SiblingHash) GetHash() []byte { 27 | if m != nil { 28 | return m.Hash 29 | } 30 | return nil 31 | } 32 | 33 | func (m *SiblingHash) GetIsLeftSibling() bool { 34 | if m != nil && m.IsLeftSibling != nil { 35 | return *m.IsLeftSibling 36 | } 37 | return false 38 | } 39 | 40 | type MerklePath struct { 41 | SiblingHashes []*SiblingHash `protobuf:"bytes,1,rep,name=sibling_hashes" json:"sibling_hashes,omitempty"` 42 | XXX_unrecognized []byte `json:"-"` 43 | } 44 | 45 | func (m *MerklePath) Reset() { *m = MerklePath{} } 46 | func (m *MerklePath) String() string { return proto.CompactTextString(m) } 47 | func (*MerklePath) ProtoMessage() {} 48 | 49 | func (m *MerklePath) GetSiblingHashes() []*SiblingHash { 50 | if m != nil { 51 | return m.SiblingHashes 52 | } 53 | return nil 54 | } 55 | 56 | func init() { 57 | } 58 | -------------------------------------------------------------------------------- /merklemap.proto: -------------------------------------------------------------------------------- 1 | package merklemap; 2 | 3 | message SiblingHash { 4 | required bytes hash = 1; 5 | required bool is_left_sibling = 2; 6 | } 7 | 8 | message MerklePath { 9 | repeated SiblingHash sibling_hashes = 1; 10 | } 11 | -------------------------------------------------------------------------------- /merklemap_test.go: -------------------------------------------------------------------------------- 1 | package merklemap 2 | 3 | import ( 4 | "testing" 5 | "bytes" 6 | "fmt" 7 | "math/rand" 8 | "os" 9 | "reflect" 10 | "code.google.com/p/goprotobuf/proto" 11 | ) 12 | 13 | const dbg = 0 14 | 15 | func TestMarshalUnmarshalMerklePath(t *testing.T) { 16 | tree, err := Open("tree.dat") 17 | snapshot := tree.GetSnapshot(0) 18 | handle, err := snapshot.OpenHandle() 19 | if err != nil { 20 | panic(err) 21 | } 22 | key := [32]byte{1,2,3,4,5,6,7,8,9,10,11,12,13,14,15} 23 | val := [32]byte{31,30,29,28,27,26,25,24,23,22,21,20,19,18,17,16} 24 | err = handle.Set(&key, &val) 25 | if err != nil { 26 | panic(err) 27 | } 28 | key[31]++; val[31]++; 29 | err = handle.Set(&key, &val) 30 | if err != nil { 31 | panic(err) 32 | } 33 | key[30]++; val[30]++; 34 | err = handle.Set(&key, &val) 35 | if err != nil { 36 | panic(err) 37 | } 38 | key[30]--; val[30]--; 39 | _, path, err := handle.GetPath(&key) 40 | if err != nil { 41 | panic(err) 42 | } 43 | bs, err := proto.Marshal(path) 44 | if err != nil { 45 | panic(err) 46 | } 47 | path2 := new(MerklePath) 48 | err = proto.Unmarshal(bs, path2) 49 | if err != nil { 50 | panic(err) 51 | } 52 | if !reflect.DeepEqual(path, path2) { 53 | t.Fatal("Lookup results not equal after a marshal roundtrip") 54 | } 55 | if !bytes.Equal(path.ComputeRootHash(&key, &val), path2.ComputeRootHash(&key, &val)) { 56 | t.Fatal("Root hashes not equal after a marshal roundtrip") 57 | } 58 | } 59 | 60 | func TestRandomly(t *testing.T) { 61 | bestTime := 100000 62 | bestSeed := -1 63 | var testCount int 64 | if testing.Short() { 65 | testCount = 0x10 66 | } else { 67 | testCount = 0x100 68 | } 69 | for i := 0x0; i < testCount; i++ { 70 | rand.Seed(int64(0x1234567 + (i ^ (i << 3)) + i*100000007)) 71 | tree, err := Open("tree.dat") 72 | if err != nil { 73 | panic(err) 74 | } 75 | randSign := rand.Intn(2)*2 - 1 76 | big := rand.Intn(20) == 0 77 | var itCount int 78 | if big { 79 | itCount = 10000 80 | } else { 81 | itCount = 100 82 | } 83 | time := mapTest(tree, itCount, (1+rand.Intn(256))*randSign, 3) 84 | fmt.Printf("seed %x: %v\n", i, time) 85 | if time < bestTime { 86 | bestTime = time 87 | bestSeed = i 88 | } 89 | } 90 | fmt.Printf("SEED %x: %v\n", bestSeed, bestTime) 91 | } 92 | 93 | func BenchmarkBigTree(b *testing.B) { 94 | rand.Seed(0x7777) 95 | tree, err := Open("tree.dat") 96 | if err != nil { 97 | panic(err) 98 | } 99 | mapTest(tree, 1000000, 256, 2) 100 | } 101 | 102 | func mapTest(tree *Map, itCount int, byteRange int, opn int) int { 103 | bytez := func(b byte) [32]byte { 104 | var bytes [32]byte 105 | for i := range bytes { 106 | bytes[i] = b<<4 | b 107 | } 108 | return bytes 109 | } 110 | randBytes := func() [32]byte { 111 | var bs [32]byte 112 | if byteRange < 0 { 113 | bs = bytez(byte(rand.Intn(-byteRange))) 114 | bs[0] = byte(rand.Intn(-byteRange)) 115 | bs[31] = byte(rand.Intn(-byteRange)) 116 | return bs 117 | } else { 118 | for i := range bs { 119 | bs[i] = byte(rand.Intn(byteRange)) 120 | } 121 | if dbg > 2 { 122 | fmt.Printf("rand bytes = %x\n", bs) 123 | } 124 | return bs 125 | } 126 | } 127 | snapshot := tree.GetSnapshot(0) 128 | handle, err := snapshot.OpenHandle() 129 | if err != nil { 130 | panic(err) 131 | } 132 | refMap := map[[32]byte][32]byte{} 133 | refMapKeys := [][32]byte{} 134 | randMapKey := func() [32]byte { 135 | return refMapKeys[rand.Intn(len(refMapKeys))] 136 | } 137 | refSet := func(key [32]byte, val [32]byte) { 138 | if _, present := refMap[key]; !present { 139 | refMapKeys = append(refMapKeys, key) 140 | } 141 | refMap[key] = val 142 | } 143 | refGet := func(key [32]byte) [32]byte { 144 | return refMap[key] 145 | } 146 | treeSet := func(key [32]byte, val [32]byte) { 147 | if dbg > 1 { 148 | fmt.Fprintf(os.Stdout, "set: [%x] = %x...\n", key, val) 149 | } 150 | err := handle.Set(&key, &val) 151 | if err != nil { 152 | panic(err) 153 | } 154 | if dbg > 0 { 155 | fmt.Fprintf(os.Stdout, "set [%x] = %x done\n", key, val) 156 | } 157 | } 158 | treeGet := func(key [32]byte) [32]byte { 159 | if dbg > 2 { 160 | fmt.Fprintf(os.Stdout, "read [%x]...\n", key) 161 | } 162 | val, result, err := handle.GetPath(&key) 163 | if err != nil { 164 | panic(err) 165 | } 166 | if result != nil { 167 | rootHash, err := handle.GetRootHash() 168 | if err != nil { 169 | panic(err) 170 | } 171 | if dbg > 1 { 172 | fmt.Fprintf(os.Stdout, "Lookup: %x\n", result) 173 | } 174 | computedRootHash := result.ComputeRootHash(&key, val) 175 | if !bytes.Equal(computedRootHash, rootHash[:]) { 176 | panic(fmt.Sprintf("bad root hash: %x != %x", computedRootHash, rootHash)) 177 | } 178 | } 179 | if dbg > 1 { 180 | fmt.Fprintf(os.Stdout, "read [%x] = %x\n", key, val) 181 | } 182 | if val == nil { 183 | return [32]byte{} 184 | } else { 185 | return *val 186 | } 187 | } 188 | for i := 0; i < itCount; i++ { 189 | if i%1000 == 0 { 190 | fmt.Printf("operation %v\n", i) 191 | } 192 | switch rand.Intn(opn) { 193 | case 0: 194 | k := randBytes() 195 | v := randBytes() 196 | refSet(k, v) 197 | treeSet(k, v) 198 | case 2: 199 | k := randBytes() 200 | v1 := refGet(k) 201 | v2 := treeGet(k) 202 | if dbg > 0 { 203 | fmt.Printf("1: [%x] = %x, %x\n", k, v2, v1) 204 | } 205 | if v1 != v2 { 206 | panic("wrong 1") 207 | } 208 | case 1: 209 | if len(refMap) > 0 { 210 | k := randMapKey() 211 | v1 := refGet(k) 212 | if dbg > 1 { 213 | fmt.Printf("read [%x]\n", k) 214 | } 215 | v2 := treeGet(k) 216 | if dbg > 0 { 217 | fmt.Printf("2: [%x] = %x, %x\n", k, v2, v1) 218 | } 219 | if v1 != v2 { 220 | panic(fmt.Sprintf("wrong 2 (t%v)", i)) 221 | } 222 | } 223 | } 224 | if rand.Intn(100) == 0 { 225 | newSnapshot, err := handle.FinishUpdate() 226 | if err != nil { 227 | panic(err) 228 | } 229 | snapshot = newSnapshot 230 | handle, err = snapshot.OpenHandle() 231 | if err != nil { 232 | panic(err) 233 | } 234 | } 235 | } 236 | return 100000000 237 | } 238 | --------------------------------------------------------------------------------